From 0b8bcb36bb00990e8df99bfc17df3afee03011e0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:39 +0000 Subject: [PATCH 001/144] feat(accesscontextmanager): update the API #### accesscontextmanager:v1 The following keys were added: - schemas.EgressTo.properties.roles.description - schemas.EgressTo.properties.roles.items.type - schemas.EgressTo.properties.roles.type - schemas.IngressTo.properties.roles.description - schemas.IngressTo.properties.roles.items.type - schemas.IngressTo.properties.roles.type The following keys were changed: - schemas.EgressSource.properties.resource.description --- discovery/accesscontextmanager-v1.json | 18 ++++++++++++++++-- src/apis/accesscontextmanager/v1.ts | 10 +++++++++- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/discovery/accesscontextmanager-v1.json b/discovery/accesscontextmanager-v1.json index 84ad266e1e9..a1eab93cc13 100644 --- a/discovery/accesscontextmanager-v1.json +++ b/discovery/accesscontextmanager-v1.json @@ -1295,7 +1295,7 @@ } } }, - "revision": "20250115", + "revision": "20250312", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1824,7 +1824,7 @@ "type": "string" }, "resource": { - "description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", + "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, @@ -1854,6 +1854,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2051,6 +2058,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index d5c77ecee2a..609741eab3b 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -462,7 +462,7 @@ export namespace accesscontextmanager_v1 { */ accessLevel?: string | null; /** - * A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number\}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + * A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number\}`. You can't use `*` in this field to allow all Google Cloud resources. */ resource?: string | null; } @@ -482,6 +482,10 @@ export namespace accesscontextmanager_v1 { * A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter. + */ + roles?: 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); \} @@ -622,6 +626,10 @@ export namespace accesscontextmanager_v1 { * A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * A response to `ListAccessLevelsRequest`. From fbe644667d8c5a3a871dac864cf765e3acde3c26 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:39 +0000 Subject: [PATCH 002/144] fix(admin): update the API #### admin:directory_v1 The following keys were changed: - resources.users.methods.list.parameters.pageToken.description - schemas.Users.properties.nextPageToken.description #### admin:reports_v1 The following keys were changed: - resources.activities.methods.list.parameters.groupIdFilter.description - resources.activities.methods.watch.parameters.groupIdFilter.description - resources.customerUsageReports.methods.get.parameters.parameters.pattern - resources.userUsageReport.methods.get.parameters.filters.pattern - resources.userUsageReport.methods.get.parameters.parameters.pattern --- discovery/admin-directory_v1.json | 6 +++--- discovery/admin-reports_v1.json | 12 ++++++------ src/apis/admin/directory_v1.ts | 4 ++-- src/apis/admin/reports_v1.ts | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index 6bef960870c..d90339118c1 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -4020,7 +4020,7 @@ "type": "string" }, "pageToken": { - "description": "Token to specify next page in the list", + "description": "Token to specify next page in the list. The page token is only valid for three days.", "location": "query", "type": "string" }, @@ -4671,7 +4671,7 @@ } } }, - "revision": "20241210", + "revision": "20250217", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -8658,7 +8658,7 @@ "type": "string" }, "nextPageToken": { - "description": "Token used to access next page of this result.", + "description": "Token used to access next page of this result. The page token is only valid for three days.", "type": "string" }, "trigger_event": { diff --git a/discovery/admin-reports_v1.json b/discovery/admin-reports_v1.json index 5ae7357cb00..92cab795c84 100644 --- a/discovery/admin-reports_v1.json +++ b/discovery/admin-reports_v1.json @@ -205,7 +205,7 @@ "type": "string" }, "groupIdFilter": { - "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"", + "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175)", "location": "query", "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)", "type": "string" @@ -344,7 +344,7 @@ "type": "string" }, "groupIdFilter": { - "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"", + "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175)", "location": "query", "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)", "type": "string" @@ -448,7 +448,7 @@ "parameters": { "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", "location": "query", - "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)", + "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)", "type": "string" } }, @@ -572,7 +572,7 @@ "filters": { "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). ", "location": "query", - "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)", + "pattern": "(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)", "type": "string" }, "groupIdFilter": { @@ -605,7 +605,7 @@ "parameters": { "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", "location": "query", - "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)", + "pattern": "(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)", "type": "string" }, "userKey": { @@ -626,7 +626,7 @@ } } }, - "revision": "20240220", + "revision": "20250304", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 14a3267990b..5f4b5e52ea7 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -2819,7 +2819,7 @@ export namespace admin_directory_v1 { */ kind?: string | null; /** - * Token used to access next page of this result. + * Token used to access next page of this result. The page token is only valid for three days. */ nextPageToken?: string | null; /** @@ -14683,7 +14683,7 @@ export namespace admin_directory_v1 { */ orderBy?: string; /** - * Token to specify next page in the list + * Token to specify next page in the list. The page token is only valid for three days. */ pageToken?: string; /** diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index d70bef3c09b..0a165b710c4 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -561,7 +561,7 @@ export namespace admin_reports_v1 { */ filters?: string; /** - * Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" + * Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175) */ groupIdFilter?: string; /** @@ -611,7 +611,7 @@ export namespace admin_reports_v1 { */ filters?: string; /** - * Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" + * Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175) */ groupIdFilter?: string; /** From 8bbb3cef69e6804e7660619158af9c68be19b457 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:39 +0000 Subject: [PATCH 003/144] feat(adsense): update the API #### adsense:v2 The following keys were added: - resources.accounts.resources.reports.methods.generate.parameters.dimensions.enumDeprecated - resources.accounts.resources.reports.methods.generateCsv.parameters.dimensions.enumDeprecated - schemas.PolicyTopic.properties.mustFix.deprecated - schemas.PolicyTopic.properties.type.description - schemas.PolicyTopic.properties.type.enum - schemas.PolicyTopic.properties.type.enumDescriptions - schemas.PolicyTopic.properties.type.type The following keys were changed: - resources.accounts.resources.reports.methods.generate.parameters.dimensions.enumDescriptions - resources.accounts.resources.reports.methods.generateCsv.parameters.dimensions.enumDescriptions - schemas.PolicyIssue.properties.action.enumDescriptions - schemas.PolicyTopic.properties.mustFix.description --- discovery/adsense-v2.json | 129 ++++++++++++++++++++++++++++++++++++-- src/apis/adsense/v2.ts | 6 +- 2 files changed, 129 insertions(+), 6 deletions(-) diff --git a/discovery/adsense-v2.json b/discovery/adsense-v2.json index 976d5d07d7f..99b2001b687 100644 --- a/discovery/adsense-v2.json +++ b/discovery/adsense-v2.json @@ -1006,6 +1006,57 @@ "DOMAIN_REGISTRANT", "WEBSEARCH_QUERY_STRING" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Unspecified dimension.", "Date dimension in YYYY-MM-DD format (e.g. \"2010-02-10\").", @@ -1022,7 +1073,7 @@ "The size code of an ad unit (e.g. \"728x90\", \"responsive\").", "Custom channel name. The members of this dimension match the values from CustomChannel.display_name.", "Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.", - "Unique ID of a hosted client's custom channel.", + "Not supported.", "Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.", "Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.", "URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478).", @@ -1328,6 +1379,57 @@ "DOMAIN_REGISTRANT", "WEBSEARCH_QUERY_STRING" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Unspecified dimension.", "Date dimension in YYYY-MM-DD format (e.g. \"2010-02-10\").", @@ -1344,7 +1446,7 @@ "The size code of an ad unit (e.g. \"728x90\", \"responsive\").", "Custom channel name. The members of this dimension match the values from CustomChannel.display_name.", "Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.", - "Unique ID of a hosted client's custom channel.", + "Not supported.", "Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.", "Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.", "URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478).", @@ -1916,7 +2018,7 @@ } } }, - "revision": "20241211", + "revision": "20250313", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { @@ -2577,7 +2679,7 @@ "Ad serving demand has been restricted on the entity.", "Ad serving has been disabled on the entity.", "Ads are being served for the entity but Confirmed Click is being applied to the ads. See https://support.google.com/adsense/answer/10025624.", - "Ad personalization is restricted because the ad requests coming from the EEA and UK do not have a TCF string or the Consent Management Platform (CMP) indicated by the TCF string is not Google certified. As a result, basic/limited ads will be served. See https://support.google.com/adsense/answer/13554116" + "Ad personalization is restricted because the ad requests coming from the EEA and UK do not have a TCF string or the Consent Management Platform (CMP) indicated by the TCF string is not Google certified. As a result, basic/limited ads will be served. See https://support.google.com/adsense/answer/13554116." ], "type": "string" }, @@ -2652,12 +2754,29 @@ "id": "PolicyTopic", "properties": { "mustFix": { - "description": "Required. Indicates if this is a policy violation or not. When the value is true, issues that are instances of this topic must be addressed to remain in compliance with the partner's agreements with Google. A false value indicates that it's not mandatory to fix the issues but advertising demand might be restricted.", + "deprecated": true, + "description": "Required. Deprecated. Policy topics no longer have a \"must-fix\" classification.", "type": "boolean" }, "topic": { "description": "Required. The policy topic. For example, \"sexual-content\" or \"ads-obscuring-content\".\"", "type": "string" + }, + "type": { + "description": "Optional. The type of policy topic. For example, \"POLICY\" represents all the policy topics that are related to the Google Publisher Policy (GPP). See https://support.google.com/adsense/answer/15689616.", + "enum": [ + "POLICY_TOPIC_TYPE_UNSPECIFIED", + "POLICY", + "ADVERTISER_PREFERENCE", + "REGULATORY" + ], + "enumDescriptions": [ + "The type is unspecified.", + "Topics that are primarily related to the Google Publisher Policy (GPP) (https://support.google.com/publisherpolicies/answer/10502938) or the Google Publisher Restrictions (GPR) policies (https://support.google.com/publisherpolicies/answer/10437795).", + "Topics that are related to advertiser preferences. Certain advertisers may choose not to bid on content that are labeled with certain policies.", + "Any topics that are a result of a country or regional regulatory requirement body." + ], + "type": "string" } }, "type": "object" diff --git a/src/apis/adsense/v2.ts b/src/apis/adsense/v2.ts index d1e7d6dd368..98b94f1e588 100644 --- a/src/apis/adsense/v2.ts +++ b/src/apis/adsense/v2.ts @@ -597,13 +597,17 @@ export namespace adsense_v2 { */ export interface Schema$PolicyTopic { /** - * Required. Indicates if this is a policy violation or not. When the value is true, issues that are instances of this topic must be addressed to remain in compliance with the partner's agreements with Google. A false value indicates that it's not mandatory to fix the issues but advertising demand might be restricted. + * Required. Deprecated. Policy topics no longer have a "must-fix" classification. */ mustFix?: boolean | null; /** * Required. The policy topic. For example, "sexual-content" or "ads-obscuring-content"." */ topic?: string | null; + /** + * Optional. The type of policy topic. For example, "POLICY" represents all the policy topics that are related to the Google Publisher Policy (GPP). See https://support.google.com/adsense/answer/15689616. + */ + type?: string | null; } /** * Result of a generated report. From e9816b17e12729749273f14ef025f413d11d76cd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:39 +0000 Subject: [PATCH 004/144] feat(aiplatform): update the API #### aiplatform:v1beta1 The following keys were added: - resources.endpoints.methods.predict.description - resources.endpoints.methods.predict.flatPath - resources.endpoints.methods.predict.httpMethod - resources.endpoints.methods.predict.id - resources.endpoints.methods.predict.parameterOrder - resources.endpoints.methods.predict.parameters.endpoint.description - resources.endpoints.methods.predict.parameters.endpoint.location - resources.endpoints.methods.predict.parameters.endpoint.pattern - resources.endpoints.methods.predict.parameters.endpoint.required - resources.endpoints.methods.predict.parameters.endpoint.type - resources.endpoints.methods.predict.path - resources.endpoints.methods.predict.request.$ref - resources.endpoints.methods.predict.response.$ref - resources.endpoints.methods.predict.scopes - resources.projects.resources.locations.methods.deployPublisherModel.deprecated - resources.projects.resources.locations.methods.deployPublisherModel.description - resources.projects.resources.locations.methods.deployPublisherModel.flatPath - resources.projects.resources.locations.methods.deployPublisherModel.httpMethod - resources.projects.resources.locations.methods.deployPublisherModel.id - resources.projects.resources.locations.methods.deployPublisherModel.parameterOrder - resources.projects.resources.locations.methods.deployPublisherModel.parameters.destination.description - resources.projects.resources.locations.methods.deployPublisherModel.parameters.destination.location - resources.projects.resources.locations.methods.deployPublisherModel.parameters.destination.pattern - resources.projects.resources.locations.methods.deployPublisherModel.parameters.destination.required - resources.projects.resources.locations.methods.deployPublisherModel.parameters.destination.type - resources.projects.resources.locations.methods.deployPublisherModel.path - resources.projects.resources.locations.methods.deployPublisherModel.request.$ref - resources.projects.resources.locations.methods.deployPublisherModel.response.$ref - resources.projects.resources.locations.methods.deployPublisherModel.scopes - resources.projects.resources.locations.methods.evaluateDataset.description - resources.projects.resources.locations.methods.evaluateDataset.flatPath - resources.projects.resources.locations.methods.evaluateDataset.httpMethod - resources.projects.resources.locations.methods.evaluateDataset.id - resources.projects.resources.locations.methods.evaluateDataset.parameterOrder - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.description - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.location - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.pattern - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.required - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.type - resources.projects.resources.locations.methods.evaluateDataset.path - resources.projects.resources.locations.methods.evaluateDataset.request.$ref - resources.projects.resources.locations.methods.evaluateDataset.response.$ref - resources.projects.resources.locations.methods.evaluateDataset.scopes - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.description - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.flatPath - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.httpMethod - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.id - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameterOrder - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.path - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.request.$ref - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.response.$ref - resources.projects.resources.locations.resources.featureGroups.resources.featureMonitors.methods.patch.scopes - resources.projects.resources.locations.resources.models.methods.listCheckpoints.description - resources.projects.resources.locations.resources.models.methods.listCheckpoints.flatPath - resources.projects.resources.locations.resources.models.methods.listCheckpoints.httpMethod - resources.projects.resources.locations.resources.models.methods.listCheckpoints.id - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameterOrder - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.description - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.location - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.pattern - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.required - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.type - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageSize.description - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageSize.format - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageSize.location - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageSize.type - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageToken.description - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageToken.location - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageToken.type - resources.projects.resources.locations.resources.models.methods.listCheckpoints.path - resources.projects.resources.locations.resources.models.methods.listCheckpoints.response.$ref - resources.projects.resources.locations.resources.models.methods.listCheckpoints.scopes - resources.publishers.resources.models.methods.get.parameters.includeEquivalentModelGardenModelDeploymentConfigs.description - resources.publishers.resources.models.methods.get.parameters.includeEquivalentModelGardenModelDeploymentConfigs.location - resources.publishers.resources.models.methods.get.parameters.includeEquivalentModelGardenModelDeploymentConfigs.type - resources.publishers.resources.models.methods.predict.description - resources.publishers.resources.models.methods.predict.flatPath - resources.publishers.resources.models.methods.predict.httpMethod - resources.publishers.resources.models.methods.predict.id - resources.publishers.resources.models.methods.predict.parameterOrder - resources.publishers.resources.models.methods.predict.parameters.endpoint.description - resources.publishers.resources.models.methods.predict.parameters.endpoint.location - resources.publishers.resources.models.methods.predict.parameters.endpoint.pattern - resources.publishers.resources.models.methods.predict.parameters.endpoint.required - resources.publishers.resources.models.methods.predict.parameters.endpoint.type - resources.publishers.resources.models.methods.predict.path - resources.publishers.resources.models.methods.predict.request.$ref - resources.publishers.resources.models.methods.predict.response.$ref - resources.publishers.resources.models.methods.predict.scopes - schemas.CloudAiLargeModelsVisionGenerateVideoResponse.properties.videos.description - schemas.CloudAiLargeModelsVisionGenerateVideoResponse.properties.videos.items.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoResponse.properties.videos.type - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.id - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.bytesBase64Encoded.description - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.bytesBase64Encoded.type - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.gcsUri.description - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.gcsUri.type - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.mimeType.description - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.mimeType.type - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.type - schemas.CloudAiLargeModelsVisionVideo.properties.text.description - schemas.CloudAiLargeModelsVisionVideo.properties.text.type - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.description - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.id - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.properties.autoraterModel.description - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.properties.autoraterModel.type - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.properties.flipEnabled.description - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.properties.flipEnabled.type - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.properties.samplingCount.description - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.properties.samplingCount.format - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.properties.samplingCount.type - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.type - schemas.GoogleCloudAiplatformV1beta1Blob.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1Blob.properties.displayName.type - schemas.GoogleCloudAiplatformV1beta1CountTokensResponse.properties.promptTokensDetails.description - schemas.GoogleCloudAiplatformV1beta1CountTokensResponse.properties.promptTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1beta1CountTokensResponse.properties.promptTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1beta1CountTokensResponse.properties.promptTokensDetails.type - schemas.GoogleCloudAiplatformV1beta1DeployPublisherModelRequest.deprecated - schemas.GoogleCloudAiplatformV1beta1DeployRequest.description - schemas.GoogleCloudAiplatformV1beta1DeployRequest.id - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.deployConfig.$ref - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.deployConfig.description - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.endpointConfig.$ref - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.endpointConfig.description - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.huggingFaceModelId.description - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.huggingFaceModelId.type - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.modelConfig.$ref - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.modelConfig.description - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.publisherModelName.description - schemas.GoogleCloudAiplatformV1beta1DeployRequest.properties.publisherModelName.type - schemas.GoogleCloudAiplatformV1beta1DeployRequest.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestDeployConfig.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestDeployConfig.id - schemas.GoogleCloudAiplatformV1beta1DeployRequestDeployConfig.properties.dedicatedResources.$ref - schemas.GoogleCloudAiplatformV1beta1DeployRequestDeployConfig.properties.dedicatedResources.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestDeployConfig.properties.fastTryoutEnabled.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestDeployConfig.properties.fastTryoutEnabled.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestDeployConfig.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig.id - schemas.GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig.properties.dedicatedEndpointEnabled.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig.properties.dedicatedEndpointEnabled.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig.properties.endpointDisplayName.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig.properties.endpointDisplayName.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.id - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.acceptEula.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.acceptEula.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.containerSpec.$ref - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.containerSpec.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.huggingFaceAccessToken.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.huggingFaceAccessToken.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.huggingFaceCacheEnabled.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.huggingFaceCacheEnabled.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.modelDisplayName.description - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.properties.modelDisplayName.type - schemas.GoogleCloudAiplatformV1beta1DeployRequestModelConfig.type - schemas.GoogleCloudAiplatformV1beta1DeployedModel.properties.rolloutOptions.$ref - schemas.GoogleCloudAiplatformV1beta1DeployedModel.properties.rolloutOptions.description - schemas.GoogleCloudAiplatformV1beta1DeployedModel.properties.speculativeDecodingSpec.$ref - schemas.GoogleCloudAiplatformV1beta1DeployedModel.properties.speculativeDecodingSpec.description - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.genAiAdvancedFeaturesConfig.$ref - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.genAiAdvancedFeaturesConfig.description - schemas.GoogleCloudAiplatformV1beta1EnterpriseWebSearch.description - schemas.GoogleCloudAiplatformV1beta1EnterpriseWebSearch.id - schemas.GoogleCloudAiplatformV1beta1EnterpriseWebSearch.type - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.description - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.id - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.autoraterConfig.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.autoraterConfig.description - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.dataset.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.dataset.description - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.metrics.description - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.metrics.items.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.metrics.type - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.outputConfig.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.properties.outputConfig.description - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRequest.type - schemas.GoogleCloudAiplatformV1beta1EvaluateInstancesRequest.properties.autoraterConfig.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluateInstancesRequest.properties.autoraterConfig.description - schemas.GoogleCloudAiplatformV1beta1EvaluationDataset.description - schemas.GoogleCloudAiplatformV1beta1EvaluationDataset.id - schemas.GoogleCloudAiplatformV1beta1EvaluationDataset.properties.bigquerySource.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluationDataset.properties.bigquerySource.description - schemas.GoogleCloudAiplatformV1beta1EvaluationDataset.properties.gcsSource.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluationDataset.properties.gcsSource.description - schemas.GoogleCloudAiplatformV1beta1EvaluationDataset.type - schemas.GoogleCloudAiplatformV1beta1FileData.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1FileData.properties.displayName.type - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig.description - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig.id - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig.properties.ragConfig.$ref - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig.properties.ragConfig.description - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig.type - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig.description - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig.id - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig.properties.enableRag.description - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig.properties.enableRag.type - schemas.GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponse.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponse.properties.createTime.format - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponse.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponse.properties.createTime.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponse.properties.responseId.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponse.properties.responseId.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponse.properties.responseId.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.cacheTokensDetails.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.cacheTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.cacheTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.cacheTokensDetails.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.candidatesTokensDetails.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.candidatesTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.candidatesTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.candidatesTokensDetails.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.promptTokensDetails.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.promptTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.promptTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.promptTokensDetails.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.format - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.format - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.type - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponse.properties.generatedSamples.deprecated - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponse.properties.videos.description - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponse.properties.videos.items.$ref - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponse.properties.videos.type - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.description - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.id - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.properties.bytesBase64Encoded.description - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.properties.bytesBase64Encoded.type - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.properties.gcsUri.type - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.properties.mimeType.description - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.properties.mimeType.type - schemas.GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo.type - schemas.GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse.description - schemas.GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse.id - schemas.GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse.properties.checkpoints.description - schemas.GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse.properties.checkpoints.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse.properties.checkpoints.type - schemas.GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse.type - schemas.GoogleCloudAiplatformV1beta1MachineSpec.properties.multihostGpuNodeCount.description - schemas.GoogleCloudAiplatformV1beta1MachineSpec.properties.multihostGpuNodeCount.format - schemas.GoogleCloudAiplatformV1beta1MachineSpec.properties.multihostGpuNodeCount.type - schemas.GoogleCloudAiplatformV1beta1Metric.description - schemas.GoogleCloudAiplatformV1beta1Metric.id - schemas.GoogleCloudAiplatformV1beta1Metric.properties.aggregationMetrics.description - schemas.GoogleCloudAiplatformV1beta1Metric.properties.aggregationMetrics.items.enum - schemas.GoogleCloudAiplatformV1beta1Metric.properties.aggregationMetrics.items.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1Metric.properties.aggregationMetrics.items.type - schemas.GoogleCloudAiplatformV1beta1Metric.properties.aggregationMetrics.type - schemas.GoogleCloudAiplatformV1beta1Metric.properties.bleuSpec.$ref - schemas.GoogleCloudAiplatformV1beta1Metric.properties.bleuSpec.description - schemas.GoogleCloudAiplatformV1beta1Metric.properties.exactMatchSpec.$ref - schemas.GoogleCloudAiplatformV1beta1Metric.properties.exactMatchSpec.description - schemas.GoogleCloudAiplatformV1beta1Metric.properties.pairwiseMetricSpec.$ref - schemas.GoogleCloudAiplatformV1beta1Metric.properties.pairwiseMetricSpec.description - schemas.GoogleCloudAiplatformV1beta1Metric.properties.pointwiseMetricSpec.$ref - schemas.GoogleCloudAiplatformV1beta1Metric.properties.pointwiseMetricSpec.description - schemas.GoogleCloudAiplatformV1beta1Metric.properties.rougeSpec.$ref - schemas.GoogleCloudAiplatformV1beta1Metric.properties.rougeSpec.description - schemas.GoogleCloudAiplatformV1beta1Metric.type - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.description - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.id - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.modality.description - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.modality.enum - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.modality.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.modality.type - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.tokenCount.description - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.tokenCount.format - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.properties.tokenCount.type - schemas.GoogleCloudAiplatformV1beta1ModalityTokenCount.type - schemas.GoogleCloudAiplatformV1beta1Model.properties.defaultCheckpointId.description - schemas.GoogleCloudAiplatformV1beta1Model.properties.defaultCheckpointId.type - schemas.GoogleCloudAiplatformV1beta1ModelGardenSource.properties.skipHfModelCache.description - schemas.GoogleCloudAiplatformV1beta1ModelGardenSource.properties.skipHfModelCache.type - schemas.GoogleCloudAiplatformV1beta1ModelGardenSource.properties.versionId.description - schemas.GoogleCloudAiplatformV1beta1ModelGardenSource.properties.versionId.type - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.description - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.id - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.checkpointId.description - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.checkpointId.type - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.epoch.description - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.epoch.format - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.epoch.type - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.name.description - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.name.type - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.step.description - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.step.format - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.properties.step.type - schemas.GoogleCloudAiplatformV1beta1ModelVersionCheckpoint.type - schemas.GoogleCloudAiplatformV1beta1NotebookRuntime.properties.softwareConfig.$ref - schemas.GoogleCloudAiplatformV1beta1NotebookRuntime.properties.softwareConfig.description - schemas.GoogleCloudAiplatformV1beta1NotebookRuntime.properties.softwareConfig.readOnly - schemas.GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate.properties.softwareConfig.$ref - schemas.GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate.properties.softwareConfig.description - schemas.GoogleCloudAiplatformV1beta1NotebookSoftwareConfig.description - schemas.GoogleCloudAiplatformV1beta1NotebookSoftwareConfig.id - schemas.GoogleCloudAiplatformV1beta1NotebookSoftwareConfig.properties.env.description - schemas.GoogleCloudAiplatformV1beta1NotebookSoftwareConfig.properties.env.items.$ref - schemas.GoogleCloudAiplatformV1beta1NotebookSoftwareConfig.properties.env.type - schemas.GoogleCloudAiplatformV1beta1NotebookSoftwareConfig.properties.postStartupScriptConfig.$ref - schemas.GoogleCloudAiplatformV1beta1NotebookSoftwareConfig.properties.postStartupScriptConfig.description - schemas.GoogleCloudAiplatformV1beta1NotebookSoftwareConfig.type - schemas.GoogleCloudAiplatformV1beta1OutputConfig.description - schemas.GoogleCloudAiplatformV1beta1OutputConfig.id - schemas.GoogleCloudAiplatformV1beta1OutputConfig.properties.gcsDestination.$ref - schemas.GoogleCloudAiplatformV1beta1OutputConfig.properties.gcsDestination.description - schemas.GoogleCloudAiplatformV1beta1OutputConfig.type - schemas.GoogleCloudAiplatformV1beta1PairwiseMetricSpec.properties.baselineResponseFieldName.description - schemas.GoogleCloudAiplatformV1beta1PairwiseMetricSpec.properties.baselineResponseFieldName.type - schemas.GoogleCloudAiplatformV1beta1PairwiseMetricSpec.properties.candidateResponseFieldName.description - schemas.GoogleCloudAiplatformV1beta1PairwiseMetricSpec.properties.candidateResponseFieldName.type - schemas.GoogleCloudAiplatformV1beta1PairwiseMetricSpec.properties.systemInstruction.description - schemas.GoogleCloudAiplatformV1beta1PairwiseMetricSpec.properties.systemInstruction.type - schemas.GoogleCloudAiplatformV1beta1PointwiseMetricSpec.properties.systemInstruction.description - schemas.GoogleCloudAiplatformV1beta1PointwiseMetricSpec.properties.systemInstruction.type - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.description - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.id - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.properties.postStartupScript.description - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.properties.postStartupScript.type - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.properties.postStartupScriptBehavior.description - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.properties.postStartupScriptBehavior.enum - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.properties.postStartupScriptBehavior.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.properties.postStartupScriptBehavior.type - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.properties.postStartupScriptUrl.description - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.properties.postStartupScriptUrl.type - schemas.GoogleCloudAiplatformV1beta1PostStartupScriptConfig.type - schemas.GoogleCloudAiplatformV1beta1Probe.properties.failureThreshold.description - schemas.GoogleCloudAiplatformV1beta1Probe.properties.failureThreshold.format - schemas.GoogleCloudAiplatformV1beta1Probe.properties.failureThreshold.type - schemas.GoogleCloudAiplatformV1beta1Probe.properties.initialDelaySeconds.description - schemas.GoogleCloudAiplatformV1beta1Probe.properties.initialDelaySeconds.format - schemas.GoogleCloudAiplatformV1beta1Probe.properties.initialDelaySeconds.type - schemas.GoogleCloudAiplatformV1beta1Probe.properties.successThreshold.description - schemas.GoogleCloudAiplatformV1beta1Probe.properties.successThreshold.format - schemas.GoogleCloudAiplatformV1beta1Probe.properties.successThreshold.type - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.ragFilesCount.description - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.ragFilesCount.format - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.ragFilesCount.readOnly - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.ragFilesCount.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.deploymentSpec.$ref - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.deploymentSpec.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.id - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.properties.env.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.properties.env.items.$ref - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.properties.env.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.properties.secretEnv.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.properties.secretEnv.items.$ref - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.properties.secretEnv.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.type - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.description - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.id - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxSurgePercentage.description - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxSurgePercentage.format - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxSurgePercentage.type - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxSurgeReplicas.description - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxSurgeReplicas.format - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxSurgeReplicas.type - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxUnavailablePercentage.description - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxUnavailablePercentage.format - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxUnavailablePercentage.type - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxUnavailableReplicas.description - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxUnavailableReplicas.format - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.maxUnavailableReplicas.type - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.previousDeployedModel.description - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.previousDeployedModel.type - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.revisionNumber.description - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.revisionNumber.format - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.revisionNumber.readOnly - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.properties.revisionNumber.type - schemas.GoogleCloudAiplatformV1beta1RolloutOptions.type - schemas.GoogleCloudAiplatformV1beta1SecretEnvVar.description - schemas.GoogleCloudAiplatformV1beta1SecretEnvVar.id - schemas.GoogleCloudAiplatformV1beta1SecretEnvVar.properties.name.description - schemas.GoogleCloudAiplatformV1beta1SecretEnvVar.properties.name.type - schemas.GoogleCloudAiplatformV1beta1SecretEnvVar.properties.secretRef.$ref - schemas.GoogleCloudAiplatformV1beta1SecretEnvVar.properties.secretRef.description - schemas.GoogleCloudAiplatformV1beta1SecretEnvVar.type - schemas.GoogleCloudAiplatformV1beta1SecretRef.description - schemas.GoogleCloudAiplatformV1beta1SecretRef.id - schemas.GoogleCloudAiplatformV1beta1SecretRef.properties.secret.description - schemas.GoogleCloudAiplatformV1beta1SecretRef.properties.secret.type - schemas.GoogleCloudAiplatformV1beta1SecretRef.properties.version.description - schemas.GoogleCloudAiplatformV1beta1SecretRef.properties.version.type - schemas.GoogleCloudAiplatformV1beta1SecretRef.type - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.description - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.id - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.properties.draftModelSpeculation.$ref - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.properties.draftModelSpeculation.description - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.properties.ngramSpeculation.$ref - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.properties.ngramSpeculation.description - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.properties.speculativeTokenCount.description - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.properties.speculativeTokenCount.format - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.properties.speculativeTokenCount.type - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec.type - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation.description - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation.id - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation.properties.draftModel.description - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation.properties.draftModel.type - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation.type - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation.description - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation.id - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation.properties.ngramSize.description - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation.properties.ngramSize.format - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation.properties.ngramSize.type - schemas.GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation.type - schemas.GoogleCloudAiplatformV1beta1Tool.properties.enterpriseWebSearch.$ref - schemas.GoogleCloudAiplatformV1beta1Tool.properties.enterpriseWebSearch.description The following keys were changed: - resources.projects.resources.locations.methods.deploy.description - resources.projects.resources.locations.methods.deploy.request.$ref - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.indexEndpoints.methods.deployIndex.description - schemas.GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig.properties.httpElementLocation.description - schemas.GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig.properties.name.description - schemas.GoogleCloudAiplatformV1beta1AutomaticResources.properties.maxReplicaCount.description - schemas.GoogleCloudAiplatformV1beta1AutomaticResources.properties.minReplicaCount.description - schemas.GoogleCloudAiplatformV1beta1CachedContent.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1CachedContent.properties.model.description - schemas.GoogleCloudAiplatformV1beta1DedicatedResources.description - schemas.GoogleCloudAiplatformV1beta1DedicatedResources.properties.machineSpec.description - schemas.GoogleCloudAiplatformV1beta1DedicatedResources.properties.maxReplicaCount.description - schemas.GoogleCloudAiplatformV1beta1DedicatedResources.properties.minReplicaCount.description - schemas.GoogleCloudAiplatformV1beta1DedicatedResources.properties.requiredReplicaCount.description - schemas.GoogleCloudAiplatformV1beta1DeployPublisherModelRequest.properties.model.description - schemas.GoogleCloudAiplatformV1beta1DiskSpec.properties.bootDiskType.description - schemas.GoogleCloudAiplatformV1beta1DistillationHyperParameters.properties.adapterSize.enum - schemas.GoogleCloudAiplatformV1beta1DistillationHyperParameters.properties.adapterSize.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.totalTokenCount.description - schemas.GoogleCloudAiplatformV1beta1ModelExportFormat.properties.id.description - schemas.GoogleCloudAiplatformV1beta1RagFileParsingConfigLlmParser.properties.modelName.description - schemas.GoogleCloudAiplatformV1beta1ReservationAffinity.properties.values.description - schemas.GoogleCloudAiplatformV1beta1SchemaTextDataItem.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1beta1SupervisedHyperParameters.properties.adapterSize.enum - schemas.GoogleCloudAiplatformV1beta1SupervisedHyperParameters.properties.adapterSize.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1Tool.properties.codeExecution.description - schemas.GoogleCloudAiplatformV1beta1TunedModel.description - schemas.GoogleCloudAiplatformV1beta1TuningJob.properties.tunedModel.description - schemas.GoogleCloudAiplatformV1beta1VertexAISearch.description - schemas.GoogleCloudAiplatformV1beta1VertexAISearch.properties.datastore.description #### aiplatform:v1 The following keys were added: - resources.endpoints.methods.predict.description - resources.endpoints.methods.predict.flatPath - resources.endpoints.methods.predict.httpMethod - resources.endpoints.methods.predict.id - resources.endpoints.methods.predict.parameterOrder - resources.endpoints.methods.predict.parameters.endpoint.description - resources.endpoints.methods.predict.parameters.endpoint.location - resources.endpoints.methods.predict.parameters.endpoint.pattern - resources.endpoints.methods.predict.parameters.endpoint.required - resources.endpoints.methods.predict.parameters.endpoint.type - resources.endpoints.methods.predict.path - resources.endpoints.methods.predict.request.$ref - resources.endpoints.methods.predict.response.$ref - resources.endpoints.methods.predict.scopes - resources.projects.resources.locations.methods.evaluateDataset.description - resources.projects.resources.locations.methods.evaluateDataset.flatPath - resources.projects.resources.locations.methods.evaluateDataset.httpMethod - resources.projects.resources.locations.methods.evaluateDataset.id - resources.projects.resources.locations.methods.evaluateDataset.parameterOrder - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.description - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.location - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.pattern - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.required - resources.projects.resources.locations.methods.evaluateDataset.parameters.location.type - resources.projects.resources.locations.methods.evaluateDataset.path - resources.projects.resources.locations.methods.evaluateDataset.request.$ref - resources.projects.resources.locations.methods.evaluateDataset.response.$ref - resources.projects.resources.locations.methods.evaluateDataset.scopes - resources.projects.resources.locations.resources.models.methods.listCheckpoints.description - resources.projects.resources.locations.resources.models.methods.listCheckpoints.flatPath - resources.projects.resources.locations.resources.models.methods.listCheckpoints.httpMethod - resources.projects.resources.locations.resources.models.methods.listCheckpoints.id - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameterOrder - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.description - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.location - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.pattern - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.required - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.name.type - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageSize.description - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageSize.format - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageSize.location - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageSize.type - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageToken.description - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageToken.location - resources.projects.resources.locations.resources.models.methods.listCheckpoints.parameters.pageToken.type - resources.projects.resources.locations.resources.models.methods.listCheckpoints.path - resources.projects.resources.locations.resources.models.methods.listCheckpoints.response.$ref - resources.projects.resources.locations.resources.models.methods.listCheckpoints.scopes - resources.publishers.resources.models.methods.predict.description - resources.publishers.resources.models.methods.predict.flatPath - resources.publishers.resources.models.methods.predict.httpMethod - resources.publishers.resources.models.methods.predict.id - resources.publishers.resources.models.methods.predict.parameterOrder - resources.publishers.resources.models.methods.predict.parameters.endpoint.description - resources.publishers.resources.models.methods.predict.parameters.endpoint.location - resources.publishers.resources.models.methods.predict.parameters.endpoint.pattern - resources.publishers.resources.models.methods.predict.parameters.endpoint.required - resources.publishers.resources.models.methods.predict.parameters.endpoint.type - resources.publishers.resources.models.methods.predict.path - resources.publishers.resources.models.methods.predict.request.$ref - resources.publishers.resources.models.methods.predict.response.$ref - resources.publishers.resources.models.methods.predict.scopes - schemas.CloudAiLargeModelsVisionGenerateVideoResponse.properties.videos.description - schemas.CloudAiLargeModelsVisionGenerateVideoResponse.properties.videos.items.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoResponse.properties.videos.type - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.id - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.bytesBase64Encoded.description - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.bytesBase64Encoded.type - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.gcsUri.description - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.gcsUri.type - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.mimeType.description - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.mimeType.type - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.type - schemas.CloudAiLargeModelsVisionVideo.properties.text.description - schemas.CloudAiLargeModelsVisionVideo.properties.text.type - schemas.GoogleCloudAiplatformV1AutoraterConfig.description - schemas.GoogleCloudAiplatformV1AutoraterConfig.id - schemas.GoogleCloudAiplatformV1AutoraterConfig.properties.autoraterModel.description - schemas.GoogleCloudAiplatformV1AutoraterConfig.properties.autoraterModel.type - schemas.GoogleCloudAiplatformV1AutoraterConfig.properties.flipEnabled.description - schemas.GoogleCloudAiplatformV1AutoraterConfig.properties.flipEnabled.type - schemas.GoogleCloudAiplatformV1AutoraterConfig.properties.samplingCount.description - schemas.GoogleCloudAiplatformV1AutoraterConfig.properties.samplingCount.format - schemas.GoogleCloudAiplatformV1AutoraterConfig.properties.samplingCount.type - schemas.GoogleCloudAiplatformV1AutoraterConfig.type - schemas.GoogleCloudAiplatformV1Blob.properties.displayName.description - schemas.GoogleCloudAiplatformV1Blob.properties.displayName.type - schemas.GoogleCloudAiplatformV1CodeExecutionResult.description - schemas.GoogleCloudAiplatformV1CodeExecutionResult.id - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.outcome.description - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.outcome.enum - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.outcome.enumDescriptions - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.outcome.type - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.output.description - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.output.type - schemas.GoogleCloudAiplatformV1CodeExecutionResult.type - schemas.GoogleCloudAiplatformV1CountTokensResponse.properties.promptTokensDetails.description - schemas.GoogleCloudAiplatformV1CountTokensResponse.properties.promptTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1CountTokensResponse.properties.promptTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1CountTokensResponse.properties.promptTokensDetails.type - schemas.GoogleCloudAiplatformV1DeployedModel.properties.speculativeDecodingSpec.$ref - schemas.GoogleCloudAiplatformV1DeployedModel.properties.speculativeDecodingSpec.description - schemas.GoogleCloudAiplatformV1Endpoint.properties.genAiAdvancedFeaturesConfig.$ref - schemas.GoogleCloudAiplatformV1Endpoint.properties.genAiAdvancedFeaturesConfig.description - schemas.GoogleCloudAiplatformV1EnterpriseWebSearch.description - schemas.GoogleCloudAiplatformV1EnterpriseWebSearch.id - schemas.GoogleCloudAiplatformV1EnterpriseWebSearch.type - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.description - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.id - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.autoraterConfig.$ref - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.autoraterConfig.description - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.dataset.$ref - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.dataset.description - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.metrics.description - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.metrics.items.$ref - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.metrics.type - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.outputConfig.$ref - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.properties.outputConfig.description - schemas.GoogleCloudAiplatformV1EvaluateDatasetRequest.type - schemas.GoogleCloudAiplatformV1EvaluateInstancesRequest.properties.autoraterConfig.$ref - schemas.GoogleCloudAiplatformV1EvaluateInstancesRequest.properties.autoraterConfig.description - schemas.GoogleCloudAiplatformV1EvaluationDataset.description - schemas.GoogleCloudAiplatformV1EvaluationDataset.id - schemas.GoogleCloudAiplatformV1EvaluationDataset.properties.bigquerySource.$ref - schemas.GoogleCloudAiplatformV1EvaluationDataset.properties.bigquerySource.description - schemas.GoogleCloudAiplatformV1EvaluationDataset.properties.gcsSource.$ref - schemas.GoogleCloudAiplatformV1EvaluationDataset.properties.gcsSource.description - schemas.GoogleCloudAiplatformV1EvaluationDataset.type - schemas.GoogleCloudAiplatformV1ExecutableCode.description - schemas.GoogleCloudAiplatformV1ExecutableCode.id - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.code.description - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.code.type - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.language.description - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.language.enum - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.language.enumDescriptions - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.language.type - schemas.GoogleCloudAiplatformV1ExecutableCode.type - schemas.GoogleCloudAiplatformV1FeatureView.properties.serviceAccountEmail.description - schemas.GoogleCloudAiplatformV1FeatureView.properties.serviceAccountEmail.readOnly - schemas.GoogleCloudAiplatformV1FeatureView.properties.serviceAccountEmail.type - schemas.GoogleCloudAiplatformV1FeatureView.properties.serviceAgentType.description - schemas.GoogleCloudAiplatformV1FeatureView.properties.serviceAgentType.enum - schemas.GoogleCloudAiplatformV1FeatureView.properties.serviceAgentType.enumDescriptions - schemas.GoogleCloudAiplatformV1FeatureView.properties.serviceAgentType.type - schemas.GoogleCloudAiplatformV1FileData.properties.displayName.description - schemas.GoogleCloudAiplatformV1FileData.properties.displayName.type - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig.description - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig.id - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig.properties.ragConfig.$ref - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig.properties.ragConfig.description - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig.type - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig.description - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig.id - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig.properties.enableRag.description - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig.properties.enableRag.type - schemas.GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig.type - schemas.GoogleCloudAiplatformV1GenerateContentResponse.properties.createTime.description - schemas.GoogleCloudAiplatformV1GenerateContentResponse.properties.createTime.format - schemas.GoogleCloudAiplatformV1GenerateContentResponse.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1GenerateContentResponse.properties.createTime.type - schemas.GoogleCloudAiplatformV1GenerateContentResponse.properties.responseId.description - schemas.GoogleCloudAiplatformV1GenerateContentResponse.properties.responseId.readOnly - schemas.GoogleCloudAiplatformV1GenerateContentResponse.properties.responseId.type - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.cacheTokensDetails.description - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.cacheTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.cacheTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.cacheTokensDetails.type - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.candidatesTokensDetails.description - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.candidatesTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.candidatesTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.candidatesTokensDetails.type - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.promptTokensDetails.description - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.promptTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.promptTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.promptTokensDetails.type - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.description - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.format - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.readOnly - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.type - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.description - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.format - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.readOnly - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.type - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.description - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.id - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.generatedSamples.deprecated - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.generatedSamples.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.generatedSamples.items.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.generatedSamples.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.raiMediaFilteredCount.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.raiMediaFilteredCount.format - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.raiMediaFilteredCount.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.raiMediaFilteredReasons.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.raiMediaFilteredReasons.items.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.raiMediaFilteredReasons.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.videos.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.videos.items.$ref - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.properties.videos.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponse.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.id - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.properties.bytesBase64Encoded.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.properties.bytesBase64Encoded.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.properties.gcsUri.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.properties.mimeType.description - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.properties.mimeType.type - schemas.GoogleCloudAiplatformV1GenerateVideoResponseVideo.type - schemas.GoogleCloudAiplatformV1ImportRagFilesConfig.properties.ragFileParsingConfig.$ref - schemas.GoogleCloudAiplatformV1ImportRagFilesConfig.properties.ragFileParsingConfig.description - schemas.GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse.description - schemas.GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse.id - schemas.GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse.properties.checkpoints.description - schemas.GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse.properties.checkpoints.items.$ref - schemas.GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse.properties.checkpoints.type - schemas.GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse.type - schemas.GoogleCloudAiplatformV1Metric.description - schemas.GoogleCloudAiplatformV1Metric.id - schemas.GoogleCloudAiplatformV1Metric.properties.aggregationMetrics.description - schemas.GoogleCloudAiplatformV1Metric.properties.aggregationMetrics.items.enum - schemas.GoogleCloudAiplatformV1Metric.properties.aggregationMetrics.items.enumDescriptions - schemas.GoogleCloudAiplatformV1Metric.properties.aggregationMetrics.items.type - schemas.GoogleCloudAiplatformV1Metric.properties.aggregationMetrics.type - schemas.GoogleCloudAiplatformV1Metric.properties.bleuSpec.$ref - schemas.GoogleCloudAiplatformV1Metric.properties.bleuSpec.description - schemas.GoogleCloudAiplatformV1Metric.properties.exactMatchSpec.$ref - schemas.GoogleCloudAiplatformV1Metric.properties.exactMatchSpec.description - schemas.GoogleCloudAiplatformV1Metric.properties.pairwiseMetricSpec.$ref - schemas.GoogleCloudAiplatformV1Metric.properties.pairwiseMetricSpec.description - schemas.GoogleCloudAiplatformV1Metric.properties.pointwiseMetricSpec.$ref - schemas.GoogleCloudAiplatformV1Metric.properties.pointwiseMetricSpec.description - schemas.GoogleCloudAiplatformV1Metric.properties.rougeSpec.$ref - schemas.GoogleCloudAiplatformV1Metric.properties.rougeSpec.description - schemas.GoogleCloudAiplatformV1Metric.type - schemas.GoogleCloudAiplatformV1ModalityTokenCount.description - schemas.GoogleCloudAiplatformV1ModalityTokenCount.id - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.modality.description - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.modality.enum - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.modality.enumDescriptions - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.modality.type - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.tokenCount.description - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.tokenCount.format - schemas.GoogleCloudAiplatformV1ModalityTokenCount.properties.tokenCount.type - schemas.GoogleCloudAiplatformV1ModalityTokenCount.type - schemas.GoogleCloudAiplatformV1Model.properties.defaultCheckpointId.description - schemas.GoogleCloudAiplatformV1Model.properties.defaultCheckpointId.type - schemas.GoogleCloudAiplatformV1ModelGardenSource.properties.skipHfModelCache.description - schemas.GoogleCloudAiplatformV1ModelGardenSource.properties.skipHfModelCache.type - schemas.GoogleCloudAiplatformV1ModelGardenSource.properties.versionId.description - schemas.GoogleCloudAiplatformV1ModelGardenSource.properties.versionId.type - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.description - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.id - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.checkpointId.description - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.checkpointId.type - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.epoch.description - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.epoch.format - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.epoch.type - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.name.description - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.name.type - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.step.description - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.step.format - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.properties.step.type - schemas.GoogleCloudAiplatformV1ModelVersionCheckpoint.type - schemas.GoogleCloudAiplatformV1NotebookRuntime.properties.softwareConfig.$ref - schemas.GoogleCloudAiplatformV1NotebookRuntime.properties.softwareConfig.description - schemas.GoogleCloudAiplatformV1NotebookRuntime.properties.softwareConfig.readOnly - schemas.GoogleCloudAiplatformV1NotebookRuntimeTemplate.properties.softwareConfig.$ref - schemas.GoogleCloudAiplatformV1NotebookRuntimeTemplate.properties.softwareConfig.description - schemas.GoogleCloudAiplatformV1NotebookSoftwareConfig.description - schemas.GoogleCloudAiplatformV1NotebookSoftwareConfig.id - schemas.GoogleCloudAiplatformV1NotebookSoftwareConfig.properties.env.description - schemas.GoogleCloudAiplatformV1NotebookSoftwareConfig.properties.env.items.$ref - schemas.GoogleCloudAiplatformV1NotebookSoftwareConfig.properties.env.type - schemas.GoogleCloudAiplatformV1NotebookSoftwareConfig.properties.postStartupScriptConfig.$ref - schemas.GoogleCloudAiplatformV1NotebookSoftwareConfig.properties.postStartupScriptConfig.description - schemas.GoogleCloudAiplatformV1NotebookSoftwareConfig.type - schemas.GoogleCloudAiplatformV1OutputConfig.description - schemas.GoogleCloudAiplatformV1OutputConfig.id - schemas.GoogleCloudAiplatformV1OutputConfig.properties.gcsDestination.$ref - schemas.GoogleCloudAiplatformV1OutputConfig.properties.gcsDestination.description - schemas.GoogleCloudAiplatformV1OutputConfig.type - schemas.GoogleCloudAiplatformV1PairwiseMetricSpec.properties.baselineResponseFieldName.description - schemas.GoogleCloudAiplatformV1PairwiseMetricSpec.properties.baselineResponseFieldName.type - schemas.GoogleCloudAiplatformV1PairwiseMetricSpec.properties.candidateResponseFieldName.description - schemas.GoogleCloudAiplatformV1PairwiseMetricSpec.properties.candidateResponseFieldName.type - schemas.GoogleCloudAiplatformV1PairwiseMetricSpec.properties.systemInstruction.description - schemas.GoogleCloudAiplatformV1PairwiseMetricSpec.properties.systemInstruction.type - schemas.GoogleCloudAiplatformV1Part.properties.codeExecutionResult.$ref - schemas.GoogleCloudAiplatformV1Part.properties.codeExecutionResult.description - schemas.GoogleCloudAiplatformV1Part.properties.executableCode.$ref - schemas.GoogleCloudAiplatformV1Part.properties.executableCode.description - schemas.GoogleCloudAiplatformV1PointwiseMetricSpec.properties.systemInstruction.description - schemas.GoogleCloudAiplatformV1PointwiseMetricSpec.properties.systemInstruction.type - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.description - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.id - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.properties.postStartupScript.description - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.properties.postStartupScript.type - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.properties.postStartupScriptBehavior.description - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.properties.postStartupScriptBehavior.enum - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.properties.postStartupScriptBehavior.enumDescriptions - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.properties.postStartupScriptBehavior.type - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.properties.postStartupScriptUrl.description - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.properties.postStartupScriptUrl.type - schemas.GoogleCloudAiplatformV1PostStartupScriptConfig.type - schemas.GoogleCloudAiplatformV1Probe.properties.failureThreshold.description - schemas.GoogleCloudAiplatformV1Probe.properties.failureThreshold.format - schemas.GoogleCloudAiplatformV1Probe.properties.failureThreshold.type - schemas.GoogleCloudAiplatformV1Probe.properties.initialDelaySeconds.description - schemas.GoogleCloudAiplatformV1Probe.properties.initialDelaySeconds.format - schemas.GoogleCloudAiplatformV1Probe.properties.initialDelaySeconds.type - schemas.GoogleCloudAiplatformV1Probe.properties.successThreshold.description - schemas.GoogleCloudAiplatformV1Probe.properties.successThreshold.format - schemas.GoogleCloudAiplatformV1Probe.properties.successThreshold.type - schemas.GoogleCloudAiplatformV1RagFileParsingConfig.description - schemas.GoogleCloudAiplatformV1RagFileParsingConfig.id - schemas.GoogleCloudAiplatformV1RagFileParsingConfig.properties.layoutParser.$ref - schemas.GoogleCloudAiplatformV1RagFileParsingConfig.properties.layoutParser.description - schemas.GoogleCloudAiplatformV1RagFileParsingConfig.type - schemas.GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser.description - schemas.GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser.id - schemas.GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser.properties.maxParsingRequestsPerMin.description - schemas.GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser.properties.maxParsingRequestsPerMin.format - schemas.GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser.properties.maxParsingRequestsPerMin.type - schemas.GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser.properties.processorName.description - schemas.GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser.properties.processorName.type - schemas.GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpec.properties.deploymentSpec.$ref - schemas.GoogleCloudAiplatformV1ReasoningEngineSpec.properties.deploymentSpec.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.id - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.properties.env.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.properties.env.items.$ref - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.properties.env.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.properties.secretEnv.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.properties.secretEnv.items.$ref - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.properties.secretEnv.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.type - schemas.GoogleCloudAiplatformV1SecretEnvVar.description - schemas.GoogleCloudAiplatformV1SecretEnvVar.id - schemas.GoogleCloudAiplatformV1SecretEnvVar.properties.name.description - schemas.GoogleCloudAiplatformV1SecretEnvVar.properties.name.type - schemas.GoogleCloudAiplatformV1SecretEnvVar.properties.secretRef.$ref - schemas.GoogleCloudAiplatformV1SecretEnvVar.properties.secretRef.description - schemas.GoogleCloudAiplatformV1SecretEnvVar.type - schemas.GoogleCloudAiplatformV1SecretRef.description - schemas.GoogleCloudAiplatformV1SecretRef.id - schemas.GoogleCloudAiplatformV1SecretRef.properties.secret.description - schemas.GoogleCloudAiplatformV1SecretRef.properties.secret.type - schemas.GoogleCloudAiplatformV1SecretRef.properties.version.description - schemas.GoogleCloudAiplatformV1SecretRef.properties.version.type - schemas.GoogleCloudAiplatformV1SecretRef.type - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.description - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.id - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.properties.draftModelSpeculation.$ref - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.properties.draftModelSpeculation.description - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.properties.ngramSpeculation.$ref - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.properties.ngramSpeculation.description - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.properties.speculativeTokenCount.description - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.properties.speculativeTokenCount.format - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.properties.speculativeTokenCount.type - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpec.type - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation.description - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation.id - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation.properties.draftModel.description - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation.properties.draftModel.type - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation.type - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation.description - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation.id - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation.properties.ngramSize.description - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation.properties.ngramSize.format - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation.properties.ngramSize.type - schemas.GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation.type - schemas.GoogleCloudAiplatformV1Tool.properties.codeExecution.$ref - schemas.GoogleCloudAiplatformV1Tool.properties.codeExecution.description - schemas.GoogleCloudAiplatformV1Tool.properties.enterpriseWebSearch.$ref - schemas.GoogleCloudAiplatformV1Tool.properties.enterpriseWebSearch.description - schemas.GoogleCloudAiplatformV1ToolCodeExecution.description - schemas.GoogleCloudAiplatformV1ToolCodeExecution.id - schemas.GoogleCloudAiplatformV1ToolCodeExecution.type The following keys were changed: - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.indexEndpoints.methods.deployIndex.description - schemas.GoogleCloudAiplatformV1AutomaticResources.properties.maxReplicaCount.description - schemas.GoogleCloudAiplatformV1AutomaticResources.properties.minReplicaCount.description - schemas.GoogleCloudAiplatformV1CachedContent.properties.createTime.description - schemas.GoogleCloudAiplatformV1CachedContent.properties.model.description - schemas.GoogleCloudAiplatformV1DedicatedResources.description - schemas.GoogleCloudAiplatformV1DedicatedResources.properties.machineSpec.description - schemas.GoogleCloudAiplatformV1DedicatedResources.properties.maxReplicaCount.description - schemas.GoogleCloudAiplatformV1DedicatedResources.properties.minReplicaCount.description - schemas.GoogleCloudAiplatformV1DedicatedResources.properties.requiredReplicaCount.description - schemas.GoogleCloudAiplatformV1DiskSpec.properties.bootDiskType.description - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.totalTokenCount.description - schemas.GoogleCloudAiplatformV1ModelExportFormat.properties.id.description - schemas.GoogleCloudAiplatformV1ReservationAffinity.properties.values.description - schemas.GoogleCloudAiplatformV1SchemaTextDataItem.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1SupervisedHyperParameters.properties.adapterSize.enum - schemas.GoogleCloudAiplatformV1SupervisedHyperParameters.properties.adapterSize.enumDescriptions - schemas.GoogleCloudAiplatformV1TunedModel.description - schemas.GoogleCloudAiplatformV1TuningJob.properties.tunedModel.description - schemas.GoogleCloudAiplatformV1VertexAISearch.description - schemas.GoogleCloudAiplatformV1VertexAISearch.properties.datastore.description --- discovery/aiplatform-v1.json | 887 +++++++++++++++++++- discovery/aiplatform-v1beta1.json | 962 +++++++++++++++++++++- src/apis/aiplatform/v1.ts | 988 ++++++++++++++++++++++- src/apis/aiplatform/v1beta1.ts | 1243 ++++++++++++++++++++++++++++- 4 files changed, 3986 insertions(+), 94 deletions(-) diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index a568299ea63..0cb4ea0094e 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -764,6 +764,35 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1/endpoints/{endpointsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.endpoints.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "streamGenerateContent": { "description": "Generate content with multimodal inputs with streaming support.", "flatPath": "v1/endpoints/{endpointsId}:streamGenerateContent", @@ -954,6 +983,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "evaluateDataset": { + "description": "Evaluates a dataset based on a set of given metrics.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateDataset", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:evaluateDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "evaluateInstances": { "description": "Evaluates instances based on a given metric.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", @@ -4871,7 +4928,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` * `big_query` * `big_query.entity_id_columns`", + "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` * `service_agent_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -8097,7 +8154,7 @@ ] }, "deployIndex": { - "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.", + "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", "httpMethod": "POST", "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", @@ -11360,6 +11417,42 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listCheckpoints": { + "description": "Lists checkpoints of the specified model version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.listCheckpoints", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "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 next_page_token of the previous ListModelVersionCheckpoints call.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:listCheckpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "listVersions": { "description": "Lists versions of the specified model.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions", @@ -19293,6 +19386,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "streamGenerateContent": { "description": "Generate content with multimodal inputs with streaming support.", "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", @@ -19327,7 +19449,7 @@ } } }, - "revision": "20250114", + "revision": "20250304", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -19352,6 +19474,31 @@ "type": "string" }, "type": "array" + }, + "videos": { + "description": "List of videos, used to align naming with the external response.", + "items": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoResponseVideo" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoResponseVideo": { + "id": "CloudAiLargeModelsVisionGenerateVideoResponseVideo", + "properties": { + "bytesBase64Encoded": { + "description": "Base64 encoded bytes string representing the video.", + "type": "string" + }, + "gcsUri": { + "description": "Cloud Storage URI where the generated video is written.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the content of the video. - video/mp4", + "type": "string" } }, "type": "object" @@ -19631,6 +19778,10 @@ "description": "Video encoding, for example \"video/mp4\".", "type": "string" }, + "text": { + "description": "Text/Expanded text input for Help Me Write.", + "type": "string" + }, "uri": { "description": "Path to another storage (typically Google Cloud Storage).", "type": "string" @@ -20167,12 +20318,32 @@ "id": "GoogleCloudAiplatformV1AutomaticResources", "properties": { "maxReplicaCount": { - "description": "Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", + "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", "format": "int32", "type": "integer" }, "minReplicaCount": { - "description": "Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.", + "description": "Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AutoraterConfig": { + "description": "The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.", + "id": "GoogleCloudAiplatformV1AutoraterConfig", + "properties": { + "autoraterModel": { + "description": "Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "type": "string" + }, + "flipEnabled": { + "description": "Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.", + "type": "boolean" + }, + "samplingCount": { + "description": "Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.", "format": "int32", "type": "integer" } @@ -20944,6 +21115,10 @@ "format": "byte", "type": "string" }, + "displayName": { + "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls.", + "type": "string" + }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" @@ -21004,7 +21179,7 @@ "type": "array" }, "createTime": { - "description": "Output only. Creatation time of the cache entry.", + "description": "Output only. Creation time of the cache entry.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -21019,7 +21194,7 @@ "type": "string" }, "model": { - "description": "Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}", + "description": "Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}", "type": "string" }, "name": { @@ -21353,6 +21528,33 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CodeExecutionResult": { + "description": "Result of executing the [ExecutableCode]. Always follows a `part` containing the [ExecutableCode].", + "id": "GoogleCloudAiplatformV1CodeExecutionResult", + "properties": { + "outcome": { + "description": "Required. Outcome of the code execution.", + "enum": [ + "OUTCOME_UNSPECIFIED", + "OUTCOME_OK", + "OUTCOME_FAILED", + "OUTCOME_DEADLINE_EXCEEDED" + ], + "enumDescriptions": [ + "Unspecified status. This value should not be used.", + "Code execution completed successfully.", + "Code execution finished but with a failure. `stderr` should contain the reason.", + "Code execution ran for too long, and was cancelled. There may or may not be a partial output present." + ], + "type": "string" + }, + "output": { + "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CoherenceInput": { "description": "Input for coherence metric.", "id": "GoogleCloudAiplatformV1CoherenceInput", @@ -21881,6 +22083,14 @@ "description": "Response message for PredictionService.CountTokens.", "id": "GoogleCloudAiplatformV1CountTokensResponse", "properties": { + "promptTokensDetails": { + "description": "Output only. List of modalities that were processed in the request input.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "totalBillableCharacters": { "description": "The total number of billable characters counted across all instances from the request.", "format": "int32", @@ -22776,7 +22986,7 @@ "type": "object" }, "GoogleCloudAiplatformV1DedicatedResources": { - "description": "A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.", + "description": "A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration.", "id": "GoogleCloudAiplatformV1DedicatedResources", "properties": { "autoscalingMetricSpecs": { @@ -22788,20 +22998,20 @@ }, "machineSpec": { "$ref": "GoogleCloudAiplatformV1MachineSpec", - "description": "Required. Immutable. The specification of a single machine used by the prediction." + "description": "Required. Immutable. The specification of a single machine being used." }, "maxReplicaCount": { - "description": "Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", + "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", "format": "int32", "type": "integer" }, "minReplicaCount": { - "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.", + "description": "Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic 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" }, "requiredReplicaCount": { - "description": "Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.", + "description": "Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.", "format": "int32", "type": "integer" }, @@ -23212,6 +23422,10 @@ "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" }, + "speculativeDecodingSpec": { + "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpec", + "description": "Optional. Spec for configuring speculative decoding." + }, "status": { "$ref": "GoogleCloudAiplatformV1DeployedModelStatus", "description": "Output only. Runtime status of the deployed model.", @@ -23403,7 +23617,7 @@ "type": "integer" }, "bootDiskType": { - "description": "Type of the boot disk (default is \"pd-ssd\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) or \"pd-standard\" (Persistent Disk Hard Disk Drive).", + "description": "Type of the boot disk. For non-A3U machines, the default value is \"pd-ssd\", for A3U machines, the default value is \"hyperdisk-balanced\". Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive), \"pd-standard\" (Persistent Disk Hard Disk Drive) or \"hyperdisk-balanced\".", "type": "string" } }, @@ -23511,6 +23725,10 @@ "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, + "genAiAdvancedFeaturesConfig": { + "$ref": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig", + "description": "Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported." + }, "labels": { "additionalProperties": { "type": "string" @@ -23567,6 +23785,12 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1EnterpriseWebSearch": { + "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", + "id": "GoogleCloudAiplatformV1EnterpriseWebSearch", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1EntityIdSelector": { "description": "Selector for entityId. Getting ids from the given source.", "id": "GoogleCloudAiplatformV1EntityIdSelector", @@ -23710,10 +23934,40 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1EvaluateDatasetRequest": { + "description": "Request message for EvaluationService.EvaluateDataset.", + "id": "GoogleCloudAiplatformV1EvaluateDatasetRequest", + "properties": { + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "description": "Optional. Autorater config used for evaluation." + }, + "dataset": { + "$ref": "GoogleCloudAiplatformV1EvaluationDataset", + "description": "Required. The dataset used for evaluation." + }, + "metrics": { + "description": "Required. The metrics used for evaluation.", + "items": { + "$ref": "GoogleCloudAiplatformV1Metric" + }, + "type": "array" + }, + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1OutputConfig", + "description": "Required. Config for evaluation output." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1EvaluateInstancesRequest": { "description": "Request message for EvaluationService.EvaluateInstances.", "id": "GoogleCloudAiplatformV1EvaluateInstancesRequest", "properties": { + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "description": "Optional. Autorater config used for evaluation." + }, "bleuInput": { "$ref": "GoogleCloudAiplatformV1BleuInput", "description": "Instances and metric spec for bleu metric." @@ -24051,6 +24305,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1EvaluationDataset": { + "description": "The dataset used for evaluation.", + "id": "GoogleCloudAiplatformV1EvaluationDataset", + "properties": { + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1BigQuerySource", + "description": "BigQuery source holds the dataset." + }, + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "Cloud storage source holds the dataset." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Event": { "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", "id": "GoogleCloudAiplatformV1Event", @@ -24275,6 +24544,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ExecutableCode": { + "description": "Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [FunctionDeclaration] tool and [FunctionCallingConfig] mode is set to [Mode.CODE].", + "id": "GoogleCloudAiplatformV1ExecutableCode", + "properties": { + "code": { + "description": "Required. The code to be executed.", + "type": "string" + }, + "language": { + "description": "Required. Programming language of the `code`.", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "PYTHON" + ], + "enumDescriptions": [ + "Unspecified language. This value should not be used.", + "Python >= 3.10, with numpy and simpy available." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Execution": { "description": "Instance of a general execution.", "id": "GoogleCloudAiplatformV1Execution", @@ -25697,6 +25989,25 @@ "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, + "type": "string" + }, + "serviceAgentType": { + "description": "Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table.", + "enum": [ + "SERVICE_AGENT_TYPE_UNSPECIFIED", + "SERVICE_AGENT_TYPE_PROJECT", + "SERVICE_AGENT_TYPE_FEATURE_VIEW" + ], + "enumDescriptions": [ + "By default, the project-level Vertex AI Service Agent is enabled.", + "Indicates the project-level Vertex AI Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used during sync jobs.", + "Enable a FeatureView service account to be created by Vertex AI and output in the field `service_account_email`. This service account will be used to read from the source BigQuery table during sync." + ], + "type": "string" + }, "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." @@ -26272,6 +26583,10 @@ "description": "URI based data.", "id": "GoogleCloudAiplatformV1FileData", "properties": { + "displayName": { + "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls.", + "type": "string" + }, "fileUri": { "description": "Required. URI.", "type": "string" @@ -26717,6 +27032,28 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig": { + "description": "Configuration for GenAiAdvancedFeatures.", + "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig", + "properties": { + "ragConfig": { + "$ref": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig", + "description": "Configuration for Retrieval Augmented Generation feature." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig": { + "description": "Configuration for Retrieval Augmented Generation feature.", + "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig", + "properties": { + "enableRag": { + "description": "If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenerateContentRequest": { "description": "Request message for [PredictionService.GenerateContent].", "id": "GoogleCloudAiplatformV1GenerateContentRequest", @@ -26780,6 +27117,12 @@ "readOnly": true, "type": "array" }, + "createTime": { + "description": "Output only. Timestamp when the request is made to the server.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "modelVersion": { "description": "Output only. The model version used to generate the response.", "readOnly": true, @@ -26790,6 +27133,11 @@ "description": "Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.", "readOnly": true }, + "responseId": { + "description": "Output only. response_id is used to identify each response. It is the encoding of the event_id.", + "readOnly": true, + "type": "string" + }, "usageMetadata": { "$ref": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata", "description": "Usage metadata about the response(s)." @@ -26840,6 +27188,14 @@ "description": "Usage metadata about response(s).", "id": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata", "properties": { + "cacheTokensDetails": { + "description": "Output only. List of modalities of the cached content in the request input.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "cachedContentTokenCount": { "description": "Output only. Number of tokens in the cached part in the input (the cached content).", "format": "int32", @@ -26851,19 +27207,108 @@ "format": "int32", "type": "integer" }, + "candidatesTokensDetails": { + "description": "Output only. List of modalities that were returned in the response.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "promptTokenCount": { "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" }, + "promptTokensDetails": { + "description": "Output only. List of modalities that were processed in the request input.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "thoughtsTokenCount": { + "description": "Output only. Number of tokens present in thoughts output.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokenCount": { + "description": "Output only. Number of tokens present in tool-use prompt(s).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokensDetails": { + "description": "Output only. List of modalities that were processed for tool-use request inputs.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "totalTokenCount": { - "description": "Total token count for prompt and response candidates.", + "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", "format": "int32", "type": "integer" } }, "type": "object" }, + "GoogleCloudAiplatformV1GenerateVideoResponse": { + "description": "Generate video response.", + "id": "GoogleCloudAiplatformV1GenerateVideoResponse", + "properties": { + "generatedSamples": { + "deprecated": true, + "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" + }, + "videos": { + "description": "List of video bytes or Cloud Storage URIs of the generated videos.", + "items": { + "$ref": "GoogleCloudAiplatformV1GenerateVideoResponseVideo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenerateVideoResponseVideo": { + "description": "A generated video.", + "id": "GoogleCloudAiplatformV1GenerateVideoResponseVideo", + "properties": { + "bytesBase64Encoded": { + "description": "Base64 encoded bytes string representing the video.", + "type": "string" + }, + "gcsUri": { + "description": "Cloud Storage URI where the generated video is written.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the content of the video. - video/mp4", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenerationConfig": { "description": "Generation config.", "id": "GoogleCloudAiplatformV1GenerationConfig", @@ -27681,6 +28126,10 @@ "deprecated": true, "description": "The Cloud Storage path to write partial failures to. Deprecated. Prefer to use `import_result_gcs_sink`." }, + "ragFileParsingConfig": { + "$ref": "GoogleCloudAiplatformV1RagFileParsingConfig", + "description": "Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set." + }, "ragFileTransformationConfig": { "$ref": "GoogleCloudAiplatformV1RagFileTransformationConfig", "description": "Specifies the transformation config for RagFiles." @@ -28764,6 +29213,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse": { + "description": "Response message for ModelService.ListModelVersionCheckpoints", + "id": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse", + "properties": { + "checkpoints": { + "description": "List of Model Version checkpoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelVersionCheckpoint" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListModelVersionCheckpointsRequest.page_token to obtain that page.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListModelVersionsResponse": { "description": "Response message for ModelService.ListModelVersions", "id": "GoogleCloudAiplatformV1ListModelVersionsResponse", @@ -29524,6 +29991,66 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Metric": { + "description": "The metric used for dataset level evaluation.", + "id": "GoogleCloudAiplatformV1Metric", + "properties": { + "aggregationMetrics": { + "description": "Optional. The aggregation metrics to use.", + "items": { + "enum": [ + "AGGREGATION_METRIC_UNSPECIFIED", + "AVERAGE", + "MODE", + "STANDARD_DEVIATION", + "VARIANCE", + "MINIMUM", + "MAXIMUM", + "MEDIAN", + "PERCENTILE_P90", + "PERCENTILE_P95", + "PERCENTILE_P99" + ], + "enumDescriptions": [ + "Unspecified aggregation metric.", + "Average aggregation metric.", + "Mode aggregation metric.", + "Standard deviation aggregation metric.", + "Variance aggregation metric.", + "Minimum aggregation metric.", + "Maximum aggregation metric.", + "Median aggregation metric.", + "90th percentile aggregation metric.", + "95th percentile aggregation metric.", + "99th percentile aggregation metric." + ], + "type": "string" + }, + "type": "array" + }, + "bleuSpec": { + "$ref": "GoogleCloudAiplatformV1BleuSpec", + "description": "Spec for bleu metric." + }, + "exactMatchSpec": { + "$ref": "GoogleCloudAiplatformV1ExactMatchSpec", + "description": "Spec for exact match metric." + }, + "pairwiseMetricSpec": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec", + "description": "Spec for pairwise metric." + }, + "pointwiseMetricSpec": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec", + "description": "Spec for pointwise metric." + }, + "rougeSpec": { + "$ref": "GoogleCloudAiplatformV1RougeSpec", + "description": "Spec for rouge metric." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1MetricxInput": { "description": "Input for MetricX metric.", "id": "GoogleCloudAiplatformV1MetricxInput", @@ -29847,6 +30374,38 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ModalityTokenCount": { + "description": "Represents token counting info for a single modality.", + "id": "GoogleCloudAiplatformV1ModalityTokenCount", + "properties": { + "modality": { + "description": "The modality associated with this token count.", + "enum": [ + "MODALITY_UNSPECIFIED", + "TEXT", + "IMAGE", + "VIDEO", + "AUDIO", + "DOCUMENT" + ], + "enumDescriptions": [ + "Unspecified modality.", + "Plain text.", + "Image.", + "Video.", + "Audio.", + "Document, e.g. PDF." + ], + "type": "string" + }, + "tokenCount": { + "description": "Number of tokens.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Model": { "description": "A trained machine learning Model.", "id": "GoogleCloudAiplatformV1Model", @@ -29873,6 +30432,10 @@ "$ref": "GoogleCloudAiplatformV1ModelDataStats", "description": "Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with data_input_config." }, + "defaultCheckpointId": { + "description": "The default checkpoint id of a model version.", + "type": "string" + }, "deployedModels": { "description": "Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.", "items": { @@ -30668,7 +31231,7 @@ "type": "array" }, "id": { - "description": "Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code.", + "description": "Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model.", "readOnly": true, "type": "string" } @@ -30682,6 +31245,14 @@ "publicModelName": { "description": "Required. The model garden source model resource name.", "type": "string" + }, + "skipHfModelCache": { + "description": "Optional. Whether to avoid pulling the model from the HF cache.", + "type": "boolean" + }, + "versionId": { + "description": "Optional. The model garden source model version ID.", + "type": "string" } }, "type": "object" @@ -30984,6 +31555,31 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ModelVersionCheckpoint": { + "description": "Describes the machine learning model version checkpoint.", + "id": "GoogleCloudAiplatformV1ModelVersionCheckpoint", + "properties": { + "checkpointId": { + "description": "The ID of the checkpoint.", + "type": "string" + }, + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}`", + "type": "string" + }, + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata": { "description": "Runtime operation information for IndexEndpointService.MutateDeployedIndex.", "id": "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata", @@ -32146,6 +32742,11 @@ "description": "Output only. Runtime Shielded VM spec.", "readOnly": true }, + "softwareConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookSoftwareConfig", + "description": "Output only. Software config of the notebook runtime.", + "readOnly": true + }, "updateTime": { "description": "Output only. Timestamp when this NotebookRuntime was most recently updated.", "format": "google-datetime", @@ -32253,6 +32854,10 @@ "$ref": "GoogleCloudAiplatformV1ShieldedVmConfig", "description": "Optional. Immutable. Runtime Shielded VM spec." }, + "softwareConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookSoftwareConfig", + "description": "Optional. The notebook software configuration of the notebook runtime." + }, "updateTime": { "description": "Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.", "format": "google-datetime", @@ -32273,6 +32878,35 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1NotebookSoftwareConfig": { + "description": "Notebook Software Config.", + "id": "GoogleCloudAiplatformV1NotebookSoftwareConfig", + "properties": { + "env": { + "description": "Optional. Environment variables to be passed to the container. Maximum limit is 100.", + "items": { + "$ref": "GoogleCloudAiplatformV1EnvVar" + }, + "type": "array" + }, + "postStartupScriptConfig": { + "$ref": "GoogleCloudAiplatformV1PostStartupScriptConfig", + "description": "Optional. Post startup script config." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OutputConfig": { + "description": "Config for evaluation output.", + "id": "GoogleCloudAiplatformV1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Cloud storage destination for evaluation output." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PSCAutomationConfig": { "description": "PSC config that is used to automatically create forwarding rule via ServiceConnectionMap.", "id": "GoogleCloudAiplatformV1PSCAutomationConfig", @@ -32347,9 +32981,21 @@ "description": "Spec for pairwise metric.", "id": "GoogleCloudAiplatformV1PairwiseMetricSpec", "properties": { + "baselineResponseFieldName": { + "description": "Optional. The field name of the baseline response.", + "type": "string" + }, + "candidateResponseFieldName": { + "description": "Optional. The field name of the candidate response.", + "type": "string" + }, "metricPromptTemplate": { "description": "Required. Metric prompt template for pairwise metric.", "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for pairwise metric.", + "type": "string" } }, "type": "object" @@ -32544,6 +33190,14 @@ "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1Part", "properties": { + "codeExecutionResult": { + "$ref": "GoogleCloudAiplatformV1CodeExecutionResult", + "description": "Optional. Result of executing the [ExecutableCode]." + }, + "executableCode": { + "$ref": "GoogleCloudAiplatformV1ExecutableCode", + "description": "Optional. Code generated by the model that is meant to be executed." + }, "fileData": { "$ref": "GoogleCloudAiplatformV1FileData", "description": "Optional. URI based data." @@ -33228,6 +33882,10 @@ "metricPromptTemplate": { "description": "Required. Metric prompt template for pointwise metric.", "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for pointwise metric.", + "type": "string" } }, "type": "object" @@ -33244,6 +33902,37 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PostStartupScriptConfig": { + "description": "Post startup script config.", + "id": "GoogleCloudAiplatformV1PostStartupScriptConfig", + "properties": { + "postStartupScript": { + "description": "Optional. Post startup script to run after runtime is started.", + "type": "string" + }, + "postStartupScriptBehavior": { + "description": "Optional. Post startup script behavior that defines download and execution behavior.", + "enum": [ + "POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED", + "RUN_ONCE", + "RUN_EVERY_START", + "DOWNLOAD_AND_RUN_EVERY_START" + ], + "enumDescriptions": [ + "Unspecified post startup script behavior.", + "Run post startup script after runtime is started.", + "Run post startup script after runtime is stopped.", + "Download and run post startup script every time runtime is started." + ], + "type": "string" + }, + "postStartupScriptUrl": { + "description": "Optional. Post startup script url to download. Example: https://bucket/script.sh", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PrebuiltVoiceConfig": { "description": "The configuration for the prebuilt speaker to use.", "id": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", @@ -33472,6 +34161,11 @@ "$ref": "GoogleCloudAiplatformV1ProbeExecAction", "description": "ExecAction probes the health of a container by executing a command." }, + "failureThreshold": { + "description": "Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.", + "format": "int32", + "type": "integer" + }, "grpc": { "$ref": "GoogleCloudAiplatformV1ProbeGrpcAction", "description": "GrpcAction probes the health of a container by sending a gRPC request." @@ -33480,11 +34174,21 @@ "$ref": "GoogleCloudAiplatformV1ProbeHttpGetAction", "description": "HttpGetAction probes the health of a container by sending an HTTP GET request." }, + "initialDelaySeconds": { + "description": "Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.", + "format": "int32", + "type": "integer" + }, "periodSeconds": { "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.", "format": "int32", "type": "integer" }, + "successThreshold": { + "description": "Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.", + "format": "int32", + "type": "integer" + }, "tcpSocket": { "$ref": "GoogleCloudAiplatformV1ProbeTcpSocketAction", "description": "TcpSocketAction probes the health of a container by opening a TCP socket connection." @@ -34725,6 +35429,33 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RagFileParsingConfig": { + "description": "Specifies the parsing config for RagFiles.", + "id": "GoogleCloudAiplatformV1RagFileParsingConfig", + "properties": { + "layoutParser": { + "$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser", + "description": "The Layout Parser to use for RagFiles." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser": { + "description": "Document AI Layout Parser config.", + "id": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser", + "properties": { + "maxParsingRequestsPerMin": { + "description": "The maximum number of requests the job is allowed to make to the Document AI processor per minute. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If unspecified, a default value of 120 QPM would be used.", + "format": "int32", + "type": "integer" + }, + "processorName": { + "description": "The full resource name of a Document AI processor or processor version. The processor must have type `LAYOUT_PARSER_PROCESSOR`. If specified, the `additional_config.parse_as_scanned_pdf` field must be false. Format: * `projects/{project_id}/locations/{location}/processors/{processor_id}` * `projects/{project_id}/locations/{location}/processors/{processor_id}/processorVersions/{processor_version_id}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RagFileTransformationConfig": { "description": "Specifies the transformation config for RagFiles.", "id": "GoogleCloudAiplatformV1RagFileTransformationConfig", @@ -35169,6 +35900,10 @@ }, "type": "array" }, + "deploymentSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec", + "description": "Optional. The specification of a Reasoning Engine deployment." + }, "packageSpec": { "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", "description": "Required. User provided package spec of the ReasoningEngine." @@ -35176,6 +35911,27 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec": { + "description": "The specification of a Reasoning Engine deployment.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec", + "properties": { + "env": { + "description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.", + "items": { + "$ref": "GoogleCloudAiplatformV1EnvVar" + }, + "type": "array" + }, + "secretEnv": { + "description": "Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.", + "items": { + "$ref": "GoogleCloudAiplatformV1SecretEnvVar" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec": { "description": "User provided package spec like pickled object and package requirements.", "id": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", @@ -35308,7 +36064,7 @@ "type": "string" }, "values": { - "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.", + "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.", "items": { "type": "string" }, @@ -38453,7 +39209,7 @@ "id": "GoogleCloudAiplatformV1SchemaTextDataItem", "properties": { "gcsUri": { - "description": "Output only. Google Cloud Storage URI points to the original text in user's bucket. The text file is up to 10MB in size.", + "description": "Output only. Google Cloud Storage URI points to a copy of the original text in the Vertex-managed bucket in the user's project. The text file is up to 10MB in size.", "readOnly": true, "type": "string" } @@ -40590,6 +41346,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1SecretEnvVar": { + "description": "Represents an environment variable where the value is a secret in Cloud Secret Manager.", + "id": "GoogleCloudAiplatformV1SecretEnvVar", + "properties": { + "name": { + "description": "Required. Name of the secret environment variable.", + "type": "string" + }, + "secretRef": { + "$ref": "GoogleCloudAiplatformV1SecretRef", + "description": "Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SecretRef": { + "description": "Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.", + "id": "GoogleCloudAiplatformV1SecretRef", + "properties": { + "secret": { + "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.", + "type": "string" + }, + "version": { + "description": "The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Segment": { "description": "Segment of the content.", "id": "GoogleCloudAiplatformV1Segment", @@ -40821,6 +41607,49 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1SpeculativeDecodingSpec": { + "description": "Configuration for Speculative Decoding.", + "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpec", + "properties": { + "draftModelSpeculation": { + "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation", + "description": "draft model speculation." + }, + "ngramSpeculation": { + "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation", + "description": "N-Gram speculation." + }, + "speculativeTokenCount": { + "description": "The number of speculative tokens to generate at each step.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation": { + "description": "Draft model speculation works by using the smaller model to generate candidate tokens for speculative decoding.", + "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation", + "properties": { + "draftModel": { + "description": "Required. The resource name of the draft model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation": { + "description": "N-Gram speculation works by trying to find matching tokens in the previous prompt sequence and use those as speculation for generating new tokens.", + "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation", + "properties": { + "ngramSize": { + "description": "The number of last N input tokens used as ngram to search/match against the previous prompt sequence. This is equal to the N in N-Gram. The default value is 3 if not specified.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1SpeechConfig": { "description": "The speech generation config.", "id": "GoogleCloudAiplatformV1SpeechConfig", @@ -41823,6 +42652,7 @@ "enum": [ "ADAPTER_SIZE_UNSPECIFIED", "ADAPTER_SIZE_ONE", + "ADAPTER_SIZE_TWO", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", "ADAPTER_SIZE_SIXTEEN", @@ -41831,6 +42661,7 @@ "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", + "Adapter size 2.", "Adapter size 4.", "Adapter size 8.", "Adapter size 16.", @@ -42641,6 +43472,14 @@ "description": "Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).", "id": "GoogleCloudAiplatformV1Tool", "properties": { + "codeExecution": { + "$ref": "GoogleCloudAiplatformV1ToolCodeExecution", + "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." + }, + "enterpriseWebSearch": { + "$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch", + "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." + }, "functionDeclarations": { "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.", "items": { @@ -42745,6 +43584,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1ToolCodeExecution": { + "description": "Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool.", + "id": "GoogleCloudAiplatformV1ToolCodeExecution", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1ToolConfig": { "description": "Tool config. This config is shared for all tools provided in the request.", "id": "GoogleCloudAiplatformV1ToolConfig", @@ -43642,7 +44487,7 @@ "type": "object" }, "GoogleCloudAiplatformV1TunedModel": { - "description": "The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob.", + "description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.", "id": "GoogleCloudAiplatformV1TunedModel", "properties": { "endpoint": { @@ -43787,7 +44632,7 @@ }, "tunedModel": { "$ref": "GoogleCloudAiplatformV1TunedModel", - "description": "Output only. The tuned model resources assiociated with this TuningJob.", + "description": "Output only. The tuned model resources associated with this TuningJob.", "readOnly": true }, "tunedModelDisplayName": { @@ -44242,11 +45087,11 @@ "type": "object" }, "GoogleCloudAiplatformV1VertexAISearch": { - "description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder", + "description": "Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder", "id": "GoogleCloudAiplatformV1VertexAISearch", "properties": { "datastore": { - "description": "Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" } }, diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index db7f3b2b5c4..6d937287822 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -765,6 +765,35 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1beta1/endpoints/{endpointsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.endpoints.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "streamGenerateContent": { "description": "Generate content with multimodal inputs with streaming support.", "flatPath": "v1beta1/endpoints/{endpointsId}:streamGenerateContent", @@ -956,7 +985,7 @@ ] }, "deploy": { - "description": "Deploys publisher models.", + "description": "Deploys a model to a new endpoint.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy", "httpMethod": "POST", "id": "aiplatform.projects.locations.deploy", @@ -973,6 +1002,35 @@ } }, "path": "v1beta1/{+destination}:deploy", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deployPublisherModel": { + "deprecated": true, + "description": "Deploys publisher models.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deployPublisherModel", + "parameterOrder": [ + "destination" + ], + "parameters": { + "destination": { + "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+destination}:deployPublisherModel", "request": { "$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest" }, @@ -983,6 +1041,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "evaluateDataset": { + "description": "Evaluates a dataset based on a set of given metrics.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateDataset", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:evaluateDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "evaluateInstances": { "description": "Evaluates instances based on a given metric.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", @@ -6294,7 +6380,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` * `big_query` * `big_query.entity_id_columns`", + "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` * `service_agent_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -6502,6 +6588,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor 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` * `schedule_config` * `feature_selection_config`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -10007,7 +10127,7 @@ ] }, "deployIndex": { - "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.", + "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", "httpMethod": "POST", "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", @@ -13781,6 +13901,42 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listCheckpoints": { + "description": "Lists checkpoints of the specified model version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.listCheckpoints", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "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 next_page_token of the previous ListModelVersionCheckpoints call.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:listCheckpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "listVersions": { "description": "Lists versions of the specified model.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions", @@ -21814,6 +21970,11 @@ "location": "query", "type": "string" }, + "includeEquivalentModelGardenModelDeploymentConfigs": { + "description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.", + "location": "query", + "type": "boolean" + }, "isHuggingFaceModel": { "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", "location": "query", @@ -21930,6 +22091,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "streamGenerateContent": { "description": "Generate content with multimodal inputs with streaming support.", "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", @@ -21964,7 +22154,7 @@ } } }, - "revision": "20250114", + "revision": "20250304", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -21989,6 +22179,31 @@ "type": "string" }, "type": "array" + }, + "videos": { + "description": "List of videos, used to align naming with the external response.", + "items": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoResponseVideo" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoResponseVideo": { + "id": "CloudAiLargeModelsVisionGenerateVideoResponseVideo", + "properties": { + "bytesBase64Encoded": { + "description": "Base64 encoded bytes string representing the video.", + "type": "string" + }, + "gcsUri": { + "description": "Cloud Storage URI where the generated video is written.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the content of the video. - video/mp4", + "type": "string" } }, "type": "object" @@ -22268,6 +22483,10 @@ "description": "Video encoding, for example \"video/mp4\".", "type": "string" }, + "text": { + "description": "Text/Expanded text input for Help Me Write.", + "type": "string" + }, "uri": { "description": "Path to another storage (typically Google Cloud Storage).", "type": "string" @@ -22885,7 +23104,7 @@ "type": "string" }, "httpElementLocation": { - "description": "Required. The location of the API key.", + "description": "Optional. The location of the API key.", "enum": [ "HTTP_IN_UNSPECIFIED", "HTTP_IN_QUERY", @@ -22905,7 +23124,7 @@ "type": "string" }, "name": { - "description": "Required. The parameter name of the API key. E.g. If the API request is \"https://example.com/act?api_key=\", \"api_key\" would be the parameter name.", + "description": "Optional. The parameter name of the API key. E.g. If the API request is \"https://example.com/act?api_key=\", \"api_key\" would be the parameter name.", "type": "string" } }, @@ -22968,12 +23187,32 @@ "id": "GoogleCloudAiplatformV1beta1AutomaticResources", "properties": { "maxReplicaCount": { - "description": "Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", + "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", "format": "int32", "type": "integer" }, "minReplicaCount": { - "description": "Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.", + "description": "Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AutoraterConfig": { + "description": "The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.", + "id": "GoogleCloudAiplatformV1beta1AutoraterConfig", + "properties": { + "autoraterModel": { + "description": "Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "type": "string" + }, + "flipEnabled": { + "description": "Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.", + "type": "boolean" + }, + "samplingCount": { + "description": "Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.", "format": "int32", "type": "integer" } @@ -23789,6 +24028,10 @@ "format": "byte", "type": "string" }, + "displayName": { + "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls.", + "type": "string" + }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" @@ -23849,7 +24092,7 @@ "type": "array" }, "createTime": { - "description": "Output only. Creatation time of the cache entry.", + "description": "Output only. Creation time of the cache entry.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -23864,7 +24107,7 @@ "type": "string" }, "model": { - "description": "Immutable. The name of the publisher model to use for cached content. Format: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}", + "description": "Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}", "type": "string" }, "name": { @@ -24753,6 +24996,14 @@ "description": "Response message for PredictionService.CountTokens.", "id": "GoogleCloudAiplatformV1beta1CountTokensResponse", "properties": { + "promptTokensDetails": { + "description": "Output only. List of modalities that were processed in the request input.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "totalBillableCharacters": { "description": "The total number of billable characters counted across all instances from the request.", "format": "int32", @@ -25840,7 +26091,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1DedicatedResources": { - "description": "A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.", + "description": "A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration.", "id": "GoogleCloudAiplatformV1beta1DedicatedResources", "properties": { "autoscalingMetricSpecs": { @@ -25852,20 +26103,20 @@ }, "machineSpec": { "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", - "description": "Required. Immutable. The specification of a single machine used by the prediction." + "description": "Required. Immutable. The specification of a single machine being used." }, "maxReplicaCount": { - "description": "Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", + "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", "format": "int32", "type": "integer" }, "minReplicaCount": { - "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.", + "description": "Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic 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" }, "requiredReplicaCount": { - "description": "Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.", + "description": "Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.", "format": "int32", "type": "integer" }, @@ -26087,6 +26338,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest": { + "deprecated": true, "description": "Request message for ModelGardenService.DeployPublisherModel.", "id": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest", "properties": { @@ -26107,7 +26359,7 @@ "type": "string" }, "model": { - "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001` or Hugging Face model ID like `google/gemma-2-2b-it`.", + "description": "Required. The model to deploy. Format: 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`. 2. Hugging Face model ID like `google/gemma-2-2b-it`. 3. Custom model Google Cloud Storage URI like `gs://bucket`. 4. Custom model zip file like `https://example.com/a.zip`.", "type": "string" }, "modelDisplayName": { @@ -26117,6 +26369,90 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1DeployRequest": { + "description": "Request message for ModelGardenService.Deploy.", + "id": "GoogleCloudAiplatformV1beta1DeployRequest", + "properties": { + "deployConfig": { + "$ref": "GoogleCloudAiplatformV1beta1DeployRequestDeployConfig", + "description": "Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used." + }, + "endpointConfig": { + "$ref": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig", + "description": "Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used." + }, + "huggingFaceModelId": { + "description": "The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.", + "type": "string" + }, + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1beta1DeployRequestModelConfig", + "description": "Optional. The model config to use for the deployment. If not specified, the default model config will be used." + }, + "publisherModelName": { + "description": "The Model Garden model to deploy. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1DeployRequestDeployConfig": { + "description": "The deploy config to use for the deployment.", + "id": "GoogleCloudAiplatformV1beta1DeployRequestDeployConfig", + "properties": { + "dedicatedResources": { + "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources", + "description": "Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used." + }, + "fastTryoutEnabled": { + "description": "Optional. If true, enable the QMT fast tryout feature for this model if possible.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig": { + "description": "The endpoint config to use for the deployment.", + "id": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig", + "properties": { + "dedicatedEndpointEnabled": { + "description": "Optional. 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 limitations will be removed soon.", + "type": "boolean" + }, + "endpointDisplayName": { + "description": "Optional. The user-specified display name of the endpoint. If not set, a default name will be used.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1DeployRequestModelConfig": { + "description": "The model config to use for the deployment.", + "id": "GoogleCloudAiplatformV1beta1DeployRequestModelConfig", + "properties": { + "acceptEula": { + "description": "Optional. Whether the user accepts the End User License Agreement (EULA) for the model.", + "type": "boolean" + }, + "containerSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec", + "description": "Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used." + }, + "huggingFaceAccessToken": { + "description": "Optional. The Hugging Face read access token used to access the model artifacts of gated models.", + "type": "string" + }, + "huggingFaceCacheEnabled": { + "description": "Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.", + "type": "boolean" + }, + "modelDisplayName": { + "description": "Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1DeploySolverOperationMetadata": { "description": "Runtime operation information for SolverService.DeploySolver.", "id": "GoogleCloudAiplatformV1beta1DeploySolverOperationMetadata", @@ -26310,6 +26646,10 @@ "description": "Output only. Provide paths for users to send predict/explain/health requests directly to the deployed model services running on Cloud via private services access. This field is populated if network is configured.", "readOnly": true }, + "rolloutOptions": { + "$ref": "GoogleCloudAiplatformV1beta1RolloutOptions", + "description": "Options for configuring rolling deployments." + }, "serviceAccount": { "description": "The service account that the DeployedModel's container runs as. Specify the email address of the service account. If this service account is not specified, the container runs as a service account that doesn't have access to the resource project. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -26318,6 +26658,10 @@ "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" }, + "speculativeDecodingSpec": { + "$ref": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec", + "description": "Optional. Spec for configuring speculative decoding." + }, "status": { "$ref": "GoogleCloudAiplatformV1beta1DeployedModelStatus", "description": "Output only. Runtime status of the deployed model.", @@ -26509,7 +26853,7 @@ "type": "integer" }, "bootDiskType": { - "description": "Type of the boot disk (default is \"pd-ssd\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) or \"pd-standard\" (Persistent Disk Hard Disk Drive).", + "description": "Type of the boot disk. For non-A3U machines, the default value is \"pd-ssd\", for A3U machines, the default value is \"hyperdisk-balanced\". Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive), \"pd-standard\" (Persistent Disk Hard Disk Drive) or \"hyperdisk-balanced\".", "type": "string" } }, @@ -26536,6 +26880,7 @@ "enum": [ "ADAPTER_SIZE_UNSPECIFIED", "ADAPTER_SIZE_ONE", + "ADAPTER_SIZE_TWO", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", "ADAPTER_SIZE_SIXTEEN", @@ -26544,6 +26889,7 @@ "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", + "Adapter size 2.", "Adapter size 4.", "Adapter size 8.", "Adapter size 16.", @@ -26704,6 +27050,10 @@ "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, + "genAiAdvancedFeaturesConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig", + "description": "Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported." + }, "labels": { "additionalProperties": { "type": "string" @@ -26760,6 +27110,12 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EnterpriseWebSearch": { + "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", + "id": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1EntityIdSelector": { "description": "Selector for entityId. Getting ids from the given source.", "id": "GoogleCloudAiplatformV1beta1EntityIdSelector", @@ -26903,10 +27259,40 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest": { + "description": "Request message for EvaluationService.EvaluateDataset.", + "id": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest", + "properties": { + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", + "description": "Optional. Autorater config used for evaluation." + }, + "dataset": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationDataset", + "description": "Required. The dataset used for evaluation." + }, + "metrics": { + "description": "Required. The metrics used for evaluation.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Metric" + }, + "type": "array" + }, + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1beta1OutputConfig", + "description": "Required. Config for evaluation output." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest": { "description": "Request message for EvaluationService.EvaluateInstances.", "id": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest", "properties": { + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", + "description": "Optional. Autorater config used for evaluation." + }, "bleuInput": { "$ref": "GoogleCloudAiplatformV1beta1BleuInput", "description": "Instances and metric spec for bleu metric." @@ -27244,6 +27630,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EvaluationDataset": { + "description": "The dataset used for evaluation.", + "id": "GoogleCloudAiplatformV1beta1EvaluationDataset", + "properties": { + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource", + "description": "BigQuery source holds the dataset." + }, + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1beta1GcsSource", + "description": "Cloud storage source holds the dataset." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Event": { "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", "id": "GoogleCloudAiplatformV1beta1Event", @@ -30055,6 +30456,10 @@ "description": "URI based data.", "id": "GoogleCloudAiplatformV1beta1FileData", "properties": { + "displayName": { + "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls.", + "type": "string" + }, "fileUri": { "description": "Required. URI.", "type": "string" @@ -30500,6 +30905,28 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig": { + "description": "Configuration for GenAiAdvancedFeatures.", + "id": "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig", + "properties": { + "ragConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig", + "description": "Configuration for Retrieval Augmented Generation feature." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig": { + "description": "Configuration for Retrieval Augmented Generation feature.", + "id": "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig", + "properties": { + "enableRag": { + "description": "If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest": { "description": "Request message for NotebookInternalService.GenerateAccessToken.", "id": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest", @@ -30598,6 +31025,12 @@ "readOnly": true, "type": "array" }, + "createTime": { + "description": "Output only. Timestamp when the request is made to the server.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "modelVersion": { "description": "Output only. The model version used to generate the response.", "readOnly": true, @@ -30608,6 +31041,11 @@ "description": "Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.", "readOnly": true }, + "responseId": { + "description": "Output only. response_id is used to identify each response. It is the encoding of the event_id.", + "readOnly": true, + "type": "string" + }, "usageMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "description": "Usage metadata about the response(s)." @@ -30658,6 +31096,14 @@ "description": "Usage metadata about response(s).", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "properties": { + "cacheTokensDetails": { + "description": "Output only. List of modalities of the cached content in the request input.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "cachedContentTokenCount": { "description": "Output only. Number of tokens in the cached part in the input (the cached content).", "format": "int32", @@ -30669,13 +31115,49 @@ "format": "int32", "type": "integer" }, + "candidatesTokensDetails": { + "description": "Output only. List of modalities that were returned in the response.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "promptTokenCount": { "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" }, + "promptTokensDetails": { + "description": "Output only. List of modalities that were processed in the request input.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "thoughtsTokenCount": { + "description": "Output only. Number of tokens present in thoughts output.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokenCount": { + "description": "Output only. Number of tokens present in tool-use prompt(s).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokensDetails": { + "description": "Output only. List of modalities that were processed for tool-use request inputs.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "totalTokenCount": { - "description": "Total token count for prompt and response candidates.", + "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", "format": "int32", "type": "integer" } @@ -30687,6 +31169,7 @@ "id": "GoogleCloudAiplatformV1beta1GenerateVideoResponse", "properties": { "generatedSamples": { + "deprecated": true, "description": "The cloud storage uris of the generated videos.", "items": { "type": "string" @@ -30704,6 +31187,32 @@ "type": "string" }, "type": "array" + }, + "videos": { + "description": "List of video bytes or Cloud Storage URIs of the generated videos.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo": { + "description": "A generated video.", + "id": "GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo", + "properties": { + "bytesBase64Encoded": { + "description": "Base64 encoded bytes string representing the video.", + "type": "string" + }, + "gcsUri": { + "description": "Cloud Storage URI where the generated video is written.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the content of the video. - video/mp4", + "type": "string" } }, "type": "object" @@ -32778,6 +33287,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse": { + "description": "Response message for ModelService.ListModelVersionCheckpoints", + "id": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse", + "properties": { + "checkpoints": { + "description": "List of Model Version checkpoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListModelVersionCheckpointsRequest.page_token to obtain that page.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListModelVersionsResponse": { "description": "Response message for ModelService.ListModelVersions", "id": "GoogleCloudAiplatformV1beta1ListModelVersionsResponse", @@ -33364,6 +33891,11 @@ "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" }, + "multihostGpuNodeCount": { + "description": "Optional. Immutable. The number of nodes per replica for multihost GPU deployments.", + "format": "int32", + "type": "integer" + }, "reservationAffinity": { "$ref": "GoogleCloudAiplatformV1beta1ReservationAffinity", "description": "Optional. Immutable. Configuration controlling how this resource pool consumes reservation." @@ -33556,6 +34088,66 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Metric": { + "description": "The metric used for dataset level evaluation.", + "id": "GoogleCloudAiplatformV1beta1Metric", + "properties": { + "aggregationMetrics": { + "description": "Optional. The aggregation metrics to use.", + "items": { + "enum": [ + "AGGREGATION_METRIC_UNSPECIFIED", + "AVERAGE", + "MODE", + "STANDARD_DEVIATION", + "VARIANCE", + "MINIMUM", + "MAXIMUM", + "MEDIAN", + "PERCENTILE_P90", + "PERCENTILE_P95", + "PERCENTILE_P99" + ], + "enumDescriptions": [ + "Unspecified aggregation metric.", + "Average aggregation metric.", + "Mode aggregation metric.", + "Standard deviation aggregation metric.", + "Variance aggregation metric.", + "Minimum aggregation metric.", + "Maximum aggregation metric.", + "Median aggregation metric.", + "90th percentile aggregation metric.", + "95th percentile aggregation metric.", + "99th percentile aggregation metric." + ], + "type": "string" + }, + "type": "array" + }, + "bleuSpec": { + "$ref": "GoogleCloudAiplatformV1beta1BleuSpec", + "description": "Spec for bleu metric." + }, + "exactMatchSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ExactMatchSpec", + "description": "Spec for exact match metric." + }, + "pairwiseMetricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", + "description": "Spec for pairwise metric." + }, + "pointwiseMetricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", + "description": "Spec for pointwise metric." + }, + "rougeSpec": { + "$ref": "GoogleCloudAiplatformV1beta1RougeSpec", + "description": "Spec for rouge metric." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1MetricxInput": { "description": "Input for MetricX metric.", "id": "GoogleCloudAiplatformV1beta1MetricxInput", @@ -33879,6 +34471,38 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ModalityTokenCount": { + "description": "Represents token counting info for a single modality.", + "id": "GoogleCloudAiplatformV1beta1ModalityTokenCount", + "properties": { + "modality": { + "description": "The modality associated with this token count.", + "enum": [ + "MODALITY_UNSPECIFIED", + "TEXT", + "IMAGE", + "VIDEO", + "AUDIO", + "DOCUMENT" + ], + "enumDescriptions": [ + "Unspecified modality.", + "Plain text.", + "Image.", + "Video.", + "Audio.", + "Document, e.g. PDF." + ], + "type": "string" + }, + "tokenCount": { + "description": "Number of tokens.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Model": { "description": "A trained machine learning Model.", "id": "GoogleCloudAiplatformV1beta1Model", @@ -33901,6 +34525,10 @@ "readOnly": true, "type": "string" }, + "defaultCheckpointId": { + "description": "The default checkpoint id of a model version.", + "type": "string" + }, "deployedModels": { "description": "Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.", "items": { @@ -34669,7 +35297,7 @@ "type": "array" }, "id": { - "description": "Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code.", + "description": "Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model.", "readOnly": true, "type": "string" } @@ -34683,6 +35311,14 @@ "publicModelName": { "description": "Required. The model garden source model resource name.", "type": "string" + }, + "skipHfModelCache": { + "description": "Optional. Whether to avoid pulling the model from the HF cache.", + "type": "boolean" + }, + "versionId": { + "description": "Optional. The model garden source model version ID.", + "type": "string" } }, "type": "object" @@ -35783,6 +36419,31 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint": { + "description": "Describes the machine learning model version checkpoint.", + "id": "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint", + "properties": { + "checkpointId": { + "description": "The ID of the checkpoint.", + "type": "string" + }, + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}`", + "type": "string" + }, + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1MutateDeployedIndexOperationMetadata": { "description": "Runtime operation information for IndexEndpointService.MutateDeployedIndex.", "id": "GoogleCloudAiplatformV1beta1MutateDeployedIndexOperationMetadata", @@ -36945,6 +37606,11 @@ "description": "Output only. Runtime Shielded VM spec.", "readOnly": true }, + "softwareConfig": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig", + "description": "Output only. Software config of the notebook runtime.", + "readOnly": true + }, "updateTime": { "description": "Output only. Timestamp when this NotebookRuntime was most recently updated.", "format": "google-datetime", @@ -37052,6 +37718,10 @@ "$ref": "GoogleCloudAiplatformV1beta1ShieldedVmConfig", "description": "Optional. Immutable. Runtime Shielded VM spec." }, + "softwareConfig": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig", + "description": "Optional. The notebook software configuration of the notebook runtime." + }, "updateTime": { "description": "Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.", "format": "google-datetime", @@ -37072,6 +37742,35 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig": { + "description": "Notebook Software Config.", + "id": "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig", + "properties": { + "env": { + "description": "Optional. Environment variables to be passed to the container. Maximum limit is 100.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1EnvVar" + }, + "type": "array" + }, + "postStartupScriptConfig": { + "$ref": "GoogleCloudAiplatformV1beta1PostStartupScriptConfig", + "description": "Optional. Post startup script config." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1OutputConfig": { + "description": "Config for evaluation output.", + "id": "GoogleCloudAiplatformV1beta1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", + "description": "Cloud storage destination for evaluation output." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PSCAutomationConfig": { "description": "PSC config that is used to automatically create forwarding rule via ServiceConnectionMap.", "id": "GoogleCloudAiplatformV1beta1PSCAutomationConfig", @@ -37146,9 +37845,21 @@ "description": "Spec for pairwise metric.", "id": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", "properties": { + "baselineResponseFieldName": { + "description": "Optional. The field name of the baseline response.", + "type": "string" + }, + "candidateResponseFieldName": { + "description": "Optional. The field name of the candidate response.", + "type": "string" + }, "metricPromptTemplate": { "description": "Required. Metric prompt template for pairwise metric.", "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for pairwise metric.", + "type": "string" } }, "type": "object" @@ -38200,6 +38911,10 @@ "metricPromptTemplate": { "description": "Required. Metric prompt template for pointwise metric.", "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for pointwise metric.", + "type": "string" } }, "type": "object" @@ -38216,6 +38931,37 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PostStartupScriptConfig": { + "description": "Post startup script config.", + "id": "GoogleCloudAiplatformV1beta1PostStartupScriptConfig", + "properties": { + "postStartupScript": { + "description": "Optional. Post startup script to run after runtime is started.", + "type": "string" + }, + "postStartupScriptBehavior": { + "description": "Optional. Post startup script behavior that defines download and execution behavior.", + "enum": [ + "POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED", + "RUN_ONCE", + "RUN_EVERY_START", + "DOWNLOAD_AND_RUN_EVERY_START" + ], + "enumDescriptions": [ + "Unspecified post startup script behavior.", + "Run post startup script after runtime is started.", + "Run post startup script after runtime is stopped.", + "Download and run post startup script every time runtime is started." + ], + "type": "string" + }, + "postStartupScriptUrl": { + "description": "Optional. Post startup script url to download. Example: https://bucket/script.sh", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig": { "description": "The configuration for the prebuilt speaker to use.", "id": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", @@ -38465,6 +39211,11 @@ "$ref": "GoogleCloudAiplatformV1beta1ProbeExecAction", "description": "ExecAction probes the health of a container by executing a command." }, + "failureThreshold": { + "description": "Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.", + "format": "int32", + "type": "integer" + }, "grpc": { "$ref": "GoogleCloudAiplatformV1beta1ProbeGrpcAction", "description": "GrpcAction probes the health of a container by sending a gRPC request." @@ -38473,11 +39224,21 @@ "$ref": "GoogleCloudAiplatformV1beta1ProbeHttpGetAction", "description": "HttpGetAction probes the health of a container by sending an HTTP GET request." }, + "initialDelaySeconds": { + "description": "Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.", + "format": "int32", + "type": "integer" + }, "periodSeconds": { "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.", "format": "int32", "type": "integer" }, + "successThreshold": { + "description": "Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.", + "format": "int32", + "type": "integer" + }, "tcpSocket": { "$ref": "GoogleCloudAiplatformV1beta1ProbeTcpSocketAction", "description": "TcpSocketAction probes the health of a container by opening a TCP socket connection." @@ -39660,6 +40421,12 @@ "deprecated": true, "description": "Optional. Immutable. The embedding model config of the RagCorpus." }, + "ragFilesCount": { + "description": "Output only. Number of RagFiles in the RagCorpus.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "ragVectorDbConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfig", "deprecated": true, @@ -39955,7 +40722,7 @@ "type": "integer" }, "modelName": { - "description": "The name of a LLM model used for parsing. Format: `gemini-1.5-pro-002`", + "description": "The name of a LLM model used for parsing. Format: * `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`", "type": "string" } }, @@ -40526,6 +41293,10 @@ }, "type": "array" }, + "deploymentSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec", + "description": "Optional. The specification of a Reasoning Engine deployment." + }, "packageSpec": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec", "description": "Required. User provided package spec of the ReasoningEngine." @@ -40533,6 +41304,27 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec": { + "description": "The specification of a Reasoning Engine deployment.", + "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec", + "properties": { + "env": { + "description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1EnvVar" + }, + "type": "array" + }, + "secretEnv": { + "description": "Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SecretEnvVar" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec": { "description": "User provided package spec like pickled object and package requirements.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec", @@ -40760,7 +41552,7 @@ "type": "string" }, "values": { - "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.", + "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.", "items": { "type": "string" }, @@ -41016,6 +41808,43 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RolloutOptions": { + "description": "Configuration for rolling deployments.", + "id": "GoogleCloudAiplatformV1beta1RolloutOptions", + "properties": { + "maxSurgePercentage": { + "description": "Percentage of allowed additional replicas. For autoscaling deployments, this refers to the target replica count.", + "format": "int32", + "type": "integer" + }, + "maxSurgeReplicas": { + "description": "Absolute count of allowed additional replicas.", + "format": "int32", + "type": "integer" + }, + "maxUnavailablePercentage": { + "description": "Percentage of replicas allowed to be unavailable. For autoscaling deployments, this refers to the target replica count.", + "format": "int32", + "type": "integer" + }, + "maxUnavailableReplicas": { + "description": "Absolute count of replicas allowed to be unavailable.", + "format": "int32", + "type": "integer" + }, + "previousDeployedModel": { + "description": "ID of the DeployedModel that this deployment should replace.", + "type": "string" + }, + "revisionNumber": { + "description": "Output only. Read-only. Revision number determines the relative priority of DeployedModels in the same rollout. The DeployedModel with the largest revision number specifies the intended state of the deployment.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RougeInput": { "description": "Input for rouge metric.", "id": "GoogleCloudAiplatformV1beta1RougeInput", @@ -44028,7 +44857,7 @@ "id": "GoogleCloudAiplatformV1beta1SchemaTextDataItem", "properties": { "gcsUri": { - "description": "Output only. Google Cloud Storage URI points to the original text in user's bucket. The text file is up to 10MB in size.", + "description": "Output only. Google Cloud Storage URI points to a copy of the original text in the Vertex-managed bucket in the user's project. The text file is up to 10MB in size.", "readOnly": true, "type": "string" } @@ -46300,6 +47129,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SecretEnvVar": { + "description": "Represents an environment variable where the value is a secret in Cloud Secret Manager.", + "id": "GoogleCloudAiplatformV1beta1SecretEnvVar", + "properties": { + "name": { + "description": "Required. Name of the secret environment variable.", + "type": "string" + }, + "secretRef": { + "$ref": "GoogleCloudAiplatformV1beta1SecretRef", + "description": "Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SecretRef": { + "description": "Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.", + "id": "GoogleCloudAiplatformV1beta1SecretRef", + "properties": { + "secret": { + "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.", + "type": "string" + }, + "version": { + "description": "The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Segment": { "description": "Segment of the content.", "id": "GoogleCloudAiplatformV1beta1Segment", @@ -46531,6 +47390,49 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec": { + "description": "Configuration for Speculative Decoding.", + "id": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec", + "properties": { + "draftModelSpeculation": { + "$ref": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation", + "description": "draft model speculation." + }, + "ngramSpeculation": { + "$ref": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation", + "description": "N-Gram speculation." + }, + "speculativeTokenCount": { + "description": "The number of speculative tokens to generate at each step.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation": { + "description": "Draft model speculation works by using the smaller model to generate candidate tokens for speculative decoding.", + "id": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation", + "properties": { + "draftModel": { + "description": "Required. The resource name of the draft model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation": { + "description": "N-Gram speculation works by trying to find matching tokens in the previous prompt sequence and use those as speculation for generating new tokens.", + "id": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation", + "properties": { + "ngramSize": { + "description": "The number of last N input tokens used as ngram to search/match against the previous prompt sequence. This is equal to the N in N-Gram. The default value is 3 if not specified.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1SpeechConfig": { "description": "The speech generation config.", "id": "GoogleCloudAiplatformV1beta1SpeechConfig", @@ -47642,6 +48544,7 @@ "enum": [ "ADAPTER_SIZE_UNSPECIFIED", "ADAPTER_SIZE_ONE", + "ADAPTER_SIZE_TWO", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", "ADAPTER_SIZE_SIXTEEN", @@ -47650,6 +48553,7 @@ "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", + "Adapter size 2.", "Adapter size 4.", "Adapter size 8.", "Adapter size 16.", @@ -48462,7 +49366,11 @@ "properties": { "codeExecution": { "$ref": "GoogleCloudAiplatformV1beta1ToolCodeExecution", - "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services." + "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." + }, + "enterpriseWebSearch": { + "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", + "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, "functionDeclarations": { "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.", @@ -49529,7 +50437,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1TunedModel": { - "description": "The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob.", + "description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.", "id": "GoogleCloudAiplatformV1beta1TunedModel", "properties": { "endpoint": { @@ -49693,7 +50601,7 @@ }, "tunedModel": { "$ref": "GoogleCloudAiplatformV1beta1TunedModel", - "description": "Output only. The tuned model resources assiociated with this TuningJob.", + "description": "Output only. The tuned model resources associated with this TuningJob.", "readOnly": true }, "tunedModelDisplayName": { @@ -50175,11 +51083,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VertexAISearch": { - "description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder", + "description": "Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder", "id": "GoogleCloudAiplatformV1beta1VertexAISearch", "properties": { "datastore": { - "description": "Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" } }, diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 9b0e5303b9b..188f3dcd4c4 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -148,6 +148,24 @@ export namespace aiplatform_v1 { * Returns rai failure reasons if any. */ raiMediaFilteredReasons?: string[] | null; + /** + * List of videos, used to align naming with the external response. + */ + videos?: Schema$CloudAiLargeModelsVisionGenerateVideoResponseVideo[]; + } + export interface Schema$CloudAiLargeModelsVisionGenerateVideoResponseVideo { + /** + * Base64 encoded bytes string representing the video. + */ + bytesBase64Encoded?: string | null; + /** + * Cloud Storage URI where the generated video is written. + */ + gcsUri?: string | null; + /** + * The MIME type of the content of the video. - video/mp4 + */ + mimeType?: string | null; } /** * Image. @@ -335,6 +353,10 @@ export namespace aiplatform_v1 { * Video encoding, for example "video/mp4". */ encoding?: string | null; + /** + * Text/Expanded text input for Help Me Write. + */ + text?: string | null; /** * Path to another storage (typically Google Cloud Storage). */ @@ -691,14 +713,31 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1AutomaticResources { /** - * Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + * Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. */ maxReplicaCount?: number | null; /** - * Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + * Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. */ minReplicaCount?: number | null; } + /** + * The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. + */ + export interface Schema$GoogleCloudAiplatformV1AutoraterConfig { + /** + * Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + autoraterModel?: string | null; + /** + * Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + */ + flipEnabled?: boolean | null; + /** + * Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + */ + samplingCount?: number | null; + } /** * The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. */ @@ -1256,6 +1295,10 @@ export namespace aiplatform_v1 { * Required. Raw bytes. */ data?: string | null; + /** + * Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + */ + displayName?: string | null; /** * Required. The IANA standard MIME type of the source data. */ @@ -1301,7 +1344,7 @@ export namespace aiplatform_v1 { */ contents?: Schema$GoogleCloudAiplatformV1Content[]; /** - * Output only. Creatation time of the cache entry. + * Output only. Creation time of the cache entry. */ createTime?: string | null; /** @@ -1313,7 +1356,7 @@ export namespace aiplatform_v1 { */ expireTime?: string | null; /** - * Immutable. The name of the publisher model to use for cached content. Format: projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\} + * Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT\}/locations/{LOCATION\}/publishers/google/models/{MODEL\} */ model?: string | null; /** @@ -1541,6 +1584,19 @@ export namespace aiplatform_v1 { */ inferenceTimeout?: string | null; } + /** + * Result of executing the [ExecutableCode]. Always follows a `part` containing the [ExecutableCode]. + */ + export interface Schema$GoogleCloudAiplatformV1CodeExecutionResult { + /** + * Required. Outcome of the code execution. + */ + outcome?: string | null; + /** + * Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + */ + output?: string | null; + } /** * Input for coherence metric. */ @@ -1929,6 +1985,10 @@ export namespace aiplatform_v1 { * Response message for PredictionService.CountTokens. */ export interface Schema$GoogleCloudAiplatformV1CountTokensResponse { + /** + * Output only. List of modalities that were processed in the request input. + */ + promptTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; /** * The total number of billable characters counted across all instances from the request. */ @@ -2605,7 +2665,7 @@ export namespace aiplatform_v1 { updateTime?: string | null; } /** - * A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. + * A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. */ export interface Schema$GoogleCloudAiplatformV1DedicatedResources { /** @@ -2613,19 +2673,19 @@ export namespace aiplatform_v1 { */ autoscalingMetricSpecs?: Schema$GoogleCloudAiplatformV1AutoscalingMetricSpec[]; /** - * Required. Immutable. The specification of a single machine used by the prediction. + * Required. Immutable. The specification of a single machine being used. */ machineSpec?: Schema$GoogleCloudAiplatformV1MachineSpec; /** - * Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + * Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). */ maxReplicaCount?: number | null; /** - * 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. + * Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic 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. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + * Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. */ requiredReplicaCount?: number | null; /** @@ -2902,6 +2962,10 @@ export namespace aiplatform_v1 { * The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ sharedResources?: string | null; + /** + * Optional. Spec for configuring speculative decoding. + */ + speculativeDecodingSpec?: Schema$GoogleCloudAiplatformV1SpeculativeDecodingSpec; /** * Output only. Runtime status of the deployed model. */ @@ -3111,7 +3175,7 @@ export namespace aiplatform_v1 { */ bootDiskSizeGb?: number | null; /** - * Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). + * Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". */ bootDiskType?: string | null; } @@ -3190,6 +3254,10 @@ export namespace aiplatform_v1 { * Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */ etag?: string | null; + /** + * Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported. + */ + genAiAdvancedFeaturesConfig?: Schema$GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig; /** * The labels with user-defined metadata to organize your Endpoints. 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. */ @@ -3231,6 +3299,10 @@ export namespace aiplatform_v1 { */ updateTime?: string | null; } + /** + * Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. + */ + export interface Schema$GoogleCloudAiplatformV1EnterpriseWebSearch {} /** * Selector for entityId. Getting ids from the given source. */ @@ -3382,10 +3454,35 @@ export namespace aiplatform_v1 { */ explanationType?: string | null; } + /** + * Request message for EvaluationService.EvaluateDataset. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluateDatasetRequest { + /** + * Optional. Autorater config used for evaluation. + */ + autoraterConfig?: Schema$GoogleCloudAiplatformV1AutoraterConfig; + /** + * Required. The dataset used for evaluation. + */ + dataset?: Schema$GoogleCloudAiplatformV1EvaluationDataset; + /** + * Required. The metrics used for evaluation. + */ + metrics?: Schema$GoogleCloudAiplatformV1Metric[]; + /** + * Required. Config for evaluation output. + */ + outputConfig?: Schema$GoogleCloudAiplatformV1OutputConfig; + } /** * Request message for EvaluationService.EvaluateInstances. */ export interface Schema$GoogleCloudAiplatformV1EvaluateInstancesRequest { + /** + * Optional. Autorater config used for evaluation. + */ + autoraterConfig?: Schema$GoogleCloudAiplatformV1AutoraterConfig; /** * Instances and metric spec for bleu metric. */ @@ -3640,6 +3737,19 @@ export namespace aiplatform_v1 { */ trajectorySingleToolUseResults?: Schema$GoogleCloudAiplatformV1TrajectorySingleToolUseResults; } + /** + * The dataset used for evaluation. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationDataset { + /** + * BigQuery source holds the dataset. + */ + bigquerySource?: Schema$GoogleCloudAiplatformV1BigQuerySource; + /** + * Cloud storage source holds the dataset. + */ + gcsSource?: Schema$GoogleCloudAiplatformV1GcsSource; + } /** * An edge describing the relationship between an Artifact and an Execution in a lineage graph. */ @@ -3789,6 +3899,19 @@ export namespace aiplatform_v1 { */ namespaceName?: string | null; } + /** + * Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [FunctionDeclaration] tool and [FunctionCallingConfig] mode is set to [Mode.CODE]. + */ + export interface Schema$GoogleCloudAiplatformV1ExecutableCode { + /** + * Required. The code to be executed. + */ + code?: string | null; + /** + * Required. Programming language of the `code`. + */ + language?: string | null; + } /** * Instance of a general execution. */ @@ -4964,6 +5087,14 @@ export namespace aiplatform_v1 { * 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. + */ + serviceAccountEmail?: string | null; + /** + * Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. + */ + serviceAgentType?: string | 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. */ @@ -5231,6 +5362,10 @@ export namespace aiplatform_v1 { * URI based data. */ export interface Schema$GoogleCloudAiplatformV1FileData { + /** + * Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + */ + displayName?: string | null; /** * Required. URI. */ @@ -5559,6 +5694,24 @@ export namespace aiplatform_v1 { */ uris?: string[] | null; } + /** + * Configuration for GenAiAdvancedFeatures. + */ + export interface Schema$GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig { + /** + * Configuration for Retrieval Augmented Generation feature. + */ + ragConfig?: Schema$GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig; + } + /** + * Configuration for Retrieval Augmented Generation feature. + */ + export interface Schema$GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig { + /** + * If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used. + */ + enableRag?: boolean | null; + } /** * Request message for [PredictionService.GenerateContent]. */ @@ -5604,6 +5757,10 @@ export namespace aiplatform_v1 { * Output only. Generated candidates. */ candidates?: Schema$GoogleCloudAiplatformV1Candidate[]; + /** + * Output only. Timestamp when the request is made to the server. + */ + createTime?: string | null; /** * Output only. The model version used to generate the response. */ @@ -5612,6 +5769,10 @@ export namespace aiplatform_v1 { * Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */ promptFeedback?: Schema$GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback; + /** + * Output only. response_id is used to identify each response. It is the encoding of the event_id. + */ + responseId?: string | null; /** * Usage metadata about the response(s). */ @@ -5642,19 +5803,81 @@ export namespace aiplatform_v1 { * Output only. Number of tokens in the cached part in the input (the cached content). */ cachedContentTokenCount?: number | null; + /** + * Output only. List of modalities of the cached content in the request input. + */ + cacheTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; /** * Number of tokens in the response(s). */ candidatesTokenCount?: number | null; + /** + * Output only. List of modalities that were returned in the response. + */ + candidatesTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; /** * 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; /** - * Total token count for prompt and response candidates. + * Output only. List of modalities that were processed in the request input. + */ + promptTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; + /** + * Output only. Number of tokens present in thoughts output. + */ + thoughtsTokenCount?: number | null; + /** + * Output only. Number of tokens present in tool-use prompt(s). + */ + toolUsePromptTokenCount?: number | null; + /** + * Output only. List of modalities that were processed for tool-use request inputs. + */ + toolUsePromptTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; + /** + * Total token count for prompt, response candidates, and tool-use prompts (if present). */ totalTokenCount?: number | null; } + /** + * Generate video response. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateVideoResponse { + /** + * 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; + /** + * List of video bytes or Cloud Storage URIs of the generated videos. + */ + videos?: Schema$GoogleCloudAiplatformV1GenerateVideoResponseVideo[]; + } + /** + * A generated video. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateVideoResponseVideo { + /** + * Base64 encoded bytes string representing the video. + */ + bytesBase64Encoded?: string | null; + /** + * Cloud Storage URI where the generated video is written. + */ + gcsUri?: string | null; + /** + * The MIME type of the content of the video. - video/mp4 + */ + mimeType?: string | null; + } /** * Generation config. */ @@ -6226,6 +6449,10 @@ export namespace aiplatform_v1 { * The Cloud Storage path to write partial failures to. Deprecated. Prefer to use `import_result_gcs_sink`. */ partialFailureGcsSink?: Schema$GoogleCloudAiplatformV1GcsDestination; + /** + * Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set. + */ + ragFileParsingConfig?: Schema$GoogleCloudAiplatformV1RagFileParsingConfig; /** * Specifies the transformation config for RagFiles. */ @@ -7025,6 +7252,19 @@ export namespace aiplatform_v1 { */ nextPageToken?: string | null; } + /** + * Response message for ModelService.ListModelVersionCheckpoints + */ + export interface Schema$GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse { + /** + * List of Model Version checkpoints. + */ + checkpoints?: Schema$GoogleCloudAiplatformV1ModelVersionCheckpoint[]; + /** + * A token to retrieve the next page of results. Pass to ListModelVersionCheckpointsRequest.page_token to obtain that page. + */ + nextPageToken?: string | null; + } /** * Response message for ModelService.ListModelVersions */ @@ -7522,6 +7762,35 @@ export namespace aiplatform_v1 { */ diskUtilizationBytes?: string | null; } + /** + * The metric used for dataset level evaluation. + */ + export interface Schema$GoogleCloudAiplatformV1Metric { + /** + * Optional. The aggregation metrics to use. + */ + aggregationMetrics?: string[] | null; + /** + * Spec for bleu metric. + */ + bleuSpec?: Schema$GoogleCloudAiplatformV1BleuSpec; + /** + * Spec for exact match metric. + */ + exactMatchSpec?: Schema$GoogleCloudAiplatformV1ExactMatchSpec; + /** + * Spec for pairwise metric. + */ + pairwiseMetricSpec?: Schema$GoogleCloudAiplatformV1PairwiseMetricSpec; + /** + * Spec for pointwise metric. + */ + pointwiseMetricSpec?: Schema$GoogleCloudAiplatformV1PointwiseMetricSpec; + /** + * Spec for rouge metric. + */ + rougeSpec?: Schema$GoogleCloudAiplatformV1RougeSpec; + } /** * Input for MetricX metric. */ @@ -7783,6 +8052,19 @@ export namespace aiplatform_v1 { */ model?: string | null; } + /** + * Represents token counting info for a single modality. + */ + export interface Schema$GoogleCloudAiplatformV1ModalityTokenCount { + /** + * The modality associated with this token count. + */ + modality?: string | null; + /** + * Number of tokens. + */ + tokenCount?: number | null; + } /** * A trained machine learning Model. */ @@ -7807,6 +8089,10 @@ export namespace aiplatform_v1 { * Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with data_input_config. */ dataStats?: Schema$GoogleCloudAiplatformV1ModelDataStats; + /** + * The default checkpoint id of a model version. + */ + defaultCheckpointId?: string | null; /** * Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. */ @@ -8363,7 +8649,7 @@ export namespace aiplatform_v1 { */ exportableContents?: string[] | null; /** - * Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. + * Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. */ id?: string | null; } @@ -8375,6 +8661,14 @@ export namespace aiplatform_v1 { * Required. The model garden source model resource name. */ publicModelName?: string | null; + /** + * Optional. Whether to avoid pulling the model from the HF cache. + */ + skipHfModelCache?: boolean | null; + /** + * Optional. The model garden source model version ID. + */ + versionId?: string | null; } /** * The alert config for model monitoring. @@ -8588,6 +8882,27 @@ export namespace aiplatform_v1 { */ sourceType?: string | null; } + /** + * Describes the machine learning model version checkpoint. + */ + export interface Schema$GoogleCloudAiplatformV1ModelVersionCheckpoint { + /** + * The ID of the checkpoint. + */ + checkpointId?: string | null; + /** + * The epoch of the checkpoint. + */ + epoch?: string | null; + /** + * Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project\}/locations/{location\}/models/{model\}/versions/{version\}/checkpoints/{checkpoint\}` + */ + name?: string | null; + /** + * The step of the checkpoint. + */ + step?: string | null; + } /** * Runtime operation information for IndexEndpointService.MutateDeployedIndex. */ @@ -9361,6 +9676,10 @@ export namespace aiplatform_v1 { * Output only. Runtime Shielded VM spec. */ shieldedVmConfig?: Schema$GoogleCloudAiplatformV1ShieldedVmConfig; + /** + * Output only. Software config of the notebook runtime. + */ + softwareConfig?: Schema$GoogleCloudAiplatformV1NotebookSoftwareConfig; /** * Output only. Timestamp when this NotebookRuntime was most recently updated. */ @@ -9442,6 +9761,10 @@ export namespace aiplatform_v1 { * Optional. Immutable. Runtime Shielded VM spec. */ shieldedVmConfig?: Schema$GoogleCloudAiplatformV1ShieldedVmConfig; + /** + * Optional. The notebook software configuration of the notebook runtime. + */ + softwareConfig?: Schema$GoogleCloudAiplatformV1NotebookSoftwareConfig; /** * Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated. */ @@ -9456,6 +9779,28 @@ export namespace aiplatform_v1 { */ notebookRuntimeTemplate?: string | null; } + /** + * Notebook Software Config. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookSoftwareConfig { + /** + * Optional. Environment variables to be passed to the container. Maximum limit is 100. + */ + env?: Schema$GoogleCloudAiplatformV1EnvVar[]; + /** + * Optional. Post startup script config. + */ + postStartupScriptConfig?: Schema$GoogleCloudAiplatformV1PostStartupScriptConfig; + } + /** + * Config for evaluation output. + */ + export interface Schema$GoogleCloudAiplatformV1OutputConfig { + /** + * Cloud storage destination for evaluation output. + */ + gcsDestination?: Schema$GoogleCloudAiplatformV1GcsDestination; + } /** * Input for pairwise metric. */ @@ -9495,10 +9840,22 @@ export namespace aiplatform_v1 { * Spec for pairwise metric. */ export interface Schema$GoogleCloudAiplatformV1PairwiseMetricSpec { + /** + * Optional. The field name of the baseline response. + */ + baselineResponseFieldName?: string | null; + /** + * Optional. The field name of the candidate response. + */ + candidateResponseFieldName?: string | null; /** * Required. Metric prompt template for pairwise metric. */ metricPromptTemplate?: string | null; + /** + * Optional. System instructions for pairwise metric. + */ + systemInstruction?: string | null; } /** * Input for pairwise question answering quality metric. @@ -9640,6 +9997,14 @@ export namespace aiplatform_v1 { * A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. */ export interface Schema$GoogleCloudAiplatformV1Part { + /** + * Optional. Result of executing the [ExecutableCode]. + */ + codeExecutionResult?: Schema$GoogleCloudAiplatformV1CodeExecutionResult; + /** + * Optional. Code generated by the model that is meant to be executed. + */ + executableCode?: Schema$GoogleCloudAiplatformV1ExecutableCode; /** * Optional. URI based data. */ @@ -10085,6 +10450,10 @@ export namespace aiplatform_v1 { * Required. Metric prompt template for pointwise metric. */ metricPromptTemplate?: string | null; + /** + * Optional. System instructions for pointwise metric. + */ + systemInstruction?: string | null; } /** * Represents a network port in a container. @@ -10095,6 +10464,23 @@ export namespace aiplatform_v1 { */ containerPort?: number | null; } + /** + * Post startup script config. + */ + export interface Schema$GoogleCloudAiplatformV1PostStartupScriptConfig { + /** + * Optional. Post startup script to run after runtime is started. + */ + postStartupScript?: string | null; + /** + * Optional. Post startup script behavior that defines download and execution behavior. + */ + postStartupScriptBehavior?: string | null; + /** + * Optional. Post startup script url to download. Example: https://bucket/script.sh + */ + postStartupScriptUrl?: string | null; + } /** * The configuration for the prebuilt speaker to use. */ @@ -10261,6 +10647,10 @@ export namespace aiplatform_v1 { * ExecAction probes the health of a container by executing a command. */ exec?: Schema$GoogleCloudAiplatformV1ProbeExecAction; + /** + * Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'. + */ + failureThreshold?: number | null; /** * GrpcAction probes the health of a container by sending a gRPC request. */ @@ -10269,10 +10659,18 @@ export namespace aiplatform_v1 { * HttpGetAction probes the health of a container by sending an HTTP GET request. */ httpGet?: Schema$GoogleCloudAiplatformV1ProbeHttpGetAction; + /** + * Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'. + */ + initialDelaySeconds?: number | null; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. */ periodSeconds?: number | null; + /** + * Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'. + */ + successThreshold?: number | null; /** * TcpSocketAction probes the health of a container by opening a TCP socket connection. */ @@ -11258,6 +11656,28 @@ export namespace aiplatform_v1 { */ chunkSize?: number | null; } + /** + * Specifies the parsing config for RagFiles. + */ + export interface Schema$GoogleCloudAiplatformV1RagFileParsingConfig { + /** + * The Layout Parser to use for RagFiles. + */ + layoutParser?: Schema$GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser; + } + /** + * Document AI Layout Parser config. + */ + export interface Schema$GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser { + /** + * The maximum number of requests the job is allowed to make to the Document AI processor per minute. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If unspecified, a default value of 120 QPM would be used. + */ + maxParsingRequestsPerMin?: number | null; + /** + * The full resource name of a Document AI processor or processor version. The processor must have type `LAYOUT_PARSER_PROCESSOR`. If specified, the `additional_config.parse_as_scanned_pdf` field must be false. Format: * `projects/{project_id\}/locations/{location\}/processors/{processor_id\}` * `projects/{project_id\}/locations/{location\}/processors/{processor_id\}/processorVersions/{processor_version_id\}` + */ + processorName?: string | null; + } /** * Specifies the transformation config for RagFiles. */ @@ -11612,11 +12032,28 @@ export namespace aiplatform_v1 { * Optional. Declarations for object class methods in OpenAPI specification format. */ classMethods?: Array<{[key: string]: any}> | null; + /** + * Optional. The specification of a Reasoning Engine deployment. + */ + deploymentSpec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec; /** * Required. User provided package spec of the ReasoningEngine. */ packageSpec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec; } + /** + * The specification of a Reasoning Engine deployment. + */ + export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec { + /** + * Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. + */ + env?: Schema$GoogleCloudAiplatformV1EnvVar[]; + /** + * Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent. + */ + secretEnv?: Schema$GoogleCloudAiplatformV1SecretEnvVar[]; + } /** * User provided package spec like pickled object and package requirements. */ @@ -11715,7 +12152,7 @@ export namespace aiplatform_v1 { */ reservationAffinityType?: string | null; /** - * Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation. + * Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block. */ values?: string[] | null; } @@ -13928,7 +14365,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1SchemaTextDataItem { /** - * Output only. Google Cloud Storage URI points to the original text in user's bucket. The text file is up to 10MB in size. + * Output only. Google Cloud Storage URI points to a copy of the original text in the Vertex-managed bucket in the user's project. The text file is up to 10MB in size. */ gcsUri?: string | null; } @@ -15368,6 +15805,32 @@ export namespace aiplatform_v1 { */ nearestNeighbors?: Schema$GoogleCloudAiplatformV1NearestNeighbors; } + /** + * Represents an environment variable where the value is a secret in Cloud Secret Manager. + */ + export interface Schema$GoogleCloudAiplatformV1SecretEnvVar { + /** + * Required. Name of the secret environment variable. + */ + name?: string | null; + /** + * Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable. + */ + secretRef?: Schema$GoogleCloudAiplatformV1SecretRef; + } + /** + * Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable. + */ + export interface Schema$GoogleCloudAiplatformV1SecretRef { + /** + * Required. The name of the secret in Cloud Secret Manager. Format: {secret_name\} if the secret is in the same project. projects/{project\}/secrets/{secret_name\} if the secret is in a different project. + */ + secret?: string | null; + /** + * The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + */ + version?: string | null; + } /** * Segment of the content. */ @@ -15546,6 +16009,41 @@ export namespace aiplatform_v1 { */ specialistWorkerEmails?: string[] | null; } + /** + * Configuration for Speculative Decoding. + */ + export interface Schema$GoogleCloudAiplatformV1SpeculativeDecodingSpec { + /** + * draft model speculation. + */ + draftModelSpeculation?: Schema$GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation; + /** + * N-Gram speculation. + */ + ngramSpeculation?: Schema$GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation; + /** + * The number of speculative tokens to generate at each step. + */ + speculativeTokenCount?: number | null; + } + /** + * Draft model speculation works by using the smaller model to generate candidate tokens for speculative decoding. + */ + export interface Schema$GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation { + /** + * Required. The resource name of the draft model. + */ + draftModel?: string | null; + } + /** + * N-Gram speculation works by trying to find matching tokens in the previous prompt sequence and use those as speculation for generating new tokens. + */ + export interface Schema$GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation { + /** + * The number of last N input tokens used as ngram to search/match against the previous prompt sequence. This is equal to the N in N-Gram. The default value is 3 if not specified. + */ + ngramSize?: number | null; + } /** * The speech generation config. */ @@ -16815,6 +17313,14 @@ export namespace aiplatform_v1 { * Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). */ export interface Schema$GoogleCloudAiplatformV1Tool { + /** + * Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + */ + codeExecution?: Schema$GoogleCloudAiplatformV1ToolCodeExecution; + /** + * Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + */ + enterpriseWebSearch?: Schema$GoogleCloudAiplatformV1EnterpriseWebSearch; /** * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. */ @@ -16893,6 +17399,10 @@ export namespace aiplatform_v1 { * Spec for tool call valid metric. */ export interface Schema$GoogleCloudAiplatformV1ToolCallValidSpec {} + /** + * Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. + */ + export interface Schema$GoogleCloudAiplatformV1ToolCodeExecution {} /** * Tool config. This config is shared for all tools provided in the request. */ @@ -17516,7 +18026,7 @@ export namespace aiplatform_v1 { value?: any | null; } /** - * The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob. + * The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. */ export interface Schema$GoogleCloudAiplatformV1TunedModel { /** @@ -17611,7 +18121,7 @@ export namespace aiplatform_v1 { */ supervisedTuningSpec?: Schema$GoogleCloudAiplatformV1SupervisedTuningSpec; /** - * Output only. The tuned model resources assiociated with this TuningJob. + * Output only. The tuned model resources associated with this TuningJob. */ tunedModel?: Schema$GoogleCloudAiplatformV1TunedModel; /** @@ -17981,11 +18491,11 @@ export namespace aiplatform_v1 { stringValue?: string | null; } /** - * Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder + * Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */ export interface Schema$GoogleCloudAiplatformV1VertexAISearch { /** - * Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` + * Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` */ datastore?: string | null; } @@ -19894,6 +20404,103 @@ export namespace aiplatform_v1 { } } + /** + * Perform an online prediction. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + predict( + params: Params$Resource$Endpoints$Predict, + options: StreamMethodOptions + ): GaxiosPromise; + predict( + params?: Params$Resource$Endpoints$Predict, + options?: MethodOptions + ): GaxiosPromise; + predict( + params: Params$Resource$Endpoints$Predict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Endpoints$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Endpoints$Predict, + callback: BodyResponseCallback + ): void; + predict( + callback: BodyResponseCallback + ): void; + predict( + paramsOrCallback?: + | Params$Resource$Endpoints$Predict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Endpoints$Predict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Endpoints$Predict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Generate content with multimodal inputs with streaming support. * @@ -20028,6 +20635,18 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; } + export interface Params$Resource$Endpoints$Predict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } export interface Params$Resource$Endpoints$Streamgeneratecontent extends StandardParameters { /** @@ -20700,6 +21319,101 @@ export namespace aiplatform_v1 { } } + /** + * Evaluates a dataset based on a set of given metrics. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + options: StreamMethodOptions + ): GaxiosPromise; + evaluateDataset( + params?: Params$Resource$Projects$Locations$Evaluatedataset, + options?: MethodOptions + ): GaxiosPromise; + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + callback: BodyResponseCallback + ): void; + evaluateDataset( + callback: BodyResponseCallback + ): void; + evaluateDataset( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluatedataset + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluatedataset; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluatedataset; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+location}:evaluateDataset').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); + } + } + /** * Evaluates instances based on a given metric. * @@ -21108,6 +21822,18 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1CorroborateContentRequest; } + export interface Params$Resource$Projects$Locations$Evaluatedataset + extends StandardParameters { + /** + * Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluateDatasetRequest; + } export interface Params$Resource$Projects$Locations$Evaluateinstances extends StandardParameters { /** @@ -33964,7 +34690,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` * `description` * `big_query` * `big_query.entity_id_columns` + * 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` * `service_agent_type` */ updateMask?: string; @@ -44820,7 +45546,7 @@ export namespace aiplatform_v1 { } /** - * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed. + * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -56006,6 +56732,104 @@ export namespace aiplatform_v1 { } } + /** + * Lists checkpoints of the specified model 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. + */ + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options: StreamMethodOptions + ): GaxiosPromise; + listCheckpoints( + params?: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options?: MethodOptions + ): GaxiosPromise; + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + callback: BodyResponseCallback + ): void; + listCheckpoints( + callback: BodyResponseCallback + ): void; + listCheckpoints( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Listcheckpoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Listcheckpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Listcheckpoints; + 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}:listCheckpoints').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 versions of the specified model. * @@ -56761,6 +57585,21 @@ export namespace aiplatform_v1 { */ readMask?: string; } + export interface Params$Resource$Projects$Locations$Models$Listcheckpoints + extends StandardParameters { + /** + * Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. + */ + name?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. + */ + pageToken?: string; + } export interface Params$Resource$Projects$Locations$Models$Listversions extends StandardParameters { /** @@ -83266,6 +84105,103 @@ export namespace aiplatform_v1 { } } + /** + * Perform an online prediction. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + predict( + params: Params$Resource$Publishers$Models$Predict, + options: StreamMethodOptions + ): GaxiosPromise; + predict( + params?: Params$Resource$Publishers$Models$Predict, + options?: MethodOptions + ): GaxiosPromise; + predict( + params: Params$Resource$Publishers$Models$Predict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Publishers$Models$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Publishers$Models$Predict, + callback: BodyResponseCallback + ): void; + predict( + callback: BodyResponseCallback + ): void; + predict( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Predict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Predict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Predict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Generate content with multimodal inputs with streaming support. * @@ -83423,6 +84359,18 @@ export namespace aiplatform_v1 { */ view?: string; } + export interface Params$Resource$Publishers$Models$Predict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } export interface Params$Resource$Publishers$Models$Streamgeneratecontent extends StandardParameters { /** diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index aa7609304e5..d0b6267e5d0 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -148,6 +148,24 @@ export namespace aiplatform_v1beta1 { * Returns rai failure reasons if any. */ raiMediaFilteredReasons?: string[] | null; + /** + * List of videos, used to align naming with the external response. + */ + videos?: Schema$CloudAiLargeModelsVisionGenerateVideoResponseVideo[]; + } + export interface Schema$CloudAiLargeModelsVisionGenerateVideoResponseVideo { + /** + * Base64 encoded bytes string representing the video. + */ + bytesBase64Encoded?: string | null; + /** + * Cloud Storage URI where the generated video is written. + */ + gcsUri?: string | null; + /** + * The MIME type of the content of the video. - video/mp4 + */ + mimeType?: string | null; } /** * Image. @@ -335,6 +353,10 @@ export namespace aiplatform_v1beta1 { * Video encoding, for example "video/mp4". */ encoding?: string | null; + /** + * Text/Expanded text input for Help Me Write. + */ + text?: string | null; /** * Path to another storage (typically Google Cloud Storage). */ @@ -749,11 +771,11 @@ export namespace aiplatform_v1beta1 { */ apiKeyString?: string | null; /** - * Required. The location of the API key. + * Optional. The location of the API key. */ httpElementLocation?: string | null; /** - * Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + * Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. */ name?: string | null; } @@ -806,14 +828,31 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1AutomaticResources { /** - * Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + * Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. */ maxReplicaCount?: number | null; /** - * Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. + * Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. */ minReplicaCount?: number | null; } + /** + * The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AutoraterConfig { + /** + * Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + autoraterModel?: string | null; + /** + * Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + */ + flipEnabled?: boolean | null; + /** + * Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + */ + samplingCount?: number | null; + } /** * The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. */ @@ -1401,6 +1440,10 @@ export namespace aiplatform_v1beta1 { * Required. Raw bytes. */ data?: string | null; + /** + * Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + */ + displayName?: string | null; /** * Required. The IANA standard MIME type of the source data. */ @@ -1446,7 +1489,7 @@ export namespace aiplatform_v1beta1 { */ contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; /** - * Output only. Creatation time of the cache entry. + * Output only. Creation time of the cache entry. */ createTime?: string | null; /** @@ -1458,7 +1501,7 @@ export namespace aiplatform_v1beta1 { */ expireTime?: string | null; /** - * Immutable. The name of the publisher model to use for cached content. Format: projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\} + * Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT\}/locations/{LOCATION\}/publishers/google/models/{MODEL\} */ model?: string | null; /** @@ -2087,6 +2130,10 @@ export namespace aiplatform_v1beta1 { * Response message for PredictionService.CountTokens. */ export interface Schema$GoogleCloudAiplatformV1beta1CountTokensResponse { + /** + * Output only. List of modalities that were processed in the request input. + */ + promptTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; /** * The total number of billable characters counted across all instances from the request. */ @@ -2902,7 +2949,7 @@ export namespace aiplatform_v1beta1 { updateTime?: string | null; } /** - * A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. + * A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. */ export interface Schema$GoogleCloudAiplatformV1beta1DedicatedResources { /** @@ -2910,19 +2957,19 @@ export namespace aiplatform_v1beta1 { */ autoscalingMetricSpecs?: Schema$GoogleCloudAiplatformV1beta1AutoscalingMetricSpec[]; /** - * Required. Immutable. The specification of a single machine used by the prediction. + * Required. Immutable. The specification of a single machine being used. */ machineSpec?: Schema$GoogleCloudAiplatformV1beta1MachineSpec; /** - * Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + * Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). */ maxReplicaCount?: number | null; /** - * 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. + * Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic 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. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. + * Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. */ requiredReplicaCount?: number | null; /** @@ -3191,6 +3238,10 @@ export namespace aiplatform_v1beta1 { * Output only. Provide paths for users to send predict/explain/health requests directly to the deployed model services running on Cloud via private services access. This field is populated if network is configured. */ privateEndpoints?: Schema$GoogleCloudAiplatformV1beta1PrivateEndpoints; + /** + * Options for configuring rolling deployments. + */ + rolloutOptions?: Schema$GoogleCloudAiplatformV1beta1RolloutOptions; /** * The service account that the DeployedModel's container runs as. Specify the email address of the service account. If this service account is not specified, the container runs as a service account that doesn't have access to the resource project. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account. */ @@ -3199,6 +3250,10 @@ export namespace aiplatform_v1beta1 { * The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ sharedResources?: string | null; + /** + * Optional. Spec for configuring speculative decoding. + */ + speculativeDecodingSpec?: Schema$GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec; /** * Output only. Runtime status of the deployed model. */ @@ -3358,7 +3413,7 @@ export namespace aiplatform_v1beta1 { */ huggingFaceAccessToken?: string | null; /** - * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}@{version_id\}`, or `publishers/hf-{hugging-face-author\}/models/{hugging-face-model-name\}@001` or Hugging Face model ID like `google/gemma-2-2b-it`. + * Required. The model to deploy. Format: 1. `publishers/{publisher\}/models/{publisher_model\}@{version_id\}`, or `publishers/hf-{hugging-face-author\}/models/{hugging-face-model-name\}@001`. 2. Hugging Face model ID like `google/gemma-2-2b-it`. 3. Custom model Google Cloud Storage URI like `gs://bucket`. 4. Custom model zip file like `https://example.com/a.zip`. */ model?: string | null; /** @@ -3366,6 +3421,82 @@ export namespace aiplatform_v1beta1 { */ modelDisplayName?: string | null; } + /** + * Request message for ModelGardenService.Deploy. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DeployRequest { + /** + * Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used. + */ + deployConfig?: Schema$GoogleCloudAiplatformV1beta1DeployRequestDeployConfig; + /** + * Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used. + */ + endpointConfig?: Schema$GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig; + /** + * The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`. + */ + huggingFaceModelId?: string | null; + /** + * Optional. The model config to use for the deployment. If not specified, the default model config will be used. + */ + modelConfig?: Schema$GoogleCloudAiplatformV1beta1DeployRequestModelConfig; + /** + * The Model Garden model to deploy. Format: `publishers/{publisher\}/models/{publisher_model\}@{version_id\}`, or `publishers/hf-{hugging-face-author\}/models/{hugging-face-model-name\}@001`. + */ + publisherModelName?: string | null; + } + /** + * The deploy config to use for the deployment. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DeployRequestDeployConfig { + /** + * Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used. + */ + dedicatedResources?: Schema$GoogleCloudAiplatformV1beta1DedicatedResources; + /** + * Optional. If true, enable the QMT fast tryout feature for this model if possible. + */ + fastTryoutEnabled?: boolean | null; + } + /** + * The endpoint config to use for the deployment. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig { + /** + * Optional. 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 limitations will be removed soon. + */ + dedicatedEndpointEnabled?: boolean | null; + /** + * Optional. The user-specified display name of the endpoint. If not set, a default name will be used. + */ + endpointDisplayName?: string | null; + } + /** + * The model config to use for the deployment. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DeployRequestModelConfig { + /** + * Optional. Whether the user accepts the End User License Agreement (EULA) for the model. + */ + acceptEula?: boolean | null; + /** + * Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used. + */ + containerSpec?: Schema$GoogleCloudAiplatformV1beta1ModelContainerSpec; + /** + * Optional. The Hugging Face read access token used to access the model artifacts of gated models. + */ + huggingFaceAccessToken?: string | null; + /** + * Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access. + */ + huggingFaceCacheEnabled?: boolean | null; + /** + * Optional. The user-specified display name of the uploaded model. If not set, a default name will be used. + */ + modelDisplayName?: string | null; + } /** * Runtime operation information for SolverService.DeploySolver. */ @@ -3446,7 +3577,7 @@ export namespace aiplatform_v1beta1 { */ bootDiskSizeGb?: number | null; /** - * Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). + * Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". */ bootDiskType?: string | null; } @@ -3584,6 +3715,10 @@ export namespace aiplatform_v1beta1 { * Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */ etag?: string | null; + /** + * Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported. + */ + genAiAdvancedFeaturesConfig?: Schema$GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig; /** * The labels with user-defined metadata to organize your Endpoints. 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. */ @@ -3625,6 +3760,10 @@ export namespace aiplatform_v1beta1 { */ updateTime?: string | null; } + /** + * Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. + */ + export interface Schema$GoogleCloudAiplatformV1beta1EnterpriseWebSearch {} /** * Selector for entityId. Getting ids from the given source. */ @@ -3776,10 +3915,35 @@ export namespace aiplatform_v1beta1 { */ explanationType?: string | null; } + /** + * Request message for EvaluationService.EvaluateDataset. + */ + export interface Schema$GoogleCloudAiplatformV1beta1EvaluateDatasetRequest { + /** + * Optional. Autorater config used for evaluation. + */ + autoraterConfig?: Schema$GoogleCloudAiplatformV1beta1AutoraterConfig; + /** + * Required. The dataset used for evaluation. + */ + dataset?: Schema$GoogleCloudAiplatformV1beta1EvaluationDataset; + /** + * Required. The metrics used for evaluation. + */ + metrics?: Schema$GoogleCloudAiplatformV1beta1Metric[]; + /** + * Required. Config for evaluation output. + */ + outputConfig?: Schema$GoogleCloudAiplatformV1beta1OutputConfig; + } /** * Request message for EvaluationService.EvaluateInstances. */ export interface Schema$GoogleCloudAiplatformV1beta1EvaluateInstancesRequest { + /** + * Optional. Autorater config used for evaluation. + */ + autoraterConfig?: Schema$GoogleCloudAiplatformV1beta1AutoraterConfig; /** * Instances and metric spec for bleu metric. */ @@ -4034,6 +4198,19 @@ export namespace aiplatform_v1beta1 { */ trajectorySingleToolUseResults?: Schema$GoogleCloudAiplatformV1beta1TrajectorySingleToolUseResults; } + /** + * The dataset used for evaluation. + */ + export interface Schema$GoogleCloudAiplatformV1beta1EvaluationDataset { + /** + * BigQuery source holds the dataset. + */ + bigquerySource?: Schema$GoogleCloudAiplatformV1beta1BigQuerySource; + /** + * Cloud storage source holds the dataset. + */ + gcsSource?: Schema$GoogleCloudAiplatformV1beta1GcsSource; + } /** * An edge describing the relationship between an Artifact and an Execution in a lineage graph. */ @@ -6040,6 +6217,10 @@ export namespace aiplatform_v1beta1 { * URI based data. */ export interface Schema$GoogleCloudAiplatformV1beta1FileData { + /** + * Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + */ + displayName?: string | null; /** * Required. URI. */ @@ -6368,6 +6549,24 @@ export namespace aiplatform_v1beta1 { */ uris?: string[] | null; } + /** + * Configuration for GenAiAdvancedFeatures. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig { + /** + * Configuration for Retrieval Augmented Generation feature. + */ + ragConfig?: Schema$GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig; + } + /** + * Configuration for Retrieval Augmented Generation feature. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig { + /** + * If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used. + */ + enableRag?: boolean | null; + } /** * Request message for NotebookInternalService.GenerateAccessToken. */ @@ -6443,6 +6642,10 @@ export namespace aiplatform_v1beta1 { * Output only. Generated candidates. */ candidates?: Schema$GoogleCloudAiplatformV1beta1Candidate[]; + /** + * Output only. Timestamp when the request is made to the server. + */ + createTime?: string | null; /** * Output only. The model version used to generate the response. */ @@ -6451,6 +6654,10 @@ export namespace aiplatform_v1beta1 { * Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */ promptFeedback?: Schema$GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback; + /** + * Output only. response_id is used to identify each response. It is the encoding of the event_id. + */ + responseId?: string | null; /** * Usage metadata about the response(s). */ @@ -6481,16 +6688,40 @@ export namespace aiplatform_v1beta1 { * Output only. Number of tokens in the cached part in the input (the cached content). */ cachedContentTokenCount?: number | null; + /** + * Output only. List of modalities of the cached content in the request input. + */ + cacheTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; /** * Number of tokens in the response(s). */ candidatesTokenCount?: number | null; + /** + * Output only. List of modalities that were returned in the response. + */ + candidatesTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; /** * 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; /** - * Total token count for prompt and response candidates. + * Output only. List of modalities that were processed in the request input. + */ + promptTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; + /** + * Output only. Number of tokens present in thoughts output. + */ + thoughtsTokenCount?: number | null; + /** + * Output only. Number of tokens present in tool-use prompt(s). + */ + toolUsePromptTokenCount?: number | null; + /** + * Output only. List of modalities that were processed for tool-use request inputs. + */ + toolUsePromptTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; + /** + * Total token count for prompt, response candidates, and tool-use prompts (if present). */ totalTokenCount?: number | null; } @@ -6510,6 +6741,27 @@ export namespace aiplatform_v1beta1 { * Returns rai failure reasons if any. */ raiMediaFilteredReasons?: string[] | null; + /** + * List of video bytes or Cloud Storage URIs of the generated videos. + */ + videos?: Schema$GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo[]; + } + /** + * A generated video. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo { + /** + * Base64 encoded bytes string representing the video. + */ + bytesBase64Encoded?: string | null; + /** + * Cloud Storage URI where the generated video is written. + */ + gcsUri?: string | null; + /** + * The MIME type of the content of the video. - video/mp4 + */ + mimeType?: string | null; } /** * Generation config. @@ -7980,6 +8232,19 @@ export namespace aiplatform_v1beta1 { */ nextPageToken?: string | null; } + /** + * Response message for ModelService.ListModelVersionCheckpoints + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse { + /** + * List of Model Version checkpoints. + */ + checkpoints?: Schema$GoogleCloudAiplatformV1beta1ModelVersionCheckpoint[]; + /** + * A token to retrieve the next page of results. Pass to ListModelVersionCheckpointsRequest.page_token to obtain that page. + */ + nextPageToken?: string | null; + } /** * Response message for ModelService.ListModelVersions */ @@ -8353,6 +8618,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. The number of nodes per replica for multihost GPU deployments. + */ + multihostGpuNodeCount?: number | null; /** * Optional. Immutable. Configuration controlling how this resource pool consumes reservation. */ @@ -8490,6 +8759,35 @@ export namespace aiplatform_v1beta1 { */ diskUtilizationBytes?: string | null; } + /** + * The metric used for dataset level evaluation. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Metric { + /** + * Optional. The aggregation metrics to use. + */ + aggregationMetrics?: string[] | null; + /** + * Spec for bleu metric. + */ + bleuSpec?: Schema$GoogleCloudAiplatformV1beta1BleuSpec; + /** + * Spec for exact match metric. + */ + exactMatchSpec?: Schema$GoogleCloudAiplatformV1beta1ExactMatchSpec; + /** + * Spec for pairwise metric. + */ + pairwiseMetricSpec?: Schema$GoogleCloudAiplatformV1beta1PairwiseMetricSpec; + /** + * Spec for pointwise metric. + */ + pointwiseMetricSpec?: Schema$GoogleCloudAiplatformV1beta1PointwiseMetricSpec; + /** + * Spec for rouge metric. + */ + rougeSpec?: Schema$GoogleCloudAiplatformV1beta1RougeSpec; + } /** * Input for MetricX metric. */ @@ -8751,6 +9049,19 @@ export namespace aiplatform_v1beta1 { */ model?: string | null; } + /** + * Represents token counting info for a single modality. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount { + /** + * The modality associated with this token count. + */ + modality?: string | null; + /** + * Number of tokens. + */ + tokenCount?: number | null; + } /** * A trained machine learning Model. */ @@ -8771,6 +9082,10 @@ export namespace aiplatform_v1beta1 { * Output only. Timestamp when this Model was uploaded into Vertex AI. */ createTime?: string | null; + /** + * The default checkpoint id of a model version. + */ + defaultCheckpointId?: string | null; /** * Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. */ @@ -9303,7 +9618,7 @@ export namespace aiplatform_v1beta1 { */ exportableContents?: string[] | null; /** - * Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. + * Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. */ id?: string | null; } @@ -9315,6 +9630,14 @@ export namespace aiplatform_v1beta1 { * Required. The model garden source model resource name. */ publicModelName?: string | null; + /** + * Optional. Whether to avoid pulling the model from the HF cache. + */ + skipHfModelCache?: boolean | null; + /** + * Optional. The model garden source model version ID. + */ + versionId?: string | null; } /** * Vertex AI Model Monitoring Service serves as a central hub for the analysis and visualization of data quality and performance related to models. ModelMonitor stands as a top level resource for overseeing your model monitoring tasks. @@ -10158,6 +10481,27 @@ export namespace aiplatform_v1beta1 { */ sourceType?: string | null; } + /** + * Describes the machine learning model version checkpoint. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ModelVersionCheckpoint { + /** + * The ID of the checkpoint. + */ + checkpointId?: string | null; + /** + * The epoch of the checkpoint. + */ + epoch?: string | null; + /** + * Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project\}/locations/{location\}/models/{model\}/versions/{version\}/checkpoints/{checkpoint\}` + */ + name?: string | null; + /** + * The step of the checkpoint. + */ + step?: string | null; + } /** * Runtime operation information for IndexEndpointService.MutateDeployedIndex. */ @@ -10931,6 +11275,10 @@ export namespace aiplatform_v1beta1 { * Output only. Runtime Shielded VM spec. */ shieldedVmConfig?: Schema$GoogleCloudAiplatformV1beta1ShieldedVmConfig; + /** + * Output only. Software config of the notebook runtime. + */ + softwareConfig?: Schema$GoogleCloudAiplatformV1beta1NotebookSoftwareConfig; /** * Output only. Timestamp when this NotebookRuntime was most recently updated. */ @@ -11012,6 +11360,10 @@ export namespace aiplatform_v1beta1 { * Optional. Immutable. Runtime Shielded VM spec. */ shieldedVmConfig?: Schema$GoogleCloudAiplatformV1beta1ShieldedVmConfig; + /** + * Optional. The notebook software configuration of the notebook runtime. + */ + softwareConfig?: Schema$GoogleCloudAiplatformV1beta1NotebookSoftwareConfig; /** * Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated. */ @@ -11026,6 +11378,28 @@ export namespace aiplatform_v1beta1 { */ notebookRuntimeTemplate?: string | null; } + /** + * Notebook Software Config. + */ + export interface Schema$GoogleCloudAiplatformV1beta1NotebookSoftwareConfig { + /** + * Optional. Environment variables to be passed to the container. Maximum limit is 100. + */ + env?: Schema$GoogleCloudAiplatformV1beta1EnvVar[]; + /** + * Optional. Post startup script config. + */ + postStartupScriptConfig?: Schema$GoogleCloudAiplatformV1beta1PostStartupScriptConfig; + } + /** + * Config for evaluation output. + */ + export interface Schema$GoogleCloudAiplatformV1beta1OutputConfig { + /** + * Cloud storage destination for evaluation output. + */ + gcsDestination?: Schema$GoogleCloudAiplatformV1beta1GcsDestination; + } /** * Input for pairwise metric. */ @@ -11065,10 +11439,22 @@ export namespace aiplatform_v1beta1 { * Spec for pairwise metric. */ export interface Schema$GoogleCloudAiplatformV1beta1PairwiseMetricSpec { + /** + * Optional. The field name of the baseline response. + */ + baselineResponseFieldName?: string | null; + /** + * Optional. The field name of the candidate response. + */ + candidateResponseFieldName?: string | null; /** * Required. Metric prompt template for pairwise metric. */ metricPromptTemplate?: string | null; + /** + * Optional. System instructions for pairwise metric. + */ + systemInstruction?: string | null; } /** * Input for pairwise question answering quality metric. @@ -11791,6 +12177,10 @@ export namespace aiplatform_v1beta1 { * Required. Metric prompt template for pointwise metric. */ metricPromptTemplate?: string | null; + /** + * Optional. System instructions for pointwise metric. + */ + systemInstruction?: string | null; } /** * Represents a network port in a container. @@ -11801,6 +12191,23 @@ export namespace aiplatform_v1beta1 { */ containerPort?: number | null; } + /** + * Post startup script config. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PostStartupScriptConfig { + /** + * Optional. Post startup script to run after runtime is started. + */ + postStartupScript?: string | null; + /** + * Optional. Post startup script behavior that defines download and execution behavior. + */ + postStartupScriptBehavior?: string | null; + /** + * Optional. Post startup script url to download. Example: https://bucket/script.sh + */ + postStartupScriptUrl?: string | null; + } /** * The configuration for the prebuilt speaker to use. */ @@ -11984,6 +12391,10 @@ export namespace aiplatform_v1beta1 { * ExecAction probes the health of a container by executing a command. */ exec?: Schema$GoogleCloudAiplatformV1beta1ProbeExecAction; + /** + * Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'. + */ + failureThreshold?: number | null; /** * GrpcAction probes the health of a container by sending a gRPC request. */ @@ -11992,10 +12403,18 @@ export namespace aiplatform_v1beta1 { * HttpGetAction probes the health of a container by sending an HTTP GET request. */ httpGet?: Schema$GoogleCloudAiplatformV1beta1ProbeHttpGetAction; + /** + * Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'. + */ + initialDelaySeconds?: number | null; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. */ periodSeconds?: number | null; + /** + * Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'. + */ + successThreshold?: number | null; /** * TcpSocketAction probes the health of a container by opening a TCP socket connection. */ @@ -12931,6 +13350,10 @@ export namespace aiplatform_v1beta1 { * Optional. Immutable. The embedding model config of the RagCorpus. */ ragEmbeddingModelConfig?: Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig; + /** + * Output only. Number of RagFiles in the RagCorpus. + */ + ragFilesCount?: number | null; /** * Optional. Immutable. The Vector DB config of the RagCorpus. */ @@ -13164,7 +13587,7 @@ export namespace aiplatform_v1beta1 { */ maxParsingRequestsPerMin?: number | null; /** - * The name of a LLM model used for parsing. Format: `gemini-1.5-pro-002` + * The name of a LLM model used for parsing. Format: * `projects/{project_id\}/locations/{location\}/publishers/{publisher\}/models/{model\}` */ modelName?: string | null; } @@ -13621,11 +14044,28 @@ export namespace aiplatform_v1beta1 { * Optional. Declarations for object class methods in OpenAPI specification format. */ classMethods?: Array<{[key: string]: any}> | null; + /** + * Optional. The specification of a Reasoning Engine deployment. + */ + deploymentSpec?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec; /** * Required. User provided package spec of the ReasoningEngine. */ packageSpec?: Schema$GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec; } + /** + * The specification of a Reasoning Engine deployment. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec { + /** + * Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. + */ + env?: Schema$GoogleCloudAiplatformV1beta1EnvVar[]; + /** + * Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent. + */ + secretEnv?: Schema$GoogleCloudAiplatformV1beta1SecretEnvVar[]; + } /** * User provided package spec like pickled object and package requirements. */ @@ -13779,7 +14219,7 @@ export namespace aiplatform_v1beta1 { */ reservationAffinityType?: string | null; /** - * Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation. + * Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block. */ values?: string[] | null; } @@ -13973,6 +14413,35 @@ export namespace aiplatform_v1beta1 { */ contexts?: Schema$GoogleCloudAiplatformV1beta1RagContexts; } + /** + * Configuration for rolling deployments. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RolloutOptions { + /** + * Percentage of allowed additional replicas. For autoscaling deployments, this refers to the target replica count. + */ + maxSurgePercentage?: number | null; + /** + * Absolute count of allowed additional replicas. + */ + maxSurgeReplicas?: number | null; + /** + * Percentage of replicas allowed to be unavailable. For autoscaling deployments, this refers to the target replica count. + */ + maxUnavailablePercentage?: number | null; + /** + * Absolute count of replicas allowed to be unavailable. + */ + maxUnavailableReplicas?: number | null; + /** + * ID of the DeployedModel that this deployment should replace. + */ + previousDeployedModel?: string | null; + /** + * Output only. Read-only. Revision number determines the relative priority of DeployedModels in the same rollout. The DeployedModel with the largest revision number specifies the intended state of the deployment. + */ + revisionNumber?: number | null; + } /** * Input for rouge metric. */ @@ -16085,7 +16554,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1SchemaTextDataItem { /** - * Output only. Google Cloud Storage URI points to the original text in user's bucket. The text file is up to 10MB in size. + * Output only. Google Cloud Storage URI points to a copy of the original text in the Vertex-managed bucket in the user's project. The text file is up to 10MB in size. */ gcsUri?: string | null; } @@ -17639,6 +18108,32 @@ export namespace aiplatform_v1beta1 { */ nearestNeighbors?: Schema$GoogleCloudAiplatformV1beta1NearestNeighbors; } + /** + * Represents an environment variable where the value is a secret in Cloud Secret Manager. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SecretEnvVar { + /** + * Required. Name of the secret environment variable. + */ + name?: string | null; + /** + * Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable. + */ + secretRef?: Schema$GoogleCloudAiplatformV1beta1SecretRef; + } + /** + * Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SecretRef { + /** + * Required. The name of the secret in Cloud Secret Manager. Format: {secret_name\} if the secret is in the same project. projects/{project\}/secrets/{secret_name\} if the secret is in a different project. + */ + secret?: string | null; + /** + * The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + */ + version?: string | null; + } /** * Segment of the content. */ @@ -17817,6 +18312,41 @@ export namespace aiplatform_v1beta1 { */ specialistWorkerEmails?: string[] | null; } + /** + * Configuration for Speculative Decoding. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec { + /** + * draft model speculation. + */ + draftModelSpeculation?: Schema$GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation; + /** + * N-Gram speculation. + */ + ngramSpeculation?: Schema$GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation; + /** + * The number of speculative tokens to generate at each step. + */ + speculativeTokenCount?: number | null; + } + /** + * Draft model speculation works by using the smaller model to generate candidate tokens for speculative decoding. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation { + /** + * Required. The resource name of the draft model. + */ + draftModel?: string | null; + } + /** + * N-Gram speculation works by trying to find matching tokens in the previous prompt sequence and use those as speculation for generating new tokens. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation { + /** + * The number of last N input tokens used as ngram to search/match against the previous prompt sequence. This is equal to the N in N-Gram. The default value is 3 if not specified. + */ + ngramSize?: number | null; + } /** * The speech generation config. */ @@ -19156,9 +19686,13 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1Tool { /** - * Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services. + * Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */ codeExecution?: Schema$GoogleCloudAiplatformV1beta1ToolCodeExecution; + /** + * Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + */ + enterpriseWebSearch?: Schema$GoogleCloudAiplatformV1beta1EnterpriseWebSearch; /** * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. */ @@ -19910,7 +20444,7 @@ export namespace aiplatform_v1beta1 { value?: any | null; } /** - * The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob. + * The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. */ export interface Schema$GoogleCloudAiplatformV1beta1TunedModel { /** @@ -20021,7 +20555,7 @@ export namespace aiplatform_v1beta1 { */ supervisedTuningSpec?: Schema$GoogleCloudAiplatformV1beta1SupervisedTuningSpec; /** - * Output only. The tuned model resources assiociated with this TuningJob. + * Output only. The tuned model resources associated with this TuningJob. */ tunedModel?: Schema$GoogleCloudAiplatformV1beta1TunedModel; /** @@ -20413,11 +20947,11 @@ export namespace aiplatform_v1beta1 { stringValue?: string | null; } /** - * Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder + * Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */ export interface Schema$GoogleCloudAiplatformV1beta1VertexAISearch { /** - * Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` + * Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` */ datastore?: string | null; } @@ -22366,6 +22900,103 @@ export namespace aiplatform_v1beta1 { } } + /** + * Perform an online prediction. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + predict( + params: Params$Resource$Endpoints$Predict, + options: StreamMethodOptions + ): GaxiosPromise; + predict( + params?: Params$Resource$Endpoints$Predict, + options?: MethodOptions + ): GaxiosPromise; + predict( + params: Params$Resource$Endpoints$Predict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Endpoints$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Endpoints$Predict, + callback: BodyResponseCallback + ): void; + predict( + callback: BodyResponseCallback + ): void; + predict( + paramsOrCallback?: + | Params$Resource$Endpoints$Predict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Endpoints$Predict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Endpoints$Predict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Generate content with multimodal inputs with streaming support. * @@ -22500,6 +23131,18 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateContentRequest; } + export interface Params$Resource$Endpoints$Predict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1PredictRequest; + } export interface Params$Resource$Endpoints$Streamgeneratecontent extends StandardParameters { /** @@ -23201,7 +23844,7 @@ export namespace aiplatform_v1beta1 { } /** - * Deploys publisher models. + * Deploys a model to a new endpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23295,6 +23938,195 @@ export namespace aiplatform_v1beta1 { } } + /** + * Deploys publisher 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. + */ + deployPublisherModel( + params: Params$Resource$Projects$Locations$Deploypublishermodel, + options: StreamMethodOptions + ): GaxiosPromise; + deployPublisherModel( + params?: Params$Resource$Projects$Locations$Deploypublishermodel, + options?: MethodOptions + ): GaxiosPromise; + deployPublisherModel( + params: Params$Resource$Projects$Locations$Deploypublishermodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deployPublisherModel( + params: Params$Resource$Projects$Locations$Deploypublishermodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deployPublisherModel( + params: Params$Resource$Projects$Locations$Deploypublishermodel, + callback: BodyResponseCallback + ): void; + deployPublisherModel( + callback: BodyResponseCallback + ): void; + deployPublisherModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploypublishermodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploypublishermodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deploypublishermodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+destination}:deployPublisherModel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['destination'], + pathParams: ['destination'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Evaluates a dataset based on a set of given metrics. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + options: StreamMethodOptions + ): GaxiosPromise; + evaluateDataset( + params?: Params$Resource$Projects$Locations$Evaluatedataset, + options?: MethodOptions + ): GaxiosPromise; + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + callback: BodyResponseCallback + ): void; + evaluateDataset( + callback: BodyResponseCallback + ): void; + evaluateDataset( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluatedataset + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluatedataset; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluatedataset; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+location}:evaluateDataset').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); + } + } + /** * Evaluates instances based on a given metric. * @@ -23710,11 +24542,35 @@ export namespace aiplatform_v1beta1 { */ destination?: string; + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1DeployRequest; + } + export interface Params$Resource$Projects$Locations$Deploypublishermodel + extends StandardParameters { + /** + * Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` + */ + destination?: string; + /** * Request body metadata */ requestBody?: Schema$GoogleCloudAiplatformV1beta1DeployPublisherModelRequest; } + export interface Params$Resource$Projects$Locations$Evaluatedataset + extends StandardParameters { + /** + * Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1EvaluateDatasetRequest; + } export interface Params$Resource$Projects$Locations$Evaluateinstances extends StandardParameters { /** @@ -41677,7 +42533,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` * `description` * `big_query` * `big_query.entity_id_columns` + * 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` * `service_agent_type` */ updateMask?: string; @@ -42107,6 +42963,99 @@ export namespace aiplatform_v1beta1 { ); } } + + /** + * Updates the parameters of a single FeatureMonitor. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Featuregroups$Featuremonitors$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$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); + } + } } export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Create @@ -42162,6 +43111,22 @@ export namespace aiplatform_v1beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Featuregroups$Featuremonitors$Patch + extends StandardParameters { + /** + * Identifier. Name of the FeatureMonitor. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}/featureMonitors/{featureMonitor\}` + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor 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` * `schedule_config` * `feature_selection_config` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureMonitor; + } export class Resource$Projects$Locations$Featuregroups$Featuremonitors$Featuremonitorjobs { context: APIRequestContext; @@ -53960,7 +54925,7 @@ export namespace aiplatform_v1beta1 { } /** - * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed. + * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -66948,6 +67913,104 @@ export namespace aiplatform_v1beta1 { } } + /** + * Lists checkpoints of the specified model 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. + */ + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options: StreamMethodOptions + ): GaxiosPromise; + listCheckpoints( + params?: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options?: MethodOptions + ): GaxiosPromise; + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + callback: BodyResponseCallback + ): void; + listCheckpoints( + callback: BodyResponseCallback + ): void; + listCheckpoints( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Listcheckpoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Listcheckpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Listcheckpoints; + 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}:listCheckpoints').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 versions of the specified model. * @@ -67698,6 +68761,21 @@ export namespace aiplatform_v1beta1 { */ readMask?: string; } + export interface Params$Resource$Projects$Locations$Models$Listcheckpoints + extends StandardParameters { + /** + * Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. + */ + name?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. + */ + pageToken?: string; + } export interface Params$Resource$Projects$Locations$Models$Listversions extends StandardParameters { /** @@ -95012,6 +96090,103 @@ export namespace aiplatform_v1beta1 { } } + /** + * Perform an online prediction. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + predict( + params: Params$Resource$Publishers$Models$Predict, + options: StreamMethodOptions + ): GaxiosPromise; + predict( + params?: Params$Resource$Publishers$Models$Predict, + options?: MethodOptions + ): GaxiosPromise; + predict( + params: Params$Resource$Publishers$Models$Predict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Publishers$Models$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Publishers$Models$Predict, + callback: BodyResponseCallback + ): void; + predict( + callback: BodyResponseCallback + ): void; + predict( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Predict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Predict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Predict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Generate content with multimodal inputs with streaming support. * @@ -95152,6 +96327,10 @@ export namespace aiplatform_v1beta1 { * Optional. Token used to access Hugging Face gated models. */ huggingFaceToken?: string; + /** + * Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model. + */ + includeEquivalentModelGardenModelDeploymentConfigs?: boolean; /** * Optional. Boolean indicates whether the requested model is a Hugging Face model. */ @@ -95204,6 +96383,18 @@ export namespace aiplatform_v1beta1 { */ view?: string; } + export interface Params$Resource$Publishers$Models$Predict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1PredictRequest; + } export interface Params$Resource$Publishers$Models$Streamgeneratecontent extends StandardParameters { /** From 91653acf66c1fccd9d3b2e2d3e17a659909f0e27 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:39 +0000 Subject: [PATCH 005/144] feat(alloydb)!: update the API BREAKING CHANGE: This release has breaking changes. #### alloydb:v1alpha The following keys were deleted: - schemas.ObservabilityInstanceConfig.properties.trackClientAddress.description - schemas.ObservabilityInstanceConfig.properties.trackClientAddress.type The following keys were added: - resources.projects.resources.locations.resources.clusters.methods.import.description - resources.projects.resources.locations.resources.clusters.methods.import.flatPath - resources.projects.resources.locations.resources.clusters.methods.import.httpMethod - resources.projects.resources.locations.resources.clusters.methods.import.id - resources.projects.resources.locations.resources.clusters.methods.import.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.description - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.location - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.pattern - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.required - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.type - resources.projects.resources.locations.resources.clusters.methods.import.path - resources.projects.resources.locations.resources.clusters.methods.import.request.$ref - resources.projects.resources.locations.resources.clusters.methods.import.response.$ref - resources.projects.resources.locations.resources.clusters.methods.import.scopes - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.description - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.enum - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.enumDescriptions - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.location - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.type - schemas.CsvImportOptions.description - schemas.CsvImportOptions.id - schemas.CsvImportOptions.properties.columns.description - schemas.CsvImportOptions.properties.columns.items.type - schemas.CsvImportOptions.properties.columns.type - schemas.CsvImportOptions.properties.escapeCharacter.description - schemas.CsvImportOptions.properties.escapeCharacter.type - schemas.CsvImportOptions.properties.fieldDelimiter.description - schemas.CsvImportOptions.properties.fieldDelimiter.type - schemas.CsvImportOptions.properties.quoteCharacter.description - schemas.CsvImportOptions.properties.quoteCharacter.type - schemas.CsvImportOptions.properties.table.description - schemas.CsvImportOptions.properties.table.type - schemas.CsvImportOptions.type - schemas.DenyMaintenancePeriod.description - schemas.DenyMaintenancePeriod.id - schemas.DenyMaintenancePeriod.properties.endDate.$ref - schemas.DenyMaintenancePeriod.properties.endDate.description - schemas.DenyMaintenancePeriod.properties.startDate.$ref - schemas.DenyMaintenancePeriod.properties.startDate.description - schemas.DenyMaintenancePeriod.properties.time.$ref - schemas.DenyMaintenancePeriod.properties.time.description - schemas.DenyMaintenancePeriod.type - schemas.GCAInstanceConfig.description - schemas.GCAInstanceConfig.id - schemas.GCAInstanceConfig.properties.gcaEntitlement.description - schemas.GCAInstanceConfig.properties.gcaEntitlement.enum - schemas.GCAInstanceConfig.properties.gcaEntitlement.enumDescriptions - schemas.GCAInstanceConfig.properties.gcaEntitlement.readOnly - schemas.GCAInstanceConfig.properties.gcaEntitlement.type - schemas.GCAInstanceConfig.type - schemas.GoogleTypeDate.description - schemas.GoogleTypeDate.id - schemas.GoogleTypeDate.properties.day.description - schemas.GoogleTypeDate.properties.day.format - schemas.GoogleTypeDate.properties.day.type - schemas.GoogleTypeDate.properties.month.description - schemas.GoogleTypeDate.properties.month.format - schemas.GoogleTypeDate.properties.month.type - schemas.GoogleTypeDate.properties.year.description - schemas.GoogleTypeDate.properties.year.format - schemas.GoogleTypeDate.properties.year.type - schemas.GoogleTypeDate.type - schemas.ImportClusterRequest.description - schemas.ImportClusterRequest.id - schemas.ImportClusterRequest.properties.csvImportOptions.$ref - schemas.ImportClusterRequest.properties.csvImportOptions.description - schemas.ImportClusterRequest.properties.database.description - schemas.ImportClusterRequest.properties.database.type - schemas.ImportClusterRequest.properties.gcsUri.description - schemas.ImportClusterRequest.properties.gcsUri.type - schemas.ImportClusterRequest.properties.sqlImportOptions.$ref - schemas.ImportClusterRequest.properties.sqlImportOptions.description - schemas.ImportClusterRequest.properties.user.description - schemas.ImportClusterRequest.properties.user.type - schemas.ImportClusterRequest.type - schemas.Instance.properties.gcaConfig.$ref - schemas.Instance.properties.gcaConfig.description - schemas.Instance.properties.gcaConfig.readOnly - schemas.InstanceNetworkConfig.properties.network.description - schemas.InstanceNetworkConfig.properties.network.readOnly - schemas.InstanceNetworkConfig.properties.network.type - schemas.MachineConfig.properties.machineType.description - schemas.MachineConfig.properties.machineType.type - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.description - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.items.$ref - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.type - schemas.ObservabilityInstanceConfig.properties.assistiveExperiencesEnabled.description - schemas.ObservabilityInstanceConfig.properties.assistiveExperiencesEnabled.type - schemas.OperationMetadata.properties.upgradeClusterStatus.$ref - schemas.OperationMetadata.properties.upgradeClusterStatus.description - schemas.OperationMetadata.properties.upgradeClusterStatus.readOnly - schemas.PscAutoConnectionConfig.description - schemas.PscAutoConnectionConfig.id - schemas.PscAutoConnectionConfig.properties.consumerNetwork.description - schemas.PscAutoConnectionConfig.properties.consumerNetwork.type - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.description - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.readOnly - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.type - schemas.PscAutoConnectionConfig.properties.consumerProject.description - schemas.PscAutoConnectionConfig.properties.consumerProject.type - schemas.PscAutoConnectionConfig.properties.ipAddress.description - schemas.PscAutoConnectionConfig.properties.ipAddress.readOnly - schemas.PscAutoConnectionConfig.properties.ipAddress.type - schemas.PscAutoConnectionConfig.properties.status.description - schemas.PscAutoConnectionConfig.properties.status.readOnly - schemas.PscAutoConnectionConfig.properties.status.type - schemas.PscAutoConnectionConfig.type - schemas.PscInstanceConfig.properties.pscAutoConnections.description - schemas.PscInstanceConfig.properties.pscAutoConnections.items.$ref - schemas.PscInstanceConfig.properties.pscAutoConnections.type - schemas.ReadPoolInstancesUpgradeStageStatus.description - schemas.ReadPoolInstancesUpgradeStageStatus.id - schemas.ReadPoolInstancesUpgradeStageStatus.properties.upgradeStats.$ref - schemas.ReadPoolInstancesUpgradeStageStatus.properties.upgradeStats.description - schemas.ReadPoolInstancesUpgradeStageStatus.type - schemas.SqlImportOptions.description - schemas.SqlImportOptions.id - schemas.SqlImportOptions.type - schemas.StageStatus.description - schemas.StageStatus.id - schemas.StageStatus.properties.readPoolInstancesUpgrade.$ref - schemas.StageStatus.properties.readPoolInstancesUpgrade.description - schemas.StageStatus.properties.stage.description - schemas.StageStatus.properties.stage.enum - schemas.StageStatus.properties.stage.enumDescriptions - schemas.StageStatus.properties.stage.type - schemas.StageStatus.properties.state.description - schemas.StageStatus.properties.state.enum - schemas.StageStatus.properties.state.enumDescriptions - schemas.StageStatus.properties.state.type - schemas.StageStatus.type - schemas.Stats.description - schemas.Stats.id - schemas.Stats.properties.failed.description - schemas.Stats.properties.failed.format - schemas.Stats.properties.failed.type - schemas.Stats.properties.notStarted.description - schemas.Stats.properties.notStarted.format - schemas.Stats.properties.notStarted.type - schemas.Stats.properties.ongoing.description - schemas.Stats.properties.ongoing.format - schemas.Stats.properties.ongoing.type - schemas.Stats.properties.success.description - schemas.Stats.properties.success.format - schemas.Stats.properties.success.type - schemas.Stats.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.gcbdrConfiguration.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.gcbdrConfiguration.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.type - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.description - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.id - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.properties.gcbdrManaged.description - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.properties.gcbdrManaged.type - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.type - schemas.StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata.properties.isDeletionProtectionEnabled.description - schemas.StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata.properties.isDeletionProtectionEnabled.type - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.description - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.format - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.type - schemas.SupportedDatabaseFlag.properties.recommendedStringValue.description - schemas.SupportedDatabaseFlag.properties.recommendedStringValue.type - schemas.SupportedDatabaseFlag.properties.scope.description - schemas.SupportedDatabaseFlag.properties.scope.enum - schemas.SupportedDatabaseFlag.properties.scope.enumDescriptions - schemas.SupportedDatabaseFlag.properties.scope.type - schemas.UpgradeClusterStatus.description - schemas.UpgradeClusterStatus.id - schemas.UpgradeClusterStatus.properties.cancellable.description - schemas.UpgradeClusterStatus.properties.cancellable.type - schemas.UpgradeClusterStatus.properties.sourceVersion.description - schemas.UpgradeClusterStatus.properties.sourceVersion.enum - schemas.UpgradeClusterStatus.properties.sourceVersion.enumDeprecated - schemas.UpgradeClusterStatus.properties.sourceVersion.enumDescriptions - schemas.UpgradeClusterStatus.properties.sourceVersion.type - schemas.UpgradeClusterStatus.properties.stages.description - schemas.UpgradeClusterStatus.properties.stages.items.$ref - schemas.UpgradeClusterStatus.properties.stages.type - schemas.UpgradeClusterStatus.properties.state.description - schemas.UpgradeClusterStatus.properties.state.enum - schemas.UpgradeClusterStatus.properties.state.enumDescriptions - schemas.UpgradeClusterStatus.properties.state.type - schemas.UpgradeClusterStatus.properties.targetVersion.description - schemas.UpgradeClusterStatus.properties.targetVersion.enum - schemas.UpgradeClusterStatus.properties.targetVersion.enumDeprecated - schemas.UpgradeClusterStatus.properties.targetVersion.enumDescriptions - schemas.UpgradeClusterStatus.properties.targetVersion.type - schemas.UpgradeClusterStatus.type The following keys were changed: - schemas.AutomatedBackupPolicy.properties.encryptionConfig.description - schemas.ContinuousBackupConfig.properties.encryptionConfig.description - schemas.Node.description - schemas.ObservabilityInstanceConfig.properties.trackWaitEventTypes.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enum - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.cpuCount.description - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.memorySizeInBytes.description - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.vcpuCount.description - schemas.StorageDatabasecenterPartnerapiV1mainObservabilityMetricData.properties.metricType.enum - schemas.StorageDatabasecenterPartnerapiV1mainObservabilityMetricData.properties.metricType.enumDescriptions #### alloydb:v1beta The following keys were deleted: - schemas.ObservabilityInstanceConfig.properties.trackClientAddress.description - schemas.ObservabilityInstanceConfig.properties.trackClientAddress.type The following keys were added: - resources.projects.resources.locations.resources.clusters.methods.import.description - resources.projects.resources.locations.resources.clusters.methods.import.flatPath - resources.projects.resources.locations.resources.clusters.methods.import.httpMethod - resources.projects.resources.locations.resources.clusters.methods.import.id - resources.projects.resources.locations.resources.clusters.methods.import.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.description - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.location - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.pattern - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.required - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.type - resources.projects.resources.locations.resources.clusters.methods.import.path - resources.projects.resources.locations.resources.clusters.methods.import.request.$ref - resources.projects.resources.locations.resources.clusters.methods.import.response.$ref - resources.projects.resources.locations.resources.clusters.methods.import.scopes - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.description - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.enum - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.enumDescriptions - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.location - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.type - schemas.CsvImportOptions.description - schemas.CsvImportOptions.id - schemas.CsvImportOptions.properties.columns.description - schemas.CsvImportOptions.properties.columns.items.type - schemas.CsvImportOptions.properties.columns.type - schemas.CsvImportOptions.properties.escapeCharacter.description - schemas.CsvImportOptions.properties.escapeCharacter.type - schemas.CsvImportOptions.properties.fieldDelimiter.description - schemas.CsvImportOptions.properties.fieldDelimiter.type - schemas.CsvImportOptions.properties.quoteCharacter.description - schemas.CsvImportOptions.properties.quoteCharacter.type - schemas.CsvImportOptions.properties.table.description - schemas.CsvImportOptions.properties.table.type - schemas.CsvImportOptions.type - schemas.DenyMaintenancePeriod.description - schemas.DenyMaintenancePeriod.id - schemas.DenyMaintenancePeriod.properties.endDate.$ref - schemas.DenyMaintenancePeriod.properties.endDate.description - schemas.DenyMaintenancePeriod.properties.startDate.$ref - schemas.DenyMaintenancePeriod.properties.startDate.description - schemas.DenyMaintenancePeriod.properties.time.$ref - schemas.DenyMaintenancePeriod.properties.time.description - schemas.DenyMaintenancePeriod.type - schemas.GCAInstanceConfig.description - schemas.GCAInstanceConfig.id - schemas.GCAInstanceConfig.properties.gcaEntitlement.description - schemas.GCAInstanceConfig.properties.gcaEntitlement.enum - schemas.GCAInstanceConfig.properties.gcaEntitlement.enumDescriptions - schemas.GCAInstanceConfig.properties.gcaEntitlement.readOnly - schemas.GCAInstanceConfig.properties.gcaEntitlement.type - schemas.GCAInstanceConfig.type - schemas.GoogleTypeDate.description - schemas.GoogleTypeDate.id - schemas.GoogleTypeDate.properties.day.description - schemas.GoogleTypeDate.properties.day.format - schemas.GoogleTypeDate.properties.day.type - schemas.GoogleTypeDate.properties.month.description - schemas.GoogleTypeDate.properties.month.format - schemas.GoogleTypeDate.properties.month.type - schemas.GoogleTypeDate.properties.year.description - schemas.GoogleTypeDate.properties.year.format - schemas.GoogleTypeDate.properties.year.type - schemas.GoogleTypeDate.type - schemas.ImportClusterRequest.description - schemas.ImportClusterRequest.id - schemas.ImportClusterRequest.properties.csvImportOptions.$ref - schemas.ImportClusterRequest.properties.csvImportOptions.description - schemas.ImportClusterRequest.properties.database.description - schemas.ImportClusterRequest.properties.database.type - schemas.ImportClusterRequest.properties.gcsUri.description - schemas.ImportClusterRequest.properties.gcsUri.type - schemas.ImportClusterRequest.properties.sqlImportOptions.$ref - schemas.ImportClusterRequest.properties.sqlImportOptions.description - schemas.ImportClusterRequest.properties.user.description - schemas.ImportClusterRequest.properties.user.type - schemas.ImportClusterRequest.type - schemas.Instance.properties.gcaConfig.$ref - schemas.Instance.properties.gcaConfig.description - schemas.Instance.properties.gcaConfig.readOnly - schemas.InstanceNetworkConfig.properties.network.description - schemas.InstanceNetworkConfig.properties.network.readOnly - schemas.InstanceNetworkConfig.properties.network.type - schemas.MachineConfig.properties.machineType.description - schemas.MachineConfig.properties.machineType.type - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.description - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.items.$ref - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.type - schemas.ObservabilityInstanceConfig.properties.assistiveExperiencesEnabled.description - schemas.ObservabilityInstanceConfig.properties.assistiveExperiencesEnabled.type - schemas.OperationMetadata.properties.upgradeClusterStatus.$ref - schemas.OperationMetadata.properties.upgradeClusterStatus.description - schemas.OperationMetadata.properties.upgradeClusterStatus.readOnly - schemas.PscAutoConnectionConfig.description - schemas.PscAutoConnectionConfig.id - schemas.PscAutoConnectionConfig.properties.consumerNetwork.description - schemas.PscAutoConnectionConfig.properties.consumerNetwork.type - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.description - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.readOnly - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.type - schemas.PscAutoConnectionConfig.properties.consumerProject.description - schemas.PscAutoConnectionConfig.properties.consumerProject.type - schemas.PscAutoConnectionConfig.properties.ipAddress.description - schemas.PscAutoConnectionConfig.properties.ipAddress.readOnly - schemas.PscAutoConnectionConfig.properties.ipAddress.type - schemas.PscAutoConnectionConfig.properties.status.description - schemas.PscAutoConnectionConfig.properties.status.readOnly - schemas.PscAutoConnectionConfig.properties.status.type - schemas.PscAutoConnectionConfig.type - schemas.PscConfig.properties.serviceOwnedProjectNumber.description - schemas.PscConfig.properties.serviceOwnedProjectNumber.format - schemas.PscConfig.properties.serviceOwnedProjectNumber.readOnly - schemas.PscConfig.properties.serviceOwnedProjectNumber.type - schemas.PscInstanceConfig.properties.pscAutoConnections.description - schemas.PscInstanceConfig.properties.pscAutoConnections.items.$ref - schemas.PscInstanceConfig.properties.pscAutoConnections.type - schemas.PscInstanceConfig.properties.pscInterfaceConfigs.description - schemas.PscInstanceConfig.properties.pscInterfaceConfigs.items.$ref - schemas.PscInstanceConfig.properties.pscInterfaceConfigs.type - schemas.PscInterfaceConfig.description - schemas.PscInterfaceConfig.id - schemas.PscInterfaceConfig.properties.networkAttachmentResource.description - schemas.PscInterfaceConfig.properties.networkAttachmentResource.type - schemas.PscInterfaceConfig.type - schemas.ReadPoolInstancesUpgradeStageStatus.description - schemas.ReadPoolInstancesUpgradeStageStatus.id - schemas.ReadPoolInstancesUpgradeStageStatus.properties.upgradeStats.$ref - schemas.ReadPoolInstancesUpgradeStageStatus.properties.upgradeStats.description - schemas.ReadPoolInstancesUpgradeStageStatus.type - schemas.SqlImportOptions.description - schemas.SqlImportOptions.id - schemas.SqlImportOptions.type - schemas.StageStatus.description - schemas.StageStatus.id - schemas.StageStatus.properties.readPoolInstancesUpgrade.$ref - schemas.StageStatus.properties.readPoolInstancesUpgrade.description - schemas.StageStatus.properties.stage.description - schemas.StageStatus.properties.stage.enum - schemas.StageStatus.properties.stage.enumDescriptions - schemas.StageStatus.properties.stage.type - schemas.StageStatus.properties.state.description - schemas.StageStatus.properties.state.enum - schemas.StageStatus.properties.state.enumDescriptions - schemas.StageStatus.properties.state.type - schemas.StageStatus.type - schemas.Stats.description - schemas.Stats.id - schemas.Stats.properties.failed.description - schemas.Stats.properties.failed.format - schemas.Stats.properties.failed.type - schemas.Stats.properties.notStarted.description - schemas.Stats.properties.notStarted.format - schemas.Stats.properties.notStarted.type - schemas.Stats.properties.ongoing.description - schemas.Stats.properties.ongoing.format - schemas.Stats.properties.ongoing.type - schemas.Stats.properties.success.description - schemas.Stats.properties.success.format - schemas.Stats.properties.success.type - schemas.Stats.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.gcbdrConfiguration.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.gcbdrConfiguration.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.type - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.description - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.id - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.properties.gcbdrManaged.description - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.properties.gcbdrManaged.type - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.type - schemas.StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata.properties.isDeletionProtectionEnabled.description - schemas.StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata.properties.isDeletionProtectionEnabled.type - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.description - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.format - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.type - schemas.SupportedDatabaseFlag.properties.recommendedStringValue.description - schemas.SupportedDatabaseFlag.properties.recommendedStringValue.type - schemas.SupportedDatabaseFlag.properties.scope.description - schemas.SupportedDatabaseFlag.properties.scope.enum - schemas.SupportedDatabaseFlag.properties.scope.enumDescriptions - schemas.SupportedDatabaseFlag.properties.scope.type - schemas.UpgradeClusterStatus.description - schemas.UpgradeClusterStatus.id - schemas.UpgradeClusterStatus.properties.cancellable.description - schemas.UpgradeClusterStatus.properties.cancellable.type - schemas.UpgradeClusterStatus.properties.sourceVersion.description - schemas.UpgradeClusterStatus.properties.sourceVersion.enum - schemas.UpgradeClusterStatus.properties.sourceVersion.enumDeprecated - schemas.UpgradeClusterStatus.properties.sourceVersion.enumDescriptions - schemas.UpgradeClusterStatus.properties.sourceVersion.type - schemas.UpgradeClusterStatus.properties.stages.description - schemas.UpgradeClusterStatus.properties.stages.items.$ref - schemas.UpgradeClusterStatus.properties.stages.type - schemas.UpgradeClusterStatus.properties.state.description - schemas.UpgradeClusterStatus.properties.state.enum - schemas.UpgradeClusterStatus.properties.state.enumDescriptions - schemas.UpgradeClusterStatus.properties.state.type - schemas.UpgradeClusterStatus.properties.targetVersion.description - schemas.UpgradeClusterStatus.properties.targetVersion.enum - schemas.UpgradeClusterStatus.properties.targetVersion.enumDeprecated - schemas.UpgradeClusterStatus.properties.targetVersion.enumDescriptions - schemas.UpgradeClusterStatus.properties.targetVersion.type - schemas.UpgradeClusterStatus.type The following keys were changed: - schemas.AutomatedBackupPolicy.properties.encryptionConfig.description - schemas.ContinuousBackupConfig.properties.encryptionConfig.description - schemas.Node.description - schemas.ObservabilityInstanceConfig.properties.trackWaitEventTypes.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enum - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.cpuCount.description - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.memorySizeInBytes.description - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.vcpuCount.description - schemas.StorageDatabasecenterPartnerapiV1mainObservabilityMetricData.properties.metricType.enum - schemas.StorageDatabasecenterPartnerapiV1mainObservabilityMetricData.properties.metricType.enumDescriptions #### alloydb:v1 The following keys were added: - resources.projects.resources.locations.resources.clusters.methods.import.description - resources.projects.resources.locations.resources.clusters.methods.import.flatPath - resources.projects.resources.locations.resources.clusters.methods.import.httpMethod - resources.projects.resources.locations.resources.clusters.methods.import.id - resources.projects.resources.locations.resources.clusters.methods.import.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.description - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.location - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.pattern - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.required - resources.projects.resources.locations.resources.clusters.methods.import.parameters.name.type - resources.projects.resources.locations.resources.clusters.methods.import.path - resources.projects.resources.locations.resources.clusters.methods.import.request.$ref - resources.projects.resources.locations.resources.clusters.methods.import.response.$ref - resources.projects.resources.locations.resources.clusters.methods.import.scopes - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.description - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.flatPath - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.httpMethod - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.id - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.parameters.parent.description - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.parameters.parent.location - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.parameters.parent.pattern - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.parameters.parent.required - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.parameters.parent.type - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.path - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.request.$ref - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.response.$ref - resources.projects.resources.locations.resources.clusters.methods.restoreFromCloudSQL.scopes - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.description - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.enum - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.enumDescriptions - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.location - resources.projects.resources.locations.resources.supportedDatabaseFlags.methods.list.parameters.scope.type - schemas.CloudSQLBackupRunSource.description - schemas.CloudSQLBackupRunSource.id - schemas.CloudSQLBackupRunSource.properties.backupRunId.description - schemas.CloudSQLBackupRunSource.properties.backupRunId.format - schemas.CloudSQLBackupRunSource.properties.backupRunId.type - schemas.CloudSQLBackupRunSource.properties.instanceId.description - schemas.CloudSQLBackupRunSource.properties.instanceId.type - schemas.CloudSQLBackupRunSource.properties.project.description - schemas.CloudSQLBackupRunSource.properties.project.type - schemas.CloudSQLBackupRunSource.type - schemas.Cluster.properties.cloudsqlBackupRunSource.$ref - schemas.Cluster.properties.cloudsqlBackupRunSource.description - schemas.Cluster.properties.cloudsqlBackupRunSource.readOnly - schemas.CsvImportOptions.description - schemas.CsvImportOptions.id - schemas.CsvImportOptions.properties.columns.description - schemas.CsvImportOptions.properties.columns.items.type - schemas.CsvImportOptions.properties.columns.type - schemas.CsvImportOptions.properties.escapeCharacter.description - schemas.CsvImportOptions.properties.escapeCharacter.type - schemas.CsvImportOptions.properties.fieldDelimiter.description - schemas.CsvImportOptions.properties.fieldDelimiter.type - schemas.CsvImportOptions.properties.quoteCharacter.description - schemas.CsvImportOptions.properties.quoteCharacter.type - schemas.CsvImportOptions.properties.table.description - schemas.CsvImportOptions.properties.table.type - schemas.CsvImportOptions.type - schemas.DenyMaintenancePeriod.description - schemas.DenyMaintenancePeriod.id - schemas.DenyMaintenancePeriod.properties.endDate.$ref - schemas.DenyMaintenancePeriod.properties.endDate.description - schemas.DenyMaintenancePeriod.properties.startDate.$ref - schemas.DenyMaintenancePeriod.properties.startDate.description - schemas.DenyMaintenancePeriod.properties.time.$ref - schemas.DenyMaintenancePeriod.properties.time.description - schemas.DenyMaintenancePeriod.type - schemas.GoogleTypeDate.description - schemas.GoogleTypeDate.id - schemas.GoogleTypeDate.properties.day.description - schemas.GoogleTypeDate.properties.day.format - schemas.GoogleTypeDate.properties.day.type - schemas.GoogleTypeDate.properties.month.description - schemas.GoogleTypeDate.properties.month.format - schemas.GoogleTypeDate.properties.month.type - schemas.GoogleTypeDate.properties.year.description - schemas.GoogleTypeDate.properties.year.format - schemas.GoogleTypeDate.properties.year.type - schemas.GoogleTypeDate.type - schemas.ImportClusterRequest.description - schemas.ImportClusterRequest.id - schemas.ImportClusterRequest.properties.csvImportOptions.$ref - schemas.ImportClusterRequest.properties.csvImportOptions.description - schemas.ImportClusterRequest.properties.database.description - schemas.ImportClusterRequest.properties.database.type - schemas.ImportClusterRequest.properties.gcsUri.description - schemas.ImportClusterRequest.properties.gcsUri.type - schemas.ImportClusterRequest.properties.sqlImportOptions.$ref - schemas.ImportClusterRequest.properties.sqlImportOptions.description - schemas.ImportClusterRequest.properties.user.description - schemas.ImportClusterRequest.properties.user.type - schemas.ImportClusterRequest.type - schemas.ImportClusterResponse.description - schemas.ImportClusterResponse.id - schemas.ImportClusterResponse.properties.bytesDownloaded.description - schemas.ImportClusterResponse.properties.bytesDownloaded.format - schemas.ImportClusterResponse.properties.bytesDownloaded.type - schemas.ImportClusterResponse.type - schemas.Instance.properties.observabilityConfig.$ref - schemas.Instance.properties.observabilityConfig.description - schemas.InstanceNetworkConfig.properties.network.description - schemas.InstanceNetworkConfig.properties.network.readOnly - schemas.InstanceNetworkConfig.properties.network.type - schemas.MachineConfig.properties.machineType.description - schemas.MachineConfig.properties.machineType.type - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.description - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.items.$ref - schemas.MaintenanceUpdatePolicy.properties.denyMaintenancePeriods.type - schemas.ObservabilityInstanceConfig.description - schemas.ObservabilityInstanceConfig.id - schemas.ObservabilityInstanceConfig.properties.enabled.description - schemas.ObservabilityInstanceConfig.properties.enabled.type - schemas.ObservabilityInstanceConfig.properties.maxQueryStringLength.description - schemas.ObservabilityInstanceConfig.properties.maxQueryStringLength.format - schemas.ObservabilityInstanceConfig.properties.maxQueryStringLength.type - schemas.ObservabilityInstanceConfig.properties.preserveComments.description - schemas.ObservabilityInstanceConfig.properties.preserveComments.type - schemas.ObservabilityInstanceConfig.properties.queryPlansPerMinute.description - schemas.ObservabilityInstanceConfig.properties.queryPlansPerMinute.format - schemas.ObservabilityInstanceConfig.properties.queryPlansPerMinute.type - schemas.ObservabilityInstanceConfig.properties.recordApplicationTags.description - schemas.ObservabilityInstanceConfig.properties.recordApplicationTags.type - schemas.ObservabilityInstanceConfig.properties.trackActiveQueries.description - schemas.ObservabilityInstanceConfig.properties.trackActiveQueries.type - schemas.ObservabilityInstanceConfig.properties.trackWaitEventTypes.description - schemas.ObservabilityInstanceConfig.properties.trackWaitEventTypes.readOnly - schemas.ObservabilityInstanceConfig.properties.trackWaitEventTypes.type - schemas.ObservabilityInstanceConfig.properties.trackWaitEvents.description - schemas.ObservabilityInstanceConfig.properties.trackWaitEvents.type - schemas.ObservabilityInstanceConfig.type - schemas.OperationMetadata.properties.upgradeClusterStatus.$ref - schemas.OperationMetadata.properties.upgradeClusterStatus.description - schemas.OperationMetadata.properties.upgradeClusterStatus.readOnly - schemas.PscAutoConnectionConfig.description - schemas.PscAutoConnectionConfig.id - schemas.PscAutoConnectionConfig.properties.consumerNetwork.description - schemas.PscAutoConnectionConfig.properties.consumerNetwork.type - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.description - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.readOnly - schemas.PscAutoConnectionConfig.properties.consumerNetworkStatus.type - schemas.PscAutoConnectionConfig.properties.consumerProject.description - schemas.PscAutoConnectionConfig.properties.consumerProject.type - schemas.PscAutoConnectionConfig.properties.ipAddress.description - schemas.PscAutoConnectionConfig.properties.ipAddress.readOnly - schemas.PscAutoConnectionConfig.properties.ipAddress.type - schemas.PscAutoConnectionConfig.properties.status.description - schemas.PscAutoConnectionConfig.properties.status.readOnly - schemas.PscAutoConnectionConfig.properties.status.type - schemas.PscAutoConnectionConfig.type - schemas.PscConfig.properties.serviceOwnedProjectNumber.description - schemas.PscConfig.properties.serviceOwnedProjectNumber.format - schemas.PscConfig.properties.serviceOwnedProjectNumber.readOnly - schemas.PscConfig.properties.serviceOwnedProjectNumber.type - schemas.PscInstanceConfig.properties.pscAutoConnections.description - schemas.PscInstanceConfig.properties.pscAutoConnections.items.$ref - schemas.PscInstanceConfig.properties.pscAutoConnections.type - schemas.PscInstanceConfig.properties.pscInterfaceConfigs.description - schemas.PscInstanceConfig.properties.pscInterfaceConfigs.items.$ref - schemas.PscInstanceConfig.properties.pscInterfaceConfigs.type - schemas.PscInterfaceConfig.description - schemas.PscInterfaceConfig.id - schemas.PscInterfaceConfig.properties.networkAttachmentResource.description - schemas.PscInterfaceConfig.properties.networkAttachmentResource.type - schemas.PscInterfaceConfig.type - schemas.ReadPoolInstancesUpgradeStageStatus.description - schemas.ReadPoolInstancesUpgradeStageStatus.id - schemas.ReadPoolInstancesUpgradeStageStatus.properties.upgradeStats.$ref - schemas.ReadPoolInstancesUpgradeStageStatus.properties.upgradeStats.description - schemas.ReadPoolInstancesUpgradeStageStatus.type - schemas.RestoreFromCloudSQLRequest.description - schemas.RestoreFromCloudSQLRequest.id - schemas.RestoreFromCloudSQLRequest.properties.cloudsqlBackupRunSource.$ref - schemas.RestoreFromCloudSQLRequest.properties.cloudsqlBackupRunSource.description - schemas.RestoreFromCloudSQLRequest.properties.cluster.$ref - schemas.RestoreFromCloudSQLRequest.properties.cluster.description - schemas.RestoreFromCloudSQLRequest.properties.clusterId.description - schemas.RestoreFromCloudSQLRequest.properties.clusterId.type - schemas.RestoreFromCloudSQLRequest.type - schemas.SqlImportOptions.description - schemas.SqlImportOptions.id - schemas.SqlImportOptions.type - schemas.StageStatus.description - schemas.StageStatus.id - schemas.StageStatus.properties.readPoolInstancesUpgrade.$ref - schemas.StageStatus.properties.readPoolInstancesUpgrade.description - schemas.StageStatus.properties.stage.description - schemas.StageStatus.properties.stage.enum - schemas.StageStatus.properties.stage.enumDescriptions - schemas.StageStatus.properties.stage.type - schemas.StageStatus.properties.state.description - schemas.StageStatus.properties.state.enum - schemas.StageStatus.properties.state.enumDescriptions - schemas.StageStatus.properties.state.type - schemas.StageStatus.type - schemas.Stats.description - schemas.Stats.id - schemas.Stats.properties.failed.description - schemas.Stats.properties.failed.format - schemas.Stats.properties.failed.type - schemas.Stats.properties.notStarted.description - schemas.Stats.properties.notStarted.format - schemas.Stats.properties.notStarted.type - schemas.Stats.properties.ongoing.description - schemas.Stats.properties.ongoing.format - schemas.Stats.properties.ongoing.type - schemas.Stats.properties.success.description - schemas.Stats.properties.success.format - schemas.Stats.properties.success.type - schemas.Stats.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.gcbdrConfiguration.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.gcbdrConfiguration.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.suspensionReason.type - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.description - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.id - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.properties.gcbdrManaged.description - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.properties.gcbdrManaged.type - schemas.StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration.type - schemas.StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata.properties.isDeletionProtectionEnabled.description - schemas.StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata.properties.isDeletionProtectionEnabled.type - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.description - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.format - schemas.SupportedDatabaseFlag.properties.recommendedIntegerValue.type - schemas.SupportedDatabaseFlag.properties.recommendedStringValue.description - schemas.SupportedDatabaseFlag.properties.recommendedStringValue.type - schemas.SupportedDatabaseFlag.properties.scope.description - schemas.SupportedDatabaseFlag.properties.scope.enum - schemas.SupportedDatabaseFlag.properties.scope.enumDescriptions - schemas.SupportedDatabaseFlag.properties.scope.type - schemas.UpgradeClusterStatus.description - schemas.UpgradeClusterStatus.id - schemas.UpgradeClusterStatus.properties.cancellable.description - schemas.UpgradeClusterStatus.properties.cancellable.type - schemas.UpgradeClusterStatus.properties.sourceVersion.description - schemas.UpgradeClusterStatus.properties.sourceVersion.enum - schemas.UpgradeClusterStatus.properties.sourceVersion.enumDeprecated - schemas.UpgradeClusterStatus.properties.sourceVersion.enumDescriptions - schemas.UpgradeClusterStatus.properties.sourceVersion.type - schemas.UpgradeClusterStatus.properties.stages.description - schemas.UpgradeClusterStatus.properties.stages.items.$ref - schemas.UpgradeClusterStatus.properties.stages.type - schemas.UpgradeClusterStatus.properties.state.description - schemas.UpgradeClusterStatus.properties.state.enum - schemas.UpgradeClusterStatus.properties.state.enumDescriptions - schemas.UpgradeClusterStatus.properties.state.type - schemas.UpgradeClusterStatus.properties.targetVersion.description - schemas.UpgradeClusterStatus.properties.targetVersion.enum - schemas.UpgradeClusterStatus.properties.targetVersion.enumDeprecated - schemas.UpgradeClusterStatus.properties.targetVersion.enumDescriptions - schemas.UpgradeClusterStatus.properties.targetVersion.type - schemas.UpgradeClusterStatus.type The following keys were changed: - schemas.AutomatedBackupPolicy.properties.encryptionConfig.description - schemas.ContinuousBackupConfig.properties.encryptionConfig.description - schemas.Node.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.instanceType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enum - schemas.StorageDatabasecenterPartnerapiV1mainEntitlement.properties.type.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.cpuCount.description - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.memorySizeInBytes.description - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.vcpuCount.description - schemas.StorageDatabasecenterPartnerapiV1mainObservabilityMetricData.properties.metricType.enum - schemas.StorageDatabasecenterPartnerapiV1mainObservabilityMetricData.properties.metricType.enumDescriptions --- discovery/alloydb-v1.json | 721 ++++++++++++++++++++++++++++++++- discovery/alloydb-v1alpha.json | 602 +++++++++++++++++++++++++-- discovery/alloydb-v1beta.json | 626 ++++++++++++++++++++++++++-- src/apis/alloydb/v1.ts | 558 ++++++++++++++++++++++++- src/apis/alloydb/v1alpha.ts | 379 ++++++++++++++++- src/apis/alloydb/v1beta.ts | 396 +++++++++++++++++- 6 files changed, 3187 insertions(+), 95 deletions(-) diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index 5d8606c5bf7..4a884d119fb 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -585,6 +585,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "import": { + "description": "Imports data to the cluster. Imperative only.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:import", + "httpMethod": "POST", + "id": "alloydb.projects.locations.clusters.import", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the cluster.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:import", + "request": { + "$ref": "ImportClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Clusters in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", @@ -736,6 +764,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "restoreFromCloudSQL": { + "description": "Restores an AlloyDB cluster from a CloudSQL resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters:restoreFromCloudSQL", + "httpMethod": "POST", + "id": "alloydb.projects.locations.clusters.restoreFromCloudSQL", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/clusters:restoreFromCloudSQL", + "request": { + "$ref": "RestoreFromCloudSQLRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "switchover": { "description": "Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:switchover", @@ -1528,6 +1584,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "scope": { + "description": "Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.", + "enum": [ + "SCOPE_UNSPECIFIED", + "DATABASE", + "CONNECTION_POOL" + ], + "enumDescriptions": [ + "The scope of the flag is not specified. Default is DATABASE.", + "The flag is a database flag.", + "The flag is a connection pool flag." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/supportedDatabaseFlags", @@ -1545,7 +1616,7 @@ } } }, - "revision": "20241228", + "revision": "20250308", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1574,7 +1645,7 @@ }, "encryptionConfig": { "$ref": "EncryptionConfig", - "description": "Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data." + "description": "Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config." }, "labels": { "additionalProperties": { @@ -1844,6 +1915,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", @@ -1864,6 +1955,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": [ @@ -2201,7 +2297,7 @@ }, "encryptionConfig": { "$ref": "EncryptionConfig", - "description": "The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data." + "description": "The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config." }, "recoveryWindowDays": { "description": "The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.", @@ -2302,6 +2398,55 @@ }, "type": "object" }, + "CsvImportOptions": { + "description": "Options for importing data in CSV format.", + "id": "CsvImportOptions", + "properties": { + "columns": { + "description": "Optional. The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.", + "items": { + "type": "string" + }, + "type": "array" + }, + "escapeCharacter": { + "description": "Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is same as quote character. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "fieldDelimiter": { + "description": "Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "quoteCharacter": { + "description": "Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "table": { + "description": "Required. The database table to import CSV file into.", + "type": "string" + } + }, + "type": "object" + }, + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring" + }, + "startDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring" + }, + "time": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time OR * All zeros for 00:00:00 UTC" + } + }, + "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", @@ -2461,6 +2606,28 @@ }, "type": "object" }, + "GoogleTypeDate": { + "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": "GoogleTypeDate", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleTypeTimeOfDay": { "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": "GoogleTypeTimeOfDay", @@ -2488,6 +2655,45 @@ }, "type": "object" }, + "ImportClusterRequest": { + "description": "Import cluster request.", + "id": "ImportClusterRequest", + "properties": { + "csvImportOptions": { + "$ref": "CsvImportOptions", + "description": "Options for importing data in CSV format." + }, + "database": { + "description": "Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference.", + "type": "string" + }, + "gcsUri": { + "description": "Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`.", + "type": "string" + }, + "sqlImportOptions": { + "$ref": "SqlImportOptions", + "description": "Options for importing data in SQL format." + }, + "user": { + "description": "Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference.", + "type": "string" + } + }, + "type": "object" + }, + "ImportClusterResponse": { + "description": "Response of import rpc.", + "id": "ImportClusterResponse", + "properties": { + "bytesDownloaded": { + "description": "Required. Size of the object downloaded from Google Cloud Storage in bytes.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "InjectFaultRequest": { "description": "Message for triggering fault injection on an instance", "id": "InjectFaultRequest", @@ -2624,6 +2830,10 @@ "readOnly": true, "type": "array" }, + "observabilityConfig": { + "$ref": "ObservabilityInstanceConfig", + "description": "Configuration for observability." + }, "outboundPublicIpAddresses": { "description": "Output only. All outbound public IP addresses configured for the instance.", "items": { @@ -2723,6 +2933,11 @@ "enablePublicIp": { "description": "Optional. Enabling public ip for the instance.", "type": "boolean" + }, + "network": { + "description": "Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number}/global/networks/{network_id}`.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -2939,6 +3154,10 @@ "description": "The number of CPU's in the VM instance.", "format": "int32", "type": "integer" + }, + "machineType": { + "description": "Machine type of the VM instance. E.g. \"n2-highmem-4\", \"n2-highmem-8\", \"c4a-highmem-4-lssd\". cpu_count must match the number of vCPUs in the machine type.", + "type": "string" } }, "type": "object" @@ -2960,6 +3179,13 @@ "description": "MaintenanceUpdatePolicy defines the policy for system updates.", "id": "MaintenanceUpdatePolicy", "properties": { + "denyMaintenancePeriods": { + "description": "Periods to deny maintenance. Currently limited to 1.", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, "maintenanceWindows": { "description": "Preferred windows to perform maintenance. Currently limited to 1.", "items": { @@ -3051,7 +3277,7 @@ "type": "object" }, "Node": { - "description": "Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.", + "description": "Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.", "id": "Node", "properties": { "id": { @@ -3077,6 +3303,48 @@ }, "type": "object" }, + "ObservabilityInstanceConfig": { + "description": "Observability Instance specific configuration.", + "id": "ObservabilityInstanceConfig", + "properties": { + "enabled": { + "description": "Observability feature status for an instance. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "maxQueryStringLength": { + "description": "Query string length. The default value is 10k.", + "format": "int32", + "type": "integer" + }, + "preserveComments": { + "description": "Preserve comments in query string for an instance. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "queryPlansPerMinute": { + "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" + }, + "recordApplicationTags": { + "description": "Record application tags for an instance. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "trackActiveQueries": { + "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.", + "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 internal API.", + "readOnly": true, + "type": "boolean" + }, + "trackWaitEvents": { + "description": "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.", + "type": "boolean" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -3148,6 +3416,11 @@ "readOnly": true, "type": "string" }, + "upgradeClusterStatus": { + "$ref": "UpgradeClusterStatus", + "description": "Output only. UpgradeClusterStatus related metadata.", + "readOnly": true + }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, @@ -3190,6 +3463,36 @@ }, "type": "object" }, + "PscAutoConnectionConfig": { + "description": "Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.", + "id": "PscAutoConnectionConfig", + "properties": { + "consumerNetwork": { + "description": "The consumer network for the PSC service automation, example: \"projects/vpc-host-project/global/networks/default\". The consumer network might be hosted a different project than the consumer project.", + "type": "string" + }, + "consumerNetworkStatus": { + "description": "Output only. The status of the service connection policy.", + "readOnly": true, + "type": "string" + }, + "consumerProject": { + "description": "The consumer project to which the PSC service automation endpoint will be created.", + "type": "string" + }, + "ipAddress": { + "description": "Output only. The IP address of the PSC service automation endpoint.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. The status of the PSC service automation connection.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PscConfig": { "description": "PscConfig contains PSC related configuration at a cluster level.", "id": "PscConfig", @@ -3197,6 +3500,12 @@ "pscEnabled": { "description": "Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.", "type": "boolean" + }, + "serviceOwnedProjectNumber": { + "description": "Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.", + "format": "int64", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3212,11 +3521,25 @@ }, "type": "array" }, + "pscAutoConnections": { + "description": "Optional. Configurations for setting up PSC service automation.", + "items": { + "$ref": "PscAutoConnectionConfig" + }, + "type": "array" + }, "pscDnsName": { "description": "Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog", "readOnly": true, "type": "string" }, + "pscInterfaceConfigs": { + "description": "Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface.", + "items": { + "$ref": "PscInterfaceConfig" + }, + "type": "array" + }, "serviceAttachmentLink": { "description": "Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`", "readOnly": true, @@ -3225,6 +3548,17 @@ }, "type": "object" }, + "PscInterfaceConfig": { + "description": "Configuration for setting up a PSC interface to enable outbound connectivity.", + "id": "PscInterfaceConfig", + "properties": { + "networkAttachmentResource": { + "description": "The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: \"projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}\". The network attachment must be in the same region as the instance.", + "type": "string" + } + }, + "type": "object" + }, "QuantityBasedExpiry": { "description": "A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)", "id": "QuantityBasedExpiry", @@ -3293,6 +3627,17 @@ }, "type": "object" }, + "ReadPoolInstancesUpgradeStageStatus": { + "description": "Read pool instances upgrade specific status.", + "id": "ReadPoolInstancesUpgradeStageStatus", + "properties": { + "upgradeStats": { + "$ref": "Stats", + "description": "Read pool instances upgrade statistics." + } + }, + "type": "object" + }, "RestartInstanceRequest": { "id": "RestartInstanceRequest", "properties": { @@ -3345,6 +3690,25 @@ }, "type": "object" }, + "RestoreFromCloudSQLRequest": { + "description": "Message for registering Restoring from CloudSQL resource.", + "id": "RestoreFromCloudSQLRequest", + "properties": { + "cloudsqlBackupRunSource": { + "$ref": "CloudSQLBackupRunSource", + "description": "Cluster created from CloudSQL backup run." + }, + "cluster": { + "$ref": "Cluster", + "description": "Required. The resource being created" + }, + "clusterId": { + "description": "Required. ID of the requesting object.", + "type": "string" + } + }, + "type": "object" + }, "SecondaryConfig": { "description": "Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.", "id": "SecondaryConfig", @@ -3382,6 +3746,12 @@ }, "type": "object" }, + "SqlImportOptions": { + "description": "Options for importing data in SQL format.", + "id": "SqlImportOptions", + "properties": {}, + "type": "object" + }, "SslConfig": { "description": "SSL configuration.", "id": "SslConfig", @@ -3488,6 +3858,92 @@ }, "type": "object" }, + "StageStatus": { + "description": "Status of an upgrade stage.", + "id": "StageStatus", + "properties": { + "readPoolInstancesUpgrade": { + "$ref": "ReadPoolInstancesUpgradeStageStatus", + "description": "Read pool instances upgrade metadata." + }, + "stage": { + "description": "Upgrade stage.", + "enum": [ + "STAGE_UNSPECIFIED", + "ALLOYDB_PRECHECK", + "PG_UPGRADE_CHECK", + "PREPARE_FOR_UPGRADE", + "PRIMARY_INSTANCE_UPGRADE", + "READ_POOL_INSTANCES_UPGRADE", + "ROLLBACK", + "CLEANUP" + ], + "enumDescriptions": [ + "Unspecified stage.", + "Pre-upgrade custom checks, not covered by pg_upgrade.", + "Pre-upgrade pg_upgrade checks.", + "Clone the original cluster.", + "Upgrade the primary instance(downtime).", + "This stage is read pool upgrade.", + "Rollback in case of critical failures.", + "Cleanup." + ], + "type": "string" + }, + "state": { + "description": "State of this stage.", + "enum": [ + "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified status.", + "Not started.", + "In progress.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." + ], + "type": "string" + } + }, + "type": "object" + }, + "Stats": { + "description": "Upgrade stats for read pool instances.", + "id": "Stats", + "properties": { + "failed": { + "description": "Number of read pool instances which failed to upgrade.", + "format": "int32", + "type": "integer" + }, + "notStarted": { + "description": "Number of read pool instances for which upgrade has not started.", + "format": "int32", + "type": "integer" + }, + "ongoing": { + "description": "Number of read pool instances undergoing upgrade.", + "format": "int32", + "type": "integer" + }, + "success": { + "description": "Number of read pool instances successfully upgraded.", + "format": "int32", + "type": "integer" + } + }, + "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", @@ -3875,7 +4331,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -3958,6 +4423,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4041,7 +4515,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" }, @@ -4105,7 +4588,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 23", + "description": "Common model for database resource instance metadata. Next ID: 25", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4190,6 +4673,10 @@ ], "type": "string" }, + "gcbdrConfiguration": { + "$ref": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", + "description": "GCBDR configuration for the resource." + }, "id": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Required. Unique identifier for a Database resource" @@ -4206,6 +4693,7 @@ "SUB_RESOURCE_TYPE_PRIMARY", "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", + "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -4218,10 +4706,11 @@ false, false, false, + false, false ], "enumDescriptions": [ - "", + "Unspecified.", "For rest of the other categories.", "A regular primary database instance.", "A cluster or an instance acting as a secondary.", @@ -4230,6 +4719,7 @@ "A regular primary database instance.", "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", + "An instance acting as an external primary.", "For rest of the other categories." ], "type": "string" @@ -4262,6 +4752,28 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "suspensionReason": { + "description": "Optional. Suspension reason for the resource.", + "enum": [ + "SUSPENSION_REASON_UNSPECIFIED", + "WIPEOUT_HIDE_EVENT", + "WIPEOUT_PURGE_EVENT", + "BILLING_DISABLED", + "ABUSER_DETECTED", + "ENCRYPTION_KEY_INACCESSIBLE", + "REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE" + ], + "enumDescriptions": [ + "Suspension reason is unspecified.", + "Wipeout hide event.", + "Wipeout purge event.", + "Billing disabled for project", + "Abuse detected for resource", + "Encryption key inaccessible.", + "Replicated cluster encryption key inaccessible." + ], + "type": "string" + }, "tagsSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainTags", "description": "Optional. Tags associated with this resources." @@ -4414,7 +4926,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -4497,6 +5018,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4580,7 +5110,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" } @@ -4609,17 +5148,38 @@ "description": "An enum that represents the type of this entitlement.", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", - "GEMINI" + "GEMINI", + "NATIVE", + "GCA_STANDARD" + ], + "enumDeprecated": [ + false, + true, + false, + false ], "enumDescriptions": [ - "", - "The root entitlement representing Gemini package ownership." + "The entitlement type is unspecified.", + "The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", + "The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", + "The entitlement representing GCA-Standard Tier." ], "type": "string" } }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration": { + "description": "GCBDR Configuration for the resource.", + "id": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", + "properties": { + "gcbdrManaged": { + "description": "Whether the resource is managed by GCBDR.", + "type": "boolean" + } + }, + "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", @@ -4632,6 +5192,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", "description": "Information about the last backup attempt for this database" }, + "isDeletionProtectionEnabled": { + "description": "Whether deletion protection is enabled for this internal resource.", + "type": "boolean" + }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct" }, @@ -4651,12 +5215,12 @@ "properties": { "cpuCount": { "deprecated": true, - "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, "memorySizeInBytes": { - "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64", "type": "string" }, @@ -4666,7 +5230,7 @@ "type": "integer" }, "vcpuCount": { - "description": "Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", "format": "double", "type": "number" } @@ -4702,7 +5266,10 @@ "MEMORY_UTILIZATION", "NETWORK_CONNECTIONS", "STORAGE_UTILIZATION", - "STORAGE_USED_BYTES" + "STORAGE_USED_BYTES", + "NODE_COUNT", + "MEMORY_USED_BYTES", + "PROCESSING_UNIT_COUNT" ], "enumDescriptions": [ "Unspecified metric type.", @@ -4710,7 +5277,10 @@ "Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Number of network connections for a resource.", "Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", - "Sotrage used by a resource." + "Sotrage used by a resource.", + "Node count for a resource. It represents the number of node units in a bigtable/spanner instance.", + "Memory used by a resource (in bytes).", + "Processing units used by a resource. It represents the number of processing units in a spanner instance." ], "type": "string" }, @@ -5010,10 +5580,33 @@ "description": "The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.", "type": "string" }, + "recommendedIntegerValue": { + "description": "The recommended value for an INTEGER flag.", + "format": "int64", + "type": "string" + }, + "recommendedStringValue": { + "description": "The recommended value for a STRING flag.", + "type": "string" + }, "requiresDbRestart": { "description": "Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).", "type": "boolean" }, + "scope": { + "description": "The scope of the flag.", + "enum": [ + "SCOPE_UNSPECIFIED", + "DATABASE", + "CONNECTION_POOL" + ], + "enumDescriptions": [ + "The scope of the flag is not specified. Default is DATABASE.", + "The flag is a database flag.", + "The flag is a connection pool flag." + ], + "type": "string" + }, "stringRestrictions": { "$ref": "StringRestrictions", "description": "Restriction on STRING type value." @@ -5206,6 +5799,98 @@ }, "type": "object" }, + "UpgradeClusterStatus": { + "description": "Message for current status of the Major Version Upgrade operation.", + "id": "UpgradeClusterStatus", + "properties": { + "cancellable": { + "description": "Whether the operation is cancellable.", + "type": "boolean" + }, + "sourceVersion": { + "description": "Source database major version.", + "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" + }, + "stages": { + "description": "Status of all upgrade stages.", + "items": { + "$ref": "StageStatus" + }, + "type": "array" + }, + "state": { + "description": "Cluster Major Version Upgrade state.", + "enum": [ + "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified status.", + "Not started.", + "In progress.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." + ], + "type": "string" + }, + "targetVersion": { + "description": "Target database major version.", + "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" + }, "User": { "description": "Message describing User object.", "id": "User", diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index 7d1ea3e40ec..76765bac277 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -585,6 +585,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "import": { + "description": "Imports data to the cluster. Imperative only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:import", + "httpMethod": "POST", + "id": "alloydb.projects.locations.clusters.import", + "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}:import", + "request": { + "$ref": "ImportClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Clusters in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters", @@ -1556,6 +1584,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "scope": { + "description": "Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.", + "enum": [ + "SCOPE_UNSPECIFIED", + "DATABASE", + "CONNECTION_POOL" + ], + "enumDescriptions": [ + "The scope of the flag is not specified. Default is DATABASE.", + "The flag is a database flag.", + "The flag is a connection pool flag." + ], + "location": "query", + "type": "string" } }, "path": "v1alpha/{+parent}/supportedDatabaseFlags", @@ -1573,7 +1616,7 @@ } } }, - "revision": "20241228", + "revision": "20250308", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1602,7 +1645,7 @@ }, "encryptionConfig": { "$ref": "EncryptionConfig", - "description": "Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data." + "description": "Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config." }, "labels": { "additionalProperties": { @@ -2282,7 +2325,7 @@ }, "encryptionConfig": { "$ref": "EncryptionConfig", - "description": "The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data." + "description": "The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config." }, "recoveryWindowDays": { "description": "The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.", @@ -2383,6 +2426,55 @@ }, "type": "object" }, + "CsvImportOptions": { + "description": "Options for importing data in CSV format.", + "id": "CsvImportOptions", + "properties": { + "columns": { + "description": "Optional. The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.", + "items": { + "type": "string" + }, + "type": "array" + }, + "escapeCharacter": { + "description": "Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is same as quote character. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "fieldDelimiter": { + "description": "Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "quoteCharacter": { + "description": "Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "table": { + "description": "Required. The database table to import CSV file into.", + "type": "string" + } + }, + "type": "object" + }, + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring" + }, + "startDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring" + }, + "time": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time OR * All zeros for 00:00:00 UTC" + } + }, + "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", @@ -2468,6 +2560,26 @@ }, "type": "object" }, + "GCAInstanceConfig": { + "description": "Instance level configuration parameters related to the Gemini Cloud Assist product.", + "id": "GCAInstanceConfig", + "properties": { + "gcaEntitlement": { + "description": "Output only. Represents the GCA entitlement state of the instance.", + "enum": [ + "GCA_ENTITLEMENT_TYPE_UNSPECIFIED", + "GCA_STANDARD" + ], + "enumDescriptions": [ + "No GCA entitlement is assigned.", + "The resource is entitled to the GCA Standard Tier." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GcsDestination": { "description": "Destination for Export. Export will be done to cloud storage.", "id": "GcsDestination", @@ -2555,6 +2667,28 @@ }, "type": "object" }, + "GoogleTypeDate": { + "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": "GoogleTypeDate", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleTypeTimeOfDay": { "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": "GoogleTypeTimeOfDay", @@ -2582,6 +2716,33 @@ }, "type": "object" }, + "ImportClusterRequest": { + "description": "Import cluster request.", + "id": "ImportClusterRequest", + "properties": { + "csvImportOptions": { + "$ref": "CsvImportOptions", + "description": "Options for importing data in CSV format." + }, + "database": { + "description": "Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference.", + "type": "string" + }, + "gcsUri": { + "description": "Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`.", + "type": "string" + }, + "sqlImportOptions": { + "$ref": "SqlImportOptions", + "description": "Options for importing data in SQL format." + }, + "user": { + "description": "Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference.", + "type": "string" + } + }, + "type": "object" + }, "InjectFaultRequest": { "description": "Message for triggering fault injection on an instance", "id": "InjectFaultRequest", @@ -2665,6 +2826,11 @@ "description": "For Resource freshness validation (https://google.aip.dev/154)", "type": "string" }, + "gcaConfig": { + "$ref": "GCAInstanceConfig", + "description": "Output only. Configuration parameters related to Gemini Cloud Assist.", + "readOnly": true + }, "gceZone": { "description": "The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.", "type": "string" @@ -2834,6 +3000,11 @@ "enablePublicIp": { "description": "Optional. Enabling public ip for the instance.", "type": "boolean" + }, + "network": { + "description": "Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number}/global/networks/{network_id}`.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3050,6 +3221,10 @@ "description": "The number of CPU's in the VM instance.", "format": "int32", "type": "integer" + }, + "machineType": { + "description": "Machine type of the VM instance. E.g. \"n2-highmem-4\", \"n2-highmem-8\", \"c4a-highmem-4-lssd\". cpu_count must match the number of vCPUs in the machine type.", + "type": "string" } }, "type": "object" @@ -3071,6 +3246,13 @@ "description": "MaintenanceUpdatePolicy defines the policy for system updates.", "id": "MaintenanceUpdatePolicy", "properties": { + "denyMaintenancePeriods": { + "description": "Periods to deny maintenance. Currently limited to 1.", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, "maintenanceWindows": { "description": "Preferred windows to perform maintenance. Currently limited to 1.", "items": { @@ -3162,7 +3344,7 @@ "type": "object" }, "Node": { - "description": "Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.", + "description": "Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.", "id": "Node", "properties": { "id": { @@ -3192,6 +3374,10 @@ "description": "Observability Instance specific configuration.", "id": "ObservabilityInstanceConfig", "properties": { + "assistiveExperiencesEnabled": { + "description": "Whether assistive experiences are enabled for this AlloyDB instance.", + "type": "boolean" + }, "enabled": { "description": "Observability feature status for an instance. This flag is turned \"off\" by default.", "type": "boolean" @@ -3218,12 +3404,8 @@ "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.", + "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 internal API.", "readOnly": true, "type": "boolean" }, @@ -3305,6 +3487,11 @@ "readOnly": true, "type": "string" }, + "upgradeClusterStatus": { + "$ref": "UpgradeClusterStatus", + "description": "Output only. UpgradeClusterStatus related metadata.", + "readOnly": true + }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, @@ -3347,6 +3534,36 @@ }, "type": "object" }, + "PscAutoConnectionConfig": { + "description": "Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.", + "id": "PscAutoConnectionConfig", + "properties": { + "consumerNetwork": { + "description": "The consumer network for the PSC service automation, example: \"projects/vpc-host-project/global/networks/default\". The consumer network might be hosted a different project than the consumer project.", + "type": "string" + }, + "consumerNetworkStatus": { + "description": "Output only. The status of the service connection policy.", + "readOnly": true, + "type": "string" + }, + "consumerProject": { + "description": "The consumer project to which the PSC service automation endpoint will be created.", + "type": "string" + }, + "ipAddress": { + "description": "Output only. The IP address of the PSC service automation endpoint.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. The status of the PSC service automation connection.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PscConfig": { "description": "PscConfig contains PSC related configuration at a cluster level.", "id": "PscConfig", @@ -3375,6 +3592,13 @@ }, "type": "array" }, + "pscAutoConnections": { + "description": "Optional. Configurations for setting up PSC service automation.", + "items": { + "$ref": "PscAutoConnectionConfig" + }, + "type": "array" + }, "pscDnsName": { "description": "Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog", "readOnly": true, @@ -3474,6 +3698,17 @@ }, "type": "object" }, + "ReadPoolInstancesUpgradeStageStatus": { + "description": "Read pool instances upgrade specific status.", + "id": "ReadPoolInstancesUpgradeStageStatus", + "properties": { + "upgradeStats": { + "$ref": "Stats", + "description": "Read pool instances upgrade statistics." + } + }, + "type": "object" + }, "RestartInstanceRequest": { "id": "RestartInstanceRequest", "properties": { @@ -3582,6 +3817,12 @@ }, "type": "object" }, + "SqlImportOptions": { + "description": "Options for importing data in SQL format.", + "id": "SqlImportOptions", + "properties": {}, + "type": "object" + }, "SslConfig": { "description": "SSL configuration.", "id": "SslConfig", @@ -3688,6 +3929,92 @@ }, "type": "object" }, + "StageStatus": { + "description": "Status of an upgrade stage.", + "id": "StageStatus", + "properties": { + "readPoolInstancesUpgrade": { + "$ref": "ReadPoolInstancesUpgradeStageStatus", + "description": "Read pool instances upgrade metadata." + }, + "stage": { + "description": "Upgrade stage.", + "enum": [ + "STAGE_UNSPECIFIED", + "ALLOYDB_PRECHECK", + "PG_UPGRADE_CHECK", + "PREPARE_FOR_UPGRADE", + "PRIMARY_INSTANCE_UPGRADE", + "READ_POOL_INSTANCES_UPGRADE", + "ROLLBACK", + "CLEANUP" + ], + "enumDescriptions": [ + "Unspecified stage.", + "Pre-upgrade custom checks, not covered by pg_upgrade.", + "Pre-upgrade pg_upgrade checks.", + "Clone the original cluster.", + "Upgrade the primary instance(downtime).", + "This stage is read pool upgrade.", + "Rollback in case of critical failures.", + "Cleanup." + ], + "type": "string" + }, + "state": { + "description": "State of this stage.", + "enum": [ + "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified status.", + "Not started.", + "In progress.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." + ], + "type": "string" + } + }, + "type": "object" + }, + "Stats": { + "description": "Upgrade stats for read pool instances.", + "id": "Stats", + "properties": { + "failed": { + "description": "Number of read pool instances which failed to upgrade.", + "format": "int32", + "type": "integer" + }, + "notStarted": { + "description": "Number of read pool instances for which upgrade has not started.", + "format": "int32", + "type": "integer" + }, + "ongoing": { + "description": "Number of read pool instances undergoing upgrade.", + "format": "int32", + "type": "integer" + }, + "success": { + "description": "Number of read pool instances successfully upgraded.", + "format": "int32", + "type": "integer" + } + }, + "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", @@ -4075,7 +4402,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -4158,6 +4494,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4241,7 +4586,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" }, @@ -4305,7 +4659,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 23", + "description": "Common model for database resource instance metadata. Next ID: 25", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4390,6 +4744,10 @@ ], "type": "string" }, + "gcbdrConfiguration": { + "$ref": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", + "description": "GCBDR configuration for the resource." + }, "id": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Required. Unique identifier for a Database resource" @@ -4406,6 +4764,7 @@ "SUB_RESOURCE_TYPE_PRIMARY", "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", + "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -4418,10 +4777,11 @@ false, false, false, + false, false ], "enumDescriptions": [ - "", + "Unspecified.", "For rest of the other categories.", "A regular primary database instance.", "A cluster or an instance acting as a secondary.", @@ -4430,6 +4790,7 @@ "A regular primary database instance.", "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", + "An instance acting as an external primary.", "For rest of the other categories." ], "type": "string" @@ -4462,6 +4823,28 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "suspensionReason": { + "description": "Optional. Suspension reason for the resource.", + "enum": [ + "SUSPENSION_REASON_UNSPECIFIED", + "WIPEOUT_HIDE_EVENT", + "WIPEOUT_PURGE_EVENT", + "BILLING_DISABLED", + "ABUSER_DETECTED", + "ENCRYPTION_KEY_INACCESSIBLE", + "REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE" + ], + "enumDescriptions": [ + "Suspension reason is unspecified.", + "Wipeout hide event.", + "Wipeout purge event.", + "Billing disabled for project", + "Abuse detected for resource", + "Encryption key inaccessible.", + "Replicated cluster encryption key inaccessible." + ], + "type": "string" + }, "tagsSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainTags", "description": "Optional. Tags associated with this resources." @@ -4614,7 +4997,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -4697,6 +5089,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4780,7 +5181,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" } @@ -4809,17 +5219,38 @@ "description": "An enum that represents the type of this entitlement.", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", - "GEMINI" + "GEMINI", + "NATIVE", + "GCA_STANDARD" + ], + "enumDeprecated": [ + false, + true, + false, + false ], "enumDescriptions": [ - "", - "The root entitlement representing Gemini package ownership." + "The entitlement type is unspecified.", + "The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", + "The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", + "The entitlement representing GCA-Standard Tier." ], "type": "string" } }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration": { + "description": "GCBDR Configuration for the resource.", + "id": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", + "properties": { + "gcbdrManaged": { + "description": "Whether the resource is managed by GCBDR.", + "type": "boolean" + } + }, + "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", @@ -4832,6 +5263,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", "description": "Information about the last backup attempt for this database" }, + "isDeletionProtectionEnabled": { + "description": "Whether deletion protection is enabled for this internal resource.", + "type": "boolean" + }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct" }, @@ -4851,12 +5286,12 @@ "properties": { "cpuCount": { "deprecated": true, - "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, "memorySizeInBytes": { - "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64", "type": "string" }, @@ -4866,7 +5301,7 @@ "type": "integer" }, "vcpuCount": { - "description": "Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", "format": "double", "type": "number" } @@ -4902,7 +5337,10 @@ "MEMORY_UTILIZATION", "NETWORK_CONNECTIONS", "STORAGE_UTILIZATION", - "STORAGE_USED_BYTES" + "STORAGE_USED_BYTES", + "NODE_COUNT", + "MEMORY_USED_BYTES", + "PROCESSING_UNIT_COUNT" ], "enumDescriptions": [ "Unspecified metric type.", @@ -4910,7 +5348,10 @@ "Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Number of network connections for a resource.", "Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", - "Sotrage used by a resource." + "Sotrage used by a resource.", + "Node count for a resource. It represents the number of node units in a bigtable/spanner instance.", + "Memory used by a resource (in bytes).", + "Processing units used by a resource. It represents the number of processing units in a spanner instance." ], "type": "string" }, @@ -5210,10 +5651,33 @@ "description": "The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.", "type": "string" }, + "recommendedIntegerValue": { + "description": "The recommended value for an INTEGER flag.", + "format": "int64", + "type": "string" + }, + "recommendedStringValue": { + "description": "The recommended value for a STRING flag.", + "type": "string" + }, "requiresDbRestart": { "description": "Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).", "type": "boolean" }, + "scope": { + "description": "The scope of the flag.", + "enum": [ + "SCOPE_UNSPECIFIED", + "DATABASE", + "CONNECTION_POOL" + ], + "enumDescriptions": [ + "The scope of the flag is not specified. Default is DATABASE.", + "The flag is a database flag.", + "The flag is a connection pool flag." + ], + "type": "string" + }, "stringRestrictions": { "$ref": "StringRestrictions", "description": "Restriction on STRING type value." @@ -5427,6 +5891,98 @@ }, "type": "object" }, + "UpgradeClusterStatus": { + "description": "Message for current status of the Major Version Upgrade operation.", + "id": "UpgradeClusterStatus", + "properties": { + "cancellable": { + "description": "Whether the operation is cancellable.", + "type": "boolean" + }, + "sourceVersion": { + "description": "Source database major version.", + "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" + }, + "stages": { + "description": "Status of all upgrade stages.", + "items": { + "$ref": "StageStatus" + }, + "type": "array" + }, + "state": { + "description": "Cluster Major Version Upgrade state.", + "enum": [ + "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified status.", + "Not started.", + "In progress.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." + ], + "type": "string" + }, + "targetVersion": { + "description": "Target database major version.", + "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" + }, "User": { "description": "Message describing User object.", "id": "User", diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index ff722f8ef0b..760bcb6d386 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -585,6 +585,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "import": { + "description": "Imports data to the cluster. Imperative only.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:import", + "httpMethod": "POST", + "id": "alloydb.projects.locations.clusters.import", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the cluster.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:import", + "request": { + "$ref": "ImportClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Clusters in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters", @@ -1553,6 +1581,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "scope": { + "description": "Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.", + "enum": [ + "SCOPE_UNSPECIFIED", + "DATABASE", + "CONNECTION_POOL" + ], + "enumDescriptions": [ + "The scope of the flag is not specified. Default is DATABASE.", + "The flag is a database flag.", + "The flag is a connection pool flag." + ], + "location": "query", + "type": "string" } }, "path": "v1beta/{+parent}/supportedDatabaseFlags", @@ -1570,7 +1613,7 @@ } } }, - "revision": "20241228", + "revision": "20250308", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1599,7 +1642,7 @@ }, "encryptionConfig": { "$ref": "EncryptionConfig", - "description": "Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data." + "description": "Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config." }, "labels": { "additionalProperties": { @@ -2263,7 +2306,7 @@ }, "encryptionConfig": { "$ref": "EncryptionConfig", - "description": "The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data." + "description": "The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config." }, "recoveryWindowDays": { "description": "The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.", @@ -2364,6 +2407,55 @@ }, "type": "object" }, + "CsvImportOptions": { + "description": "Options for importing data in CSV format.", + "id": "CsvImportOptions", + "properties": { + "columns": { + "description": "Optional. The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.", + "items": { + "type": "string" + }, + "type": "array" + }, + "escapeCharacter": { + "description": "Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is same as quote character. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "fieldDelimiter": { + "description": "Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "quoteCharacter": { + "description": "Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code.", + "type": "string" + }, + "table": { + "description": "Required. The database table to import CSV file into.", + "type": "string" + } + }, + "type": "object" + }, + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring" + }, + "startDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring" + }, + "time": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time OR * All zeros for 00:00:00 UTC" + } + }, + "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", @@ -2449,6 +2541,26 @@ }, "type": "object" }, + "GCAInstanceConfig": { + "description": "Instance level configuration parameters related to the Gemini Cloud Assist product.", + "id": "GCAInstanceConfig", + "properties": { + "gcaEntitlement": { + "description": "Output only. Represents the GCA entitlement state of the instance.", + "enum": [ + "GCA_ENTITLEMENT_TYPE_UNSPECIFIED", + "GCA_STANDARD" + ], + "enumDescriptions": [ + "No GCA entitlement is assigned.", + "The resource is entitled to the GCA Standard Tier." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GcsDestination": { "description": "Destination for Export. Export will be done to cloud storage.", "id": "GcsDestination", @@ -2536,6 +2648,28 @@ }, "type": "object" }, + "GoogleTypeDate": { + "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": "GoogleTypeDate", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleTypeTimeOfDay": { "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": "GoogleTypeTimeOfDay", @@ -2563,6 +2697,33 @@ }, "type": "object" }, + "ImportClusterRequest": { + "description": "Import cluster request.", + "id": "ImportClusterRequest", + "properties": { + "csvImportOptions": { + "$ref": "CsvImportOptions", + "description": "Options for importing data in CSV format." + }, + "database": { + "description": "Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference.", + "type": "string" + }, + "gcsUri": { + "description": "Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`.", + "type": "string" + }, + "sqlImportOptions": { + "$ref": "SqlImportOptions", + "description": "Options for importing data in SQL format." + }, + "user": { + "description": "Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference.", + "type": "string" + } + }, + "type": "object" + }, "InjectFaultRequest": { "description": "Message for triggering fault injection on an instance", "id": "InjectFaultRequest", @@ -2646,6 +2807,11 @@ "description": "For Resource freshness validation (https://google.aip.dev/154)", "type": "string" }, + "gcaConfig": { + "$ref": "GCAInstanceConfig", + "description": "Output only. Configuration parameters related to Gemini Cloud Assist.", + "readOnly": true + }, "gceZone": { "description": "The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.", "type": "string" @@ -2810,6 +2976,11 @@ "enablePublicIp": { "description": "Optional. Enabling public ip for the instance.", "type": "boolean" + }, + "network": { + "description": "Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number}/global/networks/{network_id}`.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3026,6 +3197,10 @@ "description": "The number of CPU's in the VM instance.", "format": "int32", "type": "integer" + }, + "machineType": { + "description": "Machine type of the VM instance. E.g. \"n2-highmem-4\", \"n2-highmem-8\", \"c4a-highmem-4-lssd\". cpu_count must match the number of vCPUs in the machine type.", + "type": "string" } }, "type": "object" @@ -3047,6 +3222,13 @@ "description": "MaintenanceUpdatePolicy defines the policy for system updates.", "id": "MaintenanceUpdatePolicy", "properties": { + "denyMaintenancePeriods": { + "description": "Periods to deny maintenance. Currently limited to 1.", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, "maintenanceWindows": { "description": "Preferred windows to perform maintenance. Currently limited to 1.", "items": { @@ -3138,7 +3320,7 @@ "type": "object" }, "Node": { - "description": "Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.", + "description": "Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.", "id": "Node", "properties": { "id": { @@ -3168,6 +3350,10 @@ "description": "Observability Instance specific configuration.", "id": "ObservabilityInstanceConfig", "properties": { + "assistiveExperiencesEnabled": { + "description": "Whether assistive experiences are enabled for this AlloyDB instance.", + "type": "boolean" + }, "enabled": { "description": "Observability feature status for an instance. This flag is turned \"off\" by default.", "type": "boolean" @@ -3194,12 +3380,8 @@ "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.", + "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 internal API.", "readOnly": true, "type": "boolean" }, @@ -3281,6 +3463,11 @@ "readOnly": true, "type": "string" }, + "upgradeClusterStatus": { + "$ref": "UpgradeClusterStatus", + "description": "Output only. UpgradeClusterStatus related metadata.", + "readOnly": true + }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, @@ -3323,6 +3510,36 @@ }, "type": "object" }, + "PscAutoConnectionConfig": { + "description": "Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.", + "id": "PscAutoConnectionConfig", + "properties": { + "consumerNetwork": { + "description": "The consumer network for the PSC service automation, example: \"projects/vpc-host-project/global/networks/default\". The consumer network might be hosted a different project than the consumer project.", + "type": "string" + }, + "consumerNetworkStatus": { + "description": "Output only. The status of the service connection policy.", + "readOnly": true, + "type": "string" + }, + "consumerProject": { + "description": "The consumer project to which the PSC service automation endpoint will be created.", + "type": "string" + }, + "ipAddress": { + "description": "Output only. The IP address of the PSC service automation endpoint.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. The status of the PSC service automation connection.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PscConfig": { "description": "PscConfig contains PSC related configuration at a cluster level.", "id": "PscConfig", @@ -3330,6 +3547,12 @@ "pscEnabled": { "description": "Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.", "type": "boolean" + }, + "serviceOwnedProjectNumber": { + "description": "Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.", + "format": "int64", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3345,11 +3568,25 @@ }, "type": "array" }, + "pscAutoConnections": { + "description": "Optional. Configurations for setting up PSC service automation.", + "items": { + "$ref": "PscAutoConnectionConfig" + }, + "type": "array" + }, "pscDnsName": { "description": "Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog", "readOnly": true, "type": "string" }, + "pscInterfaceConfigs": { + "description": "Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface.", + "items": { + "$ref": "PscInterfaceConfig" + }, + "type": "array" + }, "serviceAttachmentLink": { "description": "Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`", "readOnly": true, @@ -3358,6 +3595,17 @@ }, "type": "object" }, + "PscInterfaceConfig": { + "description": "Configuration for setting up a PSC interface to enable outbound connectivity.", + "id": "PscInterfaceConfig", + "properties": { + "networkAttachmentResource": { + "description": "The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: \"projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}\". The network attachment must be in the same region as the instance.", + "type": "string" + } + }, + "type": "object" + }, "QuantityBasedExpiry": { "description": "A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)", "id": "QuantityBasedExpiry", @@ -3426,6 +3674,17 @@ }, "type": "object" }, + "ReadPoolInstancesUpgradeStageStatus": { + "description": "Read pool instances upgrade specific status.", + "id": "ReadPoolInstancesUpgradeStageStatus", + "properties": { + "upgradeStats": { + "$ref": "Stats", + "description": "Read pool instances upgrade statistics." + } + }, + "type": "object" + }, "RestartInstanceRequest": { "id": "RestartInstanceRequest", "properties": { @@ -3534,6 +3793,12 @@ }, "type": "object" }, + "SqlImportOptions": { + "description": "Options for importing data in SQL format.", + "id": "SqlImportOptions", + "properties": {}, + "type": "object" + }, "SslConfig": { "description": "SSL configuration.", "id": "SslConfig", @@ -3640,6 +3905,92 @@ }, "type": "object" }, + "StageStatus": { + "description": "Status of an upgrade stage.", + "id": "StageStatus", + "properties": { + "readPoolInstancesUpgrade": { + "$ref": "ReadPoolInstancesUpgradeStageStatus", + "description": "Read pool instances upgrade metadata." + }, + "stage": { + "description": "Upgrade stage.", + "enum": [ + "STAGE_UNSPECIFIED", + "ALLOYDB_PRECHECK", + "PG_UPGRADE_CHECK", + "PREPARE_FOR_UPGRADE", + "PRIMARY_INSTANCE_UPGRADE", + "READ_POOL_INSTANCES_UPGRADE", + "ROLLBACK", + "CLEANUP" + ], + "enumDescriptions": [ + "Unspecified stage.", + "Pre-upgrade custom checks, not covered by pg_upgrade.", + "Pre-upgrade pg_upgrade checks.", + "Clone the original cluster.", + "Upgrade the primary instance(downtime).", + "This stage is read pool upgrade.", + "Rollback in case of critical failures.", + "Cleanup." + ], + "type": "string" + }, + "state": { + "description": "State of this stage.", + "enum": [ + "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified status.", + "Not started.", + "In progress.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." + ], + "type": "string" + } + }, + "type": "object" + }, + "Stats": { + "description": "Upgrade stats for read pool instances.", + "id": "Stats", + "properties": { + "failed": { + "description": "Number of read pool instances which failed to upgrade.", + "format": "int32", + "type": "integer" + }, + "notStarted": { + "description": "Number of read pool instances for which upgrade has not started.", + "format": "int32", + "type": "integer" + }, + "ongoing": { + "description": "Number of read pool instances undergoing upgrade.", + "format": "int32", + "type": "integer" + }, + "success": { + "description": "Number of read pool instances successfully upgraded.", + "format": "int32", + "type": "integer" + } + }, + "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", @@ -4027,7 +4378,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -4110,6 +4470,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4193,7 +4562,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" }, @@ -4257,7 +4635,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 23", + "description": "Common model for database resource instance metadata. Next ID: 25", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4342,6 +4720,10 @@ ], "type": "string" }, + "gcbdrConfiguration": { + "$ref": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", + "description": "GCBDR configuration for the resource." + }, "id": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Required. Unique identifier for a Database resource" @@ -4358,6 +4740,7 @@ "SUB_RESOURCE_TYPE_PRIMARY", "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", + "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -4370,10 +4753,11 @@ false, false, false, + false, false ], "enumDescriptions": [ - "", + "Unspecified.", "For rest of the other categories.", "A regular primary database instance.", "A cluster or an instance acting as a secondary.", @@ -4382,6 +4766,7 @@ "A regular primary database instance.", "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", + "An instance acting as an external primary.", "For rest of the other categories." ], "type": "string" @@ -4414,6 +4799,28 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "suspensionReason": { + "description": "Optional. Suspension reason for the resource.", + "enum": [ + "SUSPENSION_REASON_UNSPECIFIED", + "WIPEOUT_HIDE_EVENT", + "WIPEOUT_PURGE_EVENT", + "BILLING_DISABLED", + "ABUSER_DETECTED", + "ENCRYPTION_KEY_INACCESSIBLE", + "REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE" + ], + "enumDescriptions": [ + "Suspension reason is unspecified.", + "Wipeout hide event.", + "Wipeout purge event.", + "Billing disabled for project", + "Abuse detected for resource", + "Encryption key inaccessible.", + "Replicated cluster encryption key inaccessible." + ], + "type": "string" + }, "tagsSet": { "$ref": "StorageDatabasecenterPartnerapiV1mainTags", "description": "Optional. Tags associated with this resources." @@ -4566,7 +4973,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -4649,6 +5065,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4732,7 +5157,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" } @@ -4761,17 +5195,38 @@ "description": "An enum that represents the type of this entitlement.", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", - "GEMINI" + "GEMINI", + "NATIVE", + "GCA_STANDARD" + ], + "enumDeprecated": [ + false, + true, + false, + false ], "enumDescriptions": [ - "", - "The root entitlement representing Gemini package ownership." + "The entitlement type is unspecified.", + "The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", + "The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", + "The entitlement representing GCA-Standard Tier." ], "type": "string" } }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration": { + "description": "GCBDR Configuration for the resource.", + "id": "StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration", + "properties": { + "gcbdrManaged": { + "description": "Whether the resource is managed by GCBDR.", + "type": "boolean" + } + }, + "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", @@ -4784,6 +5239,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", "description": "Information about the last backup attempt for this database" }, + "isDeletionProtectionEnabled": { + "description": "Whether deletion protection is enabled for this internal resource.", + "type": "boolean" + }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct" }, @@ -4803,12 +5262,12 @@ "properties": { "cpuCount": { "deprecated": true, - "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, "memorySizeInBytes": { - "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64", "type": "string" }, @@ -4818,7 +5277,7 @@ "type": "integer" }, "vcpuCount": { - "description": "Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", "format": "double", "type": "number" } @@ -4854,7 +5313,10 @@ "MEMORY_UTILIZATION", "NETWORK_CONNECTIONS", "STORAGE_UTILIZATION", - "STORAGE_USED_BYTES" + "STORAGE_USED_BYTES", + "NODE_COUNT", + "MEMORY_USED_BYTES", + "PROCESSING_UNIT_COUNT" ], "enumDescriptions": [ "Unspecified metric type.", @@ -4862,7 +5324,10 @@ "Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Number of network connections for a resource.", "Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", - "Sotrage used by a resource." + "Sotrage used by a resource.", + "Node count for a resource. It represents the number of node units in a bigtable/spanner instance.", + "Memory used by a resource (in bytes).", + "Processing units used by a resource. It represents the number of processing units in a spanner instance." ], "type": "string" }, @@ -5162,10 +5627,33 @@ "description": "The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.", "type": "string" }, + "recommendedIntegerValue": { + "description": "The recommended value for an INTEGER flag.", + "format": "int64", + "type": "string" + }, + "recommendedStringValue": { + "description": "The recommended value for a STRING flag.", + "type": "string" + }, "requiresDbRestart": { "description": "Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).", "type": "boolean" }, + "scope": { + "description": "The scope of the flag.", + "enum": [ + "SCOPE_UNSPECIFIED", + "DATABASE", + "CONNECTION_POOL" + ], + "enumDescriptions": [ + "The scope of the flag is not specified. Default is DATABASE.", + "The flag is a database flag.", + "The flag is a connection pool flag." + ], + "type": "string" + }, "stringRestrictions": { "$ref": "StringRestrictions", "description": "Restriction on STRING type value." @@ -5379,6 +5867,98 @@ }, "type": "object" }, + "UpgradeClusterStatus": { + "description": "Message for current status of the Major Version Upgrade operation.", + "id": "UpgradeClusterStatus", + "properties": { + "cancellable": { + "description": "Whether the operation is cancellable.", + "type": "boolean" + }, + "sourceVersion": { + "description": "Source database major version.", + "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" + }, + "stages": { + "description": "Status of all upgrade stages.", + "items": { + "$ref": "StageStatus" + }, + "type": "array" + }, + "state": { + "description": "Cluster Major Version Upgrade state.", + "enum": [ + "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified status.", + "Not started.", + "In progress.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." + ], + "type": "string" + }, + "targetVersion": { + "description": "Target database major version.", + "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" + }, "User": { "description": "Message describing User object.", "id": "User", diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 5355a4cf9cf..9067a4ba70f 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -146,7 +146,7 @@ export namespace alloydb_v1 { */ enabled?: boolean | null; /** - * Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data. + * Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config. */ encryptionConfig?: Schema$EncryptionConfig; /** @@ -310,6 +310,23 @@ export namespace alloydb_v1 { */ 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_v1 { * 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` */ @@ -503,7 +524,7 @@ export namespace alloydb_v1 { */ enabled?: boolean | null; /** - * The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data. + * The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config. */ encryptionConfig?: Schema$EncryptionConfig; /** @@ -566,6 +587,48 @@ export namespace alloydb_v1 { */ selectQuery?: string | null; } + /** + * Options for importing data in CSV format. + */ + export interface Schema$CsvImportOptions { + /** + * Optional. The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. + */ + columns?: string[] | null; + /** + * Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is same as quote character. The value of this argument has to be a character in Hex ASCII Code. + */ + escapeCharacter?: string | null; + /** + * Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code. + */ + fieldDelimiter?: string | null; + /** + * Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code. + */ + quoteCharacter?: string | null; + /** + * Required. The database table to import CSV file into. + */ + table?: string | null; + } + /** + * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date. + */ + export interface Schema$DenyMaintenancePeriod { + /** + * Deny period end date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring + */ + endDate?: Schema$GoogleTypeDate; + /** + * Deny period start date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring + */ + startDate?: Schema$GoogleTypeDate; + /** + * Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time OR * All zeros for 00:00:00 UTC + */ + time?: Schema$GoogleTypeTimeOfDay; + } /** * 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); \} */ @@ -682,6 +745,23 @@ export namespace alloydb_v1 { */ name?: 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 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`. */ @@ -703,6 +783,40 @@ export namespace alloydb_v1 { */ seconds?: number | null; } + /** + * Import cluster request. + */ + export interface Schema$ImportClusterRequest { + /** + * Options for importing data in CSV format. + */ + csvImportOptions?: Schema$CsvImportOptions; + /** + * Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference. + */ + database?: string | null; + /** + * Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`. + */ + gcsUri?: string | null; + /** + * Options for importing data in SQL format. + */ + sqlImportOptions?: Schema$SqlImportOptions; + /** + * Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference. + */ + user?: string | null; + } + /** + * Response of import rpc. + */ + export interface Schema$ImportClusterResponse { + /** + * Required. Size of the object downloaded from Google Cloud Storage in bytes. + */ + bytesDownloaded?: string | null; + } /** * Message for triggering fault injection on an instance */ @@ -788,6 +902,10 @@ export namespace alloydb_v1 { * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. */ nodes?: Schema$Node[]; + /** + * Configuration for observability. + */ + observabilityConfig?: Schema$ObservabilityInstanceConfig; /** * Output only. All outbound public IP addresses configured for the instance. */ @@ -849,6 +967,10 @@ export namespace alloydb_v1 { * Optional. Enabling public ip for the instance. */ enablePublicIp?: boolean | null; + /** + * Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number\}/global/networks/{network_id\}`. + */ + network?: string | null; } /** * Details regarding the upgrade of instaces associated with a cluster. @@ -982,6 +1104,10 @@ export namespace alloydb_v1 { * The number of CPU's in the VM instance. */ cpuCount?: number | null; + /** + * Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type. + */ + machineType?: string | null; } /** * MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead. @@ -996,6 +1122,10 @@ export namespace alloydb_v1 { * MaintenanceUpdatePolicy defines the policy for system updates. */ export interface Schema$MaintenanceUpdatePolicy { + /** + * Periods to deny maintenance. Currently limited to 1. + */ + denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[]; /** * Preferred windows to perform maintenance. Currently limited to 1. */ @@ -1045,7 +1175,7 @@ export namespace alloydb_v1 { network?: string | null; } /** - * Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations. + * Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. */ export interface Schema$Node { /** @@ -1065,6 +1195,43 @@ export namespace alloydb_v1 { */ zoneId?: string | null; } + /** + * Observability Instance specific configuration. + */ + export interface Schema$ObservabilityInstanceConfig { + /** + * Observability feature status for an instance. This flag is turned "off" by default. + */ + enabled?: boolean | null; + /** + * Query string length. The default value is 10k. + */ + maxQueryStringLength?: number | null; + /** + * Preserve comments in query string for an instance. This flag is turned "off" by default. + */ + preserveComments?: boolean | null; + /** + * 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; + /** + * Record application tags for an instance. This flag is turned "off" by default. + */ + recordApplicationTags?: boolean | null; + /** + * Track actively running queries on the instance. If not set, this flag is "off" by default. + */ + trackActiveQueries?: 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. + */ + trackWaitEvents?: boolean | null; + /** + * 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 internal API. + */ + trackWaitEventTypes?: boolean | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1118,6 +1285,10 @@ export namespace alloydb_v1 { * Output only. Server-defined resource path for the target of the operation. */ target?: string | null; + /** + * Output only. UpgradeClusterStatus related metadata. + */ + upgradeClusterStatus?: Schema$UpgradeClusterStatus; /** * Output only. Name of the verb executed by the operation. */ @@ -1149,6 +1320,31 @@ export namespace alloydb_v1 { */ validateOnly?: boolean | null; } + /** + * Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance. + */ + export interface Schema$PscAutoConnectionConfig { + /** + * The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. + */ + consumerNetwork?: string | null; + /** + * Output only. The status of the service connection policy. + */ + consumerNetworkStatus?: string | null; + /** + * The consumer project to which the PSC service automation endpoint will be created. + */ + consumerProject?: string | null; + /** + * Output only. The IP address of the PSC service automation endpoint. + */ + ipAddress?: string | null; + /** + * Output only. The status of the PSC service automation connection. + */ + status?: string | null; + } /** * PscConfig contains PSC related configuration at a cluster level. */ @@ -1157,6 +1353,10 @@ export namespace alloydb_v1 { * Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance. */ pscEnabled?: boolean | null; + /** + * Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity. + */ + serviceOwnedProjectNumber?: string | null; } /** * PscInstanceConfig contains PSC related configuration at an instance level. @@ -1166,15 +1366,32 @@ export namespace alloydb_v1 { * Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. */ allowedConsumerProjects?: string[] | null; + /** + * Optional. Configurations for setting up PSC service automation. + */ + pscAutoConnections?: Schema$PscAutoConnectionConfig[]; /** * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog */ pscDnsName?: string | null; + /** + * Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface. + */ + pscInterfaceConfigs?: Schema$PscInterfaceConfig[]; /** * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` */ serviceAttachmentLink?: string | null; } + /** + * Configuration for setting up a PSC interface to enable outbound connectivity. + */ + export interface Schema$PscInterfaceConfig { + /** + * The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}". The network attachment must be in the same region as the instance. + */ + networkAttachmentResource?: string | null; + } /** * A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3) */ @@ -1227,6 +1444,15 @@ export namespace alloydb_v1 { */ nodeCount?: number | null; } + /** + * Read pool instances upgrade specific status. + */ + export interface Schema$ReadPoolInstancesUpgradeStageStatus { + /** + * Read pool instances upgrade statistics. + */ + upgradeStats?: Schema$Stats; + } export interface Schema$RestartInstanceRequest { /** * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances. @@ -1270,6 +1496,23 @@ export namespace alloydb_v1 { */ validateOnly?: boolean | null; } + /** + * Message for registering Restoring from CloudSQL resource. + */ + export interface Schema$RestoreFromCloudSQLRequest { + /** + * Cluster created from CloudSQL backup run. + */ + cloudsqlBackupRunSource?: Schema$CloudSQLBackupRunSource; + /** + * Required. The resource being created + */ + cluster?: Schema$Cluster; + /** + * Required. ID of the requesting object. + */ + clusterId?: string | null; + } /** * Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. */ @@ -1300,6 +1543,10 @@ export namespace alloydb_v1 { */ tables?: string[] | null; } + /** + * Options for importing data in SQL format. + */ + export interface Schema$SqlImportOptions {} /** * SSL configuration. */ @@ -1330,6 +1577,44 @@ export namespace alloydb_v1 { */ status?: string | null; } + /** + * Status of an upgrade stage. + */ + export interface Schema$StageStatus { + /** + * Read pool instances upgrade metadata. + */ + readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus; + /** + * Upgrade stage. + */ + stage?: string | null; + /** + * State of this stage. + */ + state?: string | null; + } + /** + * Upgrade stats for read pool instances. + */ + export interface Schema$Stats { + /** + * Number of read pool instances which failed to upgrade. + */ + failed?: number | null; + /** + * Number of read pool instances for which upgrade has not started. + */ + notStarted?: number | null; + /** + * Number of read pool instances undergoing upgrade. + */ + ongoing?: number | null; + /** + * Number of read pool instances successfully upgraded. + */ + success?: number | 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). */ @@ -1527,7 +1812,7 @@ export namespace alloydb_v1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 23 + * Common model for database resource instance metadata. Next ID: 25 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -1566,6 +1851,10 @@ export namespace alloydb_v1 { * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. */ expectedState?: string | null; + /** + * GCBDR configuration for the resource. + */ + gcbdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration; /** * Required. Unique identifier for a Database resource */ @@ -1602,6 +1891,10 @@ export namespace alloydb_v1 { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Suspension reason for the resource. + */ + suspensionReason?: string | null; /** * Optional. Tags associated with this resources. */ @@ -1665,6 +1958,15 @@ export namespace alloydb_v1 { */ type?: string | null; } + /** + * GCBDR Configuration for the resource. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration { + /** + * Whether the resource is managed by GCBDR. + */ + gcbdrManaged?: boolean | 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. */ @@ -1677,6 +1979,10 @@ export namespace alloydb_v1 { * Information about the last backup attempt for this database */ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun; + /** + * Whether deletion protection is enabled for this internal resource. + */ + isDeletionProtectionEnabled?: boolean | null; product?: Schema$StorageDatabasecenterProtoCommonProduct; resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1689,11 +1995,11 @@ export namespace alloydb_v1 { */ export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration { /** - * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix. */ cpuCount?: number | null; /** - * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; /** @@ -1701,7 +2007,7 @@ export namespace alloydb_v1 { */ shardCount?: number | null; /** - * Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix. */ vcpuCount?: number | null; } @@ -1839,10 +2145,22 @@ export namespace alloydb_v1 { * The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project\}/locations/{location\}/flags/{flag\} This field currently has no semantic meaning. */ name?: string | null; + /** + * The recommended value for an INTEGER flag. + */ + recommendedIntegerValue?: string | null; + /** + * The recommended value for a STRING flag. + */ + recommendedStringValue?: string | null; /** * Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's). */ requiresDbRestart?: boolean | null; + /** + * The scope of the flag. + */ + scope?: string | null; /** * Restriction on STRING type value. */ @@ -1934,6 +2252,31 @@ export namespace alloydb_v1 { */ status?: string | null; } + /** + * Message for current status of the Major Version Upgrade operation. + */ + export interface Schema$UpgradeClusterStatus { + /** + * Whether the operation is cancellable. + */ + cancellable?: boolean | null; + /** + * Source database major version. + */ + sourceVersion?: string | null; + /** + * Status of all upgrade stages. + */ + stages?: Schema$StageStatus[]; + /** + * Cluster Major Version Upgrade state. + */ + state?: string | null; + /** + * Target database major version. + */ + targetVersion?: string | null; + } /** * Message describing User object. */ @@ -3216,6 +3559,91 @@ export namespace alloydb_v1 { } } + /** + * Imports data to the 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. + */ + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Clusters$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + callback: BodyResponseCallback + ): void; + import(callback: BodyResponseCallback): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:import').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); + } + } + /** * Lists Clusters in a given project and location. * @@ -3570,6 +3998,94 @@ export namespace alloydb_v1 { } } + /** + * Restores an AlloyDB cluster from a CloudSQL 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. + */ + restoreFromCloudSQL( + params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, + options: StreamMethodOptions + ): GaxiosPromise; + restoreFromCloudSQL( + params?: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, + options?: MethodOptions + ): GaxiosPromise; + restoreFromCloudSQL( + params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restoreFromCloudSQL( + params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restoreFromCloudSQL( + params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, + callback: BodyResponseCallback + ): void; + restoreFromCloudSQL(callback: BodyResponseCallback): void; + restoreFromCloudSQL( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/clusters:restoreFromCloudSQL' + ).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); + } + } + /** * Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster. * @@ -3841,6 +4357,18 @@ export namespace alloydb_v1 { */ view?: string; } + export interface Params$Resource$Projects$Locations$Clusters$Import + extends StandardParameters { + /** + * Required. The resource name of the cluster. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportClusterRequest; + } export interface Params$Resource$Projects$Locations$Clusters$List extends StandardParameters { /** @@ -3916,6 +4444,18 @@ export namespace alloydb_v1 { */ requestBody?: Schema$RestoreClusterRequest; } + export interface Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql + extends StandardParameters { + /** + * Required. The location of the new cluster. For the required format, see the comment on Cluster.name field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreFromCloudSQLRequest; + } export interface Params$Resource$Projects$Locations$Clusters$Switchover extends StandardParameters { /** @@ -6072,5 +6612,9 @@ export namespace alloydb_v1 { * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags. */ parent?: string; + /** + * Optional. The scope for which supported flags are requested. If not specified, default is DATABASE. + */ + scope?: string; } } diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index e3cffdf6c41..514a98a6e12 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -146,7 +146,7 @@ export namespace alloydb_v1alpha { */ enabled?: boolean | null; /** - * Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data. + * Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config. */ encryptionConfig?: Schema$EncryptionConfig; /** @@ -544,7 +544,7 @@ export namespace alloydb_v1alpha { */ enabled?: boolean | null; /** - * The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data. + * The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config. */ encryptionConfig?: Schema$EncryptionConfig; /** @@ -607,6 +607,48 @@ export namespace alloydb_v1alpha { */ selectQuery?: string | null; } + /** + * Options for importing data in CSV format. + */ + export interface Schema$CsvImportOptions { + /** + * Optional. The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. + */ + columns?: string[] | null; + /** + * Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is same as quote character. The value of this argument has to be a character in Hex ASCII Code. + */ + escapeCharacter?: string | null; + /** + * Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code. + */ + fieldDelimiter?: string | null; + /** + * Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code. + */ + quoteCharacter?: string | null; + /** + * Required. The database table to import CSV file into. + */ + table?: string | null; + } + /** + * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date. + */ + export interface Schema$DenyMaintenancePeriod { + /** + * Deny period end date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring + */ + endDate?: Schema$GoogleTypeDate; + /** + * Deny period start date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring + */ + startDate?: Schema$GoogleTypeDate; + /** + * Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time OR * All zeros for 00:00:00 UTC + */ + time?: Schema$GoogleTypeTimeOfDay; + } /** * 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); \} */ @@ -667,6 +709,15 @@ export namespace alloydb_v1alpha { */ validateOnly?: boolean | null; } + /** + * Instance level configuration parameters related to the Gemini Cloud Assist product. + */ + export interface Schema$GCAInstanceConfig { + /** + * Output only. Represents the GCA entitlement state of the instance. + */ + gcaEntitlement?: string | null; + } /** * Destination for Export. Export will be done to cloud storage. */ @@ -732,6 +783,23 @@ export namespace alloydb_v1alpha { */ name?: 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 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`. */ @@ -753,6 +821,31 @@ export namespace alloydb_v1alpha { */ seconds?: number | null; } + /** + * Import cluster request. + */ + export interface Schema$ImportClusterRequest { + /** + * Options for importing data in CSV format. + */ + csvImportOptions?: Schema$CsvImportOptions; + /** + * Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference. + */ + database?: string | null; + /** + * Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`. + */ + gcsUri?: string | null; + /** + * Options for importing data in SQL format. + */ + sqlImportOptions?: Schema$SqlImportOptions; + /** + * Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference. + */ + user?: string | null; + } /** * Message for triggering fault injection on an instance */ @@ -806,6 +899,10 @@ export namespace alloydb_v1alpha { * For Resource freshness validation (https://google.aip.dev/154) */ etag?: string | null; + /** + * Output only. Configuration parameters related to Gemini Cloud Assist. + */ + gcaConfig?: Schema$GCAInstanceConfig; /** * The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. */ @@ -915,6 +1012,10 @@ export namespace alloydb_v1alpha { * Optional. Enabling public ip for the instance. */ enablePublicIp?: boolean | null; + /** + * Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number\}/global/networks/{network_id\}`. + */ + network?: string | null; } /** * Details regarding the upgrade of instaces associated with a cluster. @@ -1048,6 +1149,10 @@ export namespace alloydb_v1alpha { * The number of CPU's in the VM instance. */ cpuCount?: number | null; + /** + * Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type. + */ + machineType?: string | null; } /** * MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead. @@ -1062,6 +1167,10 @@ export namespace alloydb_v1alpha { * MaintenanceUpdatePolicy defines the policy for system updates. */ export interface Schema$MaintenanceUpdatePolicy { + /** + * Periods to deny maintenance. Currently limited to 1. + */ + denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[]; /** * Preferred windows to perform maintenance. Currently limited to 1. */ @@ -1111,7 +1220,7 @@ export namespace alloydb_v1alpha { network?: string | null; } /** - * Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations. + * Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. */ export interface Schema$Node { /** @@ -1135,6 +1244,10 @@ export namespace alloydb_v1alpha { * Observability Instance specific configuration. */ export interface Schema$ObservabilityInstanceConfig { + /** + * Whether assistive experiences are enabled for this AlloyDB instance. + */ + assistiveExperiencesEnabled?: boolean | null; /** * Observability feature status for an instance. This flag is turned "off" by default. */ @@ -1159,16 +1272,12 @@ 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. */ trackWaitEvents?: boolean | null; /** - * 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. + * 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 internal API. */ trackWaitEventTypes?: boolean | null; } @@ -1225,6 +1334,10 @@ export namespace alloydb_v1alpha { * Output only. Server-defined resource path for the target of the operation. */ target?: string | null; + /** + * Output only. UpgradeClusterStatus related metadata. + */ + upgradeClusterStatus?: Schema$UpgradeClusterStatus; /** * Output only. Name of the verb executed by the operation. */ @@ -1256,6 +1369,31 @@ export namespace alloydb_v1alpha { */ validateOnly?: boolean | null; } + /** + * Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance. + */ + export interface Schema$PscAutoConnectionConfig { + /** + * The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. + */ + consumerNetwork?: string | null; + /** + * Output only. The status of the service connection policy. + */ + consumerNetworkStatus?: string | null; + /** + * The consumer project to which the PSC service automation endpoint will be created. + */ + consumerProject?: string | null; + /** + * Output only. The IP address of the PSC service automation endpoint. + */ + ipAddress?: string | null; + /** + * Output only. The status of the PSC service automation connection. + */ + status?: string | null; + } /** * PscConfig contains PSC related configuration at a cluster level. */ @@ -1277,6 +1415,10 @@ export namespace alloydb_v1alpha { * Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. */ allowedConsumerProjects?: string[] | null; + /** + * Optional. Configurations for setting up PSC service automation. + */ + pscAutoConnections?: Schema$PscAutoConnectionConfig[]; /** * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog */ @@ -1351,6 +1493,15 @@ export namespace alloydb_v1alpha { */ nodeCount?: number | null; } + /** + * Read pool instances upgrade specific status. + */ + export interface Schema$ReadPoolInstancesUpgradeStageStatus { + /** + * Read pool instances upgrade statistics. + */ + upgradeStats?: Schema$Stats; + } export interface Schema$RestartInstanceRequest { /** * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances. @@ -1441,6 +1592,10 @@ export namespace alloydb_v1alpha { */ tables?: string[] | null; } + /** + * Options for importing data in SQL format. + */ + export interface Schema$SqlImportOptions {} /** * SSL configuration. */ @@ -1471,6 +1626,44 @@ export namespace alloydb_v1alpha { */ status?: string | null; } + /** + * Status of an upgrade stage. + */ + export interface Schema$StageStatus { + /** + * Read pool instances upgrade metadata. + */ + readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus; + /** + * Upgrade stage. + */ + stage?: string | null; + /** + * State of this stage. + */ + state?: string | null; + } + /** + * Upgrade stats for read pool instances. + */ + export interface Schema$Stats { + /** + * Number of read pool instances which failed to upgrade. + */ + failed?: number | null; + /** + * Number of read pool instances for which upgrade has not started. + */ + notStarted?: number | null; + /** + * Number of read pool instances undergoing upgrade. + */ + ongoing?: number | null; + /** + * Number of read pool instances successfully upgraded. + */ + success?: number | 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). */ @@ -1668,7 +1861,7 @@ export namespace alloydb_v1alpha { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 23 + * Common model for database resource instance metadata. Next ID: 25 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -1707,6 +1900,10 @@ export namespace alloydb_v1alpha { * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. */ expectedState?: string | null; + /** + * GCBDR configuration for the resource. + */ + gcbdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration; /** * Required. Unique identifier for a Database resource */ @@ -1743,6 +1940,10 @@ export namespace alloydb_v1alpha { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Suspension reason for the resource. + */ + suspensionReason?: string | null; /** * Optional. Tags associated with this resources. */ @@ -1806,6 +2007,15 @@ export namespace alloydb_v1alpha { */ type?: string | null; } + /** + * GCBDR Configuration for the resource. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration { + /** + * Whether the resource is managed by GCBDR. + */ + gcbdrManaged?: boolean | 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. */ @@ -1818,6 +2028,10 @@ export namespace alloydb_v1alpha { * Information about the last backup attempt for this database */ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun; + /** + * Whether deletion protection is enabled for this internal resource. + */ + isDeletionProtectionEnabled?: boolean | null; product?: Schema$StorageDatabasecenterProtoCommonProduct; resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1830,11 +2044,11 @@ export namespace alloydb_v1alpha { */ export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration { /** - * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix. */ cpuCount?: number | null; /** - * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; /** @@ -1842,7 +2056,7 @@ export namespace alloydb_v1alpha { */ shardCount?: number | null; /** - * Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix. */ vcpuCount?: number | null; } @@ -1980,10 +2194,22 @@ export namespace alloydb_v1alpha { * The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project\}/locations/{location\}/flags/{flag\} This field currently has no semantic meaning. */ name?: string | null; + /** + * The recommended value for an INTEGER flag. + */ + recommendedIntegerValue?: string | null; + /** + * The recommended value for a STRING flag. + */ + recommendedStringValue?: string | null; /** * Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's). */ requiresDbRestart?: boolean | null; + /** + * The scope of the flag. + */ + scope?: string | null; /** * Restriction on STRING type value. */ @@ -2084,6 +2310,31 @@ export namespace alloydb_v1alpha { */ status?: string | null; } + /** + * Message for current status of the Major Version Upgrade operation. + */ + export interface Schema$UpgradeClusterStatus { + /** + * Whether the operation is cancellable. + */ + cancellable?: boolean | null; + /** + * Source database major version. + */ + sourceVersion?: string | null; + /** + * Status of all upgrade stages. + */ + stages?: Schema$StageStatus[]; + /** + * Cluster Major Version Upgrade state. + */ + state?: string | null; + /** + * Target database major version. + */ + targetVersion?: string | null; + } /** * Message describing User object. */ @@ -3368,6 +3619,94 @@ export namespace alloydb_v1alpha { } } + /** + * Imports data to the 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. + */ + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Clusters$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + callback: BodyResponseCallback + ): void; + import(callback: BodyResponseCallback): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Import; + 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}:import').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); + } + } + /** * Lists Clusters in a given project and location. * @@ -4081,6 +4420,18 @@ export namespace alloydb_v1alpha { */ view?: string; } + export interface Params$Resource$Projects$Locations$Clusters$Import + extends StandardParameters { + /** + * Required. The resource name of the cluster. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportClusterRequest; + } export interface Params$Resource$Projects$Locations$Clusters$List extends StandardParameters { /** @@ -6325,5 +6676,9 @@ export namespace alloydb_v1alpha { * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags. */ parent?: string; + /** + * Optional. The scope for which supported flags are requested. If not specified, default is DATABASE. + */ + scope?: string; } } diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 9ff546cc40f..572f619bb85 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -146,7 +146,7 @@ export namespace alloydb_v1beta { */ enabled?: boolean | null; /** - * Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data. + * Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config. */ encryptionConfig?: Schema$EncryptionConfig; /** @@ -532,7 +532,7 @@ export namespace alloydb_v1beta { */ enabled?: boolean | null; /** - * The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data. + * The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config. */ encryptionConfig?: Schema$EncryptionConfig; /** @@ -595,6 +595,48 @@ export namespace alloydb_v1beta { */ selectQuery?: string | null; } + /** + * Options for importing data in CSV format. + */ + export interface Schema$CsvImportOptions { + /** + * Optional. The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. + */ + columns?: string[] | null; + /** + * Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is same as quote character. The value of this argument has to be a character in Hex ASCII Code. + */ + escapeCharacter?: string | null; + /** + * Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code. + */ + fieldDelimiter?: string | null; + /** + * Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code. + */ + quoteCharacter?: string | null; + /** + * Required. The database table to import CSV file into. + */ + table?: string | null; + } + /** + * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date. + */ + export interface Schema$DenyMaintenancePeriod { + /** + * Deny period end date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring + */ + endDate?: Schema$GoogleTypeDate; + /** + * Deny period start date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring + */ + startDate?: Schema$GoogleTypeDate; + /** + * Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time OR * All zeros for 00:00:00 UTC + */ + time?: Schema$GoogleTypeTimeOfDay; + } /** * 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); \} */ @@ -655,6 +697,15 @@ export namespace alloydb_v1beta { */ validateOnly?: boolean | null; } + /** + * Instance level configuration parameters related to the Gemini Cloud Assist product. + */ + export interface Schema$GCAInstanceConfig { + /** + * Output only. Represents the GCA entitlement state of the instance. + */ + gcaEntitlement?: string | null; + } /** * Destination for Export. Export will be done to cloud storage. */ @@ -720,6 +771,23 @@ export namespace alloydb_v1beta { */ name?: 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 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`. */ @@ -741,6 +809,31 @@ export namespace alloydb_v1beta { */ seconds?: number | null; } + /** + * Import cluster request. + */ + export interface Schema$ImportClusterRequest { + /** + * Options for importing data in CSV format. + */ + csvImportOptions?: Schema$CsvImportOptions; + /** + * Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference. + */ + database?: string | null; + /** + * Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`. + */ + gcsUri?: string | null; + /** + * Options for importing data in SQL format. + */ + sqlImportOptions?: Schema$SqlImportOptions; + /** + * Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference. + */ + user?: string | null; + } /** * Message for triggering fault injection on an instance */ @@ -794,6 +887,10 @@ export namespace alloydb_v1beta { * For Resource freshness validation (https://google.aip.dev/154) */ etag?: string | null; + /** + * Output only. Configuration parameters related to Gemini Cloud Assist. + */ + gcaConfig?: Schema$GCAInstanceConfig; /** * The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. */ @@ -899,6 +996,10 @@ export namespace alloydb_v1beta { * Optional. Enabling public ip for the instance. */ enablePublicIp?: boolean | null; + /** + * Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number\}/global/networks/{network_id\}`. + */ + network?: string | null; } /** * Details regarding the upgrade of instaces associated with a cluster. @@ -1032,6 +1133,10 @@ export namespace alloydb_v1beta { * The number of CPU's in the VM instance. */ cpuCount?: number | null; + /** + * Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type. + */ + machineType?: string | null; } /** * MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead. @@ -1046,6 +1151,10 @@ export namespace alloydb_v1beta { * MaintenanceUpdatePolicy defines the policy for system updates. */ export interface Schema$MaintenanceUpdatePolicy { + /** + * Periods to deny maintenance. Currently limited to 1. + */ + denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[]; /** * Preferred windows to perform maintenance. Currently limited to 1. */ @@ -1095,7 +1204,7 @@ export namespace alloydb_v1beta { network?: string | null; } /** - * Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations. + * Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations. */ export interface Schema$Node { /** @@ -1119,6 +1228,10 @@ export namespace alloydb_v1beta { * Observability Instance specific configuration. */ export interface Schema$ObservabilityInstanceConfig { + /** + * Whether assistive experiences are enabled for this AlloyDB instance. + */ + assistiveExperiencesEnabled?: boolean | null; /** * Observability feature status for an instance. This flag is turned "off" by default. */ @@ -1143,16 +1256,12 @@ export namespace alloydb_v1beta { * 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. */ trackWaitEvents?: boolean | null; /** - * 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. + * 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 internal API. */ trackWaitEventTypes?: boolean | null; } @@ -1209,6 +1318,10 @@ export namespace alloydb_v1beta { * Output only. Server-defined resource path for the target of the operation. */ target?: string | null; + /** + * Output only. UpgradeClusterStatus related metadata. + */ + upgradeClusterStatus?: Schema$UpgradeClusterStatus; /** * Output only. Name of the verb executed by the operation. */ @@ -1240,6 +1353,31 @@ export namespace alloydb_v1beta { */ validateOnly?: boolean | null; } + /** + * Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance. + */ + export interface Schema$PscAutoConnectionConfig { + /** + * The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. + */ + consumerNetwork?: string | null; + /** + * Output only. The status of the service connection policy. + */ + consumerNetworkStatus?: string | null; + /** + * The consumer project to which the PSC service automation endpoint will be created. + */ + consumerProject?: string | null; + /** + * Output only. The IP address of the PSC service automation endpoint. + */ + ipAddress?: string | null; + /** + * Output only. The status of the PSC service automation connection. + */ + status?: string | null; + } /** * PscConfig contains PSC related configuration at a cluster level. */ @@ -1248,6 +1386,10 @@ export namespace alloydb_v1beta { * Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance. */ pscEnabled?: boolean | null; + /** + * Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity. + */ + serviceOwnedProjectNumber?: string | null; } /** * PscInstanceConfig contains PSC related configuration at an instance level. @@ -1257,15 +1399,32 @@ export namespace alloydb_v1beta { * Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. */ allowedConsumerProjects?: string[] | null; + /** + * Optional. Configurations for setting up PSC service automation. + */ + pscAutoConnections?: Schema$PscAutoConnectionConfig[]; /** * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog */ pscDnsName?: string | null; + /** + * Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface. + */ + pscInterfaceConfigs?: Schema$PscInterfaceConfig[]; /** * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` */ serviceAttachmentLink?: string | null; } + /** + * Configuration for setting up a PSC interface to enable outbound connectivity. + */ + export interface Schema$PscInterfaceConfig { + /** + * The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}". The network attachment must be in the same region as the instance. + */ + networkAttachmentResource?: string | null; + } /** * A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3) */ @@ -1318,6 +1477,15 @@ export namespace alloydb_v1beta { */ nodeCount?: number | null; } + /** + * Read pool instances upgrade specific status. + */ + export interface Schema$ReadPoolInstancesUpgradeStageStatus { + /** + * Read pool instances upgrade statistics. + */ + upgradeStats?: Schema$Stats; + } export interface Schema$RestartInstanceRequest { /** * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances. @@ -1408,6 +1576,10 @@ export namespace alloydb_v1beta { */ tables?: string[] | null; } + /** + * Options for importing data in SQL format. + */ + export interface Schema$SqlImportOptions {} /** * SSL configuration. */ @@ -1438,6 +1610,44 @@ export namespace alloydb_v1beta { */ status?: string | null; } + /** + * Status of an upgrade stage. + */ + export interface Schema$StageStatus { + /** + * Read pool instances upgrade metadata. + */ + readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus; + /** + * Upgrade stage. + */ + stage?: string | null; + /** + * State of this stage. + */ + state?: string | null; + } + /** + * Upgrade stats for read pool instances. + */ + export interface Schema$Stats { + /** + * Number of read pool instances which failed to upgrade. + */ + failed?: number | null; + /** + * Number of read pool instances for which upgrade has not started. + */ + notStarted?: number | null; + /** + * Number of read pool instances undergoing upgrade. + */ + ongoing?: number | null; + /** + * Number of read pool instances successfully upgraded. + */ + success?: number | 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). */ @@ -1635,7 +1845,7 @@ export namespace alloydb_v1beta { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 23 + * Common model for database resource instance metadata. Next ID: 25 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -1674,6 +1884,10 @@ export namespace alloydb_v1beta { * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. */ expectedState?: string | null; + /** + * GCBDR configuration for the resource. + */ + gcbdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration; /** * Required. Unique identifier for a Database resource */ @@ -1710,6 +1924,10 @@ export namespace alloydb_v1beta { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Suspension reason for the resource. + */ + suspensionReason?: string | null; /** * Optional. Tags associated with this resources. */ @@ -1773,6 +1991,15 @@ export namespace alloydb_v1beta { */ type?: string | null; } + /** + * GCBDR Configuration for the resource. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration { + /** + * Whether the resource is managed by GCBDR. + */ + gcbdrManaged?: boolean | 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. */ @@ -1785,6 +2012,10 @@ export namespace alloydb_v1beta { * Information about the last backup attempt for this database */ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun; + /** + * Whether deletion protection is enabled for this internal resource. + */ + isDeletionProtectionEnabled?: boolean | null; product?: Schema$StorageDatabasecenterProtoCommonProduct; resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1797,11 +2028,11 @@ export namespace alloydb_v1beta { */ export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration { /** - * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix. */ cpuCount?: number | null; /** - * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; /** @@ -1809,7 +2040,7 @@ export namespace alloydb_v1beta { */ shardCount?: number | null; /** - * Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix. */ vcpuCount?: number | null; } @@ -1947,10 +2178,22 @@ export namespace alloydb_v1beta { * The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project\}/locations/{location\}/flags/{flag\} This field currently has no semantic meaning. */ name?: string | null; + /** + * The recommended value for an INTEGER flag. + */ + recommendedIntegerValue?: string | null; + /** + * The recommended value for a STRING flag. + */ + recommendedStringValue?: string | null; /** * Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's). */ requiresDbRestart?: boolean | null; + /** + * The scope of the flag. + */ + scope?: string | null; /** * Restriction on STRING type value. */ @@ -2051,6 +2294,31 @@ export namespace alloydb_v1beta { */ status?: string | null; } + /** + * Message for current status of the Major Version Upgrade operation. + */ + export interface Schema$UpgradeClusterStatus { + /** + * Whether the operation is cancellable. + */ + cancellable?: boolean | null; + /** + * Source database major version. + */ + sourceVersion?: string | null; + /** + * Status of all upgrade stages. + */ + stages?: Schema$StageStatus[]; + /** + * Cluster Major Version Upgrade state. + */ + state?: string | null; + /** + * Target database major version. + */ + targetVersion?: string | null; + } /** * Message describing User object. */ @@ -3335,6 +3603,94 @@ export namespace alloydb_v1beta { } } + /** + * Imports data to the 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. + */ + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Clusters$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Clusters$Import, + callback: BodyResponseCallback + ): void; + import(callback: BodyResponseCallback): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:import').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); + } + } + /** * Lists Clusters in a given project and location. * @@ -4048,6 +4404,18 @@ export namespace alloydb_v1beta { */ view?: string; } + export interface Params$Resource$Projects$Locations$Clusters$Import + extends StandardParameters { + /** + * Required. The resource name of the cluster. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportClusterRequest; + } export interface Params$Resource$Projects$Locations$Clusters$List extends StandardParameters { /** @@ -6288,5 +6656,9 @@ export namespace alloydb_v1beta { * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags. */ parent?: string; + /** + * Optional. The scope for which supported flags are requested. If not specified, default is DATABASE. + */ + scope?: string; } } From 7ac4ed3e6aedb24bf46f188a3e33badb40105db9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:39 +0000 Subject: [PATCH 006/144] feat(analyticsadmin): update the API #### analyticsadmin:v1alpha The following keys were added: - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.keyEvent.$ref - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.keyEvent.description - schemas.GoogleAnalyticsAdminV1alphaDataSharingSettings.properties.sharingWithGoogleAnySalesEnabled.deprecated The following keys were changed: - schemas.GoogleAnalyticsAdminV1alphaDataSharingSettings.properties.sharingWithGoogleAnySalesEnabled.description - schemas.GoogleAnalyticsAdminV1alphaDataSharingSettings.properties.sharingWithGoogleAssignedSalesEnabled.description - schemas.GoogleAnalyticsAdminV1alphaDataSharingSettings.properties.sharingWithGoogleProductsEnabled.description - schemas.GoogleAnalyticsAdminV1alphaDataSharingSettings.properties.sharingWithGoogleSupportEnabled.description - schemas.GoogleAnalyticsAdminV1alphaDataSharingSettings.properties.sharingWithOthersEnabled.description - schemas.GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest.properties.resourceType.items.enum - schemas.GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest.properties.resourceType.items.enumDescriptions #### analyticsadmin:v1beta The following keys were added: - schemas.GoogleAnalyticsAdminV1betaDataSharingSettings.properties.sharingWithGoogleAnySalesEnabled.deprecated The following keys were changed: - schemas.GoogleAnalyticsAdminV1betaDataSharingSettings.properties.sharingWithGoogleAnySalesEnabled.description - schemas.GoogleAnalyticsAdminV1betaDataSharingSettings.properties.sharingWithGoogleAssignedSalesEnabled.description - schemas.GoogleAnalyticsAdminV1betaDataSharingSettings.properties.sharingWithGoogleProductsEnabled.description - schemas.GoogleAnalyticsAdminV1betaDataSharingSettings.properties.sharingWithGoogleSupportEnabled.description - schemas.GoogleAnalyticsAdminV1betaDataSharingSettings.properties.sharingWithOthersEnabled.description --- discovery/analyticsadmin-v1alpha.json | 19 +++++++++++++------ discovery/analyticsadmin-v1beta.json | 13 +++++++------ src/apis/analyticsadmin/v1alpha.ts | 14 +++++++++----- src/apis/analyticsadmin/v1beta.ts | 10 +++++----- 4 files changed, 34 insertions(+), 22 deletions(-) diff --git a/discovery/analyticsadmin-v1alpha.json b/discovery/analyticsadmin-v1alpha.json index 4fbd80bc614..a31c32eea10 100644 --- a/discovery/analyticsadmin-v1alpha.json +++ b/discovery/analyticsadmin-v1alpha.json @@ -4886,7 +4886,7 @@ } } }, - "revision": "20250114", + "revision": "20250307", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -6258,6 +6258,10 @@ "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings", "description": "A snapshot of a GoogleSignalsSettings resource in change history." }, + "keyEvent": { + "$ref": "GoogleAnalyticsAdminV1alphaKeyEvent", + "description": "A snapshot of a KeyEvent resource in change history." + }, "measurementProtocolSecret": { "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret", "description": "A snapshot of a MeasurementProtocolSecret resource in change history." @@ -6879,23 +6883,24 @@ "type": "string" }, "sharingWithGoogleAnySalesEnabled": { - "description": "Allows any of Google sales to access the data in order to suggest configuration changes to improve results.", + "deprecated": true, + "description": "Deprecated. This field is no longer used and always returns false.", "type": "boolean" }, "sharingWithGoogleAssignedSalesEnabled": { - "description": "Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.", + "description": "Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the \"Recommendations for your business\" field in the Google Analytics Admin UI.", "type": "boolean" }, "sharingWithGoogleProductsEnabled": { - "description": "Allows Google to use the data to improve other Google products or services.", + "description": "Allows Google to use the data to improve other Google products or services. This fields maps to the \"Google products & services\" field in the Google Analytics Admin UI.", "type": "boolean" }, "sharingWithGoogleSupportEnabled": { - "description": "Allows Google support to access the data in order to help troubleshoot issues.", + "description": "Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the \"Technical support\" field in the Google Analytics Admin UI.", "type": "boolean" }, "sharingWithOthersEnabled": { - "description": "Allows Google to share the data anonymously in aggregate form with others.", + "description": "Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the \"Modeling contributions & business insights\" field in the Google Analytics Admin UI.", "type": "boolean" } }, @@ -8835,6 +8840,7 @@ "ADSENSE_LINK", "AUDIENCE", "EVENT_CREATE_RULE", + "KEY_EVENT", "CALCULATED_METRIC" ], "enumDescriptions": [ @@ -8863,6 +8869,7 @@ "AdSenseLink resource", "Audience resource", "EventCreateRule resource", + "KeyEvent resource", "CalculatedMetric resource" ], "type": "string" diff --git a/discovery/analyticsadmin-v1beta.json b/discovery/analyticsadmin-v1beta.json index 3308ee5f33e..8e9e3bc7849 100644 --- a/discovery/analyticsadmin-v1beta.json +++ b/discovery/analyticsadmin-v1beta.json @@ -1788,7 +1788,7 @@ } } }, - "revision": "20250114", + "revision": "20250307", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -2636,23 +2636,24 @@ "type": "string" }, "sharingWithGoogleAnySalesEnabled": { - "description": "Allows any of Google sales to access the data in order to suggest configuration changes to improve results.", + "deprecated": true, + "description": "Deprecated. This field is no longer used and always returns false.", "type": "boolean" }, "sharingWithGoogleAssignedSalesEnabled": { - "description": "Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.", + "description": "Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the \"Recommendations for your business\" field in the Google Analytics Admin UI.", "type": "boolean" }, "sharingWithGoogleProductsEnabled": { - "description": "Allows Google to use the data to improve other Google products or services.", + "description": "Allows Google to use the data to improve other Google products or services. This fields maps to the \"Google products & services\" field in the Google Analytics Admin UI.", "type": "boolean" }, "sharingWithGoogleSupportEnabled": { - "description": "Allows Google support to access the data in order to help troubleshoot issues.", + "description": "Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the \"Technical support\" field in the Google Analytics Admin UI.", "type": "boolean" }, "sharingWithOthersEnabled": { - "description": "Allows Google to share the data anonymously in aggregate form with others.", + "description": "Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the \"Modeling contributions & business insights\" field in the Google Analytics Admin UI.", "type": "boolean" } }, diff --git a/src/apis/analyticsadmin/v1alpha.ts b/src/apis/analyticsadmin/v1alpha.ts index ea86943ffbd..2cc29f45d1a 100644 --- a/src/apis/analyticsadmin/v1alpha.ts +++ b/src/apis/analyticsadmin/v1alpha.ts @@ -1063,6 +1063,10 @@ export namespace analyticsadmin_v1alpha { * A snapshot of a GoogleSignalsSettings resource in change history. */ googleSignalsSettings?: Schema$GoogleAnalyticsAdminV1alphaGoogleSignalsSettings; + /** + * A snapshot of a KeyEvent resource in change history. + */ + keyEvent?: Schema$GoogleAnalyticsAdminV1alphaKeyEvent; /** * A snapshot of a MeasurementProtocolSecret resource in change history. */ @@ -1460,23 +1464,23 @@ export namespace analyticsadmin_v1alpha { */ name?: string | null; /** - * Allows any of Google sales to access the data in order to suggest configuration changes to improve results. + * Deprecated. This field is no longer used and always returns false. */ sharingWithGoogleAnySalesEnabled?: boolean | null; /** - * Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled. + * Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the "Recommendations for your business" field in the Google Analytics Admin UI. */ sharingWithGoogleAssignedSalesEnabled?: boolean | null; /** - * Allows Google to use the data to improve other Google products or services. + * Allows Google to use the data to improve other Google products or services. This fields maps to the "Google products & services" field in the Google Analytics Admin UI. */ sharingWithGoogleProductsEnabled?: boolean | null; /** - * Allows Google support to access the data in order to help troubleshoot issues. + * Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the "Technical support" field in the Google Analytics Admin UI. */ sharingWithGoogleSupportEnabled?: boolean | null; /** - * Allows Google to share the data anonymously in aggregate form with others. + * Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the "Modeling contributions & business insights" field in the Google Analytics Admin UI. */ sharingWithOthersEnabled?: boolean | null; } diff --git a/src/apis/analyticsadmin/v1beta.ts b/src/apis/analyticsadmin/v1beta.ts index ac17873accd..27033475c3d 100644 --- a/src/apis/analyticsadmin/v1beta.ts +++ b/src/apis/analyticsadmin/v1beta.ts @@ -696,23 +696,23 @@ export namespace analyticsadmin_v1beta { */ name?: string | null; /** - * Allows any of Google sales to access the data in order to suggest configuration changes to improve results. + * Deprecated. This field is no longer used and always returns false. */ sharingWithGoogleAnySalesEnabled?: boolean | null; /** - * Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled. + * Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the "Recommendations for your business" field in the Google Analytics Admin UI. */ sharingWithGoogleAssignedSalesEnabled?: boolean | null; /** - * Allows Google to use the data to improve other Google products or services. + * Allows Google to use the data to improve other Google products or services. This fields maps to the "Google products & services" field in the Google Analytics Admin UI. */ sharingWithGoogleProductsEnabled?: boolean | null; /** - * Allows Google support to access the data in order to help troubleshoot issues. + * Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the "Technical support" field in the Google Analytics Admin UI. */ sharingWithGoogleSupportEnabled?: boolean | null; /** - * Allows Google to share the data anonymously in aggregate form with others. + * Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the "Modeling contributions & business insights" field in the Google Analytics Admin UI. */ sharingWithOthersEnabled?: boolean | null; } From 16fc986a81f2e3e2261809296915a0eab831d2e4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 007/144] feat(analyticshub)!: update the API BREAKING CHANGE: This release has breaking changes. #### analyticshub:v1beta1 The following keys were deleted: - schemas.GoogleCloudBigqueryDataexchangeV1beta1DestinationDatasetReference.description The following keys were added: - schemas.Subscription.properties.logLinkedDatasetQueryUserEmail.description - schemas.Subscription.properties.logLinkedDatasetQueryUserEmail.readOnly - schemas.Subscription.properties.logLinkedDatasetQueryUserEmail.type #### analyticshub:v1 The following keys were deleted: - schemas.DestinationDatasetReference.description The following keys were added: - resources.projects.resources.locations.resources.dataExchanges.resources.listings.methods.delete.parameters.deleteCommercial.description - resources.projects.resources.locations.resources.dataExchanges.resources.listings.methods.delete.parameters.deleteCommercial.location - resources.projects.resources.locations.resources.dataExchanges.resources.listings.methods.delete.parameters.deleteCommercial.type - schemas.DataExchange.properties.logLinkedDatasetQueryUserEmail.description - schemas.DataExchange.properties.logLinkedDatasetQueryUserEmail.type - schemas.GooglePubsubV1Subscription.properties.messageTransforms.description - schemas.GooglePubsubV1Subscription.properties.messageTransforms.items.$ref - schemas.GooglePubsubV1Subscription.properties.messageTransforms.type - schemas.JavaScriptUDF.description - schemas.JavaScriptUDF.id - schemas.JavaScriptUDF.properties.code.description - schemas.JavaScriptUDF.properties.code.type - schemas.JavaScriptUDF.properties.functionName.description - schemas.JavaScriptUDF.properties.functionName.type - schemas.JavaScriptUDF.type - schemas.Listing.properties.logLinkedDatasetQueryUserEmail.description - schemas.Listing.properties.logLinkedDatasetQueryUserEmail.type - schemas.MessageTransform.description - schemas.MessageTransform.id - schemas.MessageTransform.properties.enabled.description - schemas.MessageTransform.properties.enabled.type - schemas.MessageTransform.properties.javascriptUdf.$ref - schemas.MessageTransform.properties.javascriptUdf.description - schemas.MessageTransform.type - schemas.RevokeSubscriptionRequest.properties.revokeCommercial.description - schemas.RevokeSubscriptionRequest.properties.revokeCommercial.type - schemas.Subscription.properties.logLinkedDatasetQueryUserEmail.description - schemas.Subscription.properties.logLinkedDatasetQueryUserEmail.readOnly - schemas.Subscription.properties.logLinkedDatasetQueryUserEmail.type The following keys were changed: - schemas.BigQueryDatasetSource.properties.dataset.description - schemas.CloudStorageConfig.properties.maxDuration.description - schemas.DeadLetterPolicy.properties.maxDeliveryAttempts.description - schemas.GooglePubsubV1Subscription.properties.enableExactlyOnceDelivery.description - schemas.GooglePubsubV1Subscription.properties.retryPolicy.description - schemas.Listing.properties.bigqueryDataset.description - schemas.Listing.properties.pubsubTopic.description - schemas.RetryPolicy.description - schemas.SubscribeListingRequest.properties.destinationPubsubSubscription.description --- discovery/analyticshub-v1.json | 83 ++++++++++++++++++++++++----- discovery/analyticshub-v1beta1.json | 8 ++- src/apis/analyticshub/v1.ts | 74 ++++++++++++++++++++----- src/apis/analyticshub/v1beta1.ts | 7 +-- 4 files changed, 142 insertions(+), 30 deletions(-) diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 15f5b3ef20b..129b8a54621 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -526,6 +526,11 @@ "name" ], "parameters": { + "deleteCommercial": { + "description": "Optional. If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", "location": "path", @@ -1022,7 +1027,7 @@ } } }, - "revision": "20250115", + "revision": "20250303", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AnalyticsHubSubscriptionInfo": { @@ -1160,7 +1165,7 @@ "id": "BigQueryDatasetSource", "properties": { "dataset": { - "description": "Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", + "description": "Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`", "type": "string" }, "restrictedExportPolicy": { @@ -1229,7 +1234,7 @@ "type": "string" }, "maxDuration": { - "description": "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.", + "description": "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 acknowledgment deadline.", "format": "google-duration", "type": "string" }, @@ -1311,6 +1316,10 @@ "readOnly": true, "type": "integer" }, + "logLinkedDatasetQueryUserEmail": { + "description": "Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.", + "type": "boolean" + }, "name": { "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", "readOnly": true, @@ -1368,7 +1377,7 @@ "type": "string" }, "maxDeliveryAttempts": { - "description": "Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.", + "description": "Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgment deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.", "format": "int32", "type": "integer" } @@ -1412,7 +1421,6 @@ "type": "object" }, "DestinationDatasetReference": { - "description": "Contains the reference that identifies a destination bigquery dataset.", "id": "DestinationDatasetReference", "properties": { "datasetId": { @@ -1594,7 +1602,7 @@ "type": "boolean" }, "enableExactlyOnceDelivery": { - "description": "Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.", + "description": "Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgment deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.", "type": "boolean" }, "enableMessageOrdering": { @@ -1621,6 +1629,13 @@ "format": "google-duration", "type": "string" }, + "messageTransforms": { + "description": "Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.", + "items": { + "$ref": "MessageTransform" + }, + "type": "array" + }, "name": { "description": "Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.", "type": "string" @@ -1635,7 +1650,7 @@ }, "retryPolicy": { "$ref": "RetryPolicy", - "description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message." + "description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message." }, "state": { "description": "Output only. An output-only field indicating whether or not the subscription can receive messages.", @@ -1661,6 +1676,21 @@ }, "type": "object" }, + "JavaScriptUDF": { + "description": "User-defined JavaScript function that can transform or filter a Pub/Sub message.", + "id": "JavaScriptUDF", + "properties": { + "code": { + "description": "Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ```", + "type": "string" + }, + "functionName": { + "description": "Required. Name of the JavasScript function that should applied to Pub/Sub messages.", + "type": "string" + } + }, + "type": "object" + }, "LinkedResource": { "description": "Reference to a linked resource tracked by this Subscription.", "id": "LinkedResource", @@ -1779,7 +1809,7 @@ "properties": { "bigqueryDataset": { "$ref": "BigQueryDatasetSource", - "description": "Required. Shared dataset i.e. BigQuery dataset source." + "description": "Shared dataset i.e. BigQuery dataset source." }, "categories": { "description": "Optional. Categories of the listing. Up to two categories are allowed.", @@ -1872,6 +1902,10 @@ "format": "byte", "type": "string" }, + "logLinkedDatasetQueryUserEmail": { + "description": "Optional. By default, false. If true, the Listing has an email sharing mandate enabled.", + "type": "boolean" + }, "name": { "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`", "readOnly": true, @@ -1887,7 +1921,7 @@ }, "pubsubTopic": { "$ref": "PubSubTopicSource", - "description": "Required. Pub/Sub topic source." + "description": "Pub/Sub topic source." }, "requestAccess": { "description": "Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.", @@ -1928,6 +1962,21 @@ }, "type": "object" }, + "MessageTransform": { + "description": "All supported message transforms types.", + "id": "MessageTransform", + "properties": { + "enabled": { + "description": "Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`.", + "type": "boolean" + }, + "javascriptUdf": { + "$ref": "JavaScriptUDF", + "description": "Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`." + } + }, + "type": "object" + }, "NoWrapper": { "description": "Sets the `data` field as the HTTP body for delivery.", "id": "NoWrapper", @@ -2190,7 +2239,7 @@ "type": "object" }, "RetryPolicy": { - "description": "A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.", + "description": "A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.", "id": "RetryPolicy", "properties": { "maximumBackoff": { @@ -2209,7 +2258,12 @@ "RevokeSubscriptionRequest": { "description": "Message for revoking a subscription.", "id": "RevokeSubscriptionRequest", - "properties": {}, + "properties": { + "revokeCommercial": { + "description": "Optional. If the subscription is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid revoking commercial subscriptions accidentally.", + "type": "boolean" + } + }, "type": "object" }, "RevokeSubscriptionResponse": { @@ -2335,7 +2389,7 @@ }, "destinationPubsubSubscription": { "$ref": "DestinationPubSubSubscription", - "description": "Required. Input only. Destination Pub/Sub subscription to create for the subscriber." + "description": "Input only. Destination Pub/Sub subscription to create for the subscriber." } }, "type": "object" @@ -2398,6 +2452,11 @@ "readOnly": true, "type": "string" }, + "logLinkedDatasetQueryUserEmail": { + "description": "Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.", + "readOnly": true, + "type": "boolean" + }, "name": { "description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.", "readOnly": true, diff --git a/discovery/analyticshub-v1beta1.json b/discovery/analyticshub-v1beta1.json index 02322dacff9..d87a4f6a8c9 100644 --- a/discovery/analyticshub-v1beta1.json +++ b/discovery/analyticshub-v1beta1.json @@ -695,7 +695,7 @@ } } }, - "revision": "20241213", + "revision": "20250217", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -928,7 +928,6 @@ "type": "object" }, "GoogleCloudBigqueryDataexchangeV1beta1DestinationDatasetReference": { - "description": "Contains the reference that identifies a destination bigquery dataset.", "id": "GoogleCloudBigqueryDataexchangeV1beta1DestinationDatasetReference", "properties": { "datasetId": { @@ -1358,6 +1357,11 @@ "readOnly": true, "type": "string" }, + "logLinkedDatasetQueryUserEmail": { + "description": "Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.", + "readOnly": true, + "type": "boolean" + }, "name": { "description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.", "readOnly": true, diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index fb857caf5c4..4b5091c3715 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -216,7 +216,7 @@ export namespace analyticshub_v1 { */ export interface Schema$BigQueryDatasetSource { /** - * Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` + * Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` */ dataset?: string | null; /** @@ -274,7 +274,7 @@ export namespace analyticshub_v1 { */ maxBytes?: string | null; /** - * 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. + * 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 acknowledgment deadline. */ maxDuration?: string | null; /** @@ -322,6 +322,10 @@ export namespace analyticshub_v1 { * Output only. Number of listings contained in the data exchange. */ listingCount?: number | null; + /** + * Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. + */ + logLinkedDatasetQueryUserEmail?: boolean | null; /** * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. */ @@ -370,7 +374,7 @@ export namespace analyticshub_v1 { */ deadLetterTopic?: string | null; /** - * Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. + * Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgment deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. */ maxDeliveryAttempts?: number | null; } @@ -403,9 +407,6 @@ export namespace analyticshub_v1 { */ location?: string | null; } - /** - * Contains the reference that identifies a destination bigquery dataset. - */ export interface Schema$DestinationDatasetReference { /** * 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. @@ -546,7 +547,7 @@ export namespace analyticshub_v1 { */ detached?: boolean | null; /** - * Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. + * Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgment deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. */ enableExactlyOnceDelivery?: boolean | null; /** @@ -569,6 +570,10 @@ export namespace analyticshub_v1 { * Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. */ messageRetentionDuration?: string | null; + /** + * Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + */ + messageTransforms?: Schema$MessageTransform[]; /** * Required. Name of the subscription. Format is `projects/{project\}/subscriptions/{sub\}`. */ @@ -582,7 +587,7 @@ export namespace analyticshub_v1 { */ retainAckedMessages?: boolean | null; /** - * Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. + * Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. */ retryPolicy?: Schema$RetryPolicy; /** @@ -594,6 +599,19 @@ export namespace analyticshub_v1 { */ topicMessageRetentionDuration?: string | null; } + /** + * User-defined JavaScript function that can transform or filter a Pub/Sub message. + */ + export interface Schema$JavaScriptUDF { + /** + * Required. JavaScript code that contains a function `function_name` with the below signature: ``` /x* * Transforms a Pub/Sub message. * @return {(Object)\>|null)\} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string\} * - (optional) 'attributes' : {Object\} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)\>\} Pub/Sub * message. Keys: * - (required) 'data' : {string\} * - (required) 'attributes' : {Object\} * * @param {Object\} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string\} * - (optional) 'publish_time': {string\} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string\} x/ function (message, metadata) { \} ``` + */ + code?: string | null; + /** + * Required. Name of the JavasScript function that should applied to Pub/Sub messages. + */ + functionName?: string | null; + } /** * Reference to a linked resource tracked by this Subscription. */ @@ -629,7 +647,7 @@ export namespace analyticshub_v1 { */ export interface Schema$Listing { /** - * Required. Shared dataset i.e. BigQuery dataset source. + * Shared dataset i.e. BigQuery dataset source. */ bigqueryDataset?: Schema$BigQueryDatasetSource; /** @@ -664,6 +682,10 @@ export namespace analyticshub_v1 { * Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. */ icon?: string | null; + /** + * Optional. By default, false. If true, the Listing has an email sharing mandate enabled. + */ + logLinkedDatasetQueryUserEmail?: boolean | null; /** * Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` */ @@ -677,7 +699,7 @@ export namespace analyticshub_v1 { */ publisher?: Schema$Publisher; /** - * Required. Pub/Sub topic source. + * Pub/Sub topic source. */ pubsubTopic?: Schema$PubSubTopicSource; /** @@ -749,6 +771,19 @@ export namespace analyticshub_v1 { */ subscriptions?: Schema$Subscription[]; } + /** + * All supported message transforms types. + */ + export interface Schema$MessageTransform { + /** + * Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + */ + enabled?: boolean | null; + /** + * Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + */ + javascriptUdf?: Schema$JavaScriptUDF; + } /** * Sets the `data` field as the HTTP body for delivery. */ @@ -953,7 +988,7 @@ export namespace analyticshub_v1 { restrictQueryResult?: boolean | null; } /** - * A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. + * A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. */ export interface Schema$RetryPolicy { /** @@ -968,7 +1003,12 @@ export namespace analyticshub_v1 { /** * Message for revoking a subscription. */ - export interface Schema$RevokeSubscriptionRequest {} + export interface Schema$RevokeSubscriptionRequest { + /** + * Optional. If the subscription is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid revoking commercial subscriptions accidentally. + */ + revokeCommercial?: boolean | null; + } /** * Message for response when you revoke a subscription. Empty for now. */ @@ -1068,7 +1108,7 @@ export namespace analyticshub_v1 { */ destinationDataset?: Schema$DestinationDataset; /** - * Required. Input only. Destination Pub/Sub subscription to create for the subscriber. + * Input only. Destination Pub/Sub subscription to create for the subscriber. */ destinationPubsubSubscription?: Schema$DestinationPubSubSubscription; } @@ -1113,6 +1153,10 @@ export namespace analyticshub_v1 { * Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 */ listing?: string | null; + /** + * Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing. + */ + logLinkedDatasetQueryUserEmail?: boolean | null; /** * Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. */ @@ -3299,6 +3343,10 @@ export namespace analyticshub_v1 { } export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Delete extends StandardParameters { + /** + * Optional. If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally. + */ + deleteCommercial?: boolean; /** * Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. */ diff --git a/src/apis/analyticshub/v1beta1.ts b/src/apis/analyticshub/v1beta1.ts index 28f297aab6e..0cc732d3600 100644 --- a/src/apis/analyticshub/v1beta1.ts +++ b/src/apis/analyticshub/v1beta1.ts @@ -301,9 +301,6 @@ export namespace analyticshub_v1beta1 { */ location?: string | null; } - /** - * Contains the reference that identifies a destination bigquery dataset. - */ export interface Schema$GoogleCloudBigqueryDataexchangeV1beta1DestinationDatasetReference { /** * 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. @@ -596,6 +593,10 @@ export namespace analyticshub_v1beta1 { * Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 */ listing?: string | null; + /** + * Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing. + */ + logLinkedDatasetQueryUserEmail?: boolean | null; /** * Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. */ From 7fa755187e50a8082901c22caee1666029e77206 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 008/144] feat(androidenterprise): update the API #### androidenterprise:v1 The following keys were added: - resources.enterprises.methods.generateEnterpriseUpgradeUrl.description - resources.enterprises.methods.generateEnterpriseUpgradeUrl.flatPath - resources.enterprises.methods.generateEnterpriseUpgradeUrl.httpMethod - resources.enterprises.methods.generateEnterpriseUpgradeUrl.id - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameterOrder - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.adminEmail.description - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.adminEmail.location - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.adminEmail.type - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.allowedDomains.description - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.allowedDomains.location - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.allowedDomains.repeated - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.allowedDomains.type - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.enterpriseId.description - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.enterpriseId.location - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.enterpriseId.required - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.enterpriseId.type - resources.enterprises.methods.generateEnterpriseUpgradeUrl.path - resources.enterprises.methods.generateEnterpriseUpgradeUrl.response.$ref - resources.enterprises.methods.generateEnterpriseUpgradeUrl.scopes - schemas.Enterprise.properties.enterpriseType.description - schemas.Enterprise.properties.enterpriseType.enum - schemas.Enterprise.properties.enterpriseType.enumDescriptions - schemas.Enterprise.properties.enterpriseType.type - schemas.Enterprise.properties.managedGoogleDomainType.description - schemas.Enterprise.properties.managedGoogleDomainType.enum - schemas.Enterprise.properties.managedGoogleDomainType.enumDescriptions - schemas.Enterprise.properties.managedGoogleDomainType.type - schemas.EnterpriseUpgradeEvent.description - schemas.EnterpriseUpgradeEvent.id - schemas.EnterpriseUpgradeEvent.properties.upgradeState.description - schemas.EnterpriseUpgradeEvent.properties.upgradeState.enum - schemas.EnterpriseUpgradeEvent.properties.upgradeState.enumDescriptions - schemas.EnterpriseUpgradeEvent.properties.upgradeState.type - schemas.EnterpriseUpgradeEvent.type - schemas.GenerateEnterpriseUpgradeUrlResponse.description - schemas.GenerateEnterpriseUpgradeUrlResponse.id - schemas.GenerateEnterpriseUpgradeUrlResponse.properties.url.description - schemas.GenerateEnterpriseUpgradeUrlResponse.properties.url.type - schemas.GenerateEnterpriseUpgradeUrlResponse.type - schemas.Notification.properties.enterpriseUpgradeEvent.$ref - schemas.Notification.properties.enterpriseUpgradeEvent.description The following keys were changed: - schemas.Notification.properties.notificationType.enum - schemas.Notification.properties.notificationType.enumDescriptions --- discovery/androidenterprise-v1.json | 105 +++++++++++++++++++- src/apis/androidenterprise/v1.ts | 143 ++++++++++++++++++++++++++++ 2 files changed, 245 insertions(+), 3 deletions(-) diff --git a/discovery/androidenterprise-v1.json b/discovery/androidenterprise-v1.json index 4b23f933c13..52b5ba1f77d 100644 --- a/discovery/androidenterprise-v1.json +++ b/discovery/androidenterprise-v1.json @@ -468,6 +468,41 @@ "https://www.googleapis.com/auth/androidenterprise" ] }, + "generateEnterpriseUpgradeUrl": { + "description": "Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.", + "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/generateEnterpriseUpgradeUrl", + "httpMethod": "POST", + "id": "androidenterprise.enterprises.generateEnterpriseUpgradeUrl", + "parameterOrder": [ + "enterpriseId" + ], + "parameters": { + "adminEmail": { + "description": "Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If `allowedDomains` is non-empty then this must belong to one of the `allowedDomains`.", + "location": "query", + "type": "string" + }, + "allowedDomains": { + "description": "Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has `*.` prefixed to the domain name (e.g. *.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed.", + "location": "query", + "repeated": true, + "type": "string" + }, + "enterpriseId": { + "description": "Required. The ID of the enterprise.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "androidenterprise/v1/enterprises/{enterpriseId}/generateEnterpriseUpgradeUrl", + "response": { + "$ref": "GenerateEnterpriseUpgradeUrlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidenterprise" + ] + }, "generateSignupUrl": { "description": "Generates a sign-up URL.", "flatPath": "androidenterprise/v1/enterprises/signupUrl", @@ -2656,7 +2691,7 @@ } } }, - "revision": "20250122", + "revision": "20250302", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -3325,6 +3360,20 @@ }, "type": "array" }, + "enterpriseType": { + "description": "The type of the enterprise.", + "enum": [ + "enterpriseTypeUnspecified", + "managedGoogleDomain", + "managedGooglePlayAccountsEnterprise" + ], + "enumDescriptions": [ + "This value is not used.", + "The enterprise belongs to a managed Google domain.", + "The enterprise is a managed Google Play Accounts enterprise." + ], + "type": "string" + }, "googleAuthenticationSettings": { "$ref": "GoogleAuthenticationSettings", "description": "Output only. Settings for Google-provided user authentication.", @@ -3334,6 +3383,20 @@ "description": "The unique ID for the enterprise.", "type": "string" }, + "managedGoogleDomainType": { + "description": "The type of managed Google domain", + "enum": [ + "managedGoogleDomainTypeUnspecified", + "typeTeam", + "typeDomain" + ], + "enumDescriptions": [ + "The managed Google domain type is not specified.", + "The managed Google domain is an email-verified team.", + "The managed Google domain is domain-verified." + ], + "type": "string" + }, "name": { "description": "The name of the enterprise, for example, \"Example, Inc\".", "type": "string" @@ -3367,6 +3430,25 @@ }, "type": "object" }, + "EnterpriseUpgradeEvent": { + "description": "An event generated when an enterprise is upgraded. **Note:** This feature is not generally available.", + "id": "EnterpriseUpgradeEvent", + "properties": { + "upgradeState": { + "description": "The upgrade state.", + "enum": [ + "upgradeStateUnspecified", + "upgradeStateSucceeded" + ], + "enumDescriptions": [ + "Unspecified. This value is not used.", + "The upgrade has succeeded." + ], + "type": "string" + } + }, + "type": "object" + }, "EnterprisesListResponse": { "id": "EnterprisesListResponse", "properties": { @@ -3432,6 +3514,17 @@ }, "type": "object" }, + "GenerateEnterpriseUpgradeUrlResponse": { + "description": "Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.", + "id": "GenerateEnterpriseUpgradeUrlResponse", + "properties": { + "url": { + "description": "A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAuthenticationSettings": { "description": "Contains settings for Google-provided user authentication.", "id": "GoogleAuthenticationSettings", @@ -3915,6 +4008,10 @@ "description": "The ID of the enterprise for which the notification is sent. This will always be present.", "type": "string" }, + "enterpriseUpgradeEvent": { + "$ref": "EnterpriseUpgradeEvent", + "description": "Notifications about enterprise upgrade. **Note:** This feature is not generally available." + }, "installFailureEvent": { "$ref": "InstallFailureEvent", "description": "Notifications about an app installation failure." @@ -3939,7 +4036,8 @@ "appRestricionsSchemaChange", "productAvailabilityChange", "newDevice", - "deviceReportUpdate" + "deviceReportUpdate", + "enterpriseUpgrade" ], "enumDescriptions": [ "", @@ -3951,7 +4049,8 @@ "Notification about new app restrictions schema change.", "Notification about product availability change.", "Notification about a new device.", - "Notification about an updated device report." + "Notification about an updated device report.", + "Notification about an enterprise upgrade. **Note:** This feature is not generally available." ], "type": "string" }, diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index de57d8f4d7f..1594bbca5a7 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -574,6 +574,10 @@ export namespace androidenterprise_v1 { * Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. */ administrator?: Schema$Administrator[]; + /** + * The type of the enterprise. + */ + enterpriseType?: string | null; /** * Output only. Settings for Google-provided user authentication. */ @@ -582,6 +586,10 @@ export namespace androidenterprise_v1 { * The unique ID for the enterprise. */ id?: string | null; + /** + * The type of managed Google domain + */ + managedGoogleDomainType?: string | null; /** * The name of the enterprise, for example, "Example, Inc". */ @@ -625,6 +633,15 @@ export namespace androidenterprise_v1 { */ topicName?: string | null; } + /** + * An event generated when an enterprise is upgraded. **Note:** This feature is not generally available. + */ + export interface Schema$EnterpriseUpgradeEvent { + /** + * The upgrade state. + */ + upgradeState?: string | null; + } /** * *Deprecated:* New integrations cannot use this method and can refer to our new recommendations. */ @@ -644,6 +661,15 @@ export namespace androidenterprise_v1 { */ entitlement?: Schema$Entitlement[]; } + /** + * Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available. + */ + export interface Schema$GenerateEnterpriseUpgradeUrlResponse { + /** + * A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe. + */ + url?: string | null; + } /** * Contains settings for Google-provided user authentication. */ @@ -953,6 +979,10 @@ export namespace androidenterprise_v1 { * The ID of the enterprise for which the notification is sent. This will always be present. */ enterpriseId?: string | null; + /** + * Notifications about enterprise upgrade. **Note:** This feature is not generally available. + */ + enterpriseUpgradeEvent?: Schema$EnterpriseUpgradeEvent; /** * Notifications about an app installation failure. */ @@ -2674,6 +2704,104 @@ export namespace androidenterprise_v1 { } } + /** + * Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally 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. + */ + generateEnterpriseUpgradeUrl( + params: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + options: StreamMethodOptions + ): GaxiosPromise; + generateEnterpriseUpgradeUrl( + params?: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + options?: MethodOptions + ): GaxiosPromise; + generateEnterpriseUpgradeUrl( + params: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateEnterpriseUpgradeUrl( + params: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateEnterpriseUpgradeUrl( + params: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + callback: BodyResponseCallback + ): void; + generateEnterpriseUpgradeUrl( + callback: BodyResponseCallback + ): void; + generateEnterpriseUpgradeUrl( + paramsOrCallback?: + | Params$Resource$Enterprises$Generateenterpriseupgradeurl + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Enterprises$Generateenterpriseupgradeurl; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Enterprises$Generateenterpriseupgradeurl; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://androidenterprise.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidenterprise/v1/enterprises/{enterpriseId}/generateEnterpriseUpgradeUrl' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['enterpriseId'], + pathParams: ['enterpriseId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Generates a sign-up URL. * @@ -3621,6 +3749,21 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$Enterprise; } + export interface Params$Resource$Enterprises$Generateenterpriseupgradeurl + extends StandardParameters { + /** + * Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If `allowedDomains` is non-empty then this must belong to one of the `allowedDomains`. + */ + adminEmail?: string; + /** + * Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has `*.` prefixed to the domain name (e.g. *.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed. + */ + allowedDomains?: string[]; + /** + * Required. The ID of the enterprise. + */ + enterpriseId?: string; + } export interface Params$Resource$Enterprises$Generatesignupurl extends StandardParameters { /** From 52c6a8990c7c9d5391d25eec0310bb88f85a0fd5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 009/144] feat(androidmanagement): update the API #### androidmanagement:v1 The following keys were added: - resources.enterprises.methods.generateEnterpriseUpgradeUrl.description - resources.enterprises.methods.generateEnterpriseUpgradeUrl.flatPath - resources.enterprises.methods.generateEnterpriseUpgradeUrl.httpMethod - resources.enterprises.methods.generateEnterpriseUpgradeUrl.id - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameterOrder - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.name.description - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.name.location - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.name.pattern - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.name.required - resources.enterprises.methods.generateEnterpriseUpgradeUrl.parameters.name.type - resources.enterprises.methods.generateEnterpriseUpgradeUrl.path - resources.enterprises.methods.generateEnterpriseUpgradeUrl.request.$ref - resources.enterprises.methods.generateEnterpriseUpgradeUrl.response.$ref - resources.enterprises.methods.generateEnterpriseUpgradeUrl.scopes - schemas.Enterprise.properties.enterpriseType.description - schemas.Enterprise.properties.enterpriseType.enum - schemas.Enterprise.properties.enterpriseType.enumDescriptions - schemas.Enterprise.properties.enterpriseType.readOnly - schemas.Enterprise.properties.enterpriseType.type - schemas.Enterprise.properties.managedGoogleDomainType.description - schemas.Enterprise.properties.managedGoogleDomainType.enum - schemas.Enterprise.properties.managedGoogleDomainType.enumDescriptions - schemas.Enterprise.properties.managedGoogleDomainType.readOnly - schemas.Enterprise.properties.managedGoogleDomainType.type - schemas.Enterprise.properties.managedGooglePlayAccountsEnterpriseType.description - schemas.Enterprise.properties.managedGooglePlayAccountsEnterpriseType.enum - schemas.Enterprise.properties.managedGooglePlayAccountsEnterpriseType.enumDescriptions - schemas.Enterprise.properties.managedGooglePlayAccountsEnterpriseType.readOnly - schemas.Enterprise.properties.managedGooglePlayAccountsEnterpriseType.type - schemas.GenerateEnterpriseUpgradeUrlRequest.description - schemas.GenerateEnterpriseUpgradeUrlRequest.id - schemas.GenerateEnterpriseUpgradeUrlRequest.properties.adminEmail.description - schemas.GenerateEnterpriseUpgradeUrlRequest.properties.adminEmail.type - schemas.GenerateEnterpriseUpgradeUrlRequest.properties.allowedDomains.description - schemas.GenerateEnterpriseUpgradeUrlRequest.properties.allowedDomains.items.type - schemas.GenerateEnterpriseUpgradeUrlRequest.properties.allowedDomains.type - schemas.GenerateEnterpriseUpgradeUrlRequest.type - schemas.GenerateEnterpriseUpgradeUrlResponse.description - schemas.GenerateEnterpriseUpgradeUrlResponse.id - schemas.GenerateEnterpriseUpgradeUrlResponse.properties.url.description - schemas.GenerateEnterpriseUpgradeUrlResponse.properties.url.type - schemas.GenerateEnterpriseUpgradeUrlResponse.type The following keys were changed: - schemas.Enterprise.properties.enabledNotificationTypes.items.enum - schemas.Enterprise.properties.enabledNotificationTypes.items.enumDeprecated - schemas.Enterprise.properties.enabledNotificationTypes.items.enumDescriptions - schemas.FreezePeriod.properties.endDate.description - schemas.FreezePeriod.properties.startDate.description --- discovery/androidmanagement-v1.json | 115 ++++++++++++++++++++- src/apis/androidmanagement/v1.ts | 148 +++++++++++++++++++++++++++- 2 files changed, 256 insertions(+), 7 deletions(-) diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index ac0df0e5b37..d06122cb9d3 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -172,6 +172,34 @@ "https://www.googleapis.com/auth/androidmanagement" ] }, + "generateEnterpriseUpgradeUrl": { + "description": "Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available.", + "flatPath": "v1/enterprises/{enterprisesId}:generateEnterpriseUpgradeUrl", + "httpMethod": "POST", + "id": "androidmanagement.enterprises.generateEnterpriseUpgradeUrl", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the enterprise to be upgraded in the form enterprises/{enterpriseId}.", + "location": "path", + "pattern": "^enterprises/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateEnterpriseUpgradeUrl", + "request": { + "$ref": "GenerateEnterpriseUpgradeUrlRequest" + }, + "response": { + "$ref": "GenerateEnterpriseUpgradeUrlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidmanagement" + ] + }, "get": { "description": "Gets an enterprise.", "flatPath": "v1/enterprises/{enterprisesId}", @@ -1174,7 +1202,7 @@ } } }, - "revision": "20250123", + "revision": "20250306", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -3157,7 +3185,8 @@ "COMPLIANCE_REPORT", "STATUS_REPORT", "COMMAND", - "USAGE_LOGS" + "USAGE_LOGS", + "ENTERPRISE_UPGRADE" ], "enumDeprecated": [ false, @@ -3165,6 +3194,7 @@ true, false, false, + false, false ], "enumDescriptions": [ @@ -3173,7 +3203,8 @@ "Deprecated.", "A notification sent when a device issues a status report.", "A notification sent when a device command has completed.", - "A notification sent when device sends BatchUsageLogEvents." + "A notification sent when device sends BatchUsageLogEvents.", + "A notification sent when an enterprise is upgraded.Note: This feature is not generally available." ], "type": "string" }, @@ -3183,6 +3214,21 @@ "description": "The name of the enterprise displayed to users. This field has a maximum length of 100 characters.", "type": "string" }, + "enterpriseType": { + "description": "Output only. The type of the enterprise.", + "enum": [ + "ENTERPRISE_TYPE_UNSPECIFIED", + "MANAGED_GOOGLE_DOMAIN", + "MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE" + ], + "enumDescriptions": [ + "This value is not used.", + "The enterprise belongs to a managed Google domain (https://developers.google.com/android/work/terminology#managed_google_domain).", + "The enterprise is a managed Google Play Accounts enterprise (https://developers.google.com/android/work/terminology#managed_google_play_accounts_enterprise)." + ], + "readOnly": true, + "type": "string" + }, "googleAuthenticationSettings": { "$ref": "GoogleAuthenticationSettings", "description": "Settings for Google-provided user authentication." @@ -3191,6 +3237,36 @@ "$ref": "ExternalData", "description": "An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng." }, + "managedGoogleDomainType": { + "description": "Output only. The type of managed Google domain.", + "enum": [ + "MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED", + "TYPE_TEAM", + "TYPE_DOMAIN" + ], + "enumDescriptions": [ + "The managed Google domain type is not specified.", + "The managed Google domain is an email-verified team.", + "The managed Google domain is domain-verified." + ], + "readOnly": true, + "type": "string" + }, + "managedGooglePlayAccountsEnterpriseType": { + "description": "Output only. The type of a managed Google Play Accounts enterprise.", + "enum": [ + "MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED", + "CUSTOMER_MANAGED", + "EMM_MANAGED" + ], + "enumDescriptions": [ + "The managed Google Play Accounts enterprise type is not specified.", + "The enterprise is customer-managed", + "The enterprise is EMM-managed (deprecated)." + ], + "readOnly": true, + "type": "string" + }, "name": { "description": "The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.", "type": "string" @@ -3282,11 +3358,40 @@ "properties": { "endDate": { "$ref": "Date", - "description": "The end date (inclusive) of the freeze period. Must be no later than 90 days from the start date. If the end date is earlier than the start date, the freeze period is considered wrapping year-end. Note: year must not be set. For example, {\"month\": 1,\"date\": 30}." + "description": "The end date (inclusive) of the freeze period. Must be no later than 90 days from the start date. If the end date is earlier than the start date, the freeze period is considered wrapping year-end. Note: day and month must be set. year should not be set as it is not used. For example, {\"month\": 1,\"date\": 30}." }, "startDate": { "$ref": "Date", - "description": "The start date (inclusive) of the freeze period. Note: year must not be set. For example, {\"month\": 1,\"date\": 30}." + "description": "The start date (inclusive) of the freeze period. Note: day and month must be set. year should not be set as it is not used. For example, {\"month\": 1,\"date\": 30}." + } + }, + "type": "object" + }, + "GenerateEnterpriseUpgradeUrlRequest": { + "description": "Request message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available.", + "id": "GenerateEnterpriseUpgradeUrlRequest", + "properties": { + "adminEmail": { + "description": "Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If allowedDomains is non-empty then this must belong to one of the allowedDomains.", + "type": "string" + }, + "allowedDomains": { + "description": "Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has *. prefixed to the domain name (e.g. *.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenerateEnterpriseUpgradeUrlResponse": { + "description": "Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available.", + "id": "GenerateEnterpriseUpgradeUrlResponse", + "properties": { + "url": { + "description": "A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe.", + "type": "string" } }, "type": "object" diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index bb478d2f4b4..67be314f998 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -1252,6 +1252,10 @@ export namespace androidmanagement_v1 { * The name of the enterprise displayed to users. This field has a maximum length of 100 characters. */ enterpriseDisplayName?: string | null; + /** + * Output only. The type of the enterprise. + */ + enterpriseType?: string | null; /** * Settings for Google-provided user authentication. */ @@ -1260,6 +1264,14 @@ export namespace androidmanagement_v1 { * An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. */ logo?: Schema$ExternalData; + /** + * Output only. The type of managed Google domain. + */ + managedGoogleDomainType?: string | null; + /** + * Output only. The type of a managed Google Play Accounts enterprise. + */ + managedGooglePlayAccountsEnterpriseType?: string | null; /** * The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId\}. */ @@ -1330,14 +1342,36 @@ export namespace androidmanagement_v1 { */ export interface Schema$FreezePeriod { /** - * The end date (inclusive) of the freeze period. Must be no later than 90 days from the start date. If the end date is earlier than the start date, the freeze period is considered wrapping year-end. Note: year must not be set. For example, {"month": 1,"date": 30\}. + * The end date (inclusive) of the freeze period. Must be no later than 90 days from the start date. If the end date is earlier than the start date, the freeze period is considered wrapping year-end. Note: day and month must be set. year should not be set as it is not used. For example, {"month": 1,"date": 30\}. */ endDate?: Schema$Date; /** - * The start date (inclusive) of the freeze period. Note: year must not be set. For example, {"month": 1,"date": 30\}. + * The start date (inclusive) of the freeze period. Note: day and month must be set. year should not be set as it is not used. For example, {"month": 1,"date": 30\}. */ startDate?: Schema$Date; } + /** + * Request message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available. + */ + export interface Schema$GenerateEnterpriseUpgradeUrlRequest { + /** + * Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If allowedDomains is non-empty then this must belong to one of the allowedDomains. + */ + adminEmail?: string | null; + /** + * Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has *. prefixed to the domain name (e.g. *.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed. + */ + allowedDomains?: string[] | null; + } + /** + * Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available. + */ + export interface Schema$GenerateEnterpriseUpgradeUrlResponse { + /** + * A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe. + */ + url?: string | null; + } /** * Contains settings for Google-provided user authentication. */ @@ -3576,6 +3610,104 @@ export namespace androidmanagement_v1 { } } + /** + * Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally 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. + */ + generateEnterpriseUpgradeUrl( + params: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + options: StreamMethodOptions + ): GaxiosPromise; + generateEnterpriseUpgradeUrl( + params?: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + options?: MethodOptions + ): GaxiosPromise; + generateEnterpriseUpgradeUrl( + params: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateEnterpriseUpgradeUrl( + params: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateEnterpriseUpgradeUrl( + params: Params$Resource$Enterprises$Generateenterpriseupgradeurl, + callback: BodyResponseCallback + ): void; + generateEnterpriseUpgradeUrl( + callback: BodyResponseCallback + ): void; + generateEnterpriseUpgradeUrl( + paramsOrCallback?: + | Params$Resource$Enterprises$Generateenterpriseupgradeurl + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Enterprises$Generateenterpriseupgradeurl; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Enterprises$Generateenterpriseupgradeurl; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://androidmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateEnterpriseUpgradeUrl').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 an enterprise. * @@ -3869,6 +4001,18 @@ export namespace androidmanagement_v1 { */ name?: string; } + export interface Params$Resource$Enterprises$Generateenterpriseupgradeurl + extends StandardParameters { + /** + * Required. The name of the enterprise to be upgraded in the form enterprises/{enterpriseId\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateEnterpriseUpgradeUrlRequest; + } export interface Params$Resource$Enterprises$Get extends StandardParameters { /** * The name of the enterprise in the form enterprises/{enterpriseId\}. From b123e707c8722673177b6b54891eff094e166aa2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 010/144] feat(androidpublisher): update the API #### androidpublisher:v3 The following keys were added: - schemas.ConvertRegionPricesResponse.properties.regionVersion.$ref - schemas.ConvertRegionPricesResponse.properties.regionVersion.description --- discovery/androidpublisher-v3.json | 6 +++++- src/apis/androidpublisher/v3.ts | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 5c3bf1d414f..a275b5892b5 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -4732,7 +4732,7 @@ } } }, - "revision": "20250102", + "revision": "20250227", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -5705,6 +5705,10 @@ }, "description": "Map from region code to converted region price.", "type": "object" + }, + "regionVersion": { + "$ref": "RegionsVersion", + "description": "The region version at which the prices were generated." } }, "type": "object" diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 107681a5012..12d65f703cf 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -853,6 +853,10 @@ export namespace androidpublisher_v3 { * Map from region code to converted region price. */ convertedRegionPrices?: {[key: string]: Schema$ConvertedRegionPrice} | null; + /** + * The region version at which the prices were generated. + */ + regionVersion?: Schema$RegionsVersion; } /** * Country targeting specification. From fc1da710cc6dfeb94caba4e396dc9068605c3eea Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 011/144] feat(appengine): update the API #### appengine:v1beta The following keys were added: - resources.projects.resources.locations.resources.applications.methods.patch.description - resources.projects.resources.locations.resources.applications.methods.patch.flatPath - resources.projects.resources.locations.resources.applications.methods.patch.httpMethod - resources.projects.resources.locations.resources.applications.methods.patch.id - resources.projects.resources.locations.resources.applications.methods.patch.parameterOrder - resources.projects.resources.locations.resources.applications.methods.patch.parameters.applicationsId.description - resources.projects.resources.locations.resources.applications.methods.patch.parameters.applicationsId.location - resources.projects.resources.locations.resources.applications.methods.patch.parameters.applicationsId.required - resources.projects.resources.locations.resources.applications.methods.patch.parameters.applicationsId.type - resources.projects.resources.locations.resources.applications.methods.patch.parameters.locationsId.description - resources.projects.resources.locations.resources.applications.methods.patch.parameters.locationsId.location - resources.projects.resources.locations.resources.applications.methods.patch.parameters.locationsId.required - resources.projects.resources.locations.resources.applications.methods.patch.parameters.locationsId.type - resources.projects.resources.locations.resources.applications.methods.patch.parameters.projectsId.description - resources.projects.resources.locations.resources.applications.methods.patch.parameters.projectsId.location - resources.projects.resources.locations.resources.applications.methods.patch.parameters.projectsId.required - resources.projects.resources.locations.resources.applications.methods.patch.parameters.projectsId.type - resources.projects.resources.locations.resources.applications.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.applications.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.applications.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.applications.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.applications.methods.patch.path - resources.projects.resources.locations.resources.applications.methods.patch.request.$ref - resources.projects.resources.locations.resources.applications.methods.patch.response.$ref - resources.projects.resources.locations.resources.applications.methods.patch.scopes - schemas.Application.properties.sslPolicy.description - schemas.Application.properties.sslPolicy.enum - schemas.Application.properties.sslPolicy.enumDescriptions - schemas.Application.properties.sslPolicy.type The following keys were changed: - schemas.SslSettings.properties.sslManagementType.enumDescriptions - schemas.StandardSchedulerSettings.properties.maxInstances.description #### appengine:v1 The following keys were added: - resources.projects.resources.locations.resources.applications.methods.patch.description - resources.projects.resources.locations.resources.applications.methods.patch.flatPath - resources.projects.resources.locations.resources.applications.methods.patch.httpMethod - resources.projects.resources.locations.resources.applications.methods.patch.id - resources.projects.resources.locations.resources.applications.methods.patch.parameterOrder - resources.projects.resources.locations.resources.applications.methods.patch.parameters.applicationsId.description - resources.projects.resources.locations.resources.applications.methods.patch.parameters.applicationsId.location - resources.projects.resources.locations.resources.applications.methods.patch.parameters.applicationsId.required - resources.projects.resources.locations.resources.applications.methods.patch.parameters.applicationsId.type - resources.projects.resources.locations.resources.applications.methods.patch.parameters.locationsId.description - resources.projects.resources.locations.resources.applications.methods.patch.parameters.locationsId.location - resources.projects.resources.locations.resources.applications.methods.patch.parameters.locationsId.required - resources.projects.resources.locations.resources.applications.methods.patch.parameters.locationsId.type - resources.projects.resources.locations.resources.applications.methods.patch.parameters.projectsId.description - resources.projects.resources.locations.resources.applications.methods.patch.parameters.projectsId.location - resources.projects.resources.locations.resources.applications.methods.patch.parameters.projectsId.required - resources.projects.resources.locations.resources.applications.methods.patch.parameters.projectsId.type - resources.projects.resources.locations.resources.applications.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.applications.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.applications.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.applications.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.applications.methods.patch.path - resources.projects.resources.locations.resources.applications.methods.patch.request.$ref - resources.projects.resources.locations.resources.applications.methods.patch.response.$ref - resources.projects.resources.locations.resources.applications.methods.patch.scopes - schemas.Application.properties.sslPolicy.description - schemas.Application.properties.sslPolicy.enum - schemas.Application.properties.sslPolicy.enumDescriptions - schemas.Application.properties.sslPolicy.type The following keys were changed: - schemas.SslSettings.properties.sslManagementType.enumDescriptions - schemas.StandardSchedulerSettings.properties.maxInstances.description --- discovery/appengine-v1.json | 69 +++++++++++++++++- discovery/appengine-v1beta.json | 69 +++++++++++++++++- src/apis/appengine/v1.ts | 119 +++++++++++++++++++++++++++++++- src/apis/appengine/v1beta.ts | 119 +++++++++++++++++++++++++++++++- 4 files changed, 368 insertions(+), 8 deletions(-) diff --git a/discovery/appengine-v1.json b/discovery/appengine-v1.json index 12695fb7f7b..7c5f8704789 100644 --- a/discovery/appengine-v1.json +++ b/discovery/appengine-v1.json @@ -1655,6 +1655,55 @@ "locations": { "resources": { "applications": { + "methods": { + "patch": { + "description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}", + "httpMethod": "PATCH", + "id": "appengine.projects.locations.applications.patch", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}", + "request": { + "$ref": "Application" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "authorizedDomains": { "methods": { @@ -1825,7 +1874,7 @@ } } }, - "revision": "20241205", + "revision": "20250310", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -2005,6 +2054,20 @@ "Application has been disabled by the system." ], "type": "string" + }, + "sslPolicy": { + "description": "The SSL policy that will be applied to the application. If set to Modern it will restrict traffic with TLS < 1.2 and allow only Modern Ciphers suite", + "enum": [ + "SSL_POLICY_UNSPECIFIED", + "DEFAULT", + "MODERN" + ], + "enumDescriptions": [ + "Required by linter. Will work same as DEFAULT", + "DEFAULT is to allow all TLS versions and cipher suites supported by App Engine", + "MODERN is to allow only TLS 1.2 and TLS 1.3 along with Modern cipher suites only" + ], + "type": "string" } }, "type": "object" @@ -3899,7 +3962,7 @@ "enumDescriptions": [ "Defaults to AUTOMATIC.", "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.", - "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain." + "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explicitly mapped to this domain." ], "type": "string" } @@ -3911,7 +3974,7 @@ "id": "StandardSchedulerSettings", "properties": { "maxInstances": { - "description": "Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.", + "description": "Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration.", "format": "int32", "type": "integer" }, diff --git a/discovery/appengine-v1beta.json b/discovery/appengine-v1beta.json index 94a5ff236e5..7d906138afa 100644 --- a/discovery/appengine-v1beta.json +++ b/discovery/appengine-v1beta.json @@ -1762,6 +1762,55 @@ }, "resources": { "applications": { + "methods": { + "patch": { + "description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}", + "httpMethod": "PATCH", + "id": "appengine.projects.locations.applications.patch", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}", + "request": { + "$ref": "Application" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "authorizedDomains": { "methods": { @@ -2025,7 +2074,7 @@ } } }, - "revision": "20241205", + "revision": "20250310", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -2205,6 +2254,20 @@ "Application has been disabled by the system." ], "type": "string" + }, + "sslPolicy": { + "description": "The SSL policy that will be applied to the application. If set to Modern it will restrict traffic with TLS < 1.2 and allow only Modern Ciphers suite", + "enum": [ + "SSL_POLICY_UNSPECIFIED", + "DEFAULT", + "MODERN" + ], + "enumDescriptions": [ + "Required by linter. Will work same as DEFAULT", + "DEFAULT is to allow all TLS versions and cipher suites supported by App Engine", + "MODERN is to allow only TLS 1.2 and TLS 1.3 along with Modern cipher suites only" + ], + "type": "string" } }, "type": "object" @@ -4146,7 +4209,7 @@ ], "enumDescriptions": [ "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.", - "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain." + "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explicitly mapped to this domain." ], "type": "string" } @@ -4158,7 +4221,7 @@ "id": "StandardSchedulerSettings", "properties": { "maxInstances": { - "description": "Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.", + "description": "Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration.", "format": "int32", "type": "integer" }, diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 51344929a73..ab7cb29a9ee 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -225,6 +225,10 @@ export namespace appengine_v1 { * Serving status of this application. */ servingStatus?: string | null; + /** + * The SSL policy that will be applied to the application. If set to Modern it will restrict traffic with TLS < 1.2 and allow only Modern Ciphers suite + */ + sslPolicy?: string | null; } /** * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. @@ -1529,7 +1533,7 @@ export namespace appengine_v1 { */ export interface Schema$StandardSchedulerSettings { /** - * Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. + * Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration. */ maxInstances?: number | null; /** @@ -6129,6 +6133,119 @@ export namespace appengine_v1 { this.context ); } + + /** + * Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the 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. + */ + patch( + params: Params$Resource$Projects$Locations$Applications$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Applications$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Applications$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Applications$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectsId', 'locationsId', 'applicationsId'], + pathParams: ['applicationsId', 'locationsId', 'projectsId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Applications$Patch + extends StandardParameters { + /** + * Part of `name`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Part of `name`. Name of the Application resource to update. Example: apps/myapp. + */ + projectsId?: string; + /** + * Required. Standard field mask for the set of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Application; } export class Resource$Projects$Locations$Applications$Authorizeddomains { diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 0c26348df1c..8fdd424cb39 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -225,6 +225,10 @@ export namespace appengine_v1beta { * Serving status of this application. */ servingStatus?: string | null; + /** + * The SSL policy that will be applied to the application. If set to Modern it will restrict traffic with TLS < 1.2 and allow only Modern Ciphers suite + */ + sslPolicy?: string | null; } /** * An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. @@ -1571,7 +1575,7 @@ export namespace appengine_v1beta { */ export interface Schema$StandardSchedulerSettings { /** - * Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. + * Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration. */ maxInstances?: number | null; /** @@ -6397,6 +6401,119 @@ export namespace appengine_v1beta { this.context ); } + + /** + * Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the 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. + */ + patch( + params: Params$Resource$Projects$Locations$Applications$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Applications$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Applications$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Applications$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectsId', 'locationsId', 'applicationsId'], + pathParams: ['applicationsId', 'locationsId', 'projectsId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Applications$Patch + extends StandardParameters { + /** + * Part of `name`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Part of `name`. Name of the Application resource to update. Example: apps/myapp. + */ + projectsId?: string; + /** + * Required. Standard field mask for the set of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Application; } export class Resource$Projects$Locations$Applications$Authorizeddomains { From 1b49c4be1e015fab24e338aa0949cdbe14231b79 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 012/144] fix(areainsights): update the API #### areainsights:v1 The following keys were changed: - schemas.Circle.properties.place.description - schemas.ComputeInsightsRequest.properties.insights.items.enumDescriptions - schemas.Filter.properties.operatingStatus.items.enumDescriptions - schemas.Filter.properties.priceLevels.description - schemas.Filter.properties.priceLevels.items.enumDescriptions --- discovery/areainsights-v1.json | 16 ++++++++-------- src/apis/areainsights/v1.ts | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/discovery/areainsights-v1.json b/discovery/areainsights-v1.json index b59455ae106..0272455dd54 100644 --- a/discovery/areainsights-v1.json +++ b/discovery/areainsights-v1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20241211", + "revision": "20250226", "rootUrl": "https://areainsights.googleapis.com/", "schemas": { "Circle": { @@ -140,7 +140,7 @@ "description": "The latitude and longitude of the center of the circle." }, "place": { - "description": "The Place resource name of the center of the circle. Only point places are supported.", + "description": "**Format:** Must be in the format `places/PLACE_ID`, where `PLACE_ID` is the unique identifier of a place. For example: `places/ChIJgUbEo8cfqokR5lP9_Wh_DaM`.", "type": "string" }, "radius": { @@ -169,8 +169,8 @@ ], "enumDescriptions": [ "Not Specified.", - "Count insight. When this insight is specified ComputeInsights returns the number of places that match the specified filter criteria. ``` For example if the request is: ComputeInsightsRequest { insights: INSIGHT_COUNT filter { location_filter {region: } type_filter {included_types: \"restaurant\"} operating_status: OPERATING_STATUS_OPERATIONAL price_levels: PRICE_LEVEL_FREE price_levels: PRICE_LEVEL_INEXPENSIVE min_rating: 4.0 } } The method will return the count of restaurants in California that are operational, with price level free or inexpensive and have an average rating of at least 4 starts. Example response: ComputeInsightsResponse { count: } ```", - "Return Places When this insight is specified ComputeInsights returns Places that match the specified filter criteria. ``` For example if the request is: ComputeInsightsRequest { insights: INSIGHT_PLACES filter { location_filter {region: } type_filter {included_types: \"restaurant\"} operating_status: OPERATING_STATUS_OPERATIONAL price_levels: PRICE_LEVEL_FREE price_levels: PRICE_LEVEL_INEXPENSIVE min_rating: 4.0 } } The method will return list of places of restaurants in California that are operational, with price level free or inexpensive and have an average rating of at least 4 stars. Example response: ComputeInsightsResponse { place_insights { place: \"places/ABC\" } place_insights { place: \"places/PQR\" } place_insights { place: \"places/XYZ\" } } ```" + "Count insight. When this insight is specified ComputeInsights returns the number of places that match the specified filter criteria. Example request: ``` { \"insights\": [\"INSIGHT_COUNT\"], \"filter\": { \"locationFilter\": { \"region\": { \"place\": \"places/ChIJPV4oX_65j4ARVW8IJ6IJUYs\" } }, \"typeFilter\": { \"includedTypes\": [\"restaurant\"] }, \"operatingStatus\": [\"OPERATING_STATUS_OPERATIONAL\"], \"priceLevels\": [ \"PRICE_LEVEL_FREE\", \"PRICE_LEVEL_INEXPENSIVE\" ], \"ratingFilter\": { \"minRating\": 4.0 } } } ``` Example response: ``` { \"count\": 1234 } ```", + "Return Places When this insight is specified ComputeInsights returns places IDs that match the specified filter criteria. Example request: ``` { \"insights\": [\"INSIGHT_PLACES\"], \"filter\": { \"locationFilter\": { \"region\": { \"place\": \"places/ChIJPV4oX_65j4ARVW8IJ6IJUYs\" } }, \"typeFilter\": { \"includedTypes\": [\"restaurant\"] }, \"operatingStatus\": [\"OPERATING_STATUS_OPERATIONAL\"], \"priceLevels\": [ \"PRICE_LEVEL_FREE\", \"PRICE_LEVEL_INEXPENSIVE\" ], \"ratingFilter\": { \"minRating\": 4.0 } } } ``` Example response: ``` { \"placeInsights\": [ {\"place\": \"places/ABC\"}, {\"place\": \"places/PQR\"}, {\"place\": \"places/XYZ\"} ] } ```" ], "type": "string" }, @@ -227,17 +227,17 @@ "OPERATING_STATUS_TEMPORARILY_CLOSED" ], "enumDescriptions": [ - "Not Specified.", + "Not specified. This value should not be used.", "The place is operational and its open during its defined hours.", "The Place is no longer in business.", - "The Place is temporarily closed and expected to reopen in the future." + "The place is temporarily closed and expected to reopen in the future." ], "type": "string" }, "type": "array" }, "priceLevels": { - "description": "Optional. Restricts results to places whose price level is included on this list. If price_level is not set, all price levels are included in the results.", + "description": "Optional. Restricts results to places whose price level is included on this list. If `price_levels` is not set, all price levels are included in the results.", "items": { "enum": [ "PRICE_LEVEL_UNSPECIFIED", @@ -248,7 +248,7 @@ "PRICE_LEVEL_VERY_EXPENSIVE" ], "enumDescriptions": [ - "Place price level is unspecified or unknown.", + "Not specified. This value should not be used.", "Place provides free services.", "Place provides inexpensive services.", "Place provides moderately priced services.", diff --git a/src/apis/areainsights/v1.ts b/src/apis/areainsights/v1.ts index 6b1ed08ae58..e6ab41a85c4 100644 --- a/src/apis/areainsights/v1.ts +++ b/src/apis/areainsights/v1.ts @@ -133,7 +133,7 @@ export namespace areainsights_v1 { */ latLng?: Schema$LatLng; /** - * The Place resource name of the center of the circle. Only point places are supported. + * **Format:** Must be in the format `places/PLACE_ID`, where `PLACE_ID` is the unique identifier of a place. For example: `places/ChIJgUbEo8cfqokR5lP9_Wh_DaM`. */ place?: string | null; /** @@ -189,7 +189,7 @@ export namespace areainsights_v1 { */ operatingStatus?: string[] | null; /** - * Optional. Restricts results to places whose price level is included on this list. If price_level is not set, all price levels are included in the results. + * Optional. Restricts results to places whose price level is included on this list. If `price_levels` is not set, all price levels are included in the results. */ priceLevels?: string[] | null; /** From 6e5048bd65251d49c1e8c1656f39218ae8a83df0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 013/144] feat(authorizedbuyersmarketplace): update the API #### authorizedbuyersmarketplace:v1alpha The following keys were added: - schemas.Deal.properties.buyerPermissionType.description - schemas.Deal.properties.buyerPermissionType.enum - schemas.Deal.properties.buyerPermissionType.enumDescriptions - schemas.Deal.properties.buyerPermissionType.readOnly - schemas.Deal.properties.buyerPermissionType.type The following keys were changed: - schemas.DataSegment.properties.cpmFee.description #### authorizedbuyersmarketplace:v1 The following keys were added: - schemas.Deal.properties.buyerPermissionType.description - schemas.Deal.properties.buyerPermissionType.enum - schemas.Deal.properties.buyerPermissionType.enumDescriptions - schemas.Deal.properties.buyerPermissionType.readOnly - schemas.Deal.properties.buyerPermissionType.type --- discovery/authorizedbuyersmarketplace-v1.json | 17 ++++++++++++++++- .../authorizedbuyersmarketplace-v1alpha.json | 19 +++++++++++++++++-- src/apis/authorizedbuyersmarketplace/v1.ts | 4 ++++ .../authorizedbuyersmarketplace/v1alpha.ts | 6 +++++- 4 files changed, 42 insertions(+), 4 deletions(-) diff --git a/discovery/authorizedbuyersmarketplace-v1.json b/discovery/authorizedbuyersmarketplace-v1.json index bc8afbcf3ab..47c417c9355 100644 --- a/discovery/authorizedbuyersmarketplace-v1.json +++ b/discovery/authorizedbuyersmarketplace-v1.json @@ -1367,7 +1367,7 @@ } } }, - "revision": "20250113", + "revision": "20250303", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -1872,6 +1872,21 @@ "readOnly": true, "type": "string" }, + "buyerPermissionType": { + "description": "Output only. The buyer permission type of the deal.", + "enum": [ + "BUYER_PERMISSION_TYPE_UNSPECIFIED", + "NEGOTIATOR_ONLY", + "BIDDER" + ], + "enumDescriptions": [ + "A placeholder for an undefined buyer permission type.", + "Only the [Deal.negotiating_buyer] can transact on the deal.", + "All buyers under the [Deal.negotiating_buyer]'s bidder can transact on the deal." + ], + "readOnly": true, + "type": "string" + }, "client": { "description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", "readOnly": true, diff --git a/discovery/authorizedbuyersmarketplace-v1alpha.json b/discovery/authorizedbuyersmarketplace-v1alpha.json index cceff6b2ee8..48d473b800b 100644 --- a/discovery/authorizedbuyersmarketplace-v1alpha.json +++ b/discovery/authorizedbuyersmarketplace-v1alpha.json @@ -1550,7 +1550,7 @@ } } }, - "revision": "20250113", + "revision": "20250303", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -1974,7 +1974,7 @@ "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. Once set, the currency code cannot be changed." + "description": "Required. 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. Once set, the currency code cannot be changed." }, "createTime": { "description": "Output only. Time the data segment was created.", @@ -2109,6 +2109,21 @@ "readOnly": true, "type": "string" }, + "buyerPermissionType": { + "description": "Output only. The buyer permission type of the deal.", + "enum": [ + "BUYER_PERMISSION_TYPE_UNSPECIFIED", + "NEGOTIATOR_ONLY", + "BIDDER" + ], + "enumDescriptions": [ + "A placeholder for an undefined buyer permission type.", + "Only the [Deal.negotiating_buyer] can transact on the deal.", + "All buyers under the [Deal.negotiating_buyer]'s bidder can transact on the deal." + ], + "readOnly": true, + "type": "string" + }, "client": { "description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", "readOnly": true, diff --git a/src/apis/authorizedbuyersmarketplace/v1.ts b/src/apis/authorizedbuyersmarketplace/v1.ts index b4e32c96fcf..ab504e596eb 100644 --- a/src/apis/authorizedbuyersmarketplace/v1.ts +++ b/src/apis/authorizedbuyersmarketplace/v1.ts @@ -400,6 +400,10 @@ export namespace authorizedbuyersmarketplace_v1 { * Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId\}` */ buyer?: string | null; + /** + * Output only. The buyer permission type of the deal. + */ + buyerPermissionType?: string | null; /** * Output only. Refers to a Client. Format: `buyers/{buyerAccountId\}/clients/{clientAccountid\}` */ diff --git a/src/apis/authorizedbuyersmarketplace/v1alpha.ts b/src/apis/authorizedbuyersmarketplace/v1alpha.ts index 3e3ed22063e..53ce8c8aee2 100644 --- a/src/apis/authorizedbuyersmarketplace/v1alpha.ts +++ b/src/apis/authorizedbuyersmarketplace/v1alpha.ts @@ -359,7 +359,7 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ 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. Once set, the currency code cannot be changed. + * Required. 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. Once set, the currency code cannot be changed. */ cpmFee?: Schema$Money; /** @@ -433,6 +433,10 @@ export namespace authorizedbuyersmarketplace_v1alpha { * Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId\}` */ buyer?: string | null; + /** + * Output only. The buyer permission type of the deal. + */ + buyerPermissionType?: string | null; /** * Output only. Refers to a Client. Format: `buyers/{buyerAccountId\}/clients/{clientAccountid\}` */ From 6e0d3f9f3ffee8e5df4ebb88e6e37ee634c89a92 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 014/144] feat(backupdr): update the API #### backupdr:v1 The following keys were added: - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.description - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.id - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.path - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.scopes - schemas.BackupConfigDetails.description - schemas.BackupConfigDetails.id - schemas.BackupConfigDetails.properties.applicableResource.description - schemas.BackupConfigDetails.properties.applicableResource.readOnly - schemas.BackupConfigDetails.properties.applicableResource.type - schemas.BackupConfigDetails.properties.backupConfigSource.description - schemas.BackupConfigDetails.properties.backupConfigSource.readOnly - schemas.BackupConfigDetails.properties.backupConfigSource.type - schemas.BackupConfigDetails.properties.backupConfigSourceDisplayName.description - schemas.BackupConfigDetails.properties.backupConfigSourceDisplayName.readOnly - schemas.BackupConfigDetails.properties.backupConfigSourceDisplayName.type - schemas.BackupConfigDetails.properties.backupDrPlanConfig.$ref - schemas.BackupConfigDetails.properties.backupDrPlanConfig.description - schemas.BackupConfigDetails.properties.backupDrTemplateConfig.$ref - schemas.BackupConfigDetails.properties.backupDrTemplateConfig.description - schemas.BackupConfigDetails.properties.backupLocations.description - schemas.BackupConfigDetails.properties.backupLocations.items.$ref - schemas.BackupConfigDetails.properties.backupLocations.type - schemas.BackupConfigDetails.properties.backupVault.description - schemas.BackupConfigDetails.properties.backupVault.readOnly - schemas.BackupConfigDetails.properties.backupVault.type - schemas.BackupConfigDetails.properties.latestSuccessfulBackupTime.description - schemas.BackupConfigDetails.properties.latestSuccessfulBackupTime.format - schemas.BackupConfigDetails.properties.latestSuccessfulBackupTime.readOnly - schemas.BackupConfigDetails.properties.latestSuccessfulBackupTime.type - schemas.BackupConfigDetails.properties.pitrSettings.$ref - schemas.BackupConfigDetails.properties.pitrSettings.description - schemas.BackupConfigDetails.properties.pitrSettings.readOnly - schemas.BackupConfigDetails.properties.state.description - schemas.BackupConfigDetails.properties.state.enum - schemas.BackupConfigDetails.properties.state.enumDescriptions - schemas.BackupConfigDetails.properties.state.readOnly - schemas.BackupConfigDetails.properties.state.type - schemas.BackupConfigDetails.properties.type.description - schemas.BackupConfigDetails.properties.type.enum - schemas.BackupConfigDetails.properties.type.enumDescriptions - schemas.BackupConfigDetails.properties.type.readOnly - schemas.BackupConfigDetails.properties.type.type - schemas.BackupConfigDetails.type - schemas.BackupConfigInfo.properties.lastSuccessfulLogBackupConsistencyTime.description - schemas.BackupConfigInfo.properties.lastSuccessfulLogBackupConsistencyTime.format - schemas.BackupConfigInfo.properties.lastSuccessfulLogBackupConsistencyTime.readOnly - schemas.BackupConfigInfo.properties.lastSuccessfulLogBackupConsistencyTime.type - schemas.BackupDrPlanConfig.description - schemas.BackupDrPlanConfig.id - schemas.BackupDrPlanConfig.properties.backupDrPlanRules.description - schemas.BackupDrPlanConfig.properties.backupDrPlanRules.items.$ref - schemas.BackupDrPlanConfig.properties.backupDrPlanRules.type - schemas.BackupDrPlanConfig.type - schemas.BackupDrPlanRule.description - schemas.BackupDrPlanRule.id - schemas.BackupDrPlanRule.properties.lastSuccessfulBackupTime.description - schemas.BackupDrPlanRule.properties.lastSuccessfulBackupTime.format - schemas.BackupDrPlanRule.properties.lastSuccessfulBackupTime.readOnly - schemas.BackupDrPlanRule.properties.lastSuccessfulBackupTime.type - schemas.BackupDrPlanRule.properties.ruleId.description - schemas.BackupDrPlanRule.properties.ruleId.readOnly - schemas.BackupDrPlanRule.properties.ruleId.type - schemas.BackupDrPlanRule.type - schemas.BackupDrTemplateConfig.description - schemas.BackupDrTemplateConfig.id - schemas.BackupDrTemplateConfig.properties.firstPartyManagementUri.description - schemas.BackupDrTemplateConfig.properties.firstPartyManagementUri.readOnly - schemas.BackupDrTemplateConfig.properties.firstPartyManagementUri.type - schemas.BackupDrTemplateConfig.properties.thirdPartyManagementUri.description - schemas.BackupDrTemplateConfig.properties.thirdPartyManagementUri.readOnly - schemas.BackupDrTemplateConfig.properties.thirdPartyManagementUri.type - schemas.BackupDrTemplateConfig.type - schemas.BackupLocation.description - schemas.BackupLocation.id - schemas.BackupLocation.properties.locationId.description - schemas.BackupLocation.properties.locationId.readOnly - schemas.BackupLocation.properties.locationId.type - schemas.BackupLocation.properties.type.description - schemas.BackupLocation.properties.type.enum - schemas.BackupLocation.properties.type.enumDescriptions - schemas.BackupLocation.properties.type.readOnly - schemas.BackupLocation.properties.type.type - schemas.BackupLocation.type - schemas.ListResourceBackupConfigsResponse.description - schemas.ListResourceBackupConfigsResponse.id - schemas.ListResourceBackupConfigsResponse.properties.nextPageToken.description - schemas.ListResourceBackupConfigsResponse.properties.nextPageToken.type - schemas.ListResourceBackupConfigsResponse.properties.resourceBackupConfigs.description - schemas.ListResourceBackupConfigsResponse.properties.resourceBackupConfigs.items.$ref - schemas.ListResourceBackupConfigsResponse.properties.resourceBackupConfigs.type - schemas.ListResourceBackupConfigsResponse.type - schemas.PitrSettings.description - schemas.PitrSettings.id - schemas.PitrSettings.properties.retentionDays.description - schemas.PitrSettings.properties.retentionDays.format - schemas.PitrSettings.properties.retentionDays.readOnly - schemas.PitrSettings.properties.retentionDays.type - schemas.PitrSettings.type - schemas.ResourceBackupConfig.description - schemas.ResourceBackupConfig.id - schemas.ResourceBackupConfig.properties.backupConfigsDetails.description - schemas.ResourceBackupConfig.properties.backupConfigsDetails.items.$ref - schemas.ResourceBackupConfig.properties.backupConfigsDetails.type - schemas.ResourceBackupConfig.properties.backupConfigured.description - schemas.ResourceBackupConfig.properties.backupConfigured.readOnly - schemas.ResourceBackupConfig.properties.backupConfigured.type - schemas.ResourceBackupConfig.properties.name.description - schemas.ResourceBackupConfig.properties.name.type - schemas.ResourceBackupConfig.properties.targetResource.description - schemas.ResourceBackupConfig.properties.targetResource.readOnly - schemas.ResourceBackupConfig.properties.targetResource.type - schemas.ResourceBackupConfig.properties.targetResourceDisplayName.description - schemas.ResourceBackupConfig.properties.targetResourceDisplayName.readOnly - schemas.ResourceBackupConfig.properties.targetResourceDisplayName.type - schemas.ResourceBackupConfig.properties.targetResourceLabels.additionalProperties.type - schemas.ResourceBackupConfig.properties.targetResourceLabels.description - schemas.ResourceBackupConfig.properties.targetResourceLabels.type - schemas.ResourceBackupConfig.properties.targetResourceType.description - schemas.ResourceBackupConfig.properties.targetResourceType.enum - schemas.ResourceBackupConfig.properties.targetResourceType.enumDescriptions - schemas.ResourceBackupConfig.properties.targetResourceType.readOnly - schemas.ResourceBackupConfig.properties.targetResourceType.type - schemas.ResourceBackupConfig.properties.uid.description - schemas.ResourceBackupConfig.properties.uid.readOnly - schemas.ResourceBackupConfig.properties.uid.type - schemas.ResourceBackupConfig.properties.vaulted.description - schemas.ResourceBackupConfig.properties.vaulted.readOnly - schemas.ResourceBackupConfig.properties.vaulted.type - schemas.ResourceBackupConfig.type The following keys were changed: - schemas.BackupPlan.properties.resourceType.description - schemas.BackupPlanAssociation.properties.resourceType.description - schemas.StandardSchedule.properties.hourlyFrequency.description --- discovery/backupdr-v1.json | 327 ++++++++++++++++++++++++++++++++++++- src/apis/backupdr/v1.ts | 302 +++++++++++++++++++++++++++++++++- 2 files changed, 622 insertions(+), 7 deletions(-) diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index bac63c59406..c1ac85c76a2 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -1658,6 +1658,56 @@ } } }, + "resourceBackupConfigs": { + "methods": { + "list": { + "description": "Lists ResourceBackupConfigs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/resourceBackupConfigs", + "httpMethod": "GET", + "id": "backupdr.projects.locations.resourceBackupConfigs.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 resource backup configs. 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" + } + }, + "path": "v1/{+parent}/resourceBackupConfigs", + "response": { + "$ref": "ListResourceBackupConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "serviceConfig": { "methods": { "initialize": { @@ -1695,7 +1745,7 @@ } } }, - "revision": "20241204", + "revision": "20250305", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2282,6 +2332,95 @@ }, "type": "object" }, + "BackupConfigDetails": { + "description": "BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.", + "id": "BackupConfigDetails", + "properties": { + "applicableResource": { + "description": "Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource that is applicable for the backup configuration. Example: \"//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}\"", + "readOnly": true, + "type": "string" + }, + "backupConfigSource": { + "description": "Output only. The full resource name of the backup config source resource. For example, \"//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}\" or \"//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}\".", + "readOnly": true, + "type": "string" + }, + "backupConfigSourceDisplayName": { + "description": "Output only. The display name of the backup config source resource.", + "readOnly": true, + "type": "string" + }, + "backupDrPlanConfig": { + "$ref": "BackupDrPlanConfig", + "description": "Backup and DR's Backup Plan specific data." + }, + "backupDrTemplateConfig": { + "$ref": "BackupDrTemplateConfig", + "description": "Backup and DR's Template specific data." + }, + "backupLocations": { + "description": "The locations where the backups are to be stored.", + "items": { + "$ref": "BackupLocation" + }, + "type": "array" + }, + "backupVault": { + "description": "Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the backup vault that will store the backups generated through this backup configuration. Example: \"//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}\"", + "readOnly": true, + "type": "string" + }, + "latestSuccessfulBackupTime": { + "description": "Output only. Timestamp of the latest successful backup created via this backup configuration.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "pitrSettings": { + "$ref": "PitrSettings", + "description": "Output only. Point in time recovery settings of the backup configuration resource.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the backup config resource.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE", + "ERROR" + ], + "enumDescriptions": [ + "Backup config state not set.", + "The config is in an active state protecting the resource", + "The config is currently not protecting the resource. Either because it is disabled or the owning project has been deleted without cleanup of the actual resource.", + "The config still exists but because of some error state it is not protecting the resource. Like the source project is deleted. For eg. PlanAssociation, BackupPlan is deleted." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of the backup config resource.", + "enum": [ + "TYPE_UNSPECIFIED", + "CLOUD_SQL_INSTANCE_BACKUP_CONFIG", + "COMPUTE_ENGINE_RESOURCE_POLICY", + "BACKUPDR_BACKUP_PLAN", + "BACKUPDR_TEMPLATE" + ], + "enumDescriptions": [ + "Backup config type is unspecified.", + "Backup config is Cloud SQL instance's automated backup config.", + "Backup config is Compute Engine Resource Policy.", + "Backup config is Backup and DR's Backup Plan.", + "Backup config is Backup and DR's Template." + ], + "readOnly": true, + "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", @@ -2323,6 +2462,90 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "lastSuccessfulLogBackupConsistencyTime": { + "description": "Output only. If the last log backup were successful, this field has the consistency date.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupDrPlanConfig": { + "description": "BackupDrPlanConfig has additional information about Backup and DR's Plan backup configuration.", + "id": "BackupDrPlanConfig", + "properties": { + "backupDrPlanRules": { + "description": "Backup rules of the backup plan resource.", + "items": { + "$ref": "BackupDrPlanRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "BackupDrPlanRule": { + "description": "BackupDrPlanRule has rule specific information of the backup plan resource.", + "id": "BackupDrPlanRule", + "properties": { + "lastSuccessfulBackupTime": { + "description": "Output only. Timestamp of the latest successful backup created via this backup rule.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "ruleId": { + "description": "Output only. Unique Id of the backup rule.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupDrTemplateConfig": { + "description": "BackupDrTemplateConfig has additional information about Backup and DR's Template backup configuration.", + "id": "BackupDrTemplateConfig", + "properties": { + "firstPartyManagementUri": { + "description": "Output only. The URI of the BackupDr template resource for the first party identity users.", + "readOnly": true, + "type": "string" + }, + "thirdPartyManagementUri": { + "description": "Output only. The URI of the BackupDr template resource for the third party identity users.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupLocation": { + "description": "BackupLocation represents a cloud location where a backup can be stored.", + "id": "BackupLocation", + "properties": { + "locationId": { + "description": "Output only. The id of the cloud location. Example: \"us-central1\"", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of the location.", + "enum": [ + "TYPE_UNSPECIFIED", + "ZONAL", + "REGIONAL", + "MULTI_REGIONAL" + ], + "enumDescriptions": [ + "Location type is unspecified.", + "Location type is zonal.", + "Location type is regional.", + "Location type is multi regional." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -2395,7 +2618,7 @@ "type": "string" }, "resourceType": { - "description": "Required. The resource type to which the `BackupPlan` will be applied. Examples include, \"compute.googleapis.com/Instance\", \"sqladmin.googleapis.com/Instance\", or \"alloydb.googleapis.com/Cluster\".", + "description": "Required. ", "type": "string" }, "state": { @@ -2455,7 +2678,7 @@ "type": "string" }, "resourceType": { - "description": "Required. Immutable. Resource type of workload on which backupplan is applied", + "description": "Required. Immutable. ", "type": "string" }, "rulesConfigInfo": { @@ -3677,6 +3900,24 @@ }, "type": "object" }, + "ListResourceBackupConfigsResponse": { + "description": "Response for ListResourceBackupConfigs.", + "id": "ListResourceBackupConfigsResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "resourceBackupConfigs": { + "description": "The list of ResourceBackupConfigs for the specified scope.", + "items": { + "$ref": "ResourceBackupConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -4131,6 +4372,19 @@ }, "type": "object" }, + "PitrSettings": { + "description": "Point in time recovery settings of the backup configuration resource.", + "id": "PitrSettings", + "properties": { + "retentionDays": { + "description": "Output only. Number of days to retain the backup.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "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", @@ -4173,6 +4427,71 @@ }, "type": "object" }, + "ResourceBackupConfig": { + "description": "ResourceBackupConfig represents a resource along with its backup configurations.", + "id": "ResourceBackupConfig", + "properties": { + "backupConfigsDetails": { + "description": "Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.", + "items": { + "$ref": "BackupConfigDetails" + }, + "type": "array" + }, + "backupConfigured": { + "description": "Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}", + "type": "string" + }, + "targetResource": { + "description": "Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.", + "readOnly": true, + "type": "string" + }, + "targetResourceDisplayName": { + "description": "Output only. The human friendly name of the target resource.", + "readOnly": true, + "type": "string" + }, + "targetResourceLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with the target resource.", + "type": "object" + }, + "targetResourceType": { + "description": "Output only. The type of the target resource.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CLOUD_SQL_INSTANCE", + "COMPUTE_ENGINE_VM" + ], + "enumDescriptions": [ + "Resource type not set.", + "Cloud SQL instance.", + "Compute Engine VM." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. The unique identifier of the resource backup config.", + "readOnly": true, + "type": "string" + }, + "vaulted": { + "description": "Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, "RestoreBackupRequest": { "description": "Request message for restoring from a Backup.", "id": "RestoreBackupRequest", @@ -4462,7 +4781,7 @@ "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).", + "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 4 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" }, diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index 64d92a58002..c4e41f0452e 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -497,6 +497,55 @@ export namespace backupdr_v1 { */ slaId?: string | null; } + /** + * BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration. + */ + export interface Schema$BackupConfigDetails { + /** + * Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project\}/zones/{zone\}/instances/{instance\}" + */ + applicableResource?: string | null; + /** + * Output only. The full resource name of the backup config source resource. For example, "//backupdr.googleapis.com/v1/projects/{project\}/locations/{region\}/backupPlans/{backupplanId\}" or "//compute.googleapis.com/projects/{project\}/locations/{region\}/resourcePolicies/{resourcePolicyId\}". + */ + backupConfigSource?: string | null; + /** + * Output only. The display name of the backup config source resource. + */ + backupConfigSourceDisplayName?: string | null; + /** + * Backup and DR's Backup Plan specific data. + */ + backupDrPlanConfig?: Schema$BackupDrPlanConfig; + /** + * Backup and DR's Template specific data. + */ + backupDrTemplateConfig?: Schema$BackupDrTemplateConfig; + /** + * The locations where the backups are to be stored. + */ + backupLocations?: Schema$BackupLocation[]; + /** + * Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project\}/locations/{region\}/backupVaults/{backupvaultId\}" + */ + backupVault?: string | null; + /** + * Output only. Timestamp of the latest successful backup created via this backup configuration. + */ + latestSuccessfulBackupTime?: string | null; + /** + * Output only. Point in time recovery settings of the backup configuration resource. + */ + pitrSettings?: Schema$PitrSettings; + /** + * Output only. The state of the backup config resource. + */ + state?: string | null; + /** + * Output only. The type of the backup config resource. + */ + type?: string | null; + } /** * BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault. */ @@ -521,6 +570,58 @@ export namespace backupdr_v1 { * Output only. If the last backup were successful, this field has the consistency date. */ lastSuccessfulBackupConsistencyTime?: string | null; + /** + * Output only. If the last log backup were successful, this field has the consistency date. + */ + lastSuccessfulLogBackupConsistencyTime?: string | null; + } + /** + * BackupDrPlanConfig has additional information about Backup and DR's Plan backup configuration. + */ + export interface Schema$BackupDrPlanConfig { + /** + * Backup rules of the backup plan resource. + */ + backupDrPlanRules?: Schema$BackupDrPlanRule[]; + } + /** + * BackupDrPlanRule has rule specific information of the backup plan resource. + */ + export interface Schema$BackupDrPlanRule { + /** + * Output only. Timestamp of the latest successful backup created via this backup rule. + */ + lastSuccessfulBackupTime?: string | null; + /** + * Output only. Unique Id of the backup rule. + */ + ruleId?: string | null; + } + /** + * BackupDrTemplateConfig has additional information about Backup and DR's Template backup configuration. + */ + export interface Schema$BackupDrTemplateConfig { + /** + * Output only. The URI of the BackupDr template resource for the first party identity users. + */ + firstPartyManagementUri?: string | null; + /** + * Output only. The URI of the BackupDr template resource for the third party identity users. + */ + thirdPartyManagementUri?: string | null; + } + /** + * BackupLocation represents a cloud location where a backup can be stored. + */ + export interface Schema$BackupLocation { + /** + * Output only. The id of the cloud location. Example: "us-central1" + */ + locationId?: string | null; + /** + * Output only. The type of the location. + */ + type?: string | null; } /** * BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted. @@ -576,7 +677,7 @@ export namespace backupdr_v1 { */ name?: string | null; /** - * Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", or "alloydb.googleapis.com/Cluster". + * Required. */ resourceType?: string | null; /** @@ -613,7 +714,7 @@ export namespace backupdr_v1 { */ resource?: string | null; /** - * Required. Immutable. Resource type of workload on which backupplan is applied + * Required. Immutable. */ resourceType?: string | null; /** @@ -1470,6 +1571,19 @@ export namespace backupdr_v1 { */ operations?: Schema$Operation[]; } + /** + * Response for ListResourceBackupConfigs. + */ + export interface Schema$ListResourceBackupConfigsResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of ResourceBackupConfigs for the specified scope. + */ + resourceBackupConfigs?: Schema$ResourceBackupConfig[]; + } /** * A resource that represents a Google Cloud location. */ @@ -1748,6 +1862,15 @@ export namespace backupdr_v1 { */ verb?: string | null; } + /** + * Point in time recovery settings of the backup configuration resource. + */ + export interface Schema$PitrSettings { + /** + * Output only. Number of days to retain the backup. + */ + retentionDays?: number | 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/). */ @@ -1778,6 +1901,47 @@ export namespace backupdr_v1 { */ requestId?: string | null; } + /** + * ResourceBackupConfig represents a resource along with its backup configurations. + */ + export interface Schema$ResourceBackupConfig { + /** + * Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated. + */ + backupConfigsDetails?: Schema$BackupConfigDetails[]; + /** + * Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty. + */ + backupConfigured?: boolean | null; + /** + * Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project\}/locations/{location\}/resourceBackupConfigs/{uid\} + */ + name?: string | null; + /** + * Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType. + */ + targetResource?: string | null; + /** + * Output only. The human friendly name of the target resource. + */ + targetResourceDisplayName?: string | null; + /** + * Labels associated with the target resource. + */ + targetResourceLabels?: {[key: string]: string} | null; + /** + * Output only. The type of the target resource. + */ + targetResourceType?: string | null; + /** + * Output only. The unique identifier of the resource backup config. + */ + uid?: string | null; + /** + * Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set. + */ + vaulted?: boolean | null; + } /** * Request message for restoring from a Backup. */ @@ -1948,7 +2112,7 @@ export namespace backupdr_v1 { */ 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). + * 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 4 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; /** @@ -2090,6 +2254,7 @@ export namespace backupdr_v1 { backupVaults: Resource$Projects$Locations$Backupvaults; managementServers: Resource$Projects$Locations$Managementservers; operations: Resource$Projects$Locations$Operations; + resourceBackupConfigs: Resource$Projects$Locations$Resourcebackupconfigs; serviceConfig: Resource$Projects$Locations$Serviceconfig; constructor(context: APIRequestContext) { this.context = context; @@ -2106,6 +2271,8 @@ export namespace backupdr_v1 { this.operations = new Resource$Projects$Locations$Operations( this.context ); + this.resourceBackupConfigs = + new Resource$Projects$Locations$Resourcebackupconfigs(this.context); this.serviceConfig = new Resource$Projects$Locations$Serviceconfig( this.context ); @@ -6679,6 +6846,135 @@ export namespace backupdr_v1 { pageToken?: string; } + export class Resource$Projects$Locations$Resourcebackupconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists ResourceBackupConfigs. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Resourcebackupconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Resourcebackupconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Resourcebackupconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Resourcebackupconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Resourcebackupconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Resourcebackupconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Resourcebackupconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Resourcebackupconfigs$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}/resourceBackupConfigs').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$Resourcebackupconfigs$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 resource backup configs. Format: 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. + */ + parent?: string; + } + export class Resource$Projects$Locations$Serviceconfig { context: APIRequestContext; constructor(context: APIRequestContext) { From 143a50b53356e07a8e75f378895ee8fccc4b81aa Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 015/144] feat(batch): update the API #### batch:v1 The following keys were added: - resources.projects.resources.locations.resources.jobs.methods.cancel.description - resources.projects.resources.locations.resources.jobs.methods.cancel.flatPath - resources.projects.resources.locations.resources.jobs.methods.cancel.httpMethod - resources.projects.resources.locations.resources.jobs.methods.cancel.id - resources.projects.resources.locations.resources.jobs.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.jobs.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.jobs.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.jobs.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.jobs.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.jobs.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.jobs.methods.cancel.path - resources.projects.resources.locations.resources.jobs.methods.cancel.request.$ref - resources.projects.resources.locations.resources.jobs.methods.cancel.response.$ref - resources.projects.resources.locations.resources.jobs.methods.cancel.scopes - schemas.CancelJobRequest.description - schemas.CancelJobRequest.id - schemas.CancelJobRequest.properties.requestId.description - schemas.CancelJobRequest.properties.requestId.type - schemas.CancelJobRequest.type The following keys were changed: - schemas.JobStatus.properties.state.enum - schemas.JobStatus.properties.state.enumDescriptions - schemas.Message.properties.newJobState.enum - schemas.Message.properties.newJobState.enumDescriptions --- discovery/batch-v1.json | 57 +++++++++++++++++++-- src/apis/batch/v1.ts | 106 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 158 insertions(+), 5 deletions(-) diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 00cffc9a38e..2980454ebcd 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -179,6 +179,34 @@ "resources": { "jobs": { "methods": { + "cancel": { + "description": "Cancel a Job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:cancel", + "httpMethod": "POST", + "id": "batch.projects.locations.jobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Job name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Create a Job.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs", @@ -561,7 +589,7 @@ } } }, - "revision": "20241204", + "revision": "20250122", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1059,6 +1087,17 @@ }, "type": "object" }, + "CancelJobRequest": { + "description": "CancelJob Request.", + "id": "CancelJobRequest", + "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" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -1434,7 +1473,9 @@ "RUNNING", "SUCCEEDED", "FAILED", - "DELETION_IN_PROGRESS" + "DELETION_IN_PROGRESS", + "CANCELLATION_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Job state unspecified.", @@ -1443,7 +1484,9 @@ "Resource allocation has been successful. At least one Task in the Job is RUNNING.", "All Tasks in the Job have finished successfully.", "At least one Task in the Job has failed.", - "The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up." + "The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up.", + "The Job cancellation is in progress, this is because the resources used by the Job are still being cleaned up.", + "The Job has been cancelled, the task executions were stopped and the resources were cleaned up." ], "type": "string" }, @@ -1678,7 +1721,9 @@ "RUNNING", "SUCCEEDED", "FAILED", - "DELETION_IN_PROGRESS" + "DELETION_IN_PROGRESS", + "CANCELLATION_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Job state unspecified.", @@ -1687,7 +1732,9 @@ "Resource allocation has been successful. At least one Task in the Job is RUNNING.", "All Tasks in the Job have finished successfully.", "At least one Task in the Job has failed.", - "The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up." + "The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up.", + "The Job cancellation is in progress, this is because the resources used by the Job are still being cleaned up.", + "The Job has been cancelled, the task executions were stopped and the resources were cleaned up." ], "type": "string" }, diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index f0d2cfcbd23..a620040a52a 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -495,6 +495,15 @@ export namespace batch_v1 { */ name?: string | null; } + /** + * CancelJob Request. + */ + export interface Schema$CancelJobRequest { + /** + * 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 request message for Operations.CancelOperation. */ @@ -1587,6 +1596,91 @@ export namespace batch_v1 { ); } + /** + * Cancel a 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$Jobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Jobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Jobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Jobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Jobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Jobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Jobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://batch.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); + } + } + /** * Create a Job. * @@ -1928,6 +2022,18 @@ export namespace batch_v1 { } } + export interface Params$Resource$Projects$Locations$Jobs$Cancel + extends StandardParameters { + /** + * Required. Job name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelJobRequest; + } export interface Params$Resource$Projects$Locations$Jobs$Create extends StandardParameters { /** From 11fae66377d6a494a9a1ac9d8be6917d90eaed9e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 016/144] feat(beyondcorp)!: update the API BREAKING CHANGE: This release has breaking changes. #### beyondcorp:v1alpha The following keys were deleted: - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.request.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.request.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.request.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.description - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.flatPath - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.httpMethod - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.id - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameterOrder - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.path - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.request.$ref - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.response.$ref - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.description - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.id - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.path - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.request.$ref - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.connections.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.description - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.id - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.path - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.request.$ref - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.connectors.methods.testIamPermissions.scopes - schemas.GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription.properties.endTime.readOnly - schemas.GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription.properties.startTime.readOnly The following keys were added: - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.create.deprecated - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.delete.deprecated - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.patch.deprecated - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.create.deprecated - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.delete.deprecated - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.get.deprecated - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.list.deprecated - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.patch.deprecated - resources.projects.resources.locations.resources.appGateways.methods.shouldThrottle.deprecated - schemas.GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription.properties.csgCustomer.description - schemas.GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription.properties.csgCustomer.type - schemas.ShouldThrottleResponse.deprecated The following keys were changed: - resources.projects.resources.locations.resources.global.resources.securityGateways.resources.applications.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.securityGateways.methods.patch.parameters.updateMask.description - schemas.GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription.properties.endTime.description - schemas.GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription.properties.startTime.description #### beyondcorp:v1 The following keys were deleted: - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.getIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.request.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.methods.setIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.getIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.request.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.browserDlpRules.methods.setIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.getIamPolicy.scopes - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.flatPath - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.httpMethod - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.id - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameterOrder - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.description - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.location - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.pattern - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.required - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.parameters.resource.type - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.path - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.request.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.response.$ref - resources.organizations.resources.locations.resources.global.resources.partnerTenants.resources.proxyConfigs.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.description - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.flatPath - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.httpMethod - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.id - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameterOrder - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.path - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.request.$ref - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.response.$ref - resources.projects.resources.locations.resources.clientGateways.methods.setIamPolicy.scopes The following keys were added: - resources.projects.resources.locations.resources.appGateways.methods.shouldThrottle.deprecated - schemas.ShouldThrottleResponse.deprecated The following keys were changed: - resources.projects.resources.locations.resources.global.resources.securityGateways.resources.applications.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.securityGateways.methods.patch.parameters.updateMask.description --- discovery/beyondcorp-v1.json | 213 +----- discovery/beyondcorp-v1alpha.json | 287 +------- src/apis/beyondcorp/v1.ts | 943 +++---------------------- src/apis/beyondcorp/v1alpha.ts | 1083 ++--------------------------- 4 files changed, 190 insertions(+), 2336 deletions(-) diff --git a/discovery/beyondcorp-v1.json b/discovery/beyondcorp-v1.json index 5e0a04aa222..9fa1230c616 100644 --- a/discovery/beyondcorp-v1.json +++ b/discovery/beyondcorp-v1.json @@ -113,65 +113,6 @@ "resources": { "partnerTenants": { "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/global/partnerTenants/{partnerTenantsId}:getIamPolicy", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.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/global/partnerTenants/[^/]+$", - "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/global/partnerTenants/{partnerTenantsId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.organizations.locations.global.partnerTenants.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/global/partnerTenants/[^/]+$", - "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/global/partnerTenants/{partnerTenantsId}:testIamPermissions", @@ -204,65 +145,6 @@ "resources": { "browserDlpRules": { "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/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:getIamPolicy", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.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/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", - "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/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.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/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", - "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/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions", @@ -295,65 +177,6 @@ }, "proxyConfigs": { "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/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:getIamPolicy", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.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/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", - "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/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.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/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", - "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/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions", @@ -1465,6 +1288,7 @@ ] }, "shouldThrottle": { + "deprecated": true, "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", @@ -1655,34 +1479,6 @@ "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}/clientGateways/{clientGatewaysId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.clientGateways.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/[^/]+/clientGateways/[^/]+$", - "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}/clientGateways/{clientGatewaysId}:testIamPermissions", @@ -1779,7 +1575,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mutable fields include: display_name.", + "description": "Optional. Mutable fields include: display_name.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2152,7 +1948,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mutable fields include: display_name, hubs.", + "description": "Optional. Mutable fields include: display_name, hubs.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2403,7 +2199,7 @@ } } }, - "revision": "20241204", + "revision": "20250305", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -4248,6 +4044,7 @@ "type": "object" }, "ShouldThrottleResponse": { + "deprecated": true, "description": "Response message for calling ShouldThrottle", "id": "ShouldThrottleResponse", "properties": { diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index 32229789345..de79a280a62 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -114,6 +114,7 @@ "partnerTenants": { "methods": { "create": { + "deprecated": true, "description": "Creates a new BeyondCorp Enterprise partnerTenant in a given organization and can only be called by onboarded BeyondCorp Enterprise partner.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants", "httpMethod": "POST", @@ -147,6 +148,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a single PartnerTenant.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}", "httpMethod": "DELETE", @@ -201,37 +203,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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:getIamPolicy", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.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/global/partnerTenants/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists PartnerTenants in a given organization.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants", @@ -279,6 +250,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a single PartnerTenant.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}", "httpMethod": "PATCH", @@ -317,34 +289,6 @@ "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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.organizations.locations.global.partnerTenants.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/global/partnerTenants/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:testIamPermissions", @@ -465,37 +409,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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:getIamPolicy", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.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/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists BrowserDlpRules for PartnerTenant in a given organization.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules", @@ -560,34 +473,6 @@ "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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.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/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions", @@ -621,6 +506,7 @@ "proxyConfigs": { "methods": { "create": { + "deprecated": true, "description": "Creates a new BeyondCorp Enterprise ProxyConfig in a given organization and PartnerTenant. Can only be called by on onboarded Beyondcorp Enterprise partner.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs", "httpMethod": "POST", @@ -654,6 +540,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a single ProxyConfig.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}", "httpMethod": "DELETE", @@ -684,6 +571,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets details of a single ProxyConfig.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}", "httpMethod": "GET", @@ -708,38 +596,8 @@ "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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:getIamPolicy", - "httpMethod": "GET", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.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/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { + "deprecated": true, "description": "Lists ProxyConfigs for PartnerTenant in a given organization.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs", "httpMethod": "GET", @@ -786,6 +644,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a single proxy config.", "flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}", "httpMethod": "PATCH", @@ -824,34 +683,6 @@ "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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.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/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions", @@ -2365,6 +2196,7 @@ ] }, "shouldThrottle": { + "deprecated": true, "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", @@ -2737,34 +2569,6 @@ "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": "v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.clientGateways.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/[^/]+/clientGateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+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": "v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions", @@ -3094,34 +2898,6 @@ "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}/connections/{connectionsId}:testIamPermissions", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.connections.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/[^/]+/connections/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -3431,34 +3207,6 @@ "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}/connectors/{connectorsId}:testIamPermissions", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.connectors.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/[^/]+/connectors/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -3528,7 +3276,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mutable fields include: display_name.", + "description": "Optional. Mutable fields include: display_name.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4129,7 +3877,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mutable fields include: display_name, hubs.", + "description": "Optional. Mutable fields include: display_name, hubs.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4380,7 +4128,7 @@ } } }, - "revision": "20241204", + "revision": "20250305", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -6470,10 +6218,13 @@ "readOnly": true, "type": "string" }, + "csgCustomer": { + "description": "Optional. Whether the subscription is being created as part of the Citrix flow. If this field is set to true, the subscription should have both the start_time and end_time set in the request and the billing account used will be the Citrix master billing account regardless of what its set to in the request. This field can only be set to true in create requests.", + "type": "boolean" + }, "endTime": { - "description": "Output only. End time of the subscription.", + "description": "Optional. End time of the subscription.", "format": "google-datetime", - "readOnly": true, "type": "string" }, "name": { @@ -6498,9 +6249,8 @@ "type": "string" }, "startTime": { - "description": "Output only. Start time of the subscription.", + "description": "Optional. Start time of the subscription.", "format": "google-datetime", - "readOnly": true, "type": "string" }, "state": { @@ -7376,6 +7126,7 @@ "type": "object" }, "ShouldThrottleResponse": { + "deprecated": true, "description": "Response message for calling ShouldThrottle", "id": "ShouldThrottleResponse", "properties": { diff --git a/src/apis/beyondcorp/v1.ts b/src/apis/beyondcorp/v1.ts index ca7194d2b49..002eec50e71 100644 --- a/src/apis/beyondcorp/v1.ts +++ b/src/apis/beyondcorp/v1.ts @@ -1515,194 +1515,6 @@ export namespace beyondcorp_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$Organizations$Locations$Global$Partnertenants$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.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$Organizations$Locations$Global$Partnertenants$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.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. * @@ -1718,519 +1530,51 @@ export namespace beyondcorp_v1 { testIamPermissions( params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.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$Organizations$Locations$Global$Partnertenants$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$Global$Partnertenants$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$Global$Partnertenants$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$Organizations$Locations$Global$Partnertenants$Browserdlprules { - 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$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.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$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.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$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.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$Organizations$Locations$Global$Partnertenants$Browserdlprules$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$Global$Partnertenants$Browserdlprules$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$Global$Partnertenants$Browserdlprules$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$Organizations$Locations$Global$Partnertenants$Proxyconfigs { - 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$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - getIamPolicy( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy; + {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy; + {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Testiampermissions; options = {}; } @@ -2243,11 +1587,11 @@ export namespace beyondcorp_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 @@ -2258,73 +1602,97 @@ export namespace beyondcorp_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Organizations$Locations$Global$Partnertenants$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; /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules { + 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, + testIamPermissions( + params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - setIamPolicy( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy; + {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy; + {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Testiampermissions; options = {}; } @@ -2337,7 +1705,7 @@ export namespace beyondcorp_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), @@ -2352,14 +1720,36 @@ export namespace beyondcorp_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$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$Organizations$Locations$Global$Partnertenants$Proxyconfigs { + 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. @@ -2460,29 +1850,6 @@ export namespace beyondcorp_v1 { } } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$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$Global$Partnertenants$Proxyconfigs$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$Global$Partnertenants$Proxyconfigs$Testiampermissions extends StandardParameters { /** @@ -6591,100 +5958,6 @@ export namespace beyondcorp_v1 { } } - /** - * 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$Clientgateways$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Clientgateways$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Clientgateways$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clientgateways$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Clientgateways$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.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. * @@ -6795,18 +6068,6 @@ export namespace beyondcorp_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Clientgateways$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$Clientgateways$Testiampermissions extends StandardParameters { /** @@ -7167,7 +6428,7 @@ export namespace beyondcorp_v1 { */ requestId?: string; /** - * Required. Mutable fields include: display_name. + * Optional. Mutable fields include: display_name. */ updateMask?: string; @@ -8459,7 +7720,7 @@ export namespace beyondcorp_v1 { */ requestId?: string; /** - * Required. Mutable fields include: display_name, hubs. + * Optional. Mutable fields include: display_name, hubs. */ updateMask?: string; diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 10ea474c7a5..98d6307dd85 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -1588,7 +1588,11 @@ export namespace beyondcorp_v1alpha { */ createTime?: string | null; /** - * Output only. End time of the subscription. + * Optional. Whether the subscription is being created as part of the Citrix flow. If this field is set to true, the subscription should have both the start_time and end_time set in the request and the billing account used will be the Citrix master billing account regardless of what its set to in the request. This field can only be set to true in create requests. + */ + csgCustomer?: boolean | null; + /** + * Optional. End time of the subscription. */ endTime?: string | null; /** @@ -1604,7 +1608,7 @@ export namespace beyondcorp_v1alpha { */ sku?: string | null; /** - * Output only. Start time of the subscription. + * Optional. Start time of the subscription. */ startTime?: string | null; /** @@ -2577,100 +2581,6 @@ export namespace beyondcorp_v1alpha { } } - /** - * 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$Organizations$Locations$Global$Partnertenants$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$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 PartnerTenants in a given organization. * @@ -2862,100 +2772,6 @@ 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Global$Partnertenants$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$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. * @@ -3089,17 +2905,6 @@ export namespace beyondcorp_v1alpha { */ name?: string; } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$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$Global$Partnertenants$List extends StandardParameters { /** @@ -3143,18 +2948,6 @@ export namespace beyondcorp_v1alpha { */ requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant; } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$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$Global$Partnertenants$Testiampermissions extends StandardParameters { /** @@ -3458,100 +3251,6 @@ export namespace beyondcorp_v1alpha { } } - /** - * 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$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$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 BrowserDlpRules for PartnerTenant in a given organization. * @@ -3743,100 +3442,6 @@ 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$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. * @@ -3970,17 +3575,6 @@ export namespace beyondcorp_v1alpha { */ name?: string; } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$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$Global$Partnertenants$Browserdlprules$List extends StandardParameters { /** @@ -4008,18 +3602,6 @@ export namespace beyondcorp_v1alpha { */ requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaBrowserDlpRule; } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Browserdlprules$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$Global$Partnertenants$Browserdlprules$Testiampermissions extends StandardParameters { /** @@ -4252,135 +3834,42 @@ export namespace beyondcorp_v1alpha { get( params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$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$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getIamPolicy( + get( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy; + {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Getiampolicy; + {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Get; options = {}; } @@ -4393,27 +3882,26 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + 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 + ); } } @@ -4608,100 +4096,6 @@ 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$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. * @@ -4835,17 +4229,6 @@ export namespace beyondcorp_v1alpha { */ name?: string; } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$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$Global$Partnertenants$Proxyconfigs$List extends StandardParameters { /** @@ -4889,18 +4272,6 @@ export namespace beyondcorp_v1alpha { */ requestBody?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig; } - export interface Params$Resource$Organizations$Locations$Global$Partnertenants$Proxyconfigs$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$Global$Partnertenants$Proxyconfigs$Testiampermissions extends StandardParameters { /** @@ -10631,153 +10002,59 @@ export namespace beyondcorp_v1alpha { } export interface Params$Resource$Projects$Locations$Clientconnectorservices$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$Clientgateways { - 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$Clientgateways$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Clientgateways$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clientgateways$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Clientgateways$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); - } + /** + * 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$Clientgateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * 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$Clientgateways$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Clientgateways$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, options?: MethodOptions ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Clientgateways$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Clientgateways$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clientgateways$Setiampolicy + | Params$Resource$Projects$Locations$Clientgateways$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10793,13 +10070,13 @@ export namespace beyondcorp_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clientgateways$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Clientgateways$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clientgateways$Setiampolicy; + {} as Params$Resource$Projects$Locations$Clientgateways$Getiampolicy; options = {}; } @@ -10812,11 +10089,11 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -10946,18 +10223,6 @@ export namespace beyondcorp_v1alpha { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Clientgateways$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$Clientgateways$Testiampermissions extends StandardParameters { /** @@ -11716,104 +10981,6 @@ export namespace beyondcorp_v1alpha { 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$Connections$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Connections$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Connections$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Connections$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Connections$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Connections$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Connections$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Connections$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$Connections$Create @@ -11955,18 +11122,6 @@ export namespace beyondcorp_v1alpha { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Connections$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$Connectors { context: APIRequestContext; @@ -12811,104 +11966,6 @@ export namespace beyondcorp_v1alpha { 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$Connectors$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Connectors$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Connectors$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Connectors$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Connectors$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Connectors$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Connectors$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Connectors$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$Connectors$Create @@ -13046,18 +12103,6 @@ export namespace beyondcorp_v1alpha { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Connectors$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$Global { context: APIRequestContext; @@ -13406,7 +12451,7 @@ export namespace beyondcorp_v1alpha { */ requestId?: string; /** - * Required. Mutable fields include: display_name. + * Optional. Mutable fields include: display_name. */ updateMask?: string; @@ -15091,7 +14136,7 @@ export namespace beyondcorp_v1alpha { */ requestId?: string; /** - * Required. Mutable fields include: display_name, hubs. + * Optional. Mutable fields include: display_name, hubs. */ updateMask?: string; From 646e06d37db65de11ac8c44bc4d5d8eaa8eb54ad Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 017/144] feat(bigquery): update the API #### bigquery:v2 The following keys were added: - resources.rowAccessPolicies.methods.batchDelete.description - resources.rowAccessPolicies.methods.batchDelete.flatPath - resources.rowAccessPolicies.methods.batchDelete.httpMethod - resources.rowAccessPolicies.methods.batchDelete.id - resources.rowAccessPolicies.methods.batchDelete.parameterOrder - resources.rowAccessPolicies.methods.batchDelete.parameters.datasetId.description - resources.rowAccessPolicies.methods.batchDelete.parameters.datasetId.location - resources.rowAccessPolicies.methods.batchDelete.parameters.datasetId.pattern - resources.rowAccessPolicies.methods.batchDelete.parameters.datasetId.required - resources.rowAccessPolicies.methods.batchDelete.parameters.datasetId.type - resources.rowAccessPolicies.methods.batchDelete.parameters.projectId.description - resources.rowAccessPolicies.methods.batchDelete.parameters.projectId.location - resources.rowAccessPolicies.methods.batchDelete.parameters.projectId.pattern - resources.rowAccessPolicies.methods.batchDelete.parameters.projectId.required - resources.rowAccessPolicies.methods.batchDelete.parameters.projectId.type - resources.rowAccessPolicies.methods.batchDelete.parameters.tableId.description - resources.rowAccessPolicies.methods.batchDelete.parameters.tableId.location - resources.rowAccessPolicies.methods.batchDelete.parameters.tableId.pattern - resources.rowAccessPolicies.methods.batchDelete.parameters.tableId.required - resources.rowAccessPolicies.methods.batchDelete.parameters.tableId.type - resources.rowAccessPolicies.methods.batchDelete.path - resources.rowAccessPolicies.methods.batchDelete.request.$ref - resources.rowAccessPolicies.methods.batchDelete.scopes - resources.rowAccessPolicies.methods.delete.description - resources.rowAccessPolicies.methods.delete.flatPath - resources.rowAccessPolicies.methods.delete.httpMethod - resources.rowAccessPolicies.methods.delete.id - resources.rowAccessPolicies.methods.delete.parameterOrder - resources.rowAccessPolicies.methods.delete.parameters.datasetId.description - resources.rowAccessPolicies.methods.delete.parameters.datasetId.location - resources.rowAccessPolicies.methods.delete.parameters.datasetId.pattern - resources.rowAccessPolicies.methods.delete.parameters.datasetId.required - resources.rowAccessPolicies.methods.delete.parameters.datasetId.type - resources.rowAccessPolicies.methods.delete.parameters.force.description - resources.rowAccessPolicies.methods.delete.parameters.force.location - resources.rowAccessPolicies.methods.delete.parameters.force.type - resources.rowAccessPolicies.methods.delete.parameters.policyId.description - resources.rowAccessPolicies.methods.delete.parameters.policyId.location - resources.rowAccessPolicies.methods.delete.parameters.policyId.pattern - resources.rowAccessPolicies.methods.delete.parameters.policyId.required - resources.rowAccessPolicies.methods.delete.parameters.policyId.type - resources.rowAccessPolicies.methods.delete.parameters.projectId.description - resources.rowAccessPolicies.methods.delete.parameters.projectId.location - resources.rowAccessPolicies.methods.delete.parameters.projectId.pattern - resources.rowAccessPolicies.methods.delete.parameters.projectId.required - resources.rowAccessPolicies.methods.delete.parameters.projectId.type - resources.rowAccessPolicies.methods.delete.parameters.tableId.description - resources.rowAccessPolicies.methods.delete.parameters.tableId.location - resources.rowAccessPolicies.methods.delete.parameters.tableId.pattern - resources.rowAccessPolicies.methods.delete.parameters.tableId.required - resources.rowAccessPolicies.methods.delete.parameters.tableId.type - resources.rowAccessPolicies.methods.delete.path - resources.rowAccessPolicies.methods.delete.scopes - resources.rowAccessPolicies.methods.get.description - resources.rowAccessPolicies.methods.get.flatPath - resources.rowAccessPolicies.methods.get.httpMethod - resources.rowAccessPolicies.methods.get.id - resources.rowAccessPolicies.methods.get.parameterOrder - resources.rowAccessPolicies.methods.get.parameters.datasetId.description - resources.rowAccessPolicies.methods.get.parameters.datasetId.location - resources.rowAccessPolicies.methods.get.parameters.datasetId.pattern - resources.rowAccessPolicies.methods.get.parameters.datasetId.required - resources.rowAccessPolicies.methods.get.parameters.datasetId.type - resources.rowAccessPolicies.methods.get.parameters.policyId.description - resources.rowAccessPolicies.methods.get.parameters.policyId.location - resources.rowAccessPolicies.methods.get.parameters.policyId.pattern - resources.rowAccessPolicies.methods.get.parameters.policyId.required - resources.rowAccessPolicies.methods.get.parameters.policyId.type - resources.rowAccessPolicies.methods.get.parameters.projectId.description - resources.rowAccessPolicies.methods.get.parameters.projectId.location - resources.rowAccessPolicies.methods.get.parameters.projectId.pattern - resources.rowAccessPolicies.methods.get.parameters.projectId.required - resources.rowAccessPolicies.methods.get.parameters.projectId.type - resources.rowAccessPolicies.methods.get.parameters.tableId.description - resources.rowAccessPolicies.methods.get.parameters.tableId.location - resources.rowAccessPolicies.methods.get.parameters.tableId.pattern - resources.rowAccessPolicies.methods.get.parameters.tableId.required - resources.rowAccessPolicies.methods.get.parameters.tableId.type - resources.rowAccessPolicies.methods.get.path - resources.rowAccessPolicies.methods.get.response.$ref - resources.rowAccessPolicies.methods.get.scopes - resources.rowAccessPolicies.methods.insert.description - resources.rowAccessPolicies.methods.insert.flatPath - resources.rowAccessPolicies.methods.insert.httpMethod - resources.rowAccessPolicies.methods.insert.id - resources.rowAccessPolicies.methods.insert.parameterOrder - resources.rowAccessPolicies.methods.insert.parameters.datasetId.description - resources.rowAccessPolicies.methods.insert.parameters.datasetId.location - resources.rowAccessPolicies.methods.insert.parameters.datasetId.pattern - resources.rowAccessPolicies.methods.insert.parameters.datasetId.required - resources.rowAccessPolicies.methods.insert.parameters.datasetId.type - resources.rowAccessPolicies.methods.insert.parameters.projectId.description - resources.rowAccessPolicies.methods.insert.parameters.projectId.location - resources.rowAccessPolicies.methods.insert.parameters.projectId.pattern - resources.rowAccessPolicies.methods.insert.parameters.projectId.required - resources.rowAccessPolicies.methods.insert.parameters.projectId.type - resources.rowAccessPolicies.methods.insert.parameters.tableId.description - resources.rowAccessPolicies.methods.insert.parameters.tableId.location - resources.rowAccessPolicies.methods.insert.parameters.tableId.pattern - resources.rowAccessPolicies.methods.insert.parameters.tableId.required - resources.rowAccessPolicies.methods.insert.parameters.tableId.type - resources.rowAccessPolicies.methods.insert.path - resources.rowAccessPolicies.methods.insert.request.$ref - resources.rowAccessPolicies.methods.insert.response.$ref - resources.rowAccessPolicies.methods.insert.scopes - resources.rowAccessPolicies.methods.update.description - resources.rowAccessPolicies.methods.update.flatPath - resources.rowAccessPolicies.methods.update.httpMethod - resources.rowAccessPolicies.methods.update.id - resources.rowAccessPolicies.methods.update.parameterOrder - resources.rowAccessPolicies.methods.update.parameters.datasetId.description - resources.rowAccessPolicies.methods.update.parameters.datasetId.location - resources.rowAccessPolicies.methods.update.parameters.datasetId.pattern - resources.rowAccessPolicies.methods.update.parameters.datasetId.required - resources.rowAccessPolicies.methods.update.parameters.datasetId.type - resources.rowAccessPolicies.methods.update.parameters.policyId.description - resources.rowAccessPolicies.methods.update.parameters.policyId.location - resources.rowAccessPolicies.methods.update.parameters.policyId.pattern - resources.rowAccessPolicies.methods.update.parameters.policyId.required - resources.rowAccessPolicies.methods.update.parameters.policyId.type - resources.rowAccessPolicies.methods.update.parameters.projectId.description - resources.rowAccessPolicies.methods.update.parameters.projectId.location - resources.rowAccessPolicies.methods.update.parameters.projectId.pattern - resources.rowAccessPolicies.methods.update.parameters.projectId.required - resources.rowAccessPolicies.methods.update.parameters.projectId.type - resources.rowAccessPolicies.methods.update.parameters.tableId.description - resources.rowAccessPolicies.methods.update.parameters.tableId.location - resources.rowAccessPolicies.methods.update.parameters.tableId.pattern - resources.rowAccessPolicies.methods.update.parameters.tableId.required - resources.rowAccessPolicies.methods.update.parameters.tableId.type - resources.rowAccessPolicies.methods.update.path - resources.rowAccessPolicies.methods.update.request.$ref - resources.rowAccessPolicies.methods.update.response.$ref - resources.rowAccessPolicies.methods.update.scopes - schemas.BatchDeleteRowAccessPoliciesRequest.description - schemas.BatchDeleteRowAccessPoliciesRequest.id - schemas.BatchDeleteRowAccessPoliciesRequest.properties.force.description - schemas.BatchDeleteRowAccessPoliciesRequest.properties.force.type - schemas.BatchDeleteRowAccessPoliciesRequest.properties.policyIds.description - schemas.BatchDeleteRowAccessPoliciesRequest.properties.policyIds.items.type - schemas.BatchDeleteRowAccessPoliciesRequest.properties.policyIds.type - schemas.BatchDeleteRowAccessPoliciesRequest.type - schemas.CsvOptions.properties.nullMarkers.description - schemas.CsvOptions.properties.nullMarkers.items.type - schemas.CsvOptions.properties.nullMarkers.type - schemas.CsvOptions.properties.sourceColumnMatch.description - schemas.CsvOptions.properties.sourceColumnMatch.type - schemas.ExternalDataConfiguration.properties.dateFormat.description - schemas.ExternalDataConfiguration.properties.dateFormat.type - schemas.ExternalDataConfiguration.properties.datetimeFormat.description - schemas.ExternalDataConfiguration.properties.datetimeFormat.type - schemas.ExternalDataConfiguration.properties.timeFormat.description - schemas.ExternalDataConfiguration.properties.timeFormat.type - schemas.ExternalDataConfiguration.properties.timeZone.description - schemas.ExternalDataConfiguration.properties.timeZone.type - schemas.ExternalDataConfiguration.properties.timestampFormat.description - schemas.ExternalDataConfiguration.properties.timestampFormat.type - schemas.JobConfigurationLoad.properties.dateFormat.description - schemas.JobConfigurationLoad.properties.dateFormat.type - schemas.JobConfigurationLoad.properties.datetimeFormat.description - schemas.JobConfigurationLoad.properties.datetimeFormat.type - schemas.JobConfigurationLoad.properties.nullMarkers.description - schemas.JobConfigurationLoad.properties.nullMarkers.items.type - schemas.JobConfigurationLoad.properties.nullMarkers.type - schemas.JobConfigurationLoad.properties.sourceColumnMatch.description - schemas.JobConfigurationLoad.properties.sourceColumnMatch.enum - schemas.JobConfigurationLoad.properties.sourceColumnMatch.enumDescriptions - schemas.JobConfigurationLoad.properties.sourceColumnMatch.type - schemas.JobConfigurationLoad.properties.timeFormat.description - schemas.JobConfigurationLoad.properties.timeFormat.type - schemas.JobConfigurationLoad.properties.timeZone.description - schemas.JobConfigurationLoad.properties.timeZone.type - schemas.JobConfigurationLoad.properties.timestampFormat.description - schemas.JobConfigurationLoad.properties.timestampFormat.type - schemas.JobConfigurationQuery.properties.writeIncrementalResults.description - schemas.JobConfigurationQuery.properties.writeIncrementalResults.type - schemas.QueryRequest.properties.destinationEncryptionConfiguration.$ref - schemas.QueryRequest.properties.destinationEncryptionConfiguration.description - schemas.QueryRequest.properties.jobTimeoutMs.description - schemas.QueryRequest.properties.jobTimeoutMs.format - schemas.QueryRequest.properties.jobTimeoutMs.type - schemas.QueryRequest.properties.writeIncrementalResults.description - schemas.QueryRequest.properties.writeIncrementalResults.type - schemas.RowAccessPolicy.properties.grantees.description - schemas.RowAccessPolicy.properties.grantees.items.type - schemas.RowAccessPolicy.properties.grantees.type - schemas.StoredColumnsUnusedReason.description - schemas.StoredColumnsUnusedReason.id - schemas.StoredColumnsUnusedReason.properties.code.description - schemas.StoredColumnsUnusedReason.properties.code.enum - schemas.StoredColumnsUnusedReason.properties.code.enumDescriptions - schemas.StoredColumnsUnusedReason.properties.code.type - schemas.StoredColumnsUnusedReason.properties.message.description - schemas.StoredColumnsUnusedReason.properties.message.type - schemas.StoredColumnsUnusedReason.properties.uncoveredColumns.description - schemas.StoredColumnsUnusedReason.properties.uncoveredColumns.items.type - schemas.StoredColumnsUnusedReason.properties.uncoveredColumns.type - schemas.StoredColumnsUnusedReason.type - schemas.StoredColumnsUsage.description - schemas.StoredColumnsUsage.id - schemas.StoredColumnsUsage.properties.baseTable.$ref - schemas.StoredColumnsUsage.properties.baseTable.description - schemas.StoredColumnsUsage.properties.isQueryAccelerated.description - schemas.StoredColumnsUsage.properties.isQueryAccelerated.type - schemas.StoredColumnsUsage.properties.storedColumnsUnusedReasons.description - schemas.StoredColumnsUsage.properties.storedColumnsUnusedReasons.items.$ref - schemas.StoredColumnsUsage.properties.storedColumnsUnusedReasons.type - schemas.StoredColumnsUsage.type - schemas.TrainingOptions.properties.forecastLimitLowerBound.description - schemas.TrainingOptions.properties.forecastLimitLowerBound.format - schemas.TrainingOptions.properties.forecastLimitLowerBound.type - schemas.TrainingOptions.properties.forecastLimitUpperBound.description - schemas.TrainingOptions.properties.forecastLimitUpperBound.format - schemas.TrainingOptions.properties.forecastLimitUpperBound.type - schemas.VectorSearchStatistics.properties.storedColumnsUsages.description - schemas.VectorSearchStatistics.properties.storedColumnsUsages.items.$ref - schemas.VectorSearchStatistics.properties.storedColumnsUsages.type The following keys were changed: - resources.datasets.methods.list.parameters.filter.description - schemas.AggregateClassificationMetrics.properties.threshold.description - schemas.ExternalDataConfiguration.properties.decimalTargetTypes.description - schemas.ExternalDataConfiguration.properties.jsonExtension.enumDescriptions - schemas.JobConfigurationLoad.properties.decimalTargetTypes.description - schemas.JobConfigurationLoad.properties.jsonExtension.enumDescriptions - schemas.MetadataCacheStatistics.description - schemas.TableList.properties.tables.items.properties.view.properties.privacyPolicy.description - schemas.TrainingOptions.properties.holidayRegion.enumDescriptions - schemas.TrainingOptions.properties.holidayRegions.items.enumDescriptions - schemas.TrainingOptions.properties.hparamTuningObjectives.items.enumDescriptions - schemas.ViewDefinition.properties.privacyPolicy.description --- discovery/bigquery-v2.json | 466 ++++++++++++++++++++++++- src/apis/bigquery/v2.ts | 689 ++++++++++++++++++++++++++++++++++++- 2 files changed, 1136 insertions(+), 19 deletions(-) diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index 5bf44e3036d..7a5bc9e9e5f 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -351,7 +351,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](https://cloud.google.com/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 AND-ed 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" }, @@ -1392,6 +1392,153 @@ }, "rowAccessPolicies": { "methods": { + "batchDelete": { + "description": "Deletes provided row access policies.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies:batchDelete", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.batchDelete", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the table to delete the row access policies.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the table to delete the row access policies.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Required. Table ID of the table to delete the row access policies.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies:batchDelete", + "request": { + "$ref": "BatchDeleteRowAccessPoliciesRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "delete": { + "description": "Deletes a row access policy.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}", + "httpMethod": "DELETE", + "id": "bigquery.rowAccessPolicies.delete", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId", + "policyId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the table to delete the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "force": { + "description": "If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.", + "location": "query", + "type": "boolean" + }, + "policyId": { + "description": "Required. Policy ID of the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the table to delete the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Required. Table ID of the table to delete the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets the specified row access policy by policy ID.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}", + "httpMethod": "GET", + "id": "bigquery.rowAccessPolicies.get", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId", + "policyId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "policyId": { + "description": "Required. Policy ID of the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Required. Table ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}", + "response": { + "$ref": "RowAccessPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "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": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:getIamPolicy", @@ -1422,6 +1569,52 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "insert": { + "description": "Creates a row access policy.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.insert", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Required. Table ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies", + "request": { + "$ref": "RowAccessPolicy" + }, + "response": { + "$ref": "RowAccessPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "list": { "description": "Lists all row access policies on the specified table.", "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies", @@ -1505,6 +1698,60 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] + }, + "update": { + "description": "Updates a row access policy.", + "flatPath": "projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}", + "httpMethod": "PUT", + "id": "bigquery.rowAccessPolicies.update", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId", + "policyId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "policyId": { + "description": "Required. Policy ID of the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Required. Table ID of the table to get the row access policy.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}", + "request": { + "$ref": "RowAccessPolicy" + }, + "response": { + "$ref": "RowAccessPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } } }, @@ -2009,7 +2256,7 @@ } } }, - "revision": "20250112", + "revision": "20250302", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2047,7 +2294,7 @@ "type": "number" }, "threshold": { - "description": "Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.", + "description": "Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold.", "format": "double", "type": "number" } @@ -2502,6 +2749,24 @@ }, "type": "object" }, + "BatchDeleteRowAccessPoliciesRequest": { + "description": "Request message for the BatchDeleteRowAccessPoliciesRequest method.", + "id": "BatchDeleteRowAccessPoliciesRequest", + "properties": { + "force": { + "description": "If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.", + "type": "boolean" + }, + "policyIds": { + "description": "Required. Policy IDs of the row access policies.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "BiEngineReason": { "description": "Reason why BI Engine didn't accelerate the query (or sub-query).", "id": "BiEngineReason", @@ -3110,6 +3375,13 @@ "description": "Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" as a null value when querying a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.", "type": "string" }, + "nullMarkers": { + "description": "Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.", + "items": { + "type": "string" + }, + "type": "array" + }, "preserveAsciiControlCharacters": { "description": "Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\\x00' to '\\x1F') are preserved.", "type": "boolean" @@ -3124,6 +3396,10 @@ "description": "Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.", "format": "int64", "type": "string" + }, + "sourceColumnMatch": { + "description": "Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. Acceptable values are: POSITION - matches by position. This assumes that the columns are ordered the same way as the schema. NAME - matches by name. This reads the header row as column names and reorders columns to match the field names in the schema.", + "type": "string" } }, "type": "object" @@ -4081,8 +4357,16 @@ "$ref": "CsvOptions", "description": "Optional. Additional properties to set if sourceFormat is set to CSV." }, + "dateFormat": { + "description": "Optional. Format used to parse DATE values. Supports C-style and SQL-style values.", + "type": "string" + }, + "datetimeFormat": { + "description": "Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values.", + "type": "string" + }, "decimalTargetTypes": { - "description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", + "description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", "items": { "enum": [ "DECIMAL_TARGET_TYPE_UNSPECIFIED", @@ -4131,7 +4415,7 @@ "GEOJSON" ], "enumDescriptions": [ - "The default if provided value is not one included in the enum, or the value is not specified. The source formate is parsed without any modification.", + "The default if provided value is not one included in the enum, or the value is not specified. The source format is parsed without any modification.", "Use GeoJSON variant of JSON. See https://tools.ietf.org/html/rfc7946." ], "type": "string" @@ -4195,6 +4479,18 @@ "type": "string" }, "type": "array" + }, + "timeFormat": { + "description": "Optional. Format used to parse TIME values. Supports C-style and SQL-style values.", + "type": "string" + }, + "timeZone": { + "description": "Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles).", + "type": "string" + }, + "timestampFormat": { + "description": "Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.", + "type": "string" } }, "type": "object" @@ -5095,8 +5391,16 @@ "description": "Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic.", "type": "boolean" }, + "dateFormat": { + "description": "Optional. Date format used for parsing DATE values.", + "type": "string" + }, + "datetimeFormat": { + "description": "Optional. Date format used for parsing DATETIME values.", + "type": "string" + }, "decimalTargetTypes": { - "description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", + "description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", "items": { "enum": [ "DECIMAL_TARGET_TYPE_UNSPECIFIED", @@ -5161,7 +5465,7 @@ "GEOJSON" ], "enumDescriptions": [ - "The default if provided value is not one included in the enum, or the value is not specified. The source formate is parsed without any modification.", + "The default if provided value is not one included in the enum, or the value is not specified. The source format is parsed without any modification.", "Use GeoJSON variant of JSON. See https://tools.ietf.org/html/rfc7946." ], "type": "string" @@ -5175,6 +5479,13 @@ "description": "Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.", "type": "string" }, + "nullMarkers": { + "description": "Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.", + "items": { + "type": "string" + }, + "type": "array" + }, "parquetOptions": { "$ref": "ParquetOptions", "description": "Optional. Additional properties to set if sourceFormat is set to PARQUET." @@ -5228,6 +5539,20 @@ "format": "int32", "type": "integer" }, + "sourceColumnMatch": { + "description": "Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible.", + "enum": [ + "SOURCE_COLUMN_MATCH_UNSPECIFIED", + "POSITION", + "NAME" + ], + "enumDescriptions": [ + "Uses sensible defaults based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible.", + "Matches by position. This assumes that the columns are ordered the same way as the schema.", + "Matches by name. This reads the header row as column names and reorders columns to match the field names in the schema." + ], + "type": "string" + }, "sourceFormat": { "description": "Optional. The format of the data files. For CSV files, specify \"CSV\". For datastore backups, specify \"DATASTORE_BACKUP\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro, specify \"AVRO\". For parquet, specify \"PARQUET\". For orc, specify \"ORC\". The default value is CSV.", "type": "string" @@ -5239,10 +5564,22 @@ }, "type": "array" }, + "timeFormat": { + "description": "Optional. Date format used for parsing TIME values.", + "type": "string" + }, "timePartitioning": { "$ref": "TimePartitioning", "description": "Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified." }, + "timeZone": { + "description": "Optional. [Experimental] Default time zone that will apply when parsing timestamp values that have no specific time zone.", + "type": "string" + }, + "timestampFormat": { + "description": "Optional. Date format used for parsing TIMESTAMP values.", + "type": "string" + }, "useAvroLogicalTypes": { "description": "Optional. If sourceFormat is set to \"AVRO\", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).", "type": "boolean" @@ -5388,6 +5725,10 @@ "writeDisposition": { "description": "Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", "type": "string" + }, + "writeIncrementalResults": { + "description": "Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.", + "type": "boolean" } }, "type": "object" @@ -6432,7 +6773,7 @@ "type": "object" }, "MetadataCacheStatistics": { - "description": "Statistics for metadata caching in BigLake tables.", + "description": "Statistics for metadata caching in queried tables.", "id": "MetadataCacheStatistics", "properties": { "tableMetadataCacheUsage": { @@ -7184,6 +7525,10 @@ "$ref": "DatasetReference", "description": "Optional. Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'." }, + "destinationEncryptionConfiguration": { + "$ref": "EncryptionConfiguration", + "description": "Optional. Custom encryption configuration (e.g., Cloud KMS keys)" + }, "dryRun": { "description": "Optional. If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.", "type": "boolean" @@ -7206,6 +7551,11 @@ ], "type": "string" }, + "jobTimeoutMs": { + "description": "Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. This timeout applies to the query even if a job does not need to be created.", + "format": "int64", + "type": "string" + }, "kind": { "default": "bigquery#queryRequest", "description": "The resource type of the request.", @@ -7270,6 +7620,10 @@ "default": "true", "description": "Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.", "type": "boolean" + }, + "writeIncrementalResults": { + "description": "Optional. This is only supported for SELECT query. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.", + "type": "boolean" } }, "type": "object" @@ -7833,6 +8187,13 @@ "description": "Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region=\"EU\" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0", "type": "string" }, + "grantees": { + "description": "Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - \"user:alice@example.com\": An email address that represents a specific Google account. - \"serviceAccount:my-other-app@appspot.gserviceaccount.com\": An email address that represents a service account. - \"group:admins@example.com\": An email address that represents a Google group. - \"domain:example.com\":The Google Workspace domain (primary) that represents all the users of that domain. - \"allAuthenticatedUsers\": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - \"allUsers\":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.", + "items": { + "type": "string" + }, + "type": "array" + }, "lastModifiedTime": { "description": "Output only. The time when this row access policy was last modified, in milliseconds since the epoch.", "format": "google-datetime", @@ -8399,6 +8760,68 @@ }, "type": "object" }, + "StoredColumnsUnusedReason": { + "description": "If the stored column was not used, explain why.", + "id": "StoredColumnsUnusedReason", + "properties": { + "code": { + "description": "Specifies the high-level reason for the unused scenario, each reason must have a code associated.", + "enum": [ + "CODE_UNSPECIFIED", + "STORED_COLUMNS_COVER_INSUFFICIENT", + "BASE_TABLE_HAS_RLS", + "BASE_TABLE_HAS_CLS", + "UNSUPPORTED_PREFILTER", + "INTERNAL_ERROR", + "OTHER_REASON" + ], + "enumDescriptions": [ + "Default value.", + "If stored columns do not fully cover the columns.", + "If the base table has RLS (Row Level Security).", + "If the base table has CLS (Column Level Security).", + "If the provided prefilter is not supported.", + "If an internal error is preventing stored columns from being used.", + "Indicates that the reason stored columns cannot be used in the query is not covered by any of the other StoredColumnsUnusedReason options." + ], + "type": "string" + }, + "message": { + "description": "Specifies the detailed description for the scenario.", + "type": "string" + }, + "uncoveredColumns": { + "description": "Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "StoredColumnsUsage": { + "description": "Indicates the stored columns usage in the query.", + "id": "StoredColumnsUsage", + "properties": { + "baseTable": { + "$ref": "TableReference", + "description": "Specifies the base table." + }, + "isQueryAccelerated": { + "description": "Specifies whether the query was accelerated with stored columns.", + "type": "boolean" + }, + "storedColumnsUnusedReasons": { + "description": "If stored columns were not used, explain why.", + "items": { + "$ref": "StoredColumnsUnusedReason" + }, + "type": "array" + } + }, + "type": "object" + }, "Streamingbuffer": { "id": "Streamingbuffer", "properties": { @@ -9128,7 +9551,7 @@ "properties": { "privacyPolicy": { "$ref": "PrivacyPolicy", - "description": "Specifices the privacy policy for the view." + "description": "Specifies the privacy policy for the view." }, "useLegacySql": { "description": "True if view is defined in legacy SQL dialect, false if in GoogleSQL.", @@ -9584,6 +10007,16 @@ "description": "Whether the model should include intercept during model training.", "type": "boolean" }, + "forecastLimitLowerBound": { + "description": "The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html", + "format": "double", + "type": "number" + }, + "forecastLimitUpperBound": { + "description": "The forecast limit upper bound that was used during ARIMA model training with limits.", + "format": "double", + "type": "number" + }, "hiddenUnits": { "description": "Hidden units for dnn models.", "items": { @@ -9733,7 +10166,7 @@ "Ukraine", "United States", "Venezuela", - "Viet Nam", + "Vietnam", "South Africa" ], "type": "string" @@ -9880,7 +10313,7 @@ "Ukraine", "United States", "Venezuela", - "Viet Nam", + "Vietnam", "South Africa" ], "type": "string" @@ -9926,7 +10359,7 @@ "Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.", "Accuracy is the fraction of predictions given the correct label. For multiclass this is a globally micro-averaged metric.", "The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.", - "Logorithmic Loss. For multiclass this is a macro-averaged metric.", + "Logarithmic Loss. For multiclass this is a macro-averaged metric.", "Area Under an ROC Curve. For multiclass this is a macro-averaged metric.", "Davies-Bouldin Index.", "Mean Average Precision.", @@ -10423,6 +10856,13 @@ "The entire vector search query used vector indexes." ], "type": "string" + }, + "storedColumnsUsages": { + "description": "Specifies the usage of stored columns in the query when stored columns are used in the query.", + "items": { + "$ref": "StoredColumnsUsage" + }, + "type": "array" } }, "type": "object" @@ -10440,7 +10880,7 @@ }, "privacyPolicy": { "$ref": "PrivacyPolicy", - "description": "Optional. Specifices the privacy policy for the view." + "description": "Optional. Specifies the privacy policy for the view." }, "query": { "description": "Required. A query that BigQuery executes when the view is referenced.", diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index cfbe2c84ff9..1c1c659a669 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -167,7 +167,7 @@ export namespace bigquery_v2 { */ rocAuc?: number | null; /** - * Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold. + * Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold. */ threshold?: number | null; } @@ -423,6 +423,19 @@ export namespace bigquery_v2 { */ useAvroLogicalTypes?: boolean | null; } + /** + * Request message for the BatchDeleteRowAccessPoliciesRequest method. + */ + export interface Schema$BatchDeleteRowAccessPoliciesRequest { + /** + * If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it. + */ + force?: boolean | null; + /** + * Required. Policy IDs of the row access policies. + */ + policyIds?: string[] | null; + } /** * Reason why BI Engine didn't accelerate the query (or sub-query). */ @@ -833,6 +846,10 @@ export namespace bigquery_v2 { * Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when querying a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. */ nullMarker?: string | null; + /** + * Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types. + */ + nullMarkers?: string[] | null; /** * Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. */ @@ -845,6 +862,10 @@ export namespace bigquery_v2 { * Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N \> 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. */ skipLeadingRows?: string | null; + /** + * Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. Acceptable values are: POSITION - matches by position. This assumes that the columns are ordered the same way as the schema. NAME - matches by name. This reads the header row as column names and reorders columns to match the field names in the schema. + */ + sourceColumnMatch?: string | null; } /** * Options for data format adjustments. @@ -1524,7 +1545,15 @@ export namespace bigquery_v2 { */ csvOptions?: Schema$CsvOptions; /** - * Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -\> NUMERIC; * (39,9) -\> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -\> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -\> BIGNUMERIC; * (77,38) -\> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + * Optional. Format used to parse DATE values. Supports C-style and SQL-style values. + */ + dateFormat?: string | null; + /** + * Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values. + */ + datetimeFormat?: string | null; + /** + * Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -\> NUMERIC; * (39,9) -\> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -\> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -\> BIGNUMERIC; * (77,38) -\> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. */ decimalTargetTypes?: string[] | null; /** @@ -1583,6 +1612,18 @@ export namespace bigquery_v2 { * [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. */ sourceUris?: string[] | null; + /** + * Optional. Format used to parse TIME values. Supports C-style and SQL-style values. + */ + timeFormat?: string | null; + /** + * Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. + */ + timestampFormat?: string | null; + /** + * Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). + */ + timeZone?: string | null; } /** * Configures the access a dataset defined in an external metadata storage. @@ -2250,7 +2291,15 @@ export namespace bigquery_v2 { */ createSession?: boolean | null; /** - * Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -\> NUMERIC; * (39,9) -\> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -\> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -\> BIGNUMERIC; * (77,38) -\> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. + * Optional. Date format used for parsing DATE values. + */ + dateFormat?: string | null; + /** + * Optional. Date format used for parsing DATETIME values. + */ + datetimeFormat?: string | null; + /** + * Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -\> NUMERIC; * (39,9) -\> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -\> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -\> BIGNUMERIC; * (77,38) -\> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. */ decimalTargetTypes?: string[] | null; /** @@ -2297,6 +2346,10 @@ export namespace bigquery_v2 { * Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. */ nullMarker?: string | null; + /** + * Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types. + */ + nullMarkers?: string[] | null; /** * Optional. Additional properties to set if sourceFormat is set to PARQUET. */ @@ -2341,6 +2394,10 @@ export namespace bigquery_v2 { * Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N \> 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. */ skipLeadingRows?: number | null; + /** + * Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. + */ + sourceColumnMatch?: string | null; /** * Optional. The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. */ @@ -2349,10 +2406,22 @@ export namespace bigquery_v2 { * [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. */ sourceUris?: string[] | null; + /** + * Optional. Date format used for parsing TIME values. + */ + timeFormat?: string | null; /** * Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. */ timePartitioning?: Schema$TimePartitioning; + /** + * Optional. Date format used for parsing TIMESTAMP values. + */ + timestampFormat?: string | null; + /** + * Optional. [Experimental] Default time zone that will apply when parsing timestamp values that have no specific time zone. + */ + timeZone?: string | null; /** * Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). */ @@ -2474,6 +2543,10 @@ export namespace bigquery_v2 { * Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ writeDisposition?: string | null; + /** + * Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. + */ + writeIncrementalResults?: boolean | null; } /** * JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see [Copy a table](https://cloud.google.com/bigquery/docs/managing-tables#copy-table). @@ -3116,7 +3189,7 @@ export namespace bigquery_v2 { refreshWatermark?: string | null; } /** - * Statistics for metadata caching in BigLake tables. + * Statistics for metadata caching in queried tables. */ export interface Schema$MetadataCacheStatistics { /** @@ -3540,6 +3613,10 @@ export namespace bigquery_v2 { * Optional. Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'. */ defaultDataset?: Schema$DatasetReference; + /** + * Optional. Custom encryption configuration (e.g., Cloud KMS keys) + */ + destinationEncryptionConfiguration?: Schema$EncryptionConfiguration; /** * Optional. If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false. */ @@ -3552,6 +3629,10 @@ export namespace bigquery_v2 { * Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. [Preview](https://cloud.google.com/products/#product-launch-stages) */ jobCreationMode?: string | null; + /** + * Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. This timeout applies to the query even if a job does not need to be created. + */ + jobTimeoutMs?: string | null; /** * The resource type of the request. */ @@ -3604,6 +3685,10 @@ export namespace bigquery_v2 { * Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. */ useQueryCache?: boolean | null; + /** + * Optional. This is only supported for SELECT query. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. + */ + writeIncrementalResults?: boolean | null; } export interface Schema$QueryResponse { /** @@ -3968,6 +4053,10 @@ export namespace bigquery_v2 { * Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 */ filterPredicate?: string | null; + /** + * Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - "user:alice@example.com": An email address that represents a specific Google account. - "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account. - "group:admins@example.com": An email address that represents a Google group. - "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain. - "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users. + */ + grantees?: string[] | null; /** * Output only. The time when this row access policy was last modified, in milliseconds since the epoch. */ @@ -4342,6 +4431,40 @@ export namespace bigquery_v2 { */ serdeInfo?: Schema$SerDeInfo; } + /** + * If the stored column was not used, explain why. + */ + export interface Schema$StoredColumnsUnusedReason { + /** + * Specifies the high-level reason for the unused scenario, each reason must have a code associated. + */ + code?: string | null; + /** + * Specifies the detailed description for the scenario. + */ + message?: string | null; + /** + * Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + */ + uncoveredColumns?: string[] | null; + } + /** + * Indicates the stored columns usage in the query. + */ + export interface Schema$StoredColumnsUsage { + /** + * Specifies the base table. + */ + baseTable?: Schema$TableReference; + /** + * Specifies whether the query was accelerated with stored columns. + */ + isQueryAccelerated?: boolean | null; + /** + * If stored columns were not used, explain why. + */ + storedColumnsUnusedReasons?: Schema$StoredColumnsUnusedReason[]; + } export interface Schema$Streamingbuffer { /** * Output only. A lower-bound estimate of the number of bytes currently in the streaming buffer. @@ -5031,6 +5154,14 @@ export namespace bigquery_v2 { * Whether the model should include intercept during model training. */ fitIntercept?: boolean | null; + /** + * The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html + */ + forecastLimitLowerBound?: number | null; + /** + * The forecast limit upper bound that was used during ARIMA model training with limits. + */ + forecastLimitUpperBound?: number | null; /** * Hidden units for dnn models. */ @@ -5373,6 +5504,10 @@ export namespace bigquery_v2 { * Specifies the index usage mode for the query. */ indexUsageMode?: string | null; + /** + * Specifies the usage of stored columns in the query when stored columns are used in the query. + */ + storedColumnsUsages?: Schema$StoredColumnsUsage[]; } /** * Describes the definition of a logical view. @@ -5383,7 +5518,7 @@ export namespace bigquery_v2 { */ foreignDefinitions?: Schema$ForeignViewDefinition[]; /** - * Optional. Specifices the privacy policy for the view. + * Optional. Specifies the privacy policy for the view. */ privacyPolicy?: Schema$PrivacyPolicy; /** @@ -6070,7 +6205,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](https://cloud.google.com/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 AND-ed 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; /** @@ -8291,6 +8426,266 @@ export namespace bigquery_v2 { this.context = context; } + /** + * Deletes provided row access policies. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Rowaccesspolicies$Batchdelete, + options: StreamMethodOptions + ): GaxiosPromise; + batchDelete( + params?: Params$Resource$Rowaccesspolicies$Batchdelete, + options?: MethodOptions + ): GaxiosPromise; + batchDelete( + params: Params$Resource$Rowaccesspolicies$Batchdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Rowaccesspolicies$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Rowaccesspolicies$Batchdelete, + callback: BodyResponseCallback + ): void; + batchDelete(callback: BodyResponseCallback): void; + batchDelete( + paramsOrCallback?: + | Params$Resource$Rowaccesspolicies$Batchdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Rowaccesspolicies$Batchdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rowaccesspolicies$Batchdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies:batchDelete' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'tableId'], + pathParams: ['datasetId', 'projectId', 'tableId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a row access 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. + */ + delete( + params: Params$Resource$Rowaccesspolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Rowaccesspolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Rowaccesspolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Rowaccesspolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Rowaccesspolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Rowaccesspolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Rowaccesspolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rowaccesspolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'tableId', 'policyId'], + pathParams: ['datasetId', 'policyId', 'projectId', 'tableId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the specified row access policy by policy 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$Rowaccesspolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Rowaccesspolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Rowaccesspolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Rowaccesspolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Rowaccesspolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Rowaccesspolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Rowaccesspolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rowaccesspolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'tableId', 'policyId'], + pathParams: ['datasetId', 'policyId', 'projectId', 'tableId'], + 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. * @@ -8379,6 +8774,94 @@ export namespace bigquery_v2 { } } + /** + * Creates a row access 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. + */ + insert( + params: Params$Resource$Rowaccesspolicies$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Rowaccesspolicies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Rowaccesspolicies$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Rowaccesspolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Rowaccesspolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Rowaccesspolicies$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Rowaccesspolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rowaccesspolicies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'tableId'], + pathParams: ['datasetId', 'projectId', 'tableId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists all row access policies on the specified table. * @@ -8569,8 +9052,158 @@ export namespace bigquery_v2 { return createAPIRequest(parameters); } } + + /** + * Updates a row access 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. + */ + update( + params: Params$Resource$Rowaccesspolicies$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Rowaccesspolicies$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Rowaccesspolicies$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Rowaccesspolicies$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Rowaccesspolicies$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Rowaccesspolicies$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Rowaccesspolicies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rowaccesspolicies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'tableId', 'policyId'], + pathParams: ['datasetId', 'policyId', 'projectId', 'tableId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Rowaccesspolicies$Batchdelete + extends StandardParameters { + /** + * Required. Dataset ID of the table to delete the row access policies. + */ + datasetId?: string; + /** + * Required. Project ID of the table to delete the row access policies. + */ + projectId?: string; + /** + * Required. Table ID of the table to delete the row access policies. + */ + tableId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchDeleteRowAccessPoliciesRequest; + } + export interface Params$Resource$Rowaccesspolicies$Delete + extends StandardParameters { + /** + * Required. Dataset ID of the table to delete the row access policy. + */ + datasetId?: string; + /** + * If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it. + */ + force?: boolean; + /** + * Required. Policy ID of the row access policy. + */ + policyId?: string; + /** + * Required. Project ID of the table to delete the row access policy. + */ + projectId?: string; + /** + * Required. Table ID of the table to delete the row access policy. + */ + tableId?: string; + } + export interface Params$Resource$Rowaccesspolicies$Get + extends StandardParameters { + /** + * Required. Dataset ID of the table to get the row access policy. + */ + datasetId?: string; + /** + * Required. Policy ID of the row access policy. + */ + policyId?: string; + /** + * Required. Project ID of the table to get the row access policy. + */ + projectId?: string; + /** + * Required. Table ID of the table to get the row access policy. + */ + tableId?: string; + } export interface Params$Resource$Rowaccesspolicies$Getiampolicy extends StandardParameters { /** @@ -8583,6 +9216,26 @@ export namespace bigquery_v2 { */ requestBody?: Schema$GetIamPolicyRequest; } + export interface Params$Resource$Rowaccesspolicies$Insert + extends StandardParameters { + /** + * Required. Dataset ID of the table to get the row access policy. + */ + datasetId?: string; + /** + * Required. Project ID of the table to get the row access policy. + */ + projectId?: string; + /** + * Required. Table ID of the table to get the row access policy. + */ + tableId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RowAccessPolicy; + } export interface Params$Resource$Rowaccesspolicies$List extends StandardParameters { /** @@ -8618,6 +9271,30 @@ export namespace bigquery_v2 { */ requestBody?: Schema$TestIamPermissionsRequest; } + export interface Params$Resource$Rowaccesspolicies$Update + extends StandardParameters { + /** + * Required. Dataset ID of the table to get the row access policy. + */ + datasetId?: string; + /** + * Required. Policy ID of the row access policy. + */ + policyId?: string; + /** + * Required. Project ID of the table to get the row access policy. + */ + projectId?: string; + /** + * Required. Table ID of the table to get the row access policy. + */ + tableId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RowAccessPolicy; + } export class Resource$Tabledata { context: APIRequestContext; From 38f7d341b3cb269d714874ed40f15a5d04597c90 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:40 +0000 Subject: [PATCH 018/144] feat(bigqueryreservation): update the API #### bigqueryreservation:v1 The following keys were added: - schemas.ReplicationStatus.description - schemas.ReplicationStatus.id - schemas.ReplicationStatus.properties.error.$ref - schemas.ReplicationStatus.properties.error.description - schemas.ReplicationStatus.properties.error.readOnly - schemas.ReplicationStatus.properties.lastErrorTime.description - schemas.ReplicationStatus.properties.lastErrorTime.format - schemas.ReplicationStatus.properties.lastErrorTime.readOnly - schemas.ReplicationStatus.properties.lastErrorTime.type - schemas.ReplicationStatus.properties.lastReplicationTime.description - schemas.ReplicationStatus.properties.lastReplicationTime.format - schemas.ReplicationStatus.properties.lastReplicationTime.readOnly - schemas.ReplicationStatus.properties.lastReplicationTime.type - schemas.ReplicationStatus.type - schemas.Reservation.properties.maxSlots.description - schemas.Reservation.properties.maxSlots.format - schemas.Reservation.properties.maxSlots.type - schemas.Reservation.properties.replicationStatus.$ref - schemas.Reservation.properties.replicationStatus.description - schemas.Reservation.properties.replicationStatus.readOnly - schemas.Reservation.properties.scalingMode.description - schemas.Reservation.properties.scalingMode.enum - schemas.Reservation.properties.scalingMode.enumDescriptions - schemas.Reservation.properties.scalingMode.type --- discovery/bigqueryreservation-v1.json | 52 ++++++++++++++++++++++++++- src/apis/bigqueryreservation/v1.ts | 29 +++++++++++++++ 2 files changed, 80 insertions(+), 1 deletion(-) diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index bd4f497fee2..f7795619f18 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -935,7 +935,7 @@ } } }, - "revision": "20241231", + "revision": "20250304", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1291,6 +1291,30 @@ }, "type": "object" }, + "ReplicationStatus": { + "description": "Disaster Recovery(DR) replication status of the reservation.", + "id": "ReplicationStatus", + "properties": { + "error": { + "$ref": "Status", + "description": "Output only. The last error encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since.", + "readOnly": true + }, + "lastErrorTime": { + "description": "Output only. The time at which the last error was encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "lastReplicationTime": { + "description": "Output only. A timestamp corresponding to the last change on the primary that was successfully replicated to the secondary.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Reservation": { "description": "A reservation is a mechanism used to guarantee slots to users.", "id": "Reservation", @@ -1337,6 +1361,11 @@ "description": "Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation.", "type": "object" }, + "maxSlots": { + "description": "Optional. The overall max slots for the reservation, covering slot_capacity (baseline), idle slots (if ignore_idle_slots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the max_slots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exceed the max_slots - baseline. This field must be set together with the scaling_mode enum value, otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. If the max_slots and scaling_mode are set, the autoscale or autoscale.max_slots field must be unset. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. However, the autoscale field may still be in the output. The autopscale.max_slots will always show as 0 and the autoscaler.current_slots will represent the current slots from autoscaler excluding idle slots. For example, if the max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000. If the max_slots is 1000, scaling_mode is ALL_SLOTS, the baseline is 100 and idle slots usage is 200, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots will not be higher than 700. If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be null. If the max_slots and scaling_mode are set, then the ignore_idle_slots field must be aligned with the scaling_mode enum value.(See details in ScalingMode comments). Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. Please note, the max_slots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set max_slots smaller or equal to the baseline as it will not be meaningful. If the field is present and slot_capacity>=max_slots, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. Please note that if max_slots is set to 0, we will treat it as unset. Customers can set max_slots to 0 and set scaling_mode to SCALING_MODE_UNSPECIFIED to disable the max_slots feature.", + "format": "int64", + "type": "string" + }, "multiRegionAuxiliary": { "description": "Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.", "type": "boolean" @@ -1355,6 +1384,27 @@ "readOnly": true, "type": "string" }, + "replicationStatus": { + "$ref": "ReplicationStatus", + "description": "Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.", + "readOnly": true + }, + "scalingMode": { + "description": "The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", + "enum": [ + "SCALING_MODE_UNSPECIFIED", + "AUTOSCALE_ONLY", + "IDLE_SLOTS_ONLY", + "ALL_SLOTS" + ], + "enumDescriptions": [ + "Default value of ScalingMode.", + "The reservation will scale up only using slots from autoscaling. It will not use any idle slots even if there may be some available. The upper limit that autoscaling can scale up to will be max_slots - baseline. For example, if max_slots is 1000, baseline is 200 and customer sets ScalingMode to AUTOSCALE_ONLY, then autoscalerg will scale up to 800 slots and no idle slots will be used. Please note, in this mode, the ignore_idle_slots field must be set to true. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", + "The reservation will scale up using only idle slots contributed by other reservations or from unassigned commitments. If no idle slots are available it will not scale up further. If the idle slots which it is using are reclaimed by the contributing reservation(s) it may be forced to scale down. The max idle slots the reservation can be max_slots - baseline capacity. For example, if max_slots is 1000, baseline is 200 and customer sets ScalingMode to IDLE_SLOTS_ONLY, 1. if there are 1000 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline and 800 idle slots. 2. if there are 500 idle slots available in other reservations, the reservation will scale up to 700 slots with 200 baseline and 300 idle slots. Please note, in this mode, the reservation might not be able to scale up to max_slots. Please note, in this mode, the ignore_idle_slots field must be set to false. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", + "The reservation will scale up using all slots available to it. It will use idle slots contributed by other reservations or from unassigned commitments first. If no idle slots are available it will scale up using autoscaling. For example, if max_slots is 1000, baseline is 200 and customer sets ScalingMode to ALL_SLOTS, 1. if there are 800 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline and 800 idle slots. 2. if there are 500 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline, 500 idle slots and 300 autoscaling slots. 3. if there are no idle slots available in other reservations, it will scale up to 1000 slots with 200 baseline and 800 autoscaling slots. Please note, in this mode, the ignore_idle_slots field must be set to false. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`." + ], + "type": "string" + }, "secondaryLocation": { "description": "Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).", "type": "string" diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index cd1afccc65a..0036863132f 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -301,6 +301,23 @@ export namespace bigqueryreservation_v1 { */ destinationId?: string | null; } + /** + * Disaster Recovery(DR) replication status of the reservation. + */ + export interface Schema$ReplicationStatus { + /** + * Output only. The last error encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since. + */ + error?: Schema$Status; + /** + * Output only. The time at which the last error was encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since. + */ + lastErrorTime?: string | null; + /** + * Output only. A timestamp corresponding to the last change on the primary that was successfully replicated to the secondary. + */ + lastReplicationTime?: string | null; + } /** * A reservation is a mechanism used to guarantee slots to users. */ @@ -329,6 +346,10 @@ export namespace bigqueryreservation_v1 { * Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this property when inserting or updating a reservation. */ labels?: {[key: string]: string} | null; + /** + * Optional. The overall max slots for the reservation, covering slot_capacity (baseline), idle slots (if ignore_idle_slots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the max_slots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exceed the max_slots - baseline. This field must be set together with the scaling_mode enum value, otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. If the max_slots and scaling_mode are set, the autoscale or autoscale.max_slots field must be unset. Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. However, the autoscale field may still be in the output. The autopscale.max_slots will always show as 0 and the autoscaler.current_slots will represent the current slots from autoscaler excluding idle slots. For example, if the max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000. If the max_slots is 1000, scaling_mode is ALL_SLOTS, the baseline is 100 and idle slots usage is 200, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots will not be higher than 700. If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be null. If the max_slots and scaling_mode are set, then the ignore_idle_slots field must be aligned with the scaling_mode enum value.(See details in ScalingMode comments). Otherwise the request will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. Please note, the max_slots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set max_slots smaller or equal to the baseline as it will not be meaningful. If the field is present and slot_capacity\>=max_slots, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. Please note that if max_slots is set to 0, we will treat it as unset. Customers can set max_slots to 0 and set scaling_mode to SCALING_MODE_UNSPECIFIED to disable the max_slots feature. + */ + maxSlots?: string | null; /** * Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. */ @@ -345,6 +366,14 @@ export namespace bigqueryreservation_v1 { * Output only. The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature. */ primaryLocation?: string | null; + /** + * Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. + */ + replicationStatus?: Schema$ReplicationStatus; + /** + * The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + */ + scalingMode?: string | null; /** * Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). */ From 4b5a549713d2aba340994d801dc35bc367144da5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 019/144] feat(bigtableadmin): update the API #### bigtableadmin:v2 The following keys were added: - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.description - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.flatPath - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.httpMethod - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.id - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.parameterOrder - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.path - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.request.$ref - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.response.$ref - resources.projects.resources.instances.resources.logicalViews.methods.getIamPolicy.scopes - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.description - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.flatPath - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.httpMethod - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.id - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.parameterOrder - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.path - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.request.$ref - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.response.$ref - resources.projects.resources.instances.resources.logicalViews.methods.setIamPolicy.scopes - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.description - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.flatPath - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.httpMethod - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.id - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.parameterOrder - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.path - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.request.$ref - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.response.$ref - resources.projects.resources.instances.resources.logicalViews.methods.testIamPermissions.scopes - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.description - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.flatPath - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.httpMethod - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.id - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.parameterOrder - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.path - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.request.$ref - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.response.$ref - resources.projects.resources.instances.resources.materializedViews.methods.getIamPolicy.scopes - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.description - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.flatPath - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.httpMethod - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.id - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.parameterOrder - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.path - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.request.$ref - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.response.$ref - resources.projects.resources.instances.resources.materializedViews.methods.setIamPolicy.scopes - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.description - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.flatPath - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.httpMethod - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.id - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.parameterOrder - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.path - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.request.$ref - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.response.$ref - resources.projects.resources.instances.resources.materializedViews.methods.testIamPermissions.scopes - schemas.CreateLogicalViewMetadata.description - schemas.CreateLogicalViewMetadata.id - schemas.CreateLogicalViewMetadata.properties.endTime.description - schemas.CreateLogicalViewMetadata.properties.endTime.format - schemas.CreateLogicalViewMetadata.properties.endTime.type - schemas.CreateLogicalViewMetadata.properties.originalRequest.$ref - schemas.CreateLogicalViewMetadata.properties.originalRequest.description - schemas.CreateLogicalViewMetadata.properties.startTime.description - schemas.CreateLogicalViewMetadata.properties.startTime.format - schemas.CreateLogicalViewMetadata.properties.startTime.type - schemas.CreateLogicalViewMetadata.type - schemas.CreateLogicalViewRequest.description - schemas.CreateLogicalViewRequest.id - schemas.CreateLogicalViewRequest.properties.logicalView.$ref - schemas.CreateLogicalViewRequest.properties.logicalView.description - schemas.CreateLogicalViewRequest.properties.logicalViewId.description - schemas.CreateLogicalViewRequest.properties.logicalViewId.type - schemas.CreateLogicalViewRequest.properties.parent.description - schemas.CreateLogicalViewRequest.properties.parent.type - schemas.CreateLogicalViewRequest.type - schemas.CreateMaterializedViewMetadata.description - schemas.CreateMaterializedViewMetadata.id - schemas.CreateMaterializedViewMetadata.properties.endTime.description - schemas.CreateMaterializedViewMetadata.properties.endTime.format - schemas.CreateMaterializedViewMetadata.properties.endTime.type - schemas.CreateMaterializedViewMetadata.properties.originalRequest.$ref - schemas.CreateMaterializedViewMetadata.properties.originalRequest.description - schemas.CreateMaterializedViewMetadata.properties.startTime.description - schemas.CreateMaterializedViewMetadata.properties.startTime.format - schemas.CreateMaterializedViewMetadata.properties.startTime.type - schemas.CreateMaterializedViewMetadata.type - schemas.CreateMaterializedViewRequest.description - schemas.CreateMaterializedViewRequest.id - schemas.CreateMaterializedViewRequest.properties.materializedView.$ref - schemas.CreateMaterializedViewRequest.properties.materializedView.description - schemas.CreateMaterializedViewRequest.properties.materializedViewId.description - schemas.CreateMaterializedViewRequest.properties.materializedViewId.type - schemas.CreateMaterializedViewRequest.properties.parent.description - schemas.CreateMaterializedViewRequest.properties.parent.type - schemas.CreateMaterializedViewRequest.type - schemas.GoogleBigtableAdminV2TypeBytesEncodingRaw.properties.escapeNulls.description - schemas.GoogleBigtableAdminV2TypeBytesEncodingRaw.properties.escapeNulls.type - schemas.GoogleBigtableAdminV2TypeInt64Encoding.properties.orderedCodeBytes.$ref - schemas.GoogleBigtableAdminV2TypeInt64Encoding.properties.orderedCodeBytes.description - schemas.GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes.description - schemas.GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes.id - schemas.GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes.type - schemas.GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes.properties.nullEscapeChar.description - schemas.GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes.properties.nullEscapeChar.type - schemas.GoogleBigtableAdminV2TypeStruct.properties.encoding.$ref - schemas.GoogleBigtableAdminV2TypeStruct.properties.encoding.description - schemas.GoogleBigtableAdminV2TypeStructEncoding.description - schemas.GoogleBigtableAdminV2TypeStructEncoding.id - schemas.GoogleBigtableAdminV2TypeStructEncoding.properties.delimitedBytes.$ref - schemas.GoogleBigtableAdminV2TypeStructEncoding.properties.delimitedBytes.description - schemas.GoogleBigtableAdminV2TypeStructEncoding.properties.orderedCodeBytes.$ref - schemas.GoogleBigtableAdminV2TypeStructEncoding.properties.orderedCodeBytes.description - schemas.GoogleBigtableAdminV2TypeStructEncoding.properties.singleton.$ref - schemas.GoogleBigtableAdminV2TypeStructEncoding.properties.singleton.description - schemas.GoogleBigtableAdminV2TypeStructEncoding.type - schemas.GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes.description - schemas.GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes.id - schemas.GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes.properties.delimiter.description - schemas.GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes.properties.delimiter.format - schemas.GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes.properties.delimiter.type - schemas.GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes.type - schemas.GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes.description - schemas.GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes.id - schemas.GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes.type - schemas.GoogleBigtableAdminV2TypeStructEncodingSingleton.description - schemas.GoogleBigtableAdminV2TypeStructEncodingSingleton.id - schemas.GoogleBigtableAdminV2TypeStructEncodingSingleton.type - schemas.GoogleBigtableAdminV2TypeTimestamp.properties.encoding.$ref - schemas.GoogleBigtableAdminV2TypeTimestamp.properties.encoding.description - schemas.GoogleBigtableAdminV2TypeTimestampEncoding.description - schemas.GoogleBigtableAdminV2TypeTimestampEncoding.id - schemas.GoogleBigtableAdminV2TypeTimestampEncoding.properties.unixMicrosInt64.$ref - schemas.GoogleBigtableAdminV2TypeTimestampEncoding.properties.unixMicrosInt64.description - schemas.GoogleBigtableAdminV2TypeTimestampEncoding.type - schemas.LogicalView.description - schemas.LogicalView.id - schemas.LogicalView.properties.etag.description - schemas.LogicalView.properties.etag.type - schemas.LogicalView.properties.name.description - schemas.LogicalView.properties.name.type - schemas.LogicalView.properties.query.description - schemas.LogicalView.properties.query.type - schemas.LogicalView.type - schemas.MaterializedView.description - schemas.MaterializedView.id - schemas.MaterializedView.properties.deletionProtection.description - schemas.MaterializedView.properties.deletionProtection.type - schemas.MaterializedView.properties.etag.description - schemas.MaterializedView.properties.etag.type - schemas.MaterializedView.properties.name.description - schemas.MaterializedView.properties.name.type - schemas.MaterializedView.properties.query.description - schemas.MaterializedView.properties.query.type - schemas.MaterializedView.type - schemas.UpdateLogicalViewMetadata.description - schemas.UpdateLogicalViewMetadata.id - schemas.UpdateLogicalViewMetadata.properties.endTime.description - schemas.UpdateLogicalViewMetadata.properties.endTime.format - schemas.UpdateLogicalViewMetadata.properties.endTime.type - schemas.UpdateLogicalViewMetadata.properties.originalRequest.$ref - schemas.UpdateLogicalViewMetadata.properties.originalRequest.description - schemas.UpdateLogicalViewMetadata.properties.startTime.description - schemas.UpdateLogicalViewMetadata.properties.startTime.format - schemas.UpdateLogicalViewMetadata.properties.startTime.type - schemas.UpdateLogicalViewMetadata.type - schemas.UpdateLogicalViewRequest.description - schemas.UpdateLogicalViewRequest.id - schemas.UpdateLogicalViewRequest.properties.logicalView.$ref - schemas.UpdateLogicalViewRequest.properties.logicalView.description - schemas.UpdateLogicalViewRequest.properties.updateMask.description - schemas.UpdateLogicalViewRequest.properties.updateMask.format - schemas.UpdateLogicalViewRequest.properties.updateMask.type - schemas.UpdateLogicalViewRequest.type The following keys were changed: - resources.projects.resources.instances.resources.tables.methods.patch.parameters.updateMask.description --- discovery/bigtableadmin-v2.json | 458 ++++++++++++++++- src/apis/bigtableadmin/v2.ts | 863 +++++++++++++++++++++++++++++++- 2 files changed, 1312 insertions(+), 9 deletions(-) diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index 617aa90a5ef..b1aabdbdfda 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -1311,6 +1311,212 @@ } } }, + "logicalViews": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}:getIamPolicy", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.logicalViews.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "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/[^/]+/instances/[^/]+/logicalViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on an instance resource. Replaces any existing policy.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}:setIamPolicy", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.logicalViews.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/[^/]+/instances/[^/]+/logicalViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that the caller has on the specified instance resource.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}:testIamPermissions", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.logicalViews.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/[^/]+/instances/[^/]+/logicalViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "materializedViews": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}:getIamPolicy", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.materializedViews.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "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/[^/]+/instances/[^/]+/materializedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on an instance resource. Replaces any existing policy.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}:setIamPolicy", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.materializedViews.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/[^/]+/instances/[^/]+/materializedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that the caller has on the specified instance resource.", + "flatPath": "v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}:testIamPermissions", + "httpMethod": "POST", + "id": "bigtableadmin.projects.instances.materializedViews.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/[^/]+/instances/[^/]+/materializedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigtable.admin", + "https://www.googleapis.com/auth/bigtable.admin.cluster", + "https://www.googleapis.com/auth/bigtable.admin.instance", + "https://www.googleapis.com/auth/cloud-bigtable.admin", + "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "tables": { "methods": { "checkConsistency": { @@ -1668,7 +1874,7 @@ "type": "string" }, "updateMask": { - "description": "Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error.", + "description": "Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` * `automated_backup_policy` * `automated_backup_policy.retention_period` * `automated_backup_policy.frequency` * `row_key_schema` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2194,7 +2400,7 @@ } } }, - "revision": "20241203", + "revision": "20250308", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2928,6 +3134,86 @@ }, "type": "object" }, + "CreateLogicalViewMetadata": { + "description": "The metadata for the Operation returned by CreateLogicalView.", + "id": "CreateLogicalViewMetadata", + "properties": { + "endTime": { + "description": "If set, the time at which this operation finished or was canceled.", + "format": "google-datetime", + "type": "string" + }, + "originalRequest": { + "$ref": "CreateLogicalViewRequest", + "description": "The request that prompted the initiation of this CreateLogicalView operation." + }, + "startTime": { + "description": "The time at which this operation started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "CreateLogicalViewRequest": { + "description": "Request message for BigtableInstanceAdmin.CreateLogicalView.", + "id": "CreateLogicalViewRequest", + "properties": { + "logicalView": { + "$ref": "LogicalView", + "description": "Required. The logical view to create." + }, + "logicalViewId": { + "description": "Required. The ID to use for the logical view, which will become the final component of the logical view's resource name.", + "type": "string" + }, + "parent": { + "description": "Required. The parent instance where this logical view will be created. Format: `projects/{project}/instances/{instance}`.", + "type": "string" + } + }, + "type": "object" + }, + "CreateMaterializedViewMetadata": { + "description": "The metadata for the Operation returned by CreateMaterializedView.", + "id": "CreateMaterializedViewMetadata", + "properties": { + "endTime": { + "description": "If set, the time at which this operation finished or was canceled.", + "format": "google-datetime", + "type": "string" + }, + "originalRequest": { + "$ref": "CreateMaterializedViewRequest", + "description": "The request that prompted the initiation of this CreateMaterializedView operation." + }, + "startTime": { + "description": "The time at which this operation started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "CreateMaterializedViewRequest": { + "description": "Request message for BigtableInstanceAdmin.CreateMaterializedView.", + "id": "CreateMaterializedViewRequest", + "properties": { + "materializedView": { + "$ref": "MaterializedView", + "description": "Required. The materialized view to create." + }, + "materializedViewId": { + "description": "Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name.", + "type": "string" + }, + "parent": { + "description": "Required. The parent instance where this materialized view will be created. Format: `projects/{project}/instances/{instance}`.", + "type": "string" + } + }, + "type": "object" + }, "CreateTableRequest": { "description": "Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable", "id": "CreateTableRequest", @@ -3271,7 +3557,12 @@ "GoogleBigtableAdminV2TypeBytesEncodingRaw": { "description": "Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported.", "id": "GoogleBigtableAdminV2TypeBytesEncodingRaw", - "properties": {}, + "properties": { + "escapeNulls": { + "description": "If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended.", + "type": "boolean" + } + }, "type": "object" }, "GoogleBigtableAdminV2TypeDate": { @@ -3310,6 +3601,10 @@ "bigEndianBytes": { "$ref": "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes", "description": "Use `BigEndianBytes` encoding." + }, + "orderedCodeBytes": { + "$ref": "GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes", + "description": "Use `OrderedCodeBytes` encoding." } }, "type": "object" @@ -3326,6 +3621,12 @@ }, "type": "object" }, + "GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes": { + "description": "Encodes the value in a variable length binary format of up to 10 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported.", + "id": "GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes", + "properties": {}, + "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", @@ -3371,7 +3672,12 @@ "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes": { "description": "UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)`", "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", - "properties": {}, + "properties": { + "nullEscapeChar": { + "description": "Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. .", + "type": "string" + } + }, "type": "object" }, "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw": { @@ -3385,6 +3691,10 @@ "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": { + "encoding": { + "$ref": "GoogleBigtableAdminV2TypeStructEncoding", + "description": "The encoding to use when converting to or from lower level types." + }, "fields": { "description": "The names and types of the fields in this struct.", "items": { @@ -3395,6 +3705,49 @@ }, "type": "object" }, + "GoogleBigtableAdminV2TypeStructEncoding": { + "description": "Rules used to convert to or from lower level types.", + "id": "GoogleBigtableAdminV2TypeStructEncoding", + "properties": { + "delimitedBytes": { + "$ref": "GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes", + "description": "Use `DelimitedBytes` encoding." + }, + "orderedCodeBytes": { + "$ref": "GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes", + "description": "User `OrderedCodeBytes` encoding." + }, + "singleton": { + "$ref": "GoogleBigtableAdminV2TypeStructEncodingSingleton", + "description": "Use `Singleton` encoding." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes": { + "description": "Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`.", + "id": "GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes", + "properties": { + "delimiter": { + "description": "Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes": { + "description": "Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string \"\" have special handling: - If *every* field encodes to \"\", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> \"\\00\\00\" - STRUCT(\"\") -> \"\\00\\00\" - STRUCT(\"\", \"\") -> \"\\00\\00\" - STRUCT(\"\", \"B\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\") -> \"A\" - STRUCT(\"\", \"B\", \"\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\", \"C\") -> \"A\" + \"\\00\\01\" + \"\\00\\00\" + \"\\00\\01\" + \"C\" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed.", + "id": "GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStructEncodingSingleton": { + "description": "Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`.", + "id": "GoogleBigtableAdminV2TypeStructEncodingSingleton", + "properties": {}, + "type": "object" + }, "GoogleBigtableAdminV2TypeStructField": { "description": "A struct field and its type.", "id": "GoogleBigtableAdminV2TypeStructField", @@ -3413,7 +3766,23 @@ "GoogleBigtableAdminV2TypeTimestamp": { "description": "Timestamp Values of type `Timestamp` are stored in `Value.timestamp_value`.", "id": "GoogleBigtableAdminV2TypeTimestamp", - "properties": {}, + "properties": { + "encoding": { + "$ref": "GoogleBigtableAdminV2TypeTimestampEncoding", + "description": "The encoding to use when converting to or from lower level types." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeTimestampEncoding": { + "description": "Rules used to convert to or from lower level types.", + "id": "GoogleBigtableAdminV2TypeTimestampEncoding", + "properties": { + "unixMicrosInt64": { + "$ref": "GoogleBigtableAdminV2TypeInt64Encoding", + "description": "Encodes the number of microseconds since the Unix epoch using the given `Int64` encoding. Values must be microsecond-aligned. Compatible with: - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS`" + } + }, "type": "object" }, "HotTablet": { @@ -3755,6 +4124,48 @@ }, "type": "object" }, + "LogicalView": { + "description": "A SQL logical view object that can be referenced in SQL queries.", + "id": "LogicalView", + "properties": { + "etag": { + "description": "Optional. The etag for this logical view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.", + "type": "string" + }, + "name": { + "description": "Identifier. The unique name of the logical view. Format: `projects/{project}/instances/{instance}/logicalViews/{logical_view}`", + "type": "string" + }, + "query": { + "description": "Required. The logical view's select query.", + "type": "string" + } + }, + "type": "object" + }, + "MaterializedView": { + "description": "A materialized view object that can be referenced in SQL queries.", + "id": "MaterializedView", + "properties": { + "deletionProtection": { + "description": "Set to true to make the MaterializedView protected against deletion.", + "type": "boolean" + }, + "etag": { + "description": "Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag.", + "type": "string" + }, + "name": { + "description": "Identifier. The unique name of the materialized view. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`", + "type": "string" + }, + "query": { + "description": "Required. Immutable. The materialized view's select query.", + "type": "string" + } + }, + "type": "object" + }, "Modification": { "description": "A create, update, or delete of a particular column family.", "id": "Modification", @@ -4486,6 +4897,43 @@ }, "type": "object" }, + "UpdateLogicalViewMetadata": { + "description": "The metadata for the Operation returned by UpdateLogicalView.", + "id": "UpdateLogicalViewMetadata", + "properties": { + "endTime": { + "description": "If set, the time at which this operation finished or was canceled.", + "format": "google-datetime", + "type": "string" + }, + "originalRequest": { + "$ref": "UpdateLogicalViewRequest", + "description": "The request that prompted the initiation of this UpdateLogicalView operation." + }, + "startTime": { + "description": "The time at which this operation was started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "UpdateLogicalViewRequest": { + "description": "Request message for BigtableInstanceAdmin.UpdateLogicalView.", + "id": "UpdateLogicalViewRequest", + "properties": { + "logicalView": { + "$ref": "LogicalView", + "description": "Required. The logical view to update. The logical view's `name` field is used to identify the view to update. Format: `projects/{project}/instances/{instance}/logicalViews/{logical_view}`." + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "UpdateTableMetadata": { "description": "Metadata type for the operation returned by UpdateTable.", "id": "UpdateTableMetadata", diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 16cda468373..8a3e9983045 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -646,6 +646,74 @@ export namespace bigtableadmin_v2 { */ parent?: string | null; } + /** + * The metadata for the Operation returned by CreateLogicalView. + */ + export interface Schema$CreateLogicalViewMetadata { + /** + * If set, the time at which this operation finished or was canceled. + */ + endTime?: string | null; + /** + * The request that prompted the initiation of this CreateLogicalView operation. + */ + originalRequest?: Schema$CreateLogicalViewRequest; + /** + * The time at which this operation started. + */ + startTime?: string | null; + } + /** + * Request message for BigtableInstanceAdmin.CreateLogicalView. + */ + export interface Schema$CreateLogicalViewRequest { + /** + * Required. The logical view to create. + */ + logicalView?: Schema$LogicalView; + /** + * Required. The ID to use for the logical view, which will become the final component of the logical view's resource name. + */ + logicalViewId?: string | null; + /** + * Required. The parent instance where this logical view will be created. Format: `projects/{project\}/instances/{instance\}`. + */ + parent?: string | null; + } + /** + * The metadata for the Operation returned by CreateMaterializedView. + */ + export interface Schema$CreateMaterializedViewMetadata { + /** + * If set, the time at which this operation finished or was canceled. + */ + endTime?: string | null; + /** + * The request that prompted the initiation of this CreateMaterializedView operation. + */ + originalRequest?: Schema$CreateMaterializedViewRequest; + /** + * The time at which this operation started. + */ + startTime?: string | null; + } + /** + * Request message for BigtableInstanceAdmin.CreateMaterializedView. + */ + export interface Schema$CreateMaterializedViewRequest { + /** + * Required. The materialized view to create. + */ + materializedView?: Schema$MaterializedView; + /** + * Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name. + */ + materializedViewId?: string | null; + /** + * Required. The parent instance where this materialized view will be created. Format: `projects/{project\}/instances/{instance\}`. + */ + parent?: string | null; + } /** * Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable */ @@ -899,7 +967,12 @@ export namespace bigtableadmin_v2 { /** * Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. */ - export interface Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw {} + export interface Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw { + /** + * If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + */ + escapeNulls?: boolean | null; + } /** * Date Values of type `Date` are stored in `Value.date_value`. */ @@ -929,6 +1002,10 @@ export namespace bigtableadmin_v2 { * Use `BigEndianBytes` encoding. */ bigEndianBytes?: Schema$GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes; + /** + * Use `OrderedCodeBytes` encoding. + */ + orderedCodeBytes?: Schema$GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes; } /** * Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` @@ -939,6 +1016,10 @@ export namespace bigtableadmin_v2 { */ bytesType?: Schema$GoogleBigtableAdminV2TypeBytes; } + /** + * Encodes the value in a variable length binary format of up to 10 bytes. Values that are closer to zero use fewer bytes. Sorted mode: all values are supported. Distinct mode: all values are supported. + */ + export interface Schema$GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes {} /** * 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. */ @@ -977,7 +1058,12 @@ export namespace bigtableadmin_v2 { /** * UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` */ - export interface Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes {} + export interface Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes { + /** + * Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + */ + nullEscapeChar?: string | null; + } /** * Deprecated: prefer the equivalent `Utf8Bytes`. */ @@ -986,11 +1072,49 @@ export namespace bigtableadmin_v2 { * 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 encoding to use when converting to or from lower level types. + */ + encoding?: Schema$GoogleBigtableAdminV2TypeStructEncoding; /** * The names and types of the fields in this struct. */ fields?: Schema$GoogleBigtableAdminV2TypeStructField[]; } + /** + * Rules used to convert to or from lower level types. + */ + export interface Schema$GoogleBigtableAdminV2TypeStructEncoding { + /** + * Use `DelimitedBytes` encoding. + */ + delimitedBytes?: Schema$GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes; + /** + * User `OrderedCodeBytes` encoding. + */ + orderedCodeBytes?: Schema$GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes; + /** + * Use `Singleton` encoding. + */ + singleton?: Schema$GoogleBigtableAdminV2TypeStructEncodingSingleton; + } + /** + * Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. + */ + export interface Schema$GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes { + /** + * Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. + */ + delimiter?: string | null; + } + /** + * Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01\} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF\}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00\}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00\}. Examples: - STRUCT() -\> "\00\00" - STRUCT("") -\> "\00\00" - STRUCT("", "") -\> "\00\00" - STRUCT("", "B") -\> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -\> "A" - STRUCT("", "B", "") -\> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -\> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. + */ + export interface Schema$GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes {} + /** + * Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. + */ + export interface Schema$GoogleBigtableAdminV2TypeStructEncodingSingleton {} /** * A struct field and its type. */ @@ -1007,7 +1131,21 @@ export namespace bigtableadmin_v2 { /** * Timestamp Values of type `Timestamp` are stored in `Value.timestamp_value`. */ - export interface Schema$GoogleBigtableAdminV2TypeTimestamp {} + export interface Schema$GoogleBigtableAdminV2TypeTimestamp { + /** + * The encoding to use when converting to or from lower level types. + */ + encoding?: Schema$GoogleBigtableAdminV2TypeTimestampEncoding; + } + /** + * Rules used to convert to or from lower level types. + */ + export interface Schema$GoogleBigtableAdminV2TypeTimestampEncoding { + /** + * Encodes the number of microseconds since the Unix epoch using the given `Int64` encoding. Values must be microsecond-aligned. Compatible with: - Java `Instant.truncatedTo()` with `ChronoUnit.MICROS` + */ + unixMicrosInt64?: Schema$GoogleBigtableAdminV2TypeInt64Encoding; + } /** * 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. */ @@ -1241,6 +1379,44 @@ export namespace bigtableadmin_v2 { */ name?: string | null; } + /** + * A SQL logical view object that can be referenced in SQL queries. + */ + export interface Schema$LogicalView { + /** + * Optional. The etag for this logical view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. + */ + etag?: string | null; + /** + * Identifier. The unique name of the logical view. Format: `projects/{project\}/instances/{instance\}/logicalViews/{logical_view\}` + */ + name?: string | null; + /** + * Required. The logical view's select query. + */ + query?: string | null; + } + /** + * A materialized view object that can be referenced in SQL queries. + */ + export interface Schema$MaterializedView { + /** + * Set to true to make the MaterializedView protected against deletion. + */ + deletionProtection?: boolean | null; + /** + * Optional. The etag for this materialized view. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. + */ + etag?: string | null; + /** + * Identifier. The unique name of the materialized view. Format: `projects/{project\}/instances/{instance\}/materializedViews/{materialized_view\}` + */ + name?: string | null; + /** + * Required. Immutable. The materialized view's select query. + */ + query?: string | null; + } /** * A create, update, or delete of a particular column family. */ @@ -1777,6 +1953,36 @@ export namespace bigtableadmin_v2 { */ requestTime?: string | null; } + /** + * The metadata for the Operation returned by UpdateLogicalView. + */ + export interface Schema$UpdateLogicalViewMetadata { + /** + * If set, the time at which this operation finished or was canceled. + */ + endTime?: string | null; + /** + * The request that prompted the initiation of this UpdateLogicalView operation. + */ + originalRequest?: Schema$UpdateLogicalViewRequest; + /** + * The time at which this operation was started. + */ + startTime?: string | null; + } + /** + * Request message for BigtableInstanceAdmin.UpdateLogicalView. + */ + export interface Schema$UpdateLogicalViewRequest { + /** + * Required. The logical view to update. The logical view's `name` field is used to identify the view to update. Format: `projects/{project\}/instances/{instance\}/logicalViews/{logical_view\}`. + */ + logicalView?: Schema$LogicalView; + /** + * Optional. The list of fields to update. + */ + updateMask?: string | null; + } /** * Metadata type for the operation returned by UpdateTable. */ @@ -2043,6 +2249,8 @@ export namespace bigtableadmin_v2 { context: APIRequestContext; appProfiles: Resource$Projects$Instances$Appprofiles; clusters: Resource$Projects$Instances$Clusters; + logicalViews: Resource$Projects$Instances$Logicalviews; + materializedViews: Resource$Projects$Instances$Materializedviews; tables: Resource$Projects$Instances$Tables; constructor(context: APIRequestContext) { this.context = context; @@ -2050,6 +2258,11 @@ export namespace bigtableadmin_v2 { this.context ); this.clusters = new Resource$Projects$Instances$Clusters(this.context); + this.logicalViews = new Resource$Projects$Instances$Logicalviews( + this.context + ); + this.materializedViews = + new Resource$Projects$Instances$Materializedviews(this.context); this.tables = new Resource$Projects$Instances$Tables(this.context); } @@ -5155,6 +5368,648 @@ export namespace bigtableadmin_v2 { startTime?: string; } + export class Resource$Projects$Instances$Logicalviews { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but 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$Instances$Logicalviews$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Logicalviews$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Logicalviews$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Logicalviews$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Logicalviews$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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); + } + } + + /** + * Sets the access control policy on an instance resource. Replaces any existing 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. + */ + setIamPolicy( + params: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Logicalviews$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Logicalviews$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Logicalviews$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Logicalviews$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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 instance 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$Instances$Logicalviews$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Instances$Logicalviews$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Instances$Logicalviews$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Logicalviews$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Logicalviews$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Logicalviews$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Logicalviews$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Logicalviews$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Logicalviews$Getiampolicy + extends StandardParameters { + /** + * 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; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Logicalviews$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$Instances$Logicalviews$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$Instances$Materializedviews { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but 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$Instances$Materializedviews$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Materializedviews$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Materializedviews$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Materializedviews$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Materializedviews$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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); + } + } + + /** + * Sets the access control policy on an instance resource. Replaces any existing 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. + */ + setIamPolicy( + params: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Materializedviews$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Materializedviews$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Materializedviews$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Materializedviews$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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 instance 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$Instances$Materializedviews$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Instances$Materializedviews$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Instances$Materializedviews$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Materializedviews$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Materializedviews$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Materializedviews$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Materializedviews$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Materializedviews$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Materializedviews$Getiampolicy + extends StandardParameters { + /** + * 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; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Materializedviews$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$Instances$Materializedviews$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$Instances$Tables { context: APIRequestContext; authorizedViews: Resource$Projects$Instances$Tables$Authorizedviews; @@ -6548,7 +7403,7 @@ export namespace bigtableadmin_v2 { */ name?: string; /** - * Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error. + * Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` * `automated_backup_policy` * `automated_backup_policy.retention_period` * `automated_backup_policy.frequency` * `row_key_schema` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error. */ updateMask?: string; From bf3ff69097d80cd39bfec7c0e8c52716db6fa6e7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 020/144] feat(binaryauthorization): update the API #### binaryauthorization:v1 The following keys were added: - schemas.VerificationRule.properties.customConstraints.description - schemas.VerificationRule.properties.customConstraints.type --- discovery/binaryauthorization-v1.json | 6 +++++- src/apis/binaryauthorization/v1.ts | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/discovery/binaryauthorization-v1.json b/discovery/binaryauthorization-v1.json index a5cb22699ba..d95bd9421fe 100644 --- a/discovery/binaryauthorization-v1.json +++ b/discovery/binaryauthorization-v1.json @@ -747,7 +747,7 @@ } } }, - "revision": "20250117", + "revision": "20250311", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { @@ -1820,6 +1820,10 @@ "description": "If true, require the image to be built from a top-level configuration. `trusted_source_repo_patterns` specifies the repositories containing this configuration.", "type": "boolean" }, + "customConstraints": { + "description": "Optional. A CEL expression for specifying custom constraints on the provenance payload. This can be used when users want to specify expectations on provenance fields that are not covered by the general check. For example, users can use this field to require that certain parameters should never be used during the build process.", + "type": "string" + }, "trustedBuilder": { "description": "Each verification rule is used for evaluation against provenances generated by a specific builder (group). For some of the builders, such as the Google Cloud Build, users don't need to explicitly specify their roots of trust in the policy since the evaluation service can automatically fetch them based on the builder (group).", "enum": [ diff --git a/src/apis/binaryauthorization/v1.ts b/src/apis/binaryauthorization/v1.ts index b01e2617679..2fe167b96ab 100644 --- a/src/apis/binaryauthorization/v1.ts +++ b/src/apis/binaryauthorization/v1.ts @@ -867,6 +867,10 @@ export namespace binaryauthorization_v1 { * If true, require the image to be built from a top-level configuration. `trusted_source_repo_patterns` specifies the repositories containing this configuration. */ configBasedBuildRequired?: boolean | null; + /** + * Optional. A CEL expression for specifying custom constraints on the provenance payload. This can be used when users want to specify expectations on provenance fields that are not covered by the general check. For example, users can use this field to require that certain parameters should never be used during the build process. + */ + customConstraints?: string | null; /** * Each verification rule is used for evaluation against provenances generated by a specific builder (group). For some of the builders, such as the Google Cloud Build, users don't need to explicitly specify their roots of trust in the policy since the evaluation service can automatically fetch them based on the builder (group). */ From 44cf93302ef0547caf8755db685ceff0ff165ba9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 021/144] feat(certificatemanager): update the API #### certificatemanager:v1 The following keys were added: - schemas.Certificate.properties.usedBy.description - schemas.Certificate.properties.usedBy.items.$ref - schemas.Certificate.properties.usedBy.readOnly - schemas.Certificate.properties.usedBy.type - schemas.UsedBy.description - schemas.UsedBy.id - schemas.UsedBy.properties.name.description - schemas.UsedBy.properties.name.readOnly - schemas.UsedBy.properties.name.type - schemas.UsedBy.type The following keys were changed: - schemas.Certificate.properties.scope.enum - schemas.Certificate.properties.scope.enumDescriptions --- discovery/certificatemanager-v1.json | 28 +++++++++++++++++++++++++--- src/apis/certificatemanager/v1.ts | 13 +++++++++++++ 2 files changed, 38 insertions(+), 3 deletions(-) diff --git a/discovery/certificatemanager-v1.json b/discovery/certificatemanager-v1.json index a6aec77ace5..b89038f25b1 100644 --- a/discovery/certificatemanager-v1.json +++ b/discovery/certificatemanager-v1.json @@ -1314,7 +1314,7 @@ } } }, - "revision": "20241204", + "revision": "20250211", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -1438,12 +1438,14 @@ "enum": [ "DEFAULT", "EDGE_CACHE", - "ALL_REGIONS" + "ALL_REGIONS", + "CLIENT_AUTH" ], "enumDescriptions": [ "Use the DEFAULT scope if you plan to use the certificate with global external Application Load Balancer, global external proxy Network Load Balancer, or any of the regional Google Cloud services.", "Use the EDGE_CACHE scope if you plan to use the certificate with Media CDN. The certificates are served from Edge Points of Presence. See https://cloud.google.com/vpc/docs/edge-locations.", - "Use the ALL_REGIONS scope if you plan to use the certificate with cross-region internal Application Load Balancer. The certificates are served from all Google Cloud regions. See https://cloud.google.com/compute/docs/regions-zones." + "Use the ALL_REGIONS scope if you plan to use the certificate with cross-region internal Application Load Balancer. The certificates are served from all Google Cloud regions. See https://cloud.google.com/compute/docs/regions-zones.", + "Associated with certificates used as client certificates in Backend mTLS." ], "type": "string" }, @@ -1456,6 +1458,14 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "usedBy": { + "description": "Output only. The list of resources that use this Certificate.", + "items": { + "$ref": "UsedBy" + }, + "readOnly": true, + "type": "array" } }, "type": "object" @@ -2299,6 +2309,18 @@ } }, "type": "object" + }, + "UsedBy": { + "description": "Defines a resource that uses the certificate.", + "id": "UsedBy", + "properties": { + "name": { + "description": "Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//certificatemanager.googleapis.com/projects/*/locations/*/certificateMaps/*/certificateMapEntries/*` or `//compute.googleapis.com/projects/*/locations/*/targetHttpsProxies/*`.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/src/apis/certificatemanager/v1.ts b/src/apis/certificatemanager/v1.ts index 2a3fc22a4d8..b894310f43f 100644 --- a/src/apis/certificatemanager/v1.ts +++ b/src/apis/certificatemanager/v1.ts @@ -206,6 +206,10 @@ export namespace certificatemanager_v1 { * Output only. The last update timestamp of a Certificate. */ updateTime?: string | null; + /** + * Output only. The list of resources that use this Certificate. + */ + usedBy?: Schema$UsedBy[]; } /** * The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. @@ -775,6 +779,15 @@ export namespace certificatemanager_v1 { */ trustAnchors?: Schema$TrustAnchor[]; } + /** + * Defines a resource that uses the certificate. + */ + export interface Schema$UsedBy { + /** + * Output only. Full name of the resource https://google.aip.dev/122#full-resource-names, e.g. `//certificatemanager.googleapis.com/projects/x/locations/x/certificateMaps/x/certificateMapEntries/x` or `//compute.googleapis.com/projects/x/locations/x/targetHttpsProxies/x`. + */ + name?: string | null; + } export class Resource$Projects { context: APIRequestContext; From ee13c9825a805930ae7b3dad116193f4d4763b16 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 022/144] feat(chat)!: update the API BREAKING CHANGE: This release has breaking changes. #### chat:v1 The following keys were deleted: - schemas.Emoji.properties.customEmoji.readOnly The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/chat.users.spacesettings.description - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.description - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.flatPath - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.httpMethod - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.id - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.parameterOrder - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.parameters.name.description - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.parameters.name.location - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.parameters.name.pattern - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.parameters.name.required - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.parameters.name.type - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.path - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.response.$ref - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.get.scopes - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.description - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.flatPath - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.httpMethod - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.id - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameterOrder - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.name.description - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.name.location - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.name.pattern - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.name.required - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.name.type - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.updateMask.description - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.updateMask.format - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.updateMask.location - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.parameters.updateMask.type - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.path - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.request.$ref - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.response.$ref - resources.users.resources.spaces.resources.spaceNotificationSetting.methods.patch.scopes - schemas.Annotation.properties.customEmojiMetadata.$ref - schemas.Annotation.properties.customEmojiMetadata.description - schemas.AppCommandMetadata.description - schemas.AppCommandMetadata.id - schemas.AppCommandMetadata.properties.appCommandId.description - schemas.AppCommandMetadata.properties.appCommandId.format - schemas.AppCommandMetadata.properties.appCommandId.type - schemas.AppCommandMetadata.properties.appCommandType.description - schemas.AppCommandMetadata.properties.appCommandType.enum - schemas.AppCommandMetadata.properties.appCommandType.enumDescriptions - schemas.AppCommandMetadata.properties.appCommandType.type - schemas.AppCommandMetadata.type - schemas.CustomEmojiMetadata.description - schemas.CustomEmojiMetadata.id - schemas.CustomEmojiMetadata.properties.customEmoji.$ref - schemas.CustomEmojiMetadata.properties.customEmoji.description - schemas.CustomEmojiMetadata.type - schemas.DeprecatedEvent.properties.appCommandMetadata.$ref - schemas.DeprecatedEvent.properties.appCommandMetadata.description - schemas.DeprecatedEvent.properties.thread.$ref - schemas.DeprecatedEvent.properties.thread.description - schemas.SpaceNotificationSetting.description - schemas.SpaceNotificationSetting.id - schemas.SpaceNotificationSetting.properties.muteSetting.description - schemas.SpaceNotificationSetting.properties.muteSetting.enum - schemas.SpaceNotificationSetting.properties.muteSetting.enumDescriptions - schemas.SpaceNotificationSetting.properties.muteSetting.type - schemas.SpaceNotificationSetting.properties.name.description - schemas.SpaceNotificationSetting.properties.name.type - schemas.SpaceNotificationSetting.properties.notificationSetting.description - schemas.SpaceNotificationSetting.properties.notificationSetting.enum - schemas.SpaceNotificationSetting.properties.notificationSetting.enumDescriptions - schemas.SpaceNotificationSetting.properties.notificationSetting.type - schemas.SpaceNotificationSetting.type The following keys were changed: - resources.spaces.resources.messages.resources.reactions.methods.create.description - resources.spaces.resources.messages.resources.reactions.methods.delete.description - schemas.Annotation.properties.type.enum - schemas.Annotation.properties.type.enumDescriptions - schemas.CommonEventObject.properties.hostApp.enumDescriptions - schemas.DeletionMetadata.properties.deletionType.enum - schemas.DeletionMetadata.properties.deletionType.enumDescriptions - schemas.DeprecatedEvent.properties.configCompleteRedirectUrl.description - schemas.DeprecatedEvent.properties.type.enum - schemas.DeprecatedEvent.properties.type.enumDescriptions - schemas.Emoji.properties.customEmoji.description - schemas.SlashCommand.description - schemas.SlashCommand.properties.commandId.description --- discovery/chat-v1.json | 201 ++++++++++++++++++++++++++--- src/apis/chat/v1.ts | 281 ++++++++++++++++++++++++++++++++++++++++- 2 files changed, 457 insertions(+), 25 deletions(-) diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index b1abad5b4c8..e44be81a7ca 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -79,6 +79,9 @@ }, "https://www.googleapis.com/auth/chat.users.readstate.readonly": { "description": "View last read time for Google Chat conversations" + }, + "https://www.googleapis.com/auth/chat.users.spacesettings": { + "description": "Read and update your space settings" } } } @@ -1052,7 +1055,7 @@ "reactions": { "methods": { "create": { - "description": "Creates a reaction and adds it to a message. Only unicode emojis are supported. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions", "httpMethod": "POST", "id": "chat.spaces.messages.reactions.create", @@ -1083,7 +1086,7 @@ ] }, "delete": { - "description": "Deletes a reaction to a message. Only unicode emojis are supported. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}", "httpMethod": "DELETE", "id": "chat.spaces.messages.reactions.delete", @@ -1309,6 +1312,69 @@ } }, "resources": { + "spaceNotificationSetting": { + "methods": { + "get": { + "description": "Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceNotificationSetting", + "httpMethod": "GET", + "id": "chat.users.spaces.spaceNotificationSetting.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.", + "location": "path", + "pattern": "^users/[^/]+/spaces/[^/]+/spaceNotificationSetting$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SpaceNotificationSetting" + }, + "scopes": [ + "https://www.googleapis.com/auth/chat.users.spacesettings" + ] + }, + "patch": { + "description": "Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceNotificationSetting", + "httpMethod": "PATCH", + "id": "chat.users.spaces.spaceNotificationSetting.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.", + "location": "path", + "pattern": "^users/[^/]+/spaces/[^/]+/spaceNotificationSetting$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Supported field paths: - `notification_setting` - `mute_setting`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "SpaceNotificationSetting" + }, + "response": { + "$ref": "SpaceNotificationSetting" + }, + "scopes": [ + "https://www.googleapis.com/auth/chat.users.spacesettings" + ] + } + } + }, "threads": { "methods": { "getThreadReadState": { @@ -1344,7 +1410,7 @@ } } }, - "revision": "20250116", + "revision": "20250311", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1497,6 +1563,10 @@ "description": "Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```", "id": "Annotation", "properties": { + "customEmojiMetadata": { + "$ref": "CustomEmojiMetadata", + "description": "The metadata for a custom emoji." + }, "length": { "description": "Length of the substring in the plain-text message body this annotation corresponds to.", "format": "int32", @@ -1521,13 +1591,15 @@ "ANNOTATION_TYPE_UNSPECIFIED", "USER_MENTION", "SLASH_COMMAND", - "RICH_LINK" + "RICH_LINK", + "CUSTOM_EMOJI" ], "enumDescriptions": [ "Default value for the enum. Don't use.", "A user is mentioned.", "A slash command is invoked.", - "A rich link annotation." + "A rich link annotation.", + "A custom emoji annotation." ], "type": "string" }, @@ -1538,6 +1610,32 @@ }, "type": "object" }, + "AppCommandMetadata": { + "description": "Metadata about a [Chat app command](https://developers.google.com/workspace/chat/commands).", + "id": "AppCommandMetadata", + "properties": { + "appCommandId": { + "description": "The ID for the command specified in the Chat API configuration.", + "format": "int32", + "type": "integer" + }, + "appCommandType": { + "description": "The type of Chat app command.", + "enum": [ + "APP_COMMAND_TYPE_UNSPECIFIED", + "SLASH_COMMAND", + "QUICK_COMMAND" + ], + "enumDescriptions": [ + "Default value. Unspecified.", + "A slash command. The user sends the command in a Chat message.", + "A quick command. The user selects the command from the Chat menu in the message reply area." + ], + "type": "string" + } + }, + "type": "object" + }, "AttachedGif": { "description": "A GIF image that's specified by a URL.", "id": "AttachedGif", @@ -1839,7 +1937,7 @@ "The add-on launches from Google Sheets.", "The add-on launches from Google Slides.", "The add-on launches from Google Drawings.", - "A Google Chat app. Not used for Google Workspace Add-ons." + "A Google Chat app. Not used for Google Workspace add-ons." ], "type": "string" }, @@ -1910,6 +2008,17 @@ }, "type": "object" }, + "CustomEmojiMetadata": { + "description": "Annotation metadata for custom emoji.", + "id": "CustomEmojiMetadata", + "properties": { + "customEmoji": { + "$ref": "CustomEmoji", + "description": "The custom emoji." + } + }, + "type": "object" + }, "DateInput": { "description": "Date input values.", "id": "DateInput", @@ -1955,16 +2064,18 @@ "ADMIN", "APP_MESSAGE_EXPIRY", "CREATOR_VIA_APP", - "SPACE_OWNER_VIA_APP" + "SPACE_OWNER_VIA_APP", + "SPACE_MEMBER" ], "enumDescriptions": [ "This value is unused.", "User deleted their own message.", - "The space owner deleted the message.", - "A Google Workspace admin deleted the message.", + "A space manager deleted the message.", + "A Google Workspace administrator deleted the message. Administrators can delete any message in the space, including messages sent by any space member or Chat app.", "A Chat app deleted its own message when it expired.", - "A Chat app deleted the message on behalf of the user.", - "A Chat app deleted the message on behalf of the space owner." + "A Chat app deleted the message on behalf of the creator (using user authentication).", + "A Chat app deleted the message on behalf of a space manager (using user authentication).", + "A member of the space deleted the message. Users can delete messages sent by apps." ], "type": "string" } @@ -1979,12 +2090,16 @@ "$ref": "FormAction", "description": "For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/workspace/chat/read-form-data)." }, + "appCommandMetadata": { + "$ref": "AppCommandMetadata", + "description": "Metadata about a Chat app command." + }, "common": { "$ref": "CommonEventObject", "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": "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).", + "description": "This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. 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": { @@ -2020,6 +2135,10 @@ "$ref": "Space", "description": "The space in which the user interacted with the Chat app." }, + "thread": { + "$ref": "Thread", + "description": "The thread in which the user interacted with the Chat app. This could be in a new thread created by a newly sent message. This field is populated if the interaction event is associated with a specific message or thread." + }, "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.", "type": "string" @@ -2036,15 +2155,17 @@ "ADDED_TO_SPACE", "REMOVED_FROM_SPACE", "CARD_CLICKED", - "WIDGET_UPDATED" + "WIDGET_UPDATED", + "APP_COMMAND" ], "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, 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 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](https://developers.google.com/workspace/chat/commands#types). * 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." + "A user updates a widget in a card message or dialog.", + "A user uses a Chat app [quick command](https://developers.google.com/workspace/chat/commands#types)." ], "type": "string" }, @@ -2113,8 +2234,7 @@ "properties": { "customEmoji": { "$ref": "CustomEmoji", - "description": "Output only. A custom emoji.", - "readOnly": true + "description": "A custom emoji." }, "unicode": { "description": "Optional. A basic emoji represented by a unicode string.", @@ -4524,11 +4644,11 @@ "type": "object" }, "SlashCommand": { - "description": "A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat.", + "description": "Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat.", "id": "SlashCommand", "properties": { "commandId": { - "description": "The ID of the slash command invoked.", + "description": "The ID of the slash command.", "format": "int64", "type": "string" } @@ -4859,6 +4979,49 @@ }, "type": "object" }, + "SpaceNotificationSetting": { + "description": "The notification setting of a user in a space.", + "id": "SpaceNotificationSetting", + "properties": { + "muteSetting": { + "description": "The space notification mute setting.", + "enum": [ + "MUTE_SETTING_UNSPECIFIED", + "UNMUTED", + "MUTED" + ], + "enumDescriptions": [ + "Reserved.", + "The user will receive notifications for the space based on the notification setting.", + "The user will not receive any notifications for the space, regardless of the notification setting." + ], + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.", + "type": "string" + }, + "notificationSetting": { + "description": "The notification setting.", + "enum": [ + "NOTIFICATION_SETTING_UNSPECIFIED", + "ALL", + "MAIN_CONVERSATIONS", + "FOR_YOU", + "OFF" + ], + "enumDescriptions": [ + "Reserved.", + "Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user.", + "The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages.", + "The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages.", + "Notification is off." + ], + "type": "string" + } + }, + "type": "object" + }, "SpaceReadState": { "description": "A user's read state within a space, used to identify read and unread messages.", "id": "SpaceReadState", diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 56ca8ef68fd..e65467315be 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -201,6 +201,10 @@ export namespace chat_v1 { * Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user\}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" \}, "type":"MENTION" \} \}] ``` */ export interface Schema$Annotation { + /** + * The metadata for a custom emoji. + */ + customEmojiMetadata?: Schema$CustomEmojiMetadata; /** * Length of the substring in the plain-text message body this annotation corresponds to. */ @@ -226,6 +230,19 @@ export namespace chat_v1 { */ userMention?: Schema$UserMentionMetadata; } + /** + * Metadata about a [Chat app command](https://developers.google.com/workspace/chat/commands). + */ + export interface Schema$AppCommandMetadata { + /** + * The ID for the command specified in the Chat API configuration. + */ + appCommandId?: number | null; + /** + * The type of Chat app command. + */ + appCommandType?: string | null; + } /** * A GIF image that's specified by a URL. */ @@ -482,6 +499,15 @@ export namespace chat_v1 { */ uid?: string | null; } + /** + * Annotation metadata for custom emoji. + */ + export interface Schema$CustomEmojiMetadata { + /** + * The custom emoji. + */ + customEmoji?: Schema$CustomEmoji; + } /** * Date input values. */ @@ -525,12 +551,16 @@ export namespace chat_v1 { * For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/workspace/chat/read-form-data). */ action?: Schema$FormAction; + /** + * Metadata about a Chat app command. + */ + appCommandMetadata?: Schema$AppCommandMetadata; /** * 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; /** - * 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). + * This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. 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; /** @@ -553,6 +583,10 @@ export namespace chat_v1 { * The space in which the user interacted with the Chat app. */ space?: Schema$Space; + /** + * The thread in which the user interacted with the Chat app. This could be in a new thread created by a newly sent message. This field is populated if the interaction event is associated with a specific message or thread. + */ + thread?: Schema$Thread; /** * 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. */ @@ -619,7 +653,7 @@ export namespace chat_v1 { */ export interface Schema$Emoji { /** - * Output only. A custom emoji. + * A custom emoji. */ customEmoji?: Schema$CustomEmoji; /** @@ -2263,11 +2297,11 @@ export namespace chat_v1 { space?: Schema$Space; } /** - * A [slash command](https://developers.google.com/workspace/chat/slash-commands) in Google Chat. + * Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat. */ export interface Schema$SlashCommand { /** - * The ID of the slash command invoked. + * The ID of the slash command. */ commandId?: string | null; } @@ -2501,6 +2535,23 @@ export namespace chat_v1 { */ spaceUpdatedEventData?: Schema$SpaceUpdatedEventData; } + /** + * The notification setting of a user in a space. + */ + export interface Schema$SpaceNotificationSetting { + /** + * The space notification mute setting. + */ + muteSetting?: string | null; + /** + * Identifier. The resource name of the space notification setting. Format: `users/{user\}/spaces/{space\}/spaceNotificationSetting`. + */ + name?: string | null; + /** + * The notification setting. + */ + notificationSetting?: string | null; + } /** * A user's read state within a space, used to identify read and unread messages. */ @@ -5126,7 +5177,7 @@ export namespace chat_v1 { } /** - * Creates a reaction and adds it to a message. Only unicode emojis are supported. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5214,7 +5265,7 @@ export namespace chat_v1 { } /** - * Deletes a reaction to a message. Only unicode emojis are supported. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5654,9 +5705,12 @@ export namespace chat_v1 { export class Resource$Users$Spaces { context: APIRequestContext; + spaceNotificationSetting: Resource$Users$Spaces$Spacenotificationsetting; threads: Resource$Users$Spaces$Threads; constructor(context: APIRequestContext) { this.context = context; + this.spaceNotificationSetting = + new Resource$Users$Spaces$Spacenotificationsetting(this.context); this.threads = new Resource$Users$Spaces$Threads(this.context); } @@ -5859,6 +5913,221 @@ export namespace chat_v1 { requestBody?: Schema$SpaceReadState; } + export class Resource$Users$Spaces$Spacenotificationsetting { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-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$Users$Spaces$Spacenotificationsetting$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Users$Spaces$Spacenotificationsetting$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Users$Spaces$Spacenotificationsetting$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Users$Spaces$Spacenotificationsetting$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Users$Spaces$Spacenotificationsetting$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Users$Spaces$Spacenotificationsetting$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Spaces$Spacenotificationsetting$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Users$Spaces$Spacenotificationsetting$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://chat.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); + } + } + + /** + * Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-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. + */ + patch( + params: Params$Resource$Users$Spaces$Spacenotificationsetting$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Users$Spaces$Spacenotificationsetting$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Users$Spaces$Spacenotificationsetting$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Users$Spaces$Spacenotificationsetting$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Users$Spaces$Spacenotificationsetting$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Users$Spaces$Spacenotificationsetting$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Spaces$Spacenotificationsetting$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Users$Spaces$Spacenotificationsetting$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://chat.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$Users$Spaces$Spacenotificationsetting$Get + extends StandardParameters { + /** + * Required. Format: users/{user\}/spaces/{space\}/spaceNotificationSetting - `users/me/spaces/{space\}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space\}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space\}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path. + */ + name?: string; + } + export interface Params$Resource$Users$Spaces$Spacenotificationsetting$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the space notification setting. Format: `users/{user\}/spaces/{space\}/spaceNotificationSetting`. + */ + name?: string; + /** + * Required. Supported field paths: - `notification_setting` - `mute_setting` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SpaceNotificationSetting; + } + export class Resource$Users$Spaces$Threads { context: APIRequestContext; constructor(context: APIRequestContext) { From 55f245ea05d2a1cea1846d818402a7c05fd69856 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 023/144] feat(chromemanagement)!: update the API BREAKING CHANGE: This release has breaking changes. #### chromemanagement:v1 The following keys were deleted: - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.caConnectionAdapterConfigReference.description - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.caConnectionAdapterConfigReference.readOnly - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.caConnectionAdapterConfigReference.type - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.profileAdapterConfigReference.description - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.profileAdapterConfigReference.readOnly - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.profileAdapterConfigReference.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.id - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.caConnectionAdapterConfigReference.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.caConnectionAdapterConfigReference.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.caConnectionAdapterConfigReference.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.chromeOsDevice.$ref - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.chromeOsDevice.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.chromeOsDevice.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.chromeOsUserSession.$ref - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.chromeOsUserSession.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.chromeOsUserSession.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.failureMessage.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.failureMessage.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.failureMessage.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.issuedCertificate.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.issuedCertificate.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.issuedCertificate.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.name.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.name.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.profileAdapterConfigReference.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.profileAdapterConfigReference.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.profileAdapterConfigReference.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.provisioningProfileId.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.provisioningProfileId.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.provisioningProfileId.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signData.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signData.format - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signData.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signData.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signature.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signature.format - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signature.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signature.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signatureAlgorithm.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signatureAlgorithm.enum - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signatureAlgorithm.enumDescriptions - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signatureAlgorithm.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.signatureAlgorithm.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.startTime.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.startTime.format - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.startTime.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.startTime.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.subjectPublicKeyInfo.description - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.subjectPublicKeyInfo.format - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.subjectPublicKeyInfo.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.properties.subjectPublicKeyInfo.type - schemas.GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess.type - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.description - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.id - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.properties.deviceDirectoryApiId.description - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.properties.deviceDirectoryApiId.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.properties.deviceDirectoryApiId.type - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.properties.serialNumber.description - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.properties.serialNumber.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.properties.serialNumber.type - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsDevice.type - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.description - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.id - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.chromeOsDevice.$ref - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.chromeOsDevice.description - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.chromeOsDevice.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.userDirectoryApiId.description - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.userDirectoryApiId.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.userDirectoryApiId.type - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.userPrimaryEmail.description - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.userPrimaryEmail.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.properties.userPrimaryEmail.type - schemas.GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession.type - schemas.GoogleChromeManagementVersionsV1alpha1SignDataMetadata.description - schemas.GoogleChromeManagementVersionsV1alpha1SignDataMetadata.id - schemas.GoogleChromeManagementVersionsV1alpha1SignDataMetadata.properties.startTime.description - schemas.GoogleChromeManagementVersionsV1alpha1SignDataMetadata.properties.startTime.format - schemas.GoogleChromeManagementVersionsV1alpha1SignDataMetadata.properties.startTime.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1SignDataMetadata.properties.startTime.type - schemas.GoogleChromeManagementVersionsV1alpha1SignDataMetadata.type - schemas.GoogleChromeManagementVersionsV1alpha1SignDataResponse.description - schemas.GoogleChromeManagementVersionsV1alpha1SignDataResponse.id - schemas.GoogleChromeManagementVersionsV1alpha1SignDataResponse.properties.certificateProvisioningProcess.$ref - schemas.GoogleChromeManagementVersionsV1alpha1SignDataResponse.properties.certificateProvisioningProcess.description - schemas.GoogleChromeManagementVersionsV1alpha1SignDataResponse.properties.certificateProvisioningProcess.readOnly - schemas.GoogleChromeManagementVersionsV1alpha1SignDataResponse.type The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/chrome.management.profiles.description - auth.oauth2.scopes.https://www.googleapis.com/auth/chrome.management.profiles.readonly.description - resources.customers.resources.profiles.methods.delete.scopes - resources.customers.resources.profiles.methods.get.scopes - resources.customers.resources.profiles.methods.list.scopes - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.genericCaConnection.$ref - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.genericCaConnection.description - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.genericCaConnection.readOnly - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.genericProfile.$ref - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.genericProfile.description - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.genericProfile.readOnly - schemas.GoogleChromeManagementVersionsV1GenericCaConnection.description - schemas.GoogleChromeManagementVersionsV1GenericCaConnection.id - schemas.GoogleChromeManagementVersionsV1GenericCaConnection.properties.caConnectionAdapterConfigReference.description - schemas.GoogleChromeManagementVersionsV1GenericCaConnection.properties.caConnectionAdapterConfigReference.readOnly - schemas.GoogleChromeManagementVersionsV1GenericCaConnection.properties.caConnectionAdapterConfigReference.type - schemas.GoogleChromeManagementVersionsV1GenericCaConnection.type - schemas.GoogleChromeManagementVersionsV1GenericProfile.description - schemas.GoogleChromeManagementVersionsV1GenericProfile.id - schemas.GoogleChromeManagementVersionsV1GenericProfile.properties.profileAdapterConfigReference.description - schemas.GoogleChromeManagementVersionsV1GenericProfile.properties.profileAdapterConfigReference.readOnly - schemas.GoogleChromeManagementVersionsV1GenericProfile.properties.profileAdapterConfigReference.type - schemas.GoogleChromeManagementVersionsV1GenericProfile.type The following keys were changed: - resources.customers.resources.profiles.methods.list.parameters.filter.description - resources.customers.resources.profiles.methods.list.parameters.orderBy.description - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.chromeOsUserSession.description - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.failureMessage.description - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.signature.description - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.signatureAlgorithm.enum - schemas.GoogleChromeManagementVersionsV1CertificateProvisioningProcess.properties.signatureAlgorithm.enumDescriptions - schemas.GoogleChromeManagementVersionsV1ChromeBrowserProfile.properties.osPlatformVersion.description - schemas.GoogleChromeManagementVersionsV1ChromeOsUserSession.properties.chromeOsDevice.description --- discovery/chromemanagement-v1.json | 238 ++++++++--------------------- src/apis/chromemanagement/v1.ts | 153 ++++--------------- 2 files changed, 97 insertions(+), 294 deletions(-) diff --git a/discovery/chromemanagement-v1.json b/discovery/chromemanagement-v1.json index 4f6d7fa67bd..1da526e98af 100644 --- a/discovery/chromemanagement-v1.json +++ b/discovery/chromemanagement-v1.json @@ -5,6 +5,12 @@ "https://www.googleapis.com/auth/chrome.management.appdetails.readonly": { "description": "See detailed information about apps installed on Chrome browsers and devices managed by your organization" }, + "https://www.googleapis.com/auth/chrome.management.profiles": { + "description": "See, edit, delete, and take other necessary actions on Chrome browser profiles managed by your organization" + }, + "https://www.googleapis.com/auth/chrome.management.profiles.readonly": { + "description": "See Chrome browser profiles managed by your organization" + }, "https://www.googleapis.com/auth/chrome.management.reports.readonly": { "description": "See reports about devices and Chrome browsers managed within your organization" }, @@ -366,7 +372,10 @@ "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.profiles" + ] }, "get": { "description": "Gets a Chrome browser profile with customer ID and profile permanent ID.", @@ -388,7 +397,11 @@ "path": "v1/{+name}", "response": { "$ref": "GoogleChromeManagementVersionsV1ChromeBrowserProfile" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.profiles", + "https://www.googleapis.com/auth/chrome.management.profiles.readonly" + ] }, "list": { "description": "Lists Chrome browser profiles of a customer based on the given search and sorting criteria.", @@ -400,12 +413,12 @@ ], "parameters": { "filter": { - "description": "Optional. The filter used to filter profiles. The following fields can be used in the filter: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - ouId Any of the above fields can be used to specify a filter, and filtering by multiple fields is supported with AND operator. String type fields and enum type fields support '=' and '!=' operators. The integer type and the timestamp type fields support '=', '!=', '<', '>', '<=' and '>=' operators. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). Wildcard '*' can be used with a string type field filter. In addition, string literal filtering is also supported, for example, 'ABC' as a filter maps to a filter that checks if any of the filterable string type fields contains 'ABC'. Organization unit number can be used as a filtering criteria here by specifying 'ouId = ${your_org_unit_id}', please note that only single OU ID matching is supported.", + "description": "Optional. The filter used to filter profiles. The following fields can be used in the filter: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - os_platform_version - ouId Any of the above fields can be used to specify a filter, and filtering by multiple fields is supported with AND operator. String type fields and enum type fields support '=' and '!=' operators. The integer type and the timestamp type fields support '=', '!=', '<', '>', '<=' and '>=' operators. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). Wildcard '*' can be used with a string type field filter. In addition, string literal filtering is also supported, for example, 'ABC' as a filter maps to a filter that checks if any of the filterable string type fields contains 'ABC'. Organization unit number can be used as a filtering criteria here by specifying 'ouId = ${your_org_unit_id}', please note that only single OU ID matching is supported.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. The fields used to specify the ordering of the results. The supported fields are: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state By default, sorting is in ascending order, to specify descending order for a field, a suffix \" desc\" should be added to the field name. The default ordering is the descending order of last_status_report_time.", + "description": "Optional. The fields used to specify the ordering of the results. The supported fields are: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - os_platform_version By default, sorting is in ascending order, to specify descending order for a field, a suffix \" desc\" should be added to the field name. The default ordering is the descending order of last_status_report_time.", "location": "query", "type": "string" }, @@ -431,7 +444,11 @@ "path": "v1/{+parent}/profiles", "response": { "$ref": "GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.profiles", + "https://www.googleapis.com/auth/chrome.management.profiles.readonly" + ] } } }, @@ -1263,7 +1280,7 @@ } } }, - "revision": "20250122", + "revision": "20250313", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -4998,11 +5015,6 @@ "description": "A certificate provisioning process.", "id": "GoogleChromeManagementVersionsV1CertificateProvisioningProcess", "properties": { - "caConnectionAdapterConfigReference": { - "description": "Output only. A JSON string that contains the administrator-provided configuration for the certification authority service. This field can be missing if no configuration was given.", - "readOnly": true, - "type": "string" - }, "chromeOsDevice": { "$ref": "GoogleChromeManagementVersionsV1ChromeOsDevice", "description": "Output only. The client certificate is being provisioned for a ChromeOS device. This contains information about the device.", @@ -5010,14 +5022,24 @@ }, "chromeOsUserSession": { "$ref": "GoogleChromeManagementVersionsV1ChromeOsUserSession", - "description": "Output only. The client certificate is being provisioned for a ChromeOS user session. This contains information about the user session.", + "description": "Output only. The client certificate is being provisioned for a ChromeOS user. This contains information about the current user session.", "readOnly": true }, "failureMessage": { - "description": "Output only. A message describing why this `CertificateProvisioningProcess` failed. Presence of this field indicates that the `CertificateProvisioningProcess` has failed.", + "description": "Output only. A message describing why this `CertificateProvisioningProcess` has failed. Presence of this field indicates that the `CertificateProvisioningProcess` has failed.", "readOnly": true, "type": "string" }, + "genericCaConnection": { + "$ref": "GoogleChromeManagementVersionsV1GenericCaConnection", + "description": "Output only. The CA connection is a generic CA connection.", + "readOnly": true + }, + "genericProfile": { + "$ref": "GoogleChromeManagementVersionsV1GenericProfile", + "description": "Output only. The profile is a generic certificate provisioning profile.", + "readOnly": true + }, "issuedCertificate": { "description": "Output only. The issued certificate for this `CertificateProvisioningProcess` in PEM format.", "readOnly": true, @@ -5027,11 +5049,6 @@ "description": "Identifier. Resource name of the `CertificateProvisioningProcess`. The name pattern is given as `customers/{customer}/certificateProvisioningProcesses/{certificate_provisioning_process}` with `{customer}` being the obfuscated customer id and `{certificate_provisioning_process}` being the certificate provisioning process id.", "type": "string" }, - "profileAdapterConfigReference": { - "description": "Output only. A JSON string that contains the administrator-provided configuration for the certificate provisioning profile. This field can be missing if no configuration was given.", - "readOnly": true, - "type": "string" - }, "provisioningProfileId": { "description": "Output only. The ID of the certificate provisioning profile.", "readOnly": true, @@ -5044,7 +5061,7 @@ "type": "string" }, "signature": { - "description": "Output only. The signature of `signature_algorithm`, generated using the client's private key using `signature_algorithm`. This field is only present after the`SignData` operation has finished.", + "description": "Output only. The signature of `signature_algorithm`, generated using the client's private key using `signature_algorithm`. This field is only present after the `SignData` operation has finished.", "format": "byte", "readOnly": true, "type": "string" @@ -5053,13 +5070,11 @@ "description": "Output only. The signature algorithm that the adapter expects the client and backend components to use when processing `sign_data`. This field is only present after the `SignData` operation has been initiated.", "enum": [ "SIGNATURE_ALGORITHM_UNSPECIFIED", - "SIGNATURE_ALGORITHM_RSA_PKCS1_V1_5_SHA256", - "SIGNATURE_ALGORITHM_ECDSA_SHA256" + "SIGNATURE_ALGORITHM_RSA_PKCS1_V1_5_SHA256" ], "enumDescriptions": [ "Default value. This value is unused.", - "The server-side builds the PKCS#1 DigestInfo, i.e., the SHA256 hash is constructed on the server-side. The client should sign using RSA with PKCS#1 v1.5 padding.", - "The PKCS#1 digest info is built by the server-side and sent to the client unhashed. The client is responsible for signing and hashing. Uses the P-256 curve." + "The server-side builds the PKCS#1 DigestInfo, i.e., the SHA256 hash is constructed on the server-side. The client should sign using RSA with PKCS#1 v1.5 padding." ], "readOnly": true, "type": "string" @@ -5203,7 +5218,7 @@ "type": "string" }, "osPlatformVersion": { - "description": "Output only. Major OS version of the device on which the profile exists. (i.e. Windows 10)", + "description": "Output only. Major OS platform version of the device on which the profile exists, from profile reporting.", "readOnly": true, "type": "string" }, @@ -5269,7 +5284,7 @@ "properties": { "chromeOsDevice": { "$ref": "GoogleChromeManagementVersionsV1ChromeOsDevice", - "description": "Output only. This field contains information about the ChromeOS device that the user session is running on. It is only set if the user session is affiliated, i.e. if the user is managed by the same organization that managed the ChromeOS device.", + "description": "Output only. This field contains information about the ChromeOS device that the user session is running on. It is only set if the user is affiliated, i.e., if the user is managed by the same organization that manages the ChromeOS device.", "readOnly": true }, "userDirectoryApiId": { @@ -5320,6 +5335,30 @@ }, "type": "object" }, + "GoogleChromeManagementVersionsV1GenericCaConnection": { + "description": "Describes a generic Certificate Authority Connection.", + "id": "GoogleChromeManagementVersionsV1GenericCaConnection", + "properties": { + "caConnectionAdapterConfigReference": { + "description": "Output only. A string that references the administrator-provided configuration for the certification authority service. This field can be missing if no configuration was given.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleChromeManagementVersionsV1GenericProfile": { + "description": "Describes a generic certificate provisioning profile.", + "id": "GoogleChromeManagementVersionsV1GenericProfile", + "properties": { + "profileAdapterConfigReference": { + "description": "Output only. A string that references the administrator-provided configuration for the certificate provisioning profile. This field can be missing if no configuration was given.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse": { "description": "Response to ListChromeBrowserProfiles method.", "id": "GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse", @@ -5616,155 +5655,6 @@ }, "type": "object" }, - "GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess": { - "description": "A certificate provisioning process.", - "id": "GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess", - "properties": { - "caConnectionAdapterConfigReference": { - "description": "Output only. A JSON string that contains the administrator-provided configuration for the certification authority service. This field can be missing if no configuration was given.", - "readOnly": true, - "type": "string" - }, - "chromeOsDevice": { - "$ref": "GoogleChromeManagementVersionsV1alpha1ChromeOsDevice", - "description": "Output only. The client certificate is being provisioned for a ChromeOS device. This contains information about the device.", - "readOnly": true - }, - "chromeOsUserSession": { - "$ref": "GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession", - "description": "Output only. The client certificate is being provisioned for a ChromeOS user session. This contains information about the user session.", - "readOnly": true - }, - "failureMessage": { - "description": "Output only. A message describing why this `CertificateProvisioningProcess` failed. Presence of this field indicates that the `CertificateProvisioningProcess` has failed.", - "readOnly": true, - "type": "string" - }, - "issuedCertificate": { - "description": "Output only. The issued certificate for this `CertificateProvisioningProcess` in PEM format.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Identifier. Resource name of the `CertificateProvisioningProcess`. The name pattern is given as `customers/{customer}/certificateProvisioningProcesses/{certificate_provisioning_process}` with `{customer}` being the obfuscated customer id and `{certificate_provisioning_process}` being the certificate provisioning process id.", - "type": "string" - }, - "profileAdapterConfigReference": { - "description": "Output only. A JSON string that contains the administrator-provided configuration for the certificate provisioning profile. This field can be missing if no configuration was given.", - "readOnly": true, - "type": "string" - }, - "provisioningProfileId": { - "description": "Output only. The ID of the certificate provisioning profile.", - "readOnly": true, - "type": "string" - }, - "signData": { - "description": "Output only. The data that the client was asked to sign. This field is only present after the `SignData` operation has been initiated.", - "format": "byte", - "readOnly": true, - "type": "string" - }, - "signature": { - "description": "Output only. The signature of `signature_algorithm`, generated using the client's private key using `signature_algorithm`. This field is only present after the`SignData` operation has finished.", - "format": "byte", - "readOnly": true, - "type": "string" - }, - "signatureAlgorithm": { - "description": "Output only. The signature algorithm that the adapter expects the client and backend components to use when processing `sign_data`. This field is only present after the `SignData` operation has been initiated.", - "enum": [ - "SIGNATURE_ALGORITHM_UNSPECIFIED", - "SIGNATURE_ALGORITHM_RSA_PKCS1_V1_5_SHA256", - "SIGNATURE_ALGORITHM_ECDSA_SHA256" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "The server-side builds the PKCS#1 DigestInfo, i.e., the SHA256 hash is constructed on the server-side. The client should sign using RSA with PKCS#1 v1.5 padding.", - "The PKCS#1 digest info is built by the server-side and sent to the client unhashed. The client is responsible for signing and hashing. Uses the P-256 curve." - ], - "readOnly": true, - "type": "string" - }, - "startTime": { - "description": "Output only. Server-generated timestamp of when the certificate provisioning process has been created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "subjectPublicKeyInfo": { - "description": "Output only. The public key for which a certificate should be provisioned. Represented as a DER-encoded X.509 SubjectPublicKeyInfo.", - "format": "byte", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleChromeManagementVersionsV1alpha1ChromeOsDevice": { - "description": "Describes the ChromeOS device that a `CertificateProvisioningProcess` belongs to.", - "id": "GoogleChromeManagementVersionsV1alpha1ChromeOsDevice", - "properties": { - "deviceDirectoryApiId": { - "description": "Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab.", - "readOnly": true, - "type": "string" - }, - "serialNumber": { - "description": "Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession": { - "description": "Describes the ChromeOS user session that a `CertificateProvisioningProcess` belongs to.", - "id": "GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession", - "properties": { - "chromeOsDevice": { - "$ref": "GoogleChromeManagementVersionsV1alpha1ChromeOsDevice", - "description": "Output only. This field contains information about the ChromeOS device that the user session is running on. It is only set if the user session is affiliated, i.e. if the user is managed by the same organization that managed the ChromeOS device.", - "readOnly": true - }, - "userDirectoryApiId": { - "description": "Output only. The unique Directory API ID of the user.", - "readOnly": true, - "type": "string" - }, - "userPrimaryEmail": { - "description": "Output only. The primary e-mail address of the user.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleChromeManagementVersionsV1alpha1SignDataMetadata": { - "description": "Metadata for the long-running operation returned by signData.", - "id": "GoogleChromeManagementVersionsV1alpha1SignDataMetadata", - "properties": { - "startTime": { - "description": "Output only. Start time of the SignData operation.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleChromeManagementVersionsV1alpha1SignDataResponse": { - "description": "Response message for requesting a signature from the client that initated a certificate provisioning process.", - "id": "GoogleChromeManagementVersionsV1alpha1SignDataResponse", - "properties": { - "certificateProvisioningProcess": { - "$ref": "GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess", - "description": "Output only. The certificate provisioning process. The signature generated by the client will be available in the `signature` field of `CertificateProvisioningProcess`.", - "readOnly": true - } - }, - "type": "object" - }, "GoogleProtobufEmpty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "GoogleProtobufEmpty", diff --git a/src/apis/chromemanagement/v1.ts b/src/apis/chromemanagement/v1.ts index cad48169bf4..9cb023956e5 100644 --- a/src/apis/chromemanagement/v1.ts +++ b/src/apis/chromemanagement/v1.ts @@ -2222,111 +2222,6 @@ export namespace chromemanagement_v1 { */ justification?: string | null; } - /** - * A certificate provisioning process. - */ - export interface Schema$GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess { - /** - * Output only. A JSON string that contains the administrator-provided configuration for the certification authority service. This field can be missing if no configuration was given. - */ - caConnectionAdapterConfigReference?: string | null; - /** - * Output only. The client certificate is being provisioned for a ChromeOS device. This contains information about the device. - */ - chromeOsDevice?: Schema$GoogleChromeManagementVersionsV1alpha1ChromeOsDevice; - /** - * Output only. The client certificate is being provisioned for a ChromeOS user session. This contains information about the user session. - */ - chromeOsUserSession?: Schema$GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession; - /** - * Output only. A message describing why this `CertificateProvisioningProcess` failed. Presence of this field indicates that the `CertificateProvisioningProcess` has failed. - */ - failureMessage?: string | null; - /** - * Output only. The issued certificate for this `CertificateProvisioningProcess` in PEM format. - */ - issuedCertificate?: string | null; - /** - * Identifier. Resource name of the `CertificateProvisioningProcess`. The name pattern is given as `customers/{customer\}/certificateProvisioningProcesses/{certificate_provisioning_process\}` with `{customer\}` being the obfuscated customer id and `{certificate_provisioning_process\}` being the certificate provisioning process id. - */ - name?: string | null; - /** - * Output only. A JSON string that contains the administrator-provided configuration for the certificate provisioning profile. This field can be missing if no configuration was given. - */ - profileAdapterConfigReference?: string | null; - /** - * Output only. The ID of the certificate provisioning profile. - */ - provisioningProfileId?: string | null; - /** - * Output only. The signature of `signature_algorithm`, generated using the client's private key using `signature_algorithm`. This field is only present after the`SignData` operation has finished. - */ - signature?: string | null; - /** - * Output only. The signature algorithm that the adapter expects the client and backend components to use when processing `sign_data`. This field is only present after the `SignData` operation has been initiated. - */ - signatureAlgorithm?: string | null; - /** - * Output only. The data that the client was asked to sign. This field is only present after the `SignData` operation has been initiated. - */ - signData?: string | null; - /** - * Output only. Server-generated timestamp of when the certificate provisioning process has been created. - */ - startTime?: string | null; - /** - * Output only. The public key for which a certificate should be provisioned. Represented as a DER-encoded X.509 SubjectPublicKeyInfo. - */ - subjectPublicKeyInfo?: string | null; - } - /** - * Describes the ChromeOS device that a `CertificateProvisioningProcess` belongs to. - */ - export interface Schema$GoogleChromeManagementVersionsV1alpha1ChromeOsDevice { - /** - * Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab. - */ - deviceDirectoryApiId?: string | null; - /** - * Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab. - */ - serialNumber?: string | null; - } - /** - * Describes the ChromeOS user session that a `CertificateProvisioningProcess` belongs to. - */ - export interface Schema$GoogleChromeManagementVersionsV1alpha1ChromeOsUserSession { - /** - * Output only. This field contains information about the ChromeOS device that the user session is running on. It is only set if the user session is affiliated, i.e. if the user is managed by the same organization that managed the ChromeOS device. - */ - chromeOsDevice?: Schema$GoogleChromeManagementVersionsV1alpha1ChromeOsDevice; - /** - * Output only. The unique Directory API ID of the user. - */ - userDirectoryApiId?: string | null; - /** - * Output only. The primary e-mail address of the user. - */ - userPrimaryEmail?: string | null; - } - /** - * Metadata for the long-running operation returned by signData. - */ - export interface Schema$GoogleChromeManagementVersionsV1alpha1SignDataMetadata { - /** - * Output only. Start time of the SignData operation. - */ - startTime?: string | null; - } - /** - * Response message for requesting a signature from the client that initated a certificate provisioning process. - */ - export interface Schema$GoogleChromeManagementVersionsV1alpha1SignDataResponse { - /** - * Output only. The certificate provisioning process. The signature generated by the client will be available in the `signature` field of `CertificateProvisioningProcess`. - */ - certificateProvisioningProcess?: Schema$GoogleChromeManagementVersionsV1alpha1CertificateProvisioningProcess; - } /** * Information of public key associated with a Chrome browser profile. */ @@ -2352,22 +2247,26 @@ export namespace chromemanagement_v1 { * A certificate provisioning process. */ export interface Schema$GoogleChromeManagementVersionsV1CertificateProvisioningProcess { - /** - * Output only. A JSON string that contains the administrator-provided configuration for the certification authority service. This field can be missing if no configuration was given. - */ - caConnectionAdapterConfigReference?: string | null; /** * Output only. The client certificate is being provisioned for a ChromeOS device. This contains information about the device. */ chromeOsDevice?: Schema$GoogleChromeManagementVersionsV1ChromeOsDevice; /** - * Output only. The client certificate is being provisioned for a ChromeOS user session. This contains information about the user session. + * Output only. The client certificate is being provisioned for a ChromeOS user. This contains information about the current user session. */ chromeOsUserSession?: Schema$GoogleChromeManagementVersionsV1ChromeOsUserSession; /** - * Output only. A message describing why this `CertificateProvisioningProcess` failed. Presence of this field indicates that the `CertificateProvisioningProcess` has failed. + * Output only. A message describing why this `CertificateProvisioningProcess` has failed. Presence of this field indicates that the `CertificateProvisioningProcess` has failed. */ failureMessage?: string | null; + /** + * Output only. The CA connection is a generic CA connection. + */ + genericCaConnection?: Schema$GoogleChromeManagementVersionsV1GenericCaConnection; + /** + * Output only. The profile is a generic certificate provisioning profile. + */ + genericProfile?: Schema$GoogleChromeManagementVersionsV1GenericProfile; /** * Output only. The issued certificate for this `CertificateProvisioningProcess` in PEM format. */ @@ -2376,16 +2275,12 @@ export namespace chromemanagement_v1 { * Identifier. Resource name of the `CertificateProvisioningProcess`. The name pattern is given as `customers/{customer\}/certificateProvisioningProcesses/{certificate_provisioning_process\}` with `{customer\}` being the obfuscated customer id and `{certificate_provisioning_process\}` being the certificate provisioning process id. */ name?: string | null; - /** - * Output only. A JSON string that contains the administrator-provided configuration for the certificate provisioning profile. This field can be missing if no configuration was given. - */ - profileAdapterConfigReference?: string | null; /** * Output only. The ID of the certificate provisioning profile. */ provisioningProfileId?: string | null; /** - * Output only. The signature of `signature_algorithm`, generated using the client's private key using `signature_algorithm`. This field is only present after the`SignData` operation has finished. + * Output only. The signature of `signature_algorithm`, generated using the client's private key using `signature_algorithm`. This field is only present after the `SignData` operation has finished. */ signature?: string | null; /** @@ -2482,7 +2377,7 @@ export namespace chromemanagement_v1 { */ osPlatformType?: string | null; /** - * Output only. Major OS version of the device on which the profile exists. (i.e. Windows 10) + * Output only. Major OS platform version of the device on which the profile exists, from profile reporting. */ osPlatformVersion?: string | null; /** @@ -2532,7 +2427,7 @@ export namespace chromemanagement_v1 { */ export interface Schema$GoogleChromeManagementVersionsV1ChromeOsUserSession { /** - * Output only. This field contains information about the ChromeOS device that the user session is running on. It is only set if the user session is affiliated, i.e. if the user is managed by the same organization that managed the ChromeOS device. + * Output only. This field contains information about the ChromeOS device that the user session is running on. It is only set if the user is affiliated, i.e., if the user is managed by the same organization that manages the ChromeOS device. */ chromeOsDevice?: Schema$GoogleChromeManagementVersionsV1ChromeOsDevice; /** @@ -2565,6 +2460,24 @@ export namespace chromemanagement_v1 { */ machine?: string | null; } + /** + * Describes a generic Certificate Authority Connection. + */ + export interface Schema$GoogleChromeManagementVersionsV1GenericCaConnection { + /** + * Output only. A string that references the administrator-provided configuration for the certification authority service. This field can be missing if no configuration was given. + */ + caConnectionAdapterConfigReference?: string | null; + } + /** + * Describes a generic certificate provisioning profile. + */ + export interface Schema$GoogleChromeManagementVersionsV1GenericProfile { + /** + * Output only. A string that references the administrator-provided configuration for the certificate provisioning profile. This field can be missing if no configuration was given. + */ + profileAdapterConfigReference?: string | null; + } /** * Response to ListChromeBrowserProfiles method. */ @@ -3795,11 +3708,11 @@ export namespace chromemanagement_v1 { export interface Params$Resource$Customers$Profiles$List extends StandardParameters { /** - * Optional. The filter used to filter profiles. The following fields can be used in the filter: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - ouId Any of the above fields can be used to specify a filter, and filtering by multiple fields is supported with AND operator. String type fields and enum type fields support '=' and '!=' operators. The integer type and the timestamp type fields support '=', '!=', '<', '\>', '<=' and '\>=' operators. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). Wildcard '*' can be used with a string type field filter. In addition, string literal filtering is also supported, for example, 'ABC' as a filter maps to a filter that checks if any of the filterable string type fields contains 'ABC'. Organization unit number can be used as a filtering criteria here by specifying 'ouId = ${your_org_unit_id\}', please note that only single OU ID matching is supported. + * Optional. The filter used to filter profiles. The following fields can be used in the filter: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - os_platform_version - ouId Any of the above fields can be used to specify a filter, and filtering by multiple fields is supported with AND operator. String type fields and enum type fields support '=' and '!=' operators. The integer type and the timestamp type fields support '=', '!=', '<', '\>', '<=' and '\>=' operators. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). Wildcard '*' can be used with a string type field filter. In addition, string literal filtering is also supported, for example, 'ABC' as a filter maps to a filter that checks if any of the filterable string type fields contains 'ABC'. Organization unit number can be used as a filtering criteria here by specifying 'ouId = ${your_org_unit_id\}', please note that only single OU ID matching is supported. */ filter?: string; /** - * Optional. The fields used to specify the ordering of the results. The supported fields are: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state By default, sorting is in ascending order, to specify descending order for a field, a suffix " desc" should be added to the field name. The default ordering is the descending order of last_status_report_time. + * Optional. The fields used to specify the ordering of the results. The supported fields are: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - os_platform_version By default, sorting is in ascending order, to specify descending order for a field, a suffix " desc" should be added to the field name. The default ordering is the descending order of last_status_report_time. */ orderBy?: string; /** From 35622bec03f9a50fb30294348fb2cc29a9beb8f1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 024/144] fix(classroom): update the API #### classroom:v1 The following keys were changed: - resources.courses.resources.topics.methods.create.description --- discovery/classroom-v1.json | 4 ++-- src/apis/classroom/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 0ccd25e3414..aa2aa0dd7d4 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -3397,7 +3397,7 @@ "topics": { "methods": { "create": { - "description": "Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course does not exist.", + "description": "Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `FAILED_PRECONDITION` for the following request error: * CourseTopicLimitReached * `NOT_FOUND` if the requested course does not exist.", "flatPath": "v1/courses/{courseId}/topics", "httpMethod": "POST", "id": "classroom.courses.topics.create", @@ -4049,7 +4049,7 @@ } } }, - "revision": "20250114", + "revision": "20250303", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 2bdf2f98f71..6301b75d5f7 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -9916,7 +9916,7 @@ export namespace classroom_v1 { } /** - * Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course does not exist. + * Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `FAILED_PRECONDITION` for the following request error: * CourseTopicLimitReached * `NOT_FOUND` if the requested course does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From 946cd76adeb2096d1f4d2e1b931a29b9f11e6678 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 025/144] feat(cloudasset): update the API #### cloudasset:v1p1beta1 The following keys were added: - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.type The following keys were changed: - schemas.GoogleIdentityAccesscontextmanagerV1EgressSource.properties.resource.description - schemas.IamPolicySearchResult.properties.project.description #### cloudasset:v1p5beta1 The following keys were added: - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.type The following keys were changed: - schemas.GoogleIdentityAccesscontextmanagerV1EgressSource.properties.resource.description #### cloudasset:v1p7beta1 The following keys were added: - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.type The following keys were changed: - schemas.GoogleCloudAssetV1p7beta1PartitionSpec.properties.partitionKey.enumDescriptions - schemas.GoogleIdentityAccesscontextmanagerV1EgressSource.properties.resource.description #### cloudasset:v1beta1 The following keys were added: - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.type The following keys were changed: - schemas.GoogleIdentityAccesscontextmanagerV1EgressSource.properties.resource.description #### cloudasset:v1 The following keys were added: - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1EgressTo.properties.roles.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.description - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.items.type - schemas.GoogleIdentityAccesscontextmanagerV1IngressTo.properties.roles.type The following keys were changed: - resources.v1.methods.analyzeMove.parameters.destinationParent.description - schemas.GoogleCloudAssetV1BigQueryDestination.properties.partitionKey.enumDescriptions - schemas.GoogleIdentityAccesscontextmanagerV1EgressSource.properties.resource.description - schemas.IamPolicySearchResult.properties.project.description - schemas.PartitionSpec.properties.partitionKey.enumDescriptions --- discovery/cloudasset-v1.json | 28 +++++++++++++++++++++------- discovery/cloudasset-v1beta1.json | 18 ++++++++++++++++-- discovery/cloudasset-v1p1beta1.json | 20 +++++++++++++++++--- discovery/cloudasset-v1p5beta1.json | 18 ++++++++++++++++-- discovery/cloudasset-v1p7beta1.json | 22 ++++++++++++++++++---- src/apis/cloudasset/v1.ts | 14 +++++++++++--- src/apis/cloudasset/v1beta1.ts | 10 +++++++++- src/apis/cloudasset/v1p1beta1.ts | 12 ++++++++++-- src/apis/cloudasset/v1p5beta1.ts | 10 +++++++++- src/apis/cloudasset/v1p7beta1.ts | 10 +++++++++- 10 files changed, 136 insertions(+), 26 deletions(-) diff --git a/discovery/cloudasset-v1.json b/discovery/cloudasset-v1.json index 1450896fbd7..02b759a6a67 100644 --- a/discovery/cloudasset-v1.json +++ b/discovery/cloudasset-v1.json @@ -681,7 +681,7 @@ ], "parameters": { "destinationParent": { - "description": "Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a folder number (such as \"folders/123\") or an organization number (such as \"organizations/123\").", + "description": "Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified destination parent. This can only be a folder number (such as \"folders/123\") or an organization number (such as \"organizations/123\").", "location": "query", "type": "string" }, @@ -1095,7 +1095,7 @@ } } }, - "revision": "20250104", + "revision": "20250307", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1984,7 +1984,7 @@ ], "enumDescriptions": [ "Unspecified partition key. Tables won't be partitioned using this option.", - "The time when the request is received. If specified as partition key, the result table(s) is partitoned by the RequestTime column, an additional timestamp column representing when the request was received." + "The time when the request is received. If specified as partition key, the result table(s) is partitioned by the RequestTime column, an additional timestamp column representing when the request was received." ], "type": "string" }, @@ -2888,7 +2888,7 @@ "type": "string" }, "resource": { - "description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", + "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, @@ -2918,6 +2918,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3010,6 +3017,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3392,7 +3406,7 @@ "description": "The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g., an empty query), this contains all the bindings. To search against the `policy` bindings: * use a field query: - query by the policy contained members. Example: `policy:amy@gmail.com` - query by the policy contained roles. Example: `policy:roles/compute.admin` - query by the policy contained roles' included permissions. Example: `policy.role.permissions:compute.instances.create`" }, "project": { - "description": "The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request.", + "description": "The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or organization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request.", "type": "string" }, "resource": { @@ -3768,8 +3782,8 @@ ], "enumDescriptions": [ "Unspecified partition key. If used, it means using non-partitioned table.", - "The time when the snapshot is taken. If specified as partition key, the result table(s) is partitoned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.", - "The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitoned by the requestTime column, an additional timestamp column representing when the request was received." + "The time when the snapshot is taken. If specified as partition key, the result table(s) is partitioned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.", + "The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitioned by the requestTime column, an additional timestamp column representing when the request was received." ], "type": "string" } diff --git a/discovery/cloudasset-v1beta1.json b/discovery/cloudasset-v1beta1.json index cba4cb94cf3..c4b1c405661 100644 --- a/discovery/cloudasset-v1beta1.json +++ b/discovery/cloudasset-v1beta1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20250104", + "revision": "20250307", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -1198,7 +1198,7 @@ "type": "string" }, "resource": { - "description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", + "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, @@ -1228,6 +1228,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -1320,6 +1327,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/cloudasset-v1p1beta1.json b/discovery/cloudasset-v1p1beta1.json index 5b5f50fc532..e93e74cfff8 100644 --- a/discovery/cloudasset-v1p1beta1.json +++ b/discovery/cloudasset-v1p1beta1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20250104", + "revision": "20250307", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -900,7 +900,7 @@ "type": "string" }, "resource": { - "description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", + "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, @@ -930,6 +930,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -1022,6 +1029,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -1231,7 +1245,7 @@ "description": "The IAM policy attached to the specified resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constraint on policies (e.g. an empty query), this contains all the bindings." }, "project": { - "description": "The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty.", + "description": "The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or organization, the project field will be empty.", "type": "string" }, "resource": { diff --git a/discovery/cloudasset-v1p5beta1.json b/discovery/cloudasset-v1p5beta1.json index aad720eefdf..92f1f151852 100644 --- a/discovery/cloudasset-v1p5beta1.json +++ b/discovery/cloudasset-v1p5beta1.json @@ -177,7 +177,7 @@ } } }, - "revision": "20250104", + "revision": "20250307", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -905,7 +905,7 @@ "type": "string" }, "resource": { - "description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", + "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, @@ -935,6 +935,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -1027,6 +1034,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/cloudasset-v1p7beta1.json b/discovery/cloudasset-v1p7beta1.json index 5515f837f04..405806a43cc 100644 --- a/discovery/cloudasset-v1p7beta1.json +++ b/discovery/cloudasset-v1p7beta1.json @@ -167,7 +167,7 @@ } } }, - "revision": "20250104", + "revision": "20250307", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -460,8 +460,8 @@ ], "enumDescriptions": [ "Unspecified partition key. If used, it means using non-partitioned table.", - "The time when the snapshot is taken. If specified as partition key, the result table(s) is partitoned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.", - "The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitoned by the requestTime column, an additional timestamp column representing when the request was received." + "The time when the snapshot is taken. If specified as partition key, the result table(s) is partitioned by the additional timestamp column, readTime. If [read_time] in ExportAssetsRequest is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot.", + "The time when the request is received and started to be processed. If specified as partition key, the result table(s) is partitioned by the requestTime column, an additional timestamp column representing when the request was received." ], "type": "string" } @@ -974,7 +974,7 @@ "type": "string" }, "resource": { - "description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.", + "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" } }, @@ -1004,6 +1004,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -1096,6 +1103,13 @@ "type": "string" }, "type": "array" + }, + "roles": { + "description": "IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index 6b6cf635e8a..762c5da1b43 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -1423,7 +1423,7 @@ export namespace cloudasset_v1 { */ accessLevel?: string | null; /** - * A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number\}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + * A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number\}`. You can't use `*` in this field to allow all Google Cloud resources. */ resource?: string | null; } @@ -1443,6 +1443,10 @@ export namespace cloudasset_v1 { * A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. @@ -1503,6 +1507,10 @@ export namespace cloudasset_v1 { * A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * An allowed method or permission of a service specified in ApiOperation. @@ -1761,7 +1769,7 @@ export namespace cloudasset_v1 { */ policy?: Schema$Policy; /** - * The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER\}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request. + * The project that the associated Google Cloud resource belongs to, in the form of projects/{PROJECT_NUMBER\}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or organization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request. */ project?: string | null; /** @@ -5255,7 +5263,7 @@ export namespace cloudasset_v1 { } export interface Params$Resource$V1$Analyzemove extends StandardParameters { /** - * Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a folder number (such as "folders/123") or an organization number (such as "organizations/123"). + * Required. Name of the Google Cloud folder or organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified destination parent. This can only be a folder number (such as "folders/123") or an organization number (such as "organizations/123"). */ destinationParent?: string; /** diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index 85622ee3f6e..0a8a91f98cd 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -683,7 +683,7 @@ export namespace cloudasset_v1beta1 { */ accessLevel?: string | null; /** - * A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number\}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + * A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number\}`. You can't use `*` in this field to allow all Google Cloud resources. */ resource?: string | null; } @@ -703,6 +703,10 @@ export namespace cloudasset_v1beta1 { * A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. @@ -763,6 +767,10 @@ export namespace cloudasset_v1beta1 { * A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * An allowed method or permission of a service specified in ApiOperation. diff --git a/src/apis/cloudasset/v1p1beta1.ts b/src/apis/cloudasset/v1p1beta1.ts index 19cbf83faee..e5e730c1241 100644 --- a/src/apis/cloudasset/v1p1beta1.ts +++ b/src/apis/cloudasset/v1p1beta1.ts @@ -610,7 +610,7 @@ export namespace cloudasset_v1p1beta1 { */ accessLevel?: string | null; /** - * A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number\}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + * A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number\}`. You can't use `*` in this field to allow all Google Cloud resources. */ resource?: string | null; } @@ -630,6 +630,10 @@ export namespace cloudasset_v1p1beta1 { * A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. @@ -690,6 +694,10 @@ export namespace cloudasset_v1p1beta1 { * A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * An allowed method or permission of a service specified in ApiOperation. @@ -835,7 +843,7 @@ export namespace cloudasset_v1p1beta1 { */ policy?: Schema$Policy; /** - * The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number\}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty. + * The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number\}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or organization, the project field will be empty. */ project?: string | null; /** diff --git a/src/apis/cloudasset/v1p5beta1.ts b/src/apis/cloudasset/v1p5beta1.ts index 83f93975123..39fee3727d7 100644 --- a/src/apis/cloudasset/v1p5beta1.ts +++ b/src/apis/cloudasset/v1p5beta1.ts @@ -640,7 +640,7 @@ export namespace cloudasset_v1p5beta1 { */ accessLevel?: string | null; /** - * A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number\}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + * A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number\}`. You can't use `*` in this field to allow all Google Cloud resources. */ resource?: string | null; } @@ -660,6 +660,10 @@ export namespace cloudasset_v1p5beta1 { * A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. @@ -720,6 +724,10 @@ export namespace cloudasset_v1p5beta1 { * A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * An allowed method or permission of a service specified in ApiOperation. diff --git a/src/apis/cloudasset/v1p7beta1.ts b/src/apis/cloudasset/v1p7beta1.ts index 0c186b60920..120243557bb 100644 --- a/src/apis/cloudasset/v1p7beta1.ts +++ b/src/apis/cloudasset/v1p7beta1.ts @@ -686,7 +686,7 @@ export namespace cloudasset_v1p7beta1 { */ accessLevel?: string | null; /** - * A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number\}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources. + * A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number\}`. You can't use `*` in this field to allow all Google Cloud resources. */ resource?: string | null; } @@ -706,6 +706,10 @@ export namespace cloudasset_v1p7beta1 { * A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding EgressFrom. are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. @@ -766,6 +770,10 @@ export namespace cloudasset_v1p7beta1 { * A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed. */ resources?: string[] | null; + /** + * IAM roles that represent the set of operations that the sources specified in the corresponding IngressFrom are allowed to perform in this ServicePerimeter. + */ + roles?: string[] | null; } /** * An allowed method or permission of a service specified in ApiOperation. From 4bdcaa43fdaef040ffc1891e144d2abdafbce0d6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 026/144] feat(cloudbuild): update the API #### cloudbuild:v1 The following keys were added: - schemas.Build.properties.dependencies.description - schemas.Build.properties.dependencies.items.$ref - schemas.Build.properties.dependencies.type - schemas.BuildOptions.properties.pubsubTopic.description - schemas.BuildOptions.properties.pubsubTopic.type - schemas.Dependency.description - schemas.Dependency.id - schemas.Dependency.properties.empty.description - schemas.Dependency.properties.empty.type - schemas.Dependency.properties.gitSource.$ref - schemas.Dependency.properties.gitSource.description - schemas.Dependency.type - schemas.GitSourceDependency.description - schemas.GitSourceDependency.id - schemas.GitSourceDependency.properties.depth.description - schemas.GitSourceDependency.properties.depth.format - schemas.GitSourceDependency.properties.depth.type - schemas.GitSourceDependency.properties.destPath.description - schemas.GitSourceDependency.properties.destPath.type - schemas.GitSourceDependency.properties.recurseSubmodules.description - schemas.GitSourceDependency.properties.recurseSubmodules.type - schemas.GitSourceDependency.properties.repository.$ref - schemas.GitSourceDependency.properties.repository.description - schemas.GitSourceDependency.properties.revision.description - schemas.GitSourceDependency.properties.revision.type - schemas.GitSourceDependency.type - schemas.GitSourceRepository.description - schemas.GitSourceRepository.id - schemas.GitSourceRepository.properties.developerConnect.description - schemas.GitSourceRepository.properties.developerConnect.type - schemas.GitSourceRepository.properties.url.description - schemas.GitSourceRepository.properties.url.type - schemas.GitSourceRepository.type The following keys were changed: - endpoints #### cloudbuild:v2 The following keys were added: - resources.projects.resources.locations.resources.connections.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.connections.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.connections.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.connections.resources.repositories.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.connections.resources.repositories.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.connections.resources.repositories.methods.list.parameters.returnPartialSuccess.type - schemas.ListConnectionsResponse.properties.unreachable.description - schemas.ListConnectionsResponse.properties.unreachable.items.type - schemas.ListConnectionsResponse.properties.unreachable.type - schemas.ListRepositoriesResponse.properties.unreachable.description - schemas.ListRepositoriesResponse.properties.unreachable.items.type - schemas.ListRepositoriesResponse.properties.unreachable.type The following keys were changed: - endpoints - resources.projects.resources.locations.resources.connections.methods.processWebhook.parameters.webhookKey.description --- discovery/cloudbuild-v1.json | 76 +++++++++++++++++++++++++++++++++++- discovery/cloudbuild-v2.json | 33 +++++++++++++++- src/apis/cloudbuild/v1.ts | 59 ++++++++++++++++++++++++++++ src/apis/cloudbuild/v2.ts | 18 ++++++++- 4 files changed, 182 insertions(+), 4 deletions(-) diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index bcfa8cb6100..caef4bf2d22 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -161,6 +161,11 @@ "endpointUrl": "https://cloudbuild.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudbuild.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://cloudbuild.southamerica-east1.rep.googleapis.com/", @@ -2563,7 +2568,7 @@ } } }, - "revision": "20250114", + "revision": "20250303", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3017,6 +3022,13 @@ "readOnly": true, "type": "string" }, + "dependencies": { + "description": "Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.", + "items": { + "$ref": "Dependency" + }, + "type": "array" + }, "failureInfo": { "$ref": "FailureInfo", "description": "Output only. Contains information about the build when status=FAILURE.", @@ -3345,6 +3357,10 @@ "$ref": "PoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, + "pubsubTopic": { + "description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", + "type": "string" + }, "requestedVerifyOption": { "description": "Requested verifiability options.", "enum": [ @@ -3970,6 +3986,21 @@ }, "type": "object" }, + "Dependency": { + "description": "A dependency that the Cloud Build worker will fetch before executing user steps.", + "id": "Dependency", + "properties": { + "empty": { + "description": "If set to true disable all dependency fetching (ignoring the default source as well).", + "type": "boolean" + }, + "gitSource": { + "$ref": "GitSourceDependency", + "description": "Represents a git repository as a build dependency." + } + }, + "type": "object" + }, "DeveloperConnectConfig": { "description": "This config defines the location of a source through Developer Connect.", "id": "DeveloperConnectConfig", @@ -4467,6 +4498,49 @@ }, "type": "object" }, + "GitSourceDependency": { + "description": "Represents a git repository as a build dependency.", + "id": "GitSourceDependency", + "properties": { + "depth": { + "description": "Optional. How much history should be fetched for the build (default 1, -1 for all history).", + "format": "int64", + "type": "string" + }, + "destPath": { + "description": "Required. Where should the files be placed on the worker.", + "type": "string" + }, + "recurseSubmodules": { + "description": "Optional. True if submodules should be fetched too (default false).", + "type": "boolean" + }, + "repository": { + "$ref": "GitSourceRepository", + "description": "Required. The kind of repo (url or dev connect)." + }, + "revision": { + "description": "Required. The revision that we will fetch the repo at.", + "type": "string" + } + }, + "type": "object" + }, + "GitSourceRepository": { + "description": "A repository for a git source.", + "id": "GitSourceRepository", + "properties": { + "developerConnect": { + "description": "The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", + "type": "string" + }, + "url": { + "description": "Location of the Git repository.", + "type": "string" + } + }, + "type": "object" + }, "GoModule": { "description": "Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.", "id": "GoModule", diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index ea6580e2afe..393df92e629 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -161,6 +161,11 @@ "endpointUrl": "https://cloudbuild.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudbuild.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://cloudbuild.southamerica-east1.rep.googleapis.com/", @@ -582,6 +587,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. If set to false, the response will fail if any region is unreachable.", + "location": "query", + "type": "boolean" } }, "path": "v2/{+parent}/connections", @@ -653,7 +663,7 @@ "type": "string" }, "webhookKey": { - "description": "Arbitrary additional key to find the maching repository for a webhook event if needed.", + "description": "Arbitrary additional key to find the matching repository for a webhook event if needed.", "location": "query", "type": "string" } @@ -985,6 +995,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If set to true, the response will return partial results when some regions are unreachable. If set to false, the response will fail if any region is unreachable.", + "location": "query", + "type": "boolean" } }, "path": "v2/{+parent}/repositories", @@ -1061,7 +1076,7 @@ } } }, - "revision": "20250114", + "revision": "20250303", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -1818,6 +1833,13 @@ "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" @@ -1854,6 +1876,13 @@ "$ref": "Repository" }, "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index c0c5b900691..3819a762bd8 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -482,6 +482,10 @@ export namespace cloudbuild_v1 { * Output only. Time at which the request to create the build was received. */ createTime?: string | null; + /** + * Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. + */ + dependencies?: Schema$Dependency[]; /** * Output only. Contains information about the build when status=FAILURE. */ @@ -653,6 +657,10 @@ export namespace cloudbuild_v1 { * Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. */ pool?: Schema$PoolOption; + /** + * Optional. Option to specify the Pub/Sub topic to receive build status updates. + */ + pubsubTopic?: string | null; /** * Requested verifiability options. */ @@ -1098,6 +1106,19 @@ export namespace cloudbuild_v1 { */ workerPool?: string | null; } + /** + * A dependency that the Cloud Build worker will fetch before executing user steps. + */ + export interface Schema$Dependency { + /** + * If set to true disable all dependency fetching (ignoring the default source as well). + */ + empty?: boolean | null; + /** + * Represents a git repository as a build dependency. + */ + gitSource?: Schema$GitSourceDependency; + } /** * This config defines the location of a source through Developer Connect. */ @@ -1487,6 +1508,44 @@ export namespace cloudbuild_v1 { */ url?: string | null; } + /** + * Represents a git repository as a build dependency. + */ + export interface Schema$GitSourceDependency { + /** + * Optional. How much history should be fetched for the build (default 1, -1 for all history). + */ + depth?: string | null; + /** + * Required. Where should the files be placed on the worker. + */ + destPath?: string | null; + /** + * Optional. True if submodules should be fetched too (default false). + */ + recurseSubmodules?: boolean | null; + /** + * Required. The kind of repo (url or dev connect). + */ + repository?: Schema$GitSourceRepository; + /** + * Required. The revision that we will fetch the repo at. + */ + revision?: string | null; + } + /** + * A repository for a git source. + */ + export interface Schema$GitSourceRepository { + /** + * The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/x/locations/x/connections/x/gitRepositoryLink/x` + */ + developerConnect?: string | null; + /** + * Location of the Git repository. + */ + url?: string | null; + } /** * Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. */ diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index f66ebdd2ec5..ceb5829820f 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -683,6 +683,10 @@ export namespace cloudbuild_v2 { * 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. @@ -709,6 +713,10 @@ export namespace cloudbuild_v2 { * The list of Repositories. */ repositories?: Schema$Repository[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; } /** * A resource that represents a Google Cloud location. @@ -2969,6 +2977,10 @@ export namespace cloudbuild_v2 { * Required. The parent, which owns this collection of Connections. Format: `projects/x/locations/x`. */ parent?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable. If set to false, the response will fail if any region is unreachable. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Connections$Patch extends StandardParameters { @@ -3001,7 +3013,7 @@ export namespace cloudbuild_v2 { */ parent?: string; /** - * Arbitrary additional key to find the maching repository for a webhook event if needed. + * Arbitrary additional key to find the matching repository for a webhook event if needed. */ webhookKey?: string; @@ -3885,6 +3897,10 @@ export namespace cloudbuild_v2 { * Required. The parent, which owns this collection of Repositories. Format: `projects/x/locations/x/connections/x`. */ parent?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable. If set to false, the response will fail if any region is unreachable. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Operations { From d52586fb80777785c86d7fa437f7a8a0064fb8a0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 027/144] feat(clouddeploy): update the API #### clouddeploy:v1 The following keys were added: - schemas.JobRun.properties.name.readOnly The following keys were changed: - schemas.DeployJobRun.properties.failureCause.enumDescriptions - schemas.JobRun.properties.name.description - schemas.ListRolloutsResponse.description - schemas.PostdeployJobRun.properties.failureCause.enumDescriptions - schemas.PredeployJobRun.properties.failureCause.enumDescriptions - schemas.Rollout.properties.deployFailureCause.enumDescriptions - schemas.RouteDestinations.properties.propagateService.description - schemas.TargetArtifact.properties.manifestPath.description - schemas.TargetArtifact.properties.skaffoldConfigPath.description - schemas.TargetRender.properties.failureCause.enumDescriptions - schemas.VerifyJobRun.properties.failureCause.enumDescriptions --- discovery/clouddeploy-v1.json | 25 +++++++++++++------------ src/apis/clouddeploy/v1.ts | 10 +++++----- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index a87acb33f3d..44b1e0de994 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -2348,7 +2348,7 @@ } } }, - "revision": "20250101", + "revision": "20250226", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -3655,7 +3655,7 @@ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [Required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The deploy operation did not complete successfully; check Cloud Build logs.", - "The deploy job run did not complete within the alloted time.", + "The deploy job run did not complete within the allotted time.", "There were missing resources in the runtime environment required for a canary deployment. Check the Cloud Build logs for more information.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.", "The deploy operation had a feature configured that is not supported." @@ -4275,7 +4275,8 @@ "type": "string" }, "name": { - "description": "Identifier. Name of the `JobRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}`.", + "description": "Output only. Name of the `JobRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}`.", + "readOnly": true, "type": "string" }, "phaseId": { @@ -4636,7 +4637,7 @@ "type": "object" }, "ListRolloutsResponse": { - "description": "ListRolloutsResponse is the response object reutrned by `ListRollouts`.", + "description": "ListRolloutsResponse is the response object returned by `ListRollouts`.", "id": "ListRolloutsResponse", "properties": { "nextPageToken": { @@ -5125,7 +5126,7 @@ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The postdeploy operation did not complete successfully; check Cloud Build logs.", - "The postdeploy job run did not complete within the alloted time.", + "The postdeploy job run did not complete within the allotted time.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], "readOnly": true, @@ -5190,7 +5191,7 @@ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The predeploy operation did not complete successfully; check Cloud Build logs.", - "The predeploy job run did not complete within the alloted time.", + "The predeploy job run did not complete within the allotted time.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], "readOnly": true, @@ -6052,7 +6053,7 @@ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The deploy operation did not complete successfully; check Cloud Build logs.", - "Deployment did not complete within the alloted time.", + "Deployment did not complete within the allotted time.", "Release is in a failed state.", "Release is abandoned.", "No Skaffold verify configuration was found.", @@ -6421,7 +6422,7 @@ "type": "array" }, "propagateService": { - "description": "Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.", + "description": "Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.", "type": "boolean" } }, @@ -6836,7 +6837,7 @@ "type": "string" }, "manifestPath": { - "description": "Output only. File path of the rendered manifest relative to the URI.", + "description": "Output only. File path of the rendered manifest relative to the URI for the stable phase.", "readOnly": true, "type": "string" }, @@ -6849,7 +6850,7 @@ "type": "object" }, "skaffoldConfigPath": { - "description": "Output only. File path of the resolved Skaffold configuration relative to the URI.", + "description": "Output only. File path of the resolved Skaffold configuration for the stable phase, relative to the URI.", "readOnly": true, "type": "string" } @@ -6948,7 +6949,7 @@ "The render operation did not complete successfully; check Cloud Build logs.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.", "The render operation did not complete successfully because the verification stanza required for verify was not found on the Skaffold configuration.", - "The render operation did not complete successfully because the custom action required for predeploy or postdeploy was not found in the Skaffold configuration. See failure_message for additional details.", + "The render operation did not complete successfully because the custom action(s) required for Rollout jobs were not found in the Skaffold configuration. See failure_message for additional details.", "Release failed during rendering because the release configuration is not supported with the specified deployment strategy.", "The render operation had a feature configured that is not supported." ], @@ -7257,7 +7258,7 @@ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The verify operation did not complete successfully; check Cloud Build logs.", - "The verify job run did not complete within the alloted time.", + "The verify job run did not complete within the allotted time.", "No Skaffold verify configuration was found.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], diff --git a/src/apis/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index 618374dab93..9488d491d7a 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -1397,7 +1397,7 @@ export namespace clouddeploy_v1 { */ jobId?: string | null; /** - * Identifier. Name of the `JobRun`. Format is `projects/{project\}/locations/{location\}/deliveryPipelines/{deliveryPipeline\}/releases/{releases\}/rollouts/{rollouts\}/jobRuns/{uuid\}`. + * Output only. Name of the `JobRun`. Format is `projects/{project\}/locations/{location\}/deliveryPipelines/{deliveryPipeline\}/releases/{releases\}/rollouts/{rollouts\}/jobRuns/{uuid\}`. */ name?: string | null; /** @@ -1629,7 +1629,7 @@ export namespace clouddeploy_v1 { unreachable?: string[] | null; } /** - * ListRolloutsResponse is the response object reutrned by `ListRollouts`. + * ListRolloutsResponse is the response object returned by `ListRollouts`. */ export interface Schema$ListRolloutsResponse { /** @@ -2706,7 +2706,7 @@ export namespace clouddeploy_v1 { */ destinationIds?: string[] | null; /** - * Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitiate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. + * Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. */ propagateService?: boolean | null; } @@ -3030,7 +3030,7 @@ export namespace clouddeploy_v1 { */ artifactUri?: string | null; /** - * Output only. File path of the rendered manifest relative to the URI. + * Output only. File path of the rendered manifest relative to the URI for the stable phase. */ manifestPath?: string | null; /** @@ -3038,7 +3038,7 @@ export namespace clouddeploy_v1 { */ phaseArtifacts?: {[key: string]: Schema$PhaseArtifact} | null; /** - * Output only. File path of the resolved Skaffold configuration relative to the URI. + * Output only. File path of the resolved Skaffold configuration for the stable phase, relative to the URI. */ skaffoldConfigPath?: string | null; } From 083f7c2b35c416988ca9a5956fe3c4fd1b9e63c9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 028/144] feat(cloudfunctions): update the API #### cloudfunctions:v2alpha The following keys were added: - schemas.Function.properties.satisfiesPzi.description - schemas.Function.properties.satisfiesPzi.readOnly - schemas.Function.properties.satisfiesPzi.type - schemas.GoogleCloudFunctionsV2alphaOperationMetadata.properties.customIamRoleDetected.description - schemas.GoogleCloudFunctionsV2alphaOperationMetadata.properties.customIamRoleDetected.readOnly - schemas.GoogleCloudFunctionsV2alphaOperationMetadata.properties.customIamRoleDetected.type The following keys were changed: - resources.projects.resources.locations.resources.functions.methods.list.parameters.orderBy.description - schemas.Function.properties.state.enum - schemas.Function.properties.state.enumDescriptions - schemas.GoogleCloudFunctionsV2alphaStage.properties.name.enumDescriptions - schemas.UpgradeInfo.description - schemas.UpgradeInfo.properties.upgradeState.enum - schemas.UpgradeInfo.properties.upgradeState.enumDescriptions #### cloudfunctions:v2beta The following keys were added: - schemas.Function.properties.satisfiesPzi.description - schemas.Function.properties.satisfiesPzi.readOnly - schemas.Function.properties.satisfiesPzi.type - schemas.GoogleCloudFunctionsV2betaOperationMetadata.properties.customIamRoleDetected.description - schemas.GoogleCloudFunctionsV2betaOperationMetadata.properties.customIamRoleDetected.readOnly - schemas.GoogleCloudFunctionsV2betaOperationMetadata.properties.customIamRoleDetected.type The following keys were changed: - resources.projects.resources.locations.resources.functions.methods.list.parameters.orderBy.description - schemas.Function.properties.state.enum - schemas.Function.properties.state.enumDescriptions - schemas.GoogleCloudFunctionsV2betaStage.properties.name.enumDescriptions - schemas.UpgradeInfo.description - schemas.UpgradeInfo.properties.upgradeState.enum - schemas.UpgradeInfo.properties.upgradeState.enumDescriptions #### cloudfunctions:v1 The following keys were changed: - schemas.SecretEnvVar.properties.projectId.description #### cloudfunctions:v2 The following keys were added: - schemas.Function.properties.satisfiesPzi.description - schemas.Function.properties.satisfiesPzi.readOnly - schemas.Function.properties.satisfiesPzi.type - schemas.GoogleCloudFunctionsV2OperationMetadata.properties.customIamRoleDetected.description - schemas.GoogleCloudFunctionsV2OperationMetadata.properties.customIamRoleDetected.readOnly - schemas.GoogleCloudFunctionsV2OperationMetadata.properties.customIamRoleDetected.type The following keys were changed: - resources.projects.resources.locations.resources.functions.methods.list.parameters.orderBy.description - schemas.Function.properties.state.enum - schemas.Function.properties.state.enumDescriptions - schemas.GoogleCloudFunctionsV2Stage.properties.name.enumDescriptions - schemas.UpgradeInfo.description - schemas.UpgradeInfo.properties.upgradeState.enum - schemas.UpgradeInfo.properties.upgradeState.enumDescriptions --- discovery/cloudfunctions-v1.json | 4 ++-- discovery/cloudfunctions-v2.json | 32 ++++++++++++++++++--------- discovery/cloudfunctions-v2alpha.json | 32 ++++++++++++++++++--------- discovery/cloudfunctions-v2beta.json | 32 ++++++++++++++++++--------- src/apis/cloudfunctions/v1.ts | 2 +- src/apis/cloudfunctions/v2.ts | 12 ++++++++-- src/apis/cloudfunctions/v2alpha.ts | 12 ++++++++-- src/apis/cloudfunctions/v2beta.ts | 12 ++++++++-- 8 files changed, 99 insertions(+), 39 deletions(-) diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index 9ddd3db3ec7..3561ae2b485 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -552,7 +552,7 @@ } } }, - "revision": "20250102", + "revision": "20250124", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -1259,7 +1259,7 @@ "type": "string" }, "projectId": { - "description": "Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.", + "description": "Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.", "type": "string" }, "secret": { diff --git a/discovery/cloudfunctions-v2.json b/discovery/cloudfunctions-v2.json index 7b442bba4dd..adc24dd5a0e 100644 --- a/discovery/cloudfunctions-v2.json +++ b/discovery/cloudfunctions-v2.json @@ -428,7 +428,7 @@ "type": "string" }, "orderBy": { - "description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.", + "description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering.", "location": "query", "type": "string" }, @@ -744,7 +744,7 @@ } } }, - "revision": "20250116", + "revision": "20250228", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1086,6 +1086,11 @@ "description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -1103,7 +1108,9 @@ "FAILED", "DEPLOYING", "DELETING", - "UNKNOWN" + "UNKNOWN", + "DETACHING", + "DETACH_FAILED" ], "enumDescriptions": [ "Not specified. Invalid state.", @@ -1111,7 +1118,9 @@ "Function deployment failed and the function is not serving.", "Function is being created or updated.", "Function is being deleted.", - "Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state." + "Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.", + "Function is being detached.", + "Function detach failed and the function is still serving." ], "readOnly": true, "type": "string" @@ -1245,6 +1254,11 @@ "format": "google-datetime", "type": "string" }, + "customIamRoleDetected": { + "description": "Output only. Whether a custom IAM role binding was detected during the upgrade.", + "readOnly": true, + "type": "boolean" + }, "endTime": { "description": "The time the operation finished running.", "format": "google-datetime", @@ -1333,7 +1347,7 @@ ], "enumDescriptions": [ "Not specified. Invalid name.", - "Artifact Regsitry Stage", + "Artifact Registry Stage", "Build Stage", "Service Stage", "Trigger Stage", @@ -2095,7 +2109,7 @@ "type": "object" }, "UpgradeInfo": { - "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration and 2nd Gen to CRf detach. * Current state of migration for function undergoing migration/detach.", + "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration. * Current state of migration for function undergoing migration.", "id": "UpgradeInfo", "properties": { "buildConfig": { @@ -2122,8 +2136,7 @@ "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_SUCCESSFUL", "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_ERROR", "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC_ERROR", - "COMMIT_FUNCTION_UPGRADE_ERROR", - "DETACH_IN_PROGRESS" + "COMMIT_FUNCTION_UPGRADE_ERROR" ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", @@ -2135,8 +2148,7 @@ "RedirectFunctionUpgradeTraffic API was successful and traffic is served by 2nd Gen function stack.", "RedirectFunctionUpgradeTraffic API was un-successful.", "RollbackFunctionUpgradeTraffic API was un-successful.", - "CommitFunctionUpgrade API was un-successful.", - "Function is requested to be detached from 2nd Gen to CRf." + "CommitFunctionUpgrade API was un-successful." ], "type": "string" } diff --git a/discovery/cloudfunctions-v2alpha.json b/discovery/cloudfunctions-v2alpha.json index 835e1bfd721..340352a54d4 100644 --- a/discovery/cloudfunctions-v2alpha.json +++ b/discovery/cloudfunctions-v2alpha.json @@ -428,7 +428,7 @@ "type": "string" }, "orderBy": { - "description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.", + "description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering.", "location": "query", "type": "string" }, @@ -744,7 +744,7 @@ } } }, - "revision": "20250116", + "revision": "20250228", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1086,6 +1086,11 @@ "description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -1103,7 +1108,9 @@ "FAILED", "DEPLOYING", "DELETING", - "UNKNOWN" + "UNKNOWN", + "DETACHING", + "DETACH_FAILED" ], "enumDescriptions": [ "Not specified. Invalid state.", @@ -1111,7 +1118,9 @@ "Function deployment failed and the function is not serving.", "Function is being created or updated.", "Function is being deleted.", - "Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state." + "Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.", + "Function is being detached.", + "Function detach failed and the function is still serving." ], "readOnly": true, "type": "string" @@ -1245,6 +1254,11 @@ "format": "google-datetime", "type": "string" }, + "customIamRoleDetected": { + "description": "Output only. Whether a custom IAM role binding was detected during the upgrade.", + "readOnly": true, + "type": "boolean" + }, "endTime": { "description": "The time the operation finished running.", "format": "google-datetime", @@ -1333,7 +1347,7 @@ ], "enumDescriptions": [ "Not specified. Invalid name.", - "Artifact Regsitry Stage", + "Artifact Registry Stage", "Build Stage", "Service Stage", "Trigger Stage", @@ -2095,7 +2109,7 @@ "type": "object" }, "UpgradeInfo": { - "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration and 2nd Gen to CRf detach. * Current state of migration for function undergoing migration/detach.", + "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration. * Current state of migration for function undergoing migration.", "id": "UpgradeInfo", "properties": { "buildConfig": { @@ -2122,8 +2136,7 @@ "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_SUCCESSFUL", "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_ERROR", "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC_ERROR", - "COMMIT_FUNCTION_UPGRADE_ERROR", - "DETACH_IN_PROGRESS" + "COMMIT_FUNCTION_UPGRADE_ERROR" ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", @@ -2135,8 +2148,7 @@ "RedirectFunctionUpgradeTraffic API was successful and traffic is served by 2nd Gen function stack.", "RedirectFunctionUpgradeTraffic API was un-successful.", "RollbackFunctionUpgradeTraffic API was un-successful.", - "CommitFunctionUpgrade API was un-successful.", - "Function is requested to be detached from 2nd Gen to CRf." + "CommitFunctionUpgrade API was un-successful." ], "type": "string" } diff --git a/discovery/cloudfunctions-v2beta.json b/discovery/cloudfunctions-v2beta.json index add7be2e0fe..0dc67424869 100644 --- a/discovery/cloudfunctions-v2beta.json +++ b/discovery/cloudfunctions-v2beta.json @@ -428,7 +428,7 @@ "type": "string" }, "orderBy": { - "description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.", + "description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering.", "location": "query", "type": "string" }, @@ -744,7 +744,7 @@ } } }, - "revision": "20250116", + "revision": "20250228", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1086,6 +1086,11 @@ "description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -1103,7 +1108,9 @@ "FAILED", "DEPLOYING", "DELETING", - "UNKNOWN" + "UNKNOWN", + "DETACHING", + "DETACH_FAILED" ], "enumDescriptions": [ "Not specified. Invalid state.", @@ -1111,7 +1118,9 @@ "Function deployment failed and the function is not serving.", "Function is being created or updated.", "Function is being deleted.", - "Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state." + "Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.", + "Function is being detached.", + "Function detach failed and the function is still serving." ], "readOnly": true, "type": "string" @@ -1245,6 +1254,11 @@ "format": "google-datetime", "type": "string" }, + "customIamRoleDetected": { + "description": "Output only. Whether a custom IAM role binding was detected during the upgrade.", + "readOnly": true, + "type": "boolean" + }, "endTime": { "description": "The time the operation finished running.", "format": "google-datetime", @@ -1333,7 +1347,7 @@ ], "enumDescriptions": [ "Not specified. Invalid name.", - "Artifact Regsitry Stage", + "Artifact Registry Stage", "Build Stage", "Service Stage", "Trigger Stage", @@ -2095,7 +2109,7 @@ "type": "object" }, "UpgradeInfo": { - "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration and 2nd Gen to CRf detach. * Current state of migration for function undergoing migration/detach.", + "description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration. * Current state of migration for function undergoing migration.", "id": "UpgradeInfo", "properties": { "buildConfig": { @@ -2122,8 +2136,7 @@ "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_SUCCESSFUL", "REDIRECT_FUNCTION_UPGRADE_TRAFFIC_ERROR", "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC_ERROR", - "COMMIT_FUNCTION_UPGRADE_ERROR", - "DETACH_IN_PROGRESS" + "COMMIT_FUNCTION_UPGRADE_ERROR" ], "enumDescriptions": [ "Unspecified state. Most functions are in this upgrade state.", @@ -2135,8 +2148,7 @@ "RedirectFunctionUpgradeTraffic API was successful and traffic is served by 2nd Gen function stack.", "RedirectFunctionUpgradeTraffic API was un-successful.", "RollbackFunctionUpgradeTraffic API was un-successful.", - "CommitFunctionUpgrade API was un-successful.", - "Function is requested to be detached from 2nd Gen to CRf." + "CommitFunctionUpgrade API was un-successful." ], "type": "string" } diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 4acf0a7d4ba..8e1ea8627d9 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -615,7 +615,7 @@ export namespace cloudfunctions_v1 { */ key?: string | null; /** - * Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function. + * Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function. */ projectId?: string | null; /** diff --git a/src/apis/cloudfunctions/v2.ts b/src/apis/cloudfunctions/v2.ts index 6b11bcb1754..1588e9a65b7 100644 --- a/src/apis/cloudfunctions/v2.ts +++ b/src/apis/cloudfunctions/v2.ts @@ -366,6 +366,10 @@ export namespace cloudfunctions_v2 { * A user-defined name of the function. Function names must be unique globally and match pattern `projects/x/locations/x/functions/x` */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * Output only. Reserved for future use. */ @@ -463,6 +467,10 @@ export namespace cloudfunctions_v2 { * The time the operation was created. */ createTime?: string | null; + /** + * Output only. Whether a custom IAM role binding was detected during the upgrade. + */ + customIamRoleDetected?: boolean | null; /** * The time the operation finished running. */ @@ -1025,7 +1033,7 @@ export namespace cloudfunctions_v2 { permissions?: string[] | null; } /** - * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration and 2nd Gen to CRf detach. * Current state of migration for function undergoing migration/detach. + * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration. * Current state of migration for function undergoing migration. */ export interface Schema$UpgradeInfo { /** @@ -2762,7 +2770,7 @@ export namespace cloudfunctions_v2 { */ filter?: string; /** - * The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering. + * The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering. */ orderBy?: string; /** diff --git a/src/apis/cloudfunctions/v2alpha.ts b/src/apis/cloudfunctions/v2alpha.ts index a05a193f222..47aeee8ebe0 100644 --- a/src/apis/cloudfunctions/v2alpha.ts +++ b/src/apis/cloudfunctions/v2alpha.ts @@ -366,6 +366,10 @@ export namespace cloudfunctions_v2alpha { * A user-defined name of the function. Function names must be unique globally and match pattern `projects/x/locations/x/functions/x` */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * Output only. Reserved for future use. */ @@ -463,6 +467,10 @@ export namespace cloudfunctions_v2alpha { * The time the operation was created. */ createTime?: string | null; + /** + * Output only. Whether a custom IAM role binding was detected during the upgrade. + */ + customIamRoleDetected?: boolean | null; /** * The time the operation finished running. */ @@ -1025,7 +1033,7 @@ export namespace cloudfunctions_v2alpha { permissions?: string[] | null; } /** - * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration and 2nd Gen to CRf detach. * Current state of migration for function undergoing migration/detach. + * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration. * Current state of migration for function undergoing migration. */ export interface Schema$UpgradeInfo { /** @@ -2761,7 +2769,7 @@ export namespace cloudfunctions_v2alpha { */ filter?: string; /** - * The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering. + * The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering. */ orderBy?: string; /** diff --git a/src/apis/cloudfunctions/v2beta.ts b/src/apis/cloudfunctions/v2beta.ts index 06610714a02..6ad01a5e6b5 100644 --- a/src/apis/cloudfunctions/v2beta.ts +++ b/src/apis/cloudfunctions/v2beta.ts @@ -366,6 +366,10 @@ export namespace cloudfunctions_v2beta { * A user-defined name of the function. Function names must be unique globally and match pattern `projects/x/locations/x/functions/x` */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * Output only. Reserved for future use. */ @@ -463,6 +467,10 @@ export namespace cloudfunctions_v2beta { * The time the operation was created. */ createTime?: string | null; + /** + * Output only. Whether a custom IAM role binding was detected during the upgrade. + */ + customIamRoleDetected?: boolean | null; /** * The time the operation finished running. */ @@ -1025,7 +1033,7 @@ export namespace cloudfunctions_v2beta { permissions?: string[] | null; } /** - * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration and 2nd Gen to CRf detach. * Current state of migration for function undergoing migration/detach. + * Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration. * Current state of migration for function undergoing migration. */ export interface Schema$UpgradeInfo { /** @@ -2761,7 +2769,7 @@ export namespace cloudfunctions_v2beta { */ filter?: string; /** - * The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering. + * The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering. */ orderBy?: string; /** From 3a6e5fc4e3d2317d9afb2302a8ee354a6f991f14 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 029/144] feat(cloudkms): update the API #### cloudkms:v1 The following keys were added: - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.getPublicKey.parameters.publicKeyFormat.description - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.getPublicKey.parameters.publicKeyFormat.enum - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.getPublicKey.parameters.publicKeyFormat.enumDescriptions - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.getPublicKey.parameters.publicKeyFormat.location - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.getPublicKey.parameters.publicKeyFormat.type - schemas.ChecksummedData.description - schemas.ChecksummedData.id - schemas.ChecksummedData.properties.crc32cChecksum.description - schemas.ChecksummedData.properties.crc32cChecksum.format - schemas.ChecksummedData.properties.crc32cChecksum.type - schemas.ChecksummedData.properties.data.description - schemas.ChecksummedData.properties.data.format - schemas.ChecksummedData.properties.data.type - schemas.ChecksummedData.type - schemas.PublicKey.properties.publicKey.$ref - schemas.PublicKey.properties.publicKey.description - schemas.PublicKey.properties.publicKeyFormat.description - schemas.PublicKey.properties.publicKeyFormat.enum - schemas.PublicKey.properties.publicKeyFormat.enumDescriptions - schemas.PublicKey.properties.publicKeyFormat.type The following keys were changed: - schemas.CryptoKeyVersion.properties.algorithm.enum - schemas.CryptoKeyVersion.properties.algorithm.enumDescriptions - schemas.CryptoKeyVersion.properties.state.enumDescriptions - schemas.CryptoKeyVersionTemplate.properties.algorithm.enum - schemas.CryptoKeyVersionTemplate.properties.algorithm.enumDescriptions - schemas.ImportCryptoKeyVersionRequest.properties.algorithm.enum - schemas.ImportCryptoKeyVersionRequest.properties.algorithm.enumDescriptions - schemas.PublicKey.properties.algorithm.enum - schemas.PublicKey.properties.algorithm.enumDescriptions - schemas.PublicKey.properties.pemCrc32c.description --- discovery/cloudkms-v1.json | 88 +++++++++++++++++++++++++++++++++----- src/apis/cloudkms/v1.ts | 27 +++++++++++- 2 files changed, 103 insertions(+), 12 deletions(-) diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index 2f75010276b..8d03b06ede4 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -1615,6 +1615,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", "required": true, "type": "string" + }, + "publicKeyFormat": { + "description": "Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.", + "enum": [ + "PUBLIC_KEY_FORMAT_UNSPECIFIED", + "PEM", + "NIST_PQC" + ], + "enumDescriptions": [ + "If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.", + "The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.", + "This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205)." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+name}/publicKey", @@ -2137,7 +2152,7 @@ } } }, - "revision": "20250102", + "revision": "20250227", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -2456,6 +2471,23 @@ }, "type": "object" }, + "ChecksummedData": { + "description": "Data with integrity verification field.", + "id": "ChecksummedData", + "properties": { + "crc32cChecksum": { + "description": "Integrity verification field. A CRC32C checksum of the returned ChecksummedData.data. An integrity check of ChecksummedData.data can be performed by computing the CRC32C checksum of ChecksummedData.data and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type.", + "format": "int64", + "type": "string" + }, + "data": { + "description": "Raw Data.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "CryptoKey": { "description": "A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.", "id": "CryptoKey", @@ -2579,7 +2611,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", - "EXTERNAL_SYMMETRIC_ENCRYPTION" + "EXTERNAL_SYMMETRIC_ENCRYPTION", + "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -2617,7 +2651,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", - "Algorithm representing symmetric encryption by an external key manager." + "Algorithm representing symmetric encryption by an external key manager.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "readOnly": true, "type": "string" @@ -2730,7 +2766,7 @@ "This version is still being generated. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.", "This version may be used for cryptographic operations.", "This version may not be used, but the key material is still available, and the version can be placed back into the ENABLED state.", - "This version is destroyed, and the key material is no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.", + "This key material of this version is destroyed and no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.", "This version is scheduled for destruction, and will be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the DISABLED state.", "This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.", "This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason.", @@ -2785,7 +2821,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", - "EXTERNAL_SYMMETRIC_ENCRYPTION" + "EXTERNAL_SYMMETRIC_ENCRYPTION", + "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -2823,7 +2861,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", - "Algorithm representing symmetric encryption by an external key manager." + "Algorithm representing symmetric encryption by an external key manager.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "type": "string" }, @@ -3206,7 +3246,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", - "EXTERNAL_SYMMETRIC_ENCRYPTION" + "EXTERNAL_SYMMETRIC_ENCRYPTION", + "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -3244,7 +3286,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", - "Algorithm representing symmetric encryption by an external key manager." + "Algorithm representing symmetric encryption by an external key manager.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "type": "string" }, @@ -3925,7 +3969,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", - "EXTERNAL_SYMMETRIC_ENCRYPTION" + "EXTERNAL_SYMMETRIC_ENCRYPTION", + "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -3963,7 +4009,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", - "Algorithm representing symmetric encryption by an external key manager." + "Algorithm representing symmetric encryption by an external key manager.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "type": "string" }, @@ -3976,7 +4024,7 @@ "type": "string" }, "pemCrc32c": { - "description": "Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.", + "description": "Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.", "format": "int64", "type": "string" }, @@ -3997,6 +4045,24 @@ "Crypto operations are performed in an EKM-over-VPC backend." ], "type": "string" + }, + "publicKey": { + "$ref": "ChecksummedData", + "description": "This field contains the public key (with integrity verification), formatted according to the public_key_format field." + }, + "publicKeyFormat": { + "description": "The PublicKey format specified by the customer through the public_key_format field.", + "enum": [ + "PUBLIC_KEY_FORMAT_UNSPECIFIED", + "PEM", + "NIST_PQC" + ], + "enumDescriptions": [ + "If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.", + "The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.", + "This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205)." + ], + "type": "string" } }, "type": "object" diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index f811c2c2d77..8929375b6a7 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -328,6 +328,19 @@ export namespace cloudkms_v1 { */ googlePartitionCerts?: string[] | null; } + /** + * Data with integrity verification field. + */ + export interface Schema$ChecksummedData { + /** + * Integrity verification field. A CRC32C checksum of the returned ChecksummedData.data. An integrity check of ChecksummedData.data can be performed by computing the CRC32C checksum of ChecksummedData.data and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. + */ + crc32cChecksum?: string | null; + /** + * Raw Data. + */ + data?: string | null; + } /** * A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations. */ @@ -1104,13 +1117,21 @@ export namespace cloudkms_v1 { */ pem?: string | null; /** - * Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta. + * Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta. */ pemCrc32c?: string | null; /** * The ProtectionLevel of the CryptoKeyVersion public key. */ protectionLevel?: string | null; + /** + * This field contains the public key (with integrity verification), formatted according to the public_key_format field. + */ + publicKey?: Schema$ChecksummedData; + /** + * The PublicKey format specified by the customer through the public_key_format field. + */ + publicKeyFormat?: string | null; } /** * Request message for KeyManagementService.RawDecrypt. @@ -6695,6 +6716,10 @@ export namespace cloudkms_v1 { * Required. The name of the CryptoKeyVersion public key to get. */ name?: string; + /** + * Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms. + */ + publicKeyFormat?: string; } export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Import extends StandardParameters { From 7eadcefa0391c419609e263d5237c708b56668b5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:41 +0000 Subject: [PATCH 030/144] fix(cloudresourcemanager): update the API #### cloudresourcemanager:v1beta1 The following keys were changed: - resources.organizations.methods.list.parameters.filter.description #### cloudresourcemanager:v1 The following keys were changed: - schemas.SearchOrganizationsRequest.properties.filter.description #### cloudresourcemanager:v3 The following keys were changed: - resources.projects.methods.delete.description --- discovery/cloudresourcemanager-v1.json | 4 ++-- discovery/cloudresourcemanager-v1beta1.json | 4 ++-- discovery/cloudresourcemanager-v3.json | 4 ++-- src/apis/cloudresourcemanager/v1.ts | 2 +- src/apis/cloudresourcemanager/v1beta1.ts | 2 +- src/apis/cloudresourcemanager/v3.ts | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/cloudresourcemanager-v1.json b/discovery/cloudresourcemanager-v1.json index 909edf11909..e9ac370bfd3 100644 --- a/discovery/cloudresourcemanager-v1.json +++ b/discovery/cloudresourcemanager-v1.json @@ -1171,7 +1171,7 @@ } } }, - "revision": "20240310", + "revision": "20250302", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { @@ -2131,7 +2131,7 @@ "id": "SearchOrganizationsRequest", "properties": { "filter": { - "description": "An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional.", + "description": "An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a verified G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional.", "type": "string" }, "pageSize": { diff --git a/discovery/cloudresourcemanager-v1beta1.json b/discovery/cloudresourcemanager-v1beta1.json index 6a1df9e8fcf..4461eea5c60 100644 --- a/discovery/cloudresourcemanager-v1beta1.json +++ b/discovery/cloudresourcemanager-v1beta1.json @@ -179,7 +179,7 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional.", + "description": "An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a verified G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional.", "location": "query", "type": "string" }, @@ -568,7 +568,7 @@ } } }, - "revision": "20240128", + "revision": "20250302", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/discovery/cloudresourcemanager-v3.json b/discovery/cloudresourcemanager-v3.json index 6f56849aa20..0460bf1a709 100644 --- a/discovery/cloudresourcemanager-v3.json +++ b/discovery/cloudresourcemanager-v3.json @@ -772,7 +772,7 @@ ] }, "delete": { - "description": "Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. This method behaves idempotently, such that deleting a `DELETE_REQUESTED` project will not cause an error, but also won't do anything. The caller must have `resourcemanager.projects.delete` permissions for this project.", + "description": "Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. The caller must have `resourcemanager.projects.delete` permissions for this project.", "flatPath": "v3/projects/{projectsId}", "httpMethod": "DELETE", "id": "cloudresourcemanager.projects.delete", @@ -1805,7 +1805,7 @@ } } }, - "revision": "20240310", + "revision": "20250206", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 478a72a7c88..24c139dbbcb 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -810,7 +810,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$SearchOrganizationsRequest { /** - * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional. + * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a verified G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional. */ filter?: string | null; /** diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 1b3339b82df..deb0eff2441 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -1180,7 +1180,7 @@ export namespace cloudresourcemanager_v1beta1 { export interface Params$Resource$Organizations$List extends StandardParameters { /** - * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional. + * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a verified G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional. */ filter?: string; /** diff --git a/src/apis/cloudresourcemanager/v3.ts b/src/apis/cloudresourcemanager/v3.ts index 04c9c3b2422..6798f6b9f4d 100644 --- a/src/apis/cloudresourcemanager/v3.ts +++ b/src/apis/cloudresourcemanager/v3.ts @@ -3315,7 +3315,7 @@ export namespace cloudresourcemanager_v3 { } /** - * Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. This method behaves idempotently, such that deleting a `DELETE_REQUESTED` project will not cause an error, but also won't do anything. The caller must have `resourcemanager.projects.delete` permissions for this project. + * Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. The caller must have `resourcemanager.projects.delete` permissions for this project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From 5de06da443e196f1e2fd7128cc532da404ced48f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:42 +0000 Subject: [PATCH 031/144] fix(composer): update the API #### composer:v1beta1 The following keys were changed: - schemas.MasterAuthorizedNetworksConfig.properties.enabled.description - schemas.NetworkingConfig.properties.connectionType.description #### composer:v1 The following keys were changed: - schemas.MasterAuthorizedNetworksConfig.properties.enabled.description - schemas.NetworkingConfig.properties.connectionType.description --- discovery/composer-v1.json | 6 +++--- discovery/composer-v1beta1.json | 6 +++--- src/apis/composer/v1.ts | 4 ++-- src/apis/composer/v1beta1.ts | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/discovery/composer-v1.json b/discovery/composer-v1.json index 599b679e4ba..70b51ebc293 100644 --- a/discovery/composer-v1.json +++ b/discovery/composer-v1.json @@ -1188,7 +1188,7 @@ } } }, - "revision": "20250108", + "revision": "20250303", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -2008,7 +2008,7 @@ "type": "array" }, "enabled": { - "description": "Whether or not master authorized networks feature is enabled.", + "description": "Optional. Whether or not master authorized networks feature is enabled.", "type": "boolean" } }, @@ -2019,7 +2019,7 @@ "id": "NetworkingConfig", "properties": { "connectionType": { - "description": "Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.", + "description": "Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.", "enum": [ "CONNECTION_TYPE_UNSPECIFIED", "VPC_PEERING", diff --git a/discovery/composer-v1beta1.json b/discovery/composer-v1beta1.json index 018ab9a58c2..236890ff315 100644 --- a/discovery/composer-v1beta1.json +++ b/discovery/composer-v1beta1.json @@ -1216,7 +1216,7 @@ } } }, - "revision": "20250108", + "revision": "20250303", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -2048,7 +2048,7 @@ "type": "array" }, "enabled": { - "description": "Whether or not master authorized networks feature is enabled.", + "description": "Optional. Whether or not master authorized networks feature is enabled.", "type": "boolean" } }, @@ -2059,7 +2059,7 @@ "id": "NetworkingConfig", "properties": { "connectionType": { - "description": "Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.", + "description": "Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.", "enum": [ "CONNECTION_TYPE_UNSPECIFIED", "VPC_PEERING", diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index c0e83bf3f22..4dc2248e492 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -719,7 +719,7 @@ export namespace composer_v1 { */ cidrBlocks?: Schema$CidrBlock[]; /** - * Whether or not master authorized networks feature is enabled. + * Optional. Whether or not master authorized networks feature is enabled. */ enabled?: boolean | null; } @@ -728,7 +728,7 @@ export namespace composer_v1 { */ export interface Schema$NetworkingConfig { /** - * Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment. + * Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment. */ connectionType?: string | null; } diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 9a545a14e4e..1116db78631 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -723,7 +723,7 @@ export namespace composer_v1beta1 { */ cidrBlocks?: Schema$CidrBlock[]; /** - * Whether or not master authorized networks feature is enabled. + * Optional. Whether or not master authorized networks feature is enabled. */ enabled?: boolean | null; } @@ -732,7 +732,7 @@ export namespace composer_v1beta1 { */ export interface Schema$NetworkingConfig { /** - * Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment. + * Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment. */ connectionType?: string | null; } From 95a3c1ab958e8fc5bda0267d358d8ac356f1b5a3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:42 +0000 Subject: [PATCH 032/144] feat(compute)!: update the API BREAKING CHANGE: This release has breaking changes. #### compute:alpha The following keys were deleted: - schemas.Commitment.properties.existingReservations.description - schemas.NetworkEndpoint.properties.zone.description - schemas.NetworkEndpoint.properties.zone.type - schemas.NetworkProfile.properties.zone.description - schemas.NetworkProfile.properties.zone.type The following keys were added: - resources.disks.methods.bulkSetLabels.description - resources.disks.methods.bulkSetLabels.flatPath - resources.disks.methods.bulkSetLabels.httpMethod - resources.disks.methods.bulkSetLabels.id - resources.disks.methods.bulkSetLabels.parameterOrder - resources.disks.methods.bulkSetLabels.parameters.project.description - resources.disks.methods.bulkSetLabels.parameters.project.location - resources.disks.methods.bulkSetLabels.parameters.project.pattern - resources.disks.methods.bulkSetLabels.parameters.project.required - resources.disks.methods.bulkSetLabels.parameters.project.type - resources.disks.methods.bulkSetLabels.parameters.requestId.description - resources.disks.methods.bulkSetLabels.parameters.requestId.location - resources.disks.methods.bulkSetLabels.parameters.requestId.type - resources.disks.methods.bulkSetLabels.parameters.resource.description - resources.disks.methods.bulkSetLabels.parameters.resource.location - resources.disks.methods.bulkSetLabels.parameters.resource.pattern - resources.disks.methods.bulkSetLabels.parameters.resource.type - resources.disks.methods.bulkSetLabels.parameters.zone.description - resources.disks.methods.bulkSetLabels.parameters.zone.location - resources.disks.methods.bulkSetLabels.parameters.zone.pattern - resources.disks.methods.bulkSetLabels.parameters.zone.required - resources.disks.methods.bulkSetLabels.parameters.zone.type - resources.disks.methods.bulkSetLabels.path - resources.disks.methods.bulkSetLabels.request.$ref - resources.disks.methods.bulkSetLabels.response.$ref - resources.disks.methods.bulkSetLabels.scopes - resources.interconnectAttachmentGroups.methods.createMembers.description - resources.interconnectAttachmentGroups.methods.createMembers.flatPath - resources.interconnectAttachmentGroups.methods.createMembers.httpMethod - resources.interconnectAttachmentGroups.methods.createMembers.id - resources.interconnectAttachmentGroups.methods.createMembers.parameterOrder - resources.interconnectAttachmentGroups.methods.createMembers.parameters.interconnectAttachmentGroup.description - resources.interconnectAttachmentGroups.methods.createMembers.parameters.interconnectAttachmentGroup.location - resources.interconnectAttachmentGroups.methods.createMembers.parameters.interconnectAttachmentGroup.pattern - resources.interconnectAttachmentGroups.methods.createMembers.parameters.interconnectAttachmentGroup.required - resources.interconnectAttachmentGroups.methods.createMembers.parameters.interconnectAttachmentGroup.type - resources.interconnectAttachmentGroups.methods.createMembers.parameters.project.description - resources.interconnectAttachmentGroups.methods.createMembers.parameters.project.location - resources.interconnectAttachmentGroups.methods.createMembers.parameters.project.pattern - resources.interconnectAttachmentGroups.methods.createMembers.parameters.project.required - resources.interconnectAttachmentGroups.methods.createMembers.parameters.project.type - resources.interconnectAttachmentGroups.methods.createMembers.path - resources.interconnectAttachmentGroups.methods.createMembers.request.$ref - resources.interconnectAttachmentGroups.methods.createMembers.response.$ref - resources.interconnectAttachmentGroups.methods.createMembers.scopes - resources.interconnectGroups.methods.createMembers.description - resources.interconnectGroups.methods.createMembers.flatPath - resources.interconnectGroups.methods.createMembers.httpMethod - resources.interconnectGroups.methods.createMembers.id - resources.interconnectGroups.methods.createMembers.parameterOrder - resources.interconnectGroups.methods.createMembers.parameters.interconnectGroup.description - resources.interconnectGroups.methods.createMembers.parameters.interconnectGroup.location - resources.interconnectGroups.methods.createMembers.parameters.interconnectGroup.pattern - resources.interconnectGroups.methods.createMembers.parameters.interconnectGroup.required - resources.interconnectGroups.methods.createMembers.parameters.interconnectGroup.type - resources.interconnectGroups.methods.createMembers.parameters.project.description - resources.interconnectGroups.methods.createMembers.parameters.project.location - resources.interconnectGroups.methods.createMembers.parameters.project.pattern - resources.interconnectGroups.methods.createMembers.parameters.project.required - resources.interconnectGroups.methods.createMembers.parameters.project.type - resources.interconnectGroups.methods.createMembers.path - resources.interconnectGroups.methods.createMembers.request.$ref - resources.interconnectGroups.methods.createMembers.response.$ref - resources.interconnectGroups.methods.createMembers.scopes - resources.regionCompositeHealthChecks.methods.aggregatedList.description - resources.regionCompositeHealthChecks.methods.aggregatedList.flatPath - resources.regionCompositeHealthChecks.methods.aggregatedList.httpMethod - resources.regionCompositeHealthChecks.methods.aggregatedList.id - resources.regionCompositeHealthChecks.methods.aggregatedList.parameterOrder - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.filter.description - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.filter.location - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.filter.type - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.includeAllScopes.description - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.includeAllScopes.location - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.includeAllScopes.type - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.maxResults.default - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.maxResults.description - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.maxResults.format - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.maxResults.location - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.maxResults.minimum - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.maxResults.type - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.orderBy.description - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.orderBy.location - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.orderBy.type - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.pageToken.description - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.pageToken.location - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.pageToken.type - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.project.description - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.project.location - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.project.pattern - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.project.required - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.project.type - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.returnPartialSuccess.description - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.returnPartialSuccess.location - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.returnPartialSuccess.type - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.regionCompositeHealthChecks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.regionCompositeHealthChecks.methods.aggregatedList.path - resources.regionCompositeHealthChecks.methods.aggregatedList.response.$ref - resources.regionCompositeHealthChecks.methods.aggregatedList.scopes - resources.regionCompositeHealthChecks.methods.delete.description - resources.regionCompositeHealthChecks.methods.delete.flatPath - resources.regionCompositeHealthChecks.methods.delete.httpMethod - resources.regionCompositeHealthChecks.methods.delete.id - resources.regionCompositeHealthChecks.methods.delete.parameterOrder - resources.regionCompositeHealthChecks.methods.delete.parameters.compositeHealthCheck.description - resources.regionCompositeHealthChecks.methods.delete.parameters.compositeHealthCheck.location - resources.regionCompositeHealthChecks.methods.delete.parameters.compositeHealthCheck.pattern - resources.regionCompositeHealthChecks.methods.delete.parameters.compositeHealthCheck.required - resources.regionCompositeHealthChecks.methods.delete.parameters.compositeHealthCheck.type - resources.regionCompositeHealthChecks.methods.delete.parameters.project.description - resources.regionCompositeHealthChecks.methods.delete.parameters.project.location - resources.regionCompositeHealthChecks.methods.delete.parameters.project.pattern - resources.regionCompositeHealthChecks.methods.delete.parameters.project.required - resources.regionCompositeHealthChecks.methods.delete.parameters.project.type - resources.regionCompositeHealthChecks.methods.delete.parameters.region.description - resources.regionCompositeHealthChecks.methods.delete.parameters.region.location - resources.regionCompositeHealthChecks.methods.delete.parameters.region.pattern - resources.regionCompositeHealthChecks.methods.delete.parameters.region.required - resources.regionCompositeHealthChecks.methods.delete.parameters.region.type - resources.regionCompositeHealthChecks.methods.delete.parameters.requestId.description - resources.regionCompositeHealthChecks.methods.delete.parameters.requestId.location - resources.regionCompositeHealthChecks.methods.delete.parameters.requestId.type - resources.regionCompositeHealthChecks.methods.delete.path - resources.regionCompositeHealthChecks.methods.delete.response.$ref - resources.regionCompositeHealthChecks.methods.delete.scopes - resources.regionCompositeHealthChecks.methods.get.description - resources.regionCompositeHealthChecks.methods.get.flatPath - resources.regionCompositeHealthChecks.methods.get.httpMethod - resources.regionCompositeHealthChecks.methods.get.id - resources.regionCompositeHealthChecks.methods.get.parameterOrder - resources.regionCompositeHealthChecks.methods.get.parameters.compositeHealthCheck.description - resources.regionCompositeHealthChecks.methods.get.parameters.compositeHealthCheck.location - resources.regionCompositeHealthChecks.methods.get.parameters.compositeHealthCheck.pattern - resources.regionCompositeHealthChecks.methods.get.parameters.compositeHealthCheck.required - resources.regionCompositeHealthChecks.methods.get.parameters.compositeHealthCheck.type - resources.regionCompositeHealthChecks.methods.get.parameters.project.description - resources.regionCompositeHealthChecks.methods.get.parameters.project.location - resources.regionCompositeHealthChecks.methods.get.parameters.project.pattern - resources.regionCompositeHealthChecks.methods.get.parameters.project.required - resources.regionCompositeHealthChecks.methods.get.parameters.project.type - resources.regionCompositeHealthChecks.methods.get.parameters.region.description - resources.regionCompositeHealthChecks.methods.get.parameters.region.location - resources.regionCompositeHealthChecks.methods.get.parameters.region.pattern - resources.regionCompositeHealthChecks.methods.get.parameters.region.required - resources.regionCompositeHealthChecks.methods.get.parameters.region.type - resources.regionCompositeHealthChecks.methods.get.path - resources.regionCompositeHealthChecks.methods.get.response.$ref - resources.regionCompositeHealthChecks.methods.get.scopes - resources.regionCompositeHealthChecks.methods.insert.description - resources.regionCompositeHealthChecks.methods.insert.flatPath - resources.regionCompositeHealthChecks.methods.insert.httpMethod - resources.regionCompositeHealthChecks.methods.insert.id - resources.regionCompositeHealthChecks.methods.insert.parameterOrder - resources.regionCompositeHealthChecks.methods.insert.parameters.project.description - resources.regionCompositeHealthChecks.methods.insert.parameters.project.location - resources.regionCompositeHealthChecks.methods.insert.parameters.project.pattern - resources.regionCompositeHealthChecks.methods.insert.parameters.project.required - resources.regionCompositeHealthChecks.methods.insert.parameters.project.type - resources.regionCompositeHealthChecks.methods.insert.parameters.region.description - resources.regionCompositeHealthChecks.methods.insert.parameters.region.location - resources.regionCompositeHealthChecks.methods.insert.parameters.region.pattern - resources.regionCompositeHealthChecks.methods.insert.parameters.region.required - resources.regionCompositeHealthChecks.methods.insert.parameters.region.type - resources.regionCompositeHealthChecks.methods.insert.parameters.requestId.description - resources.regionCompositeHealthChecks.methods.insert.parameters.requestId.location - resources.regionCompositeHealthChecks.methods.insert.parameters.requestId.type - resources.regionCompositeHealthChecks.methods.insert.path - resources.regionCompositeHealthChecks.methods.insert.request.$ref - resources.regionCompositeHealthChecks.methods.insert.response.$ref - resources.regionCompositeHealthChecks.methods.insert.scopes - resources.regionCompositeHealthChecks.methods.list.description - resources.regionCompositeHealthChecks.methods.list.flatPath - resources.regionCompositeHealthChecks.methods.list.httpMethod - resources.regionCompositeHealthChecks.methods.list.id - resources.regionCompositeHealthChecks.methods.list.parameterOrder - resources.regionCompositeHealthChecks.methods.list.parameters.filter.description - resources.regionCompositeHealthChecks.methods.list.parameters.filter.location - resources.regionCompositeHealthChecks.methods.list.parameters.filter.type - resources.regionCompositeHealthChecks.methods.list.parameters.maxResults.default - resources.regionCompositeHealthChecks.methods.list.parameters.maxResults.description - resources.regionCompositeHealthChecks.methods.list.parameters.maxResults.format - resources.regionCompositeHealthChecks.methods.list.parameters.maxResults.location - resources.regionCompositeHealthChecks.methods.list.parameters.maxResults.minimum - resources.regionCompositeHealthChecks.methods.list.parameters.maxResults.type - resources.regionCompositeHealthChecks.methods.list.parameters.orderBy.description - resources.regionCompositeHealthChecks.methods.list.parameters.orderBy.location - resources.regionCompositeHealthChecks.methods.list.parameters.orderBy.type - resources.regionCompositeHealthChecks.methods.list.parameters.pageToken.description - resources.regionCompositeHealthChecks.methods.list.parameters.pageToken.location - resources.regionCompositeHealthChecks.methods.list.parameters.pageToken.type - resources.regionCompositeHealthChecks.methods.list.parameters.project.description - resources.regionCompositeHealthChecks.methods.list.parameters.project.location - resources.regionCompositeHealthChecks.methods.list.parameters.project.pattern - resources.regionCompositeHealthChecks.methods.list.parameters.project.required - resources.regionCompositeHealthChecks.methods.list.parameters.project.type - resources.regionCompositeHealthChecks.methods.list.parameters.region.description - resources.regionCompositeHealthChecks.methods.list.parameters.region.location - resources.regionCompositeHealthChecks.methods.list.parameters.region.pattern - resources.regionCompositeHealthChecks.methods.list.parameters.region.required - resources.regionCompositeHealthChecks.methods.list.parameters.region.type - resources.regionCompositeHealthChecks.methods.list.parameters.returnPartialSuccess.description - resources.regionCompositeHealthChecks.methods.list.parameters.returnPartialSuccess.location - resources.regionCompositeHealthChecks.methods.list.parameters.returnPartialSuccess.type - resources.regionCompositeHealthChecks.methods.list.path - resources.regionCompositeHealthChecks.methods.list.response.$ref - resources.regionCompositeHealthChecks.methods.list.scopes - resources.regionCompositeHealthChecks.methods.patch.description - resources.regionCompositeHealthChecks.methods.patch.flatPath - resources.regionCompositeHealthChecks.methods.patch.httpMethod - resources.regionCompositeHealthChecks.methods.patch.id - resources.regionCompositeHealthChecks.methods.patch.parameterOrder - resources.regionCompositeHealthChecks.methods.patch.parameters.compositeHealthCheck.description - resources.regionCompositeHealthChecks.methods.patch.parameters.compositeHealthCheck.location - resources.regionCompositeHealthChecks.methods.patch.parameters.compositeHealthCheck.required - resources.regionCompositeHealthChecks.methods.patch.parameters.compositeHealthCheck.type - resources.regionCompositeHealthChecks.methods.patch.parameters.project.description - resources.regionCompositeHealthChecks.methods.patch.parameters.project.location - resources.regionCompositeHealthChecks.methods.patch.parameters.project.pattern - resources.regionCompositeHealthChecks.methods.patch.parameters.project.required - resources.regionCompositeHealthChecks.methods.patch.parameters.project.type - resources.regionCompositeHealthChecks.methods.patch.parameters.region.description - resources.regionCompositeHealthChecks.methods.patch.parameters.region.location - resources.regionCompositeHealthChecks.methods.patch.parameters.region.pattern - resources.regionCompositeHealthChecks.methods.patch.parameters.region.required - resources.regionCompositeHealthChecks.methods.patch.parameters.region.type - resources.regionCompositeHealthChecks.methods.patch.parameters.requestId.description - resources.regionCompositeHealthChecks.methods.patch.parameters.requestId.location - resources.regionCompositeHealthChecks.methods.patch.parameters.requestId.type - resources.regionCompositeHealthChecks.methods.patch.path - resources.regionCompositeHealthChecks.methods.patch.request.$ref - resources.regionCompositeHealthChecks.methods.patch.response.$ref - resources.regionCompositeHealthChecks.methods.patch.scopes - resources.regionCompositeHealthChecks.methods.testIamPermissions.description - resources.regionCompositeHealthChecks.methods.testIamPermissions.flatPath - resources.regionCompositeHealthChecks.methods.testIamPermissions.httpMethod - resources.regionCompositeHealthChecks.methods.testIamPermissions.id - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameterOrder - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.project.description - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.project.location - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.project.pattern - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.project.required - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.project.type - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.region.description - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.region.location - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.region.pattern - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.region.required - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.region.type - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.resource.description - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.resource.location - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.resource.pattern - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.resource.required - resources.regionCompositeHealthChecks.methods.testIamPermissions.parameters.resource.type - resources.regionCompositeHealthChecks.methods.testIamPermissions.path - resources.regionCompositeHealthChecks.methods.testIamPermissions.request.$ref - resources.regionCompositeHealthChecks.methods.testIamPermissions.response.$ref - resources.regionCompositeHealthChecks.methods.testIamPermissions.scopes - resources.regionHealthAggregationPolicies.methods.delete.description - resources.regionHealthAggregationPolicies.methods.delete.flatPath - resources.regionHealthAggregationPolicies.methods.delete.httpMethod - resources.regionHealthAggregationPolicies.methods.delete.id - resources.regionHealthAggregationPolicies.methods.delete.parameterOrder - resources.regionHealthAggregationPolicies.methods.delete.parameters.healthAggregationPolicy.description - resources.regionHealthAggregationPolicies.methods.delete.parameters.healthAggregationPolicy.location - resources.regionHealthAggregationPolicies.methods.delete.parameters.healthAggregationPolicy.pattern - resources.regionHealthAggregationPolicies.methods.delete.parameters.healthAggregationPolicy.required - resources.regionHealthAggregationPolicies.methods.delete.parameters.healthAggregationPolicy.type - resources.regionHealthAggregationPolicies.methods.delete.parameters.project.description - resources.regionHealthAggregationPolicies.methods.delete.parameters.project.location - resources.regionHealthAggregationPolicies.methods.delete.parameters.project.pattern - resources.regionHealthAggregationPolicies.methods.delete.parameters.project.required - resources.regionHealthAggregationPolicies.methods.delete.parameters.project.type - resources.regionHealthAggregationPolicies.methods.delete.parameters.region.description - resources.regionHealthAggregationPolicies.methods.delete.parameters.region.location - resources.regionHealthAggregationPolicies.methods.delete.parameters.region.pattern - resources.regionHealthAggregationPolicies.methods.delete.parameters.region.required - resources.regionHealthAggregationPolicies.methods.delete.parameters.region.type - resources.regionHealthAggregationPolicies.methods.delete.parameters.requestId.description - resources.regionHealthAggregationPolicies.methods.delete.parameters.requestId.location - resources.regionHealthAggregationPolicies.methods.delete.parameters.requestId.type - resources.regionHealthAggregationPolicies.methods.delete.path - resources.regionHealthAggregationPolicies.methods.delete.response.$ref - resources.regionHealthAggregationPolicies.methods.delete.scopes - resources.regionHealthAggregationPolicies.methods.get.description - resources.regionHealthAggregationPolicies.methods.get.flatPath - resources.regionHealthAggregationPolicies.methods.get.httpMethod - resources.regionHealthAggregationPolicies.methods.get.id - resources.regionHealthAggregationPolicies.methods.get.parameterOrder - resources.regionHealthAggregationPolicies.methods.get.parameters.healthAggregationPolicy.description - resources.regionHealthAggregationPolicies.methods.get.parameters.healthAggregationPolicy.location - resources.regionHealthAggregationPolicies.methods.get.parameters.healthAggregationPolicy.pattern - resources.regionHealthAggregationPolicies.methods.get.parameters.healthAggregationPolicy.required - resources.regionHealthAggregationPolicies.methods.get.parameters.healthAggregationPolicy.type - resources.regionHealthAggregationPolicies.methods.get.parameters.project.description - resources.regionHealthAggregationPolicies.methods.get.parameters.project.location - resources.regionHealthAggregationPolicies.methods.get.parameters.project.pattern - resources.regionHealthAggregationPolicies.methods.get.parameters.project.required - resources.regionHealthAggregationPolicies.methods.get.parameters.project.type - resources.regionHealthAggregationPolicies.methods.get.parameters.region.description - resources.regionHealthAggregationPolicies.methods.get.parameters.region.location - resources.regionHealthAggregationPolicies.methods.get.parameters.region.pattern - resources.regionHealthAggregationPolicies.methods.get.parameters.region.required - resources.regionHealthAggregationPolicies.methods.get.parameters.region.type - resources.regionHealthAggregationPolicies.methods.get.path - resources.regionHealthAggregationPolicies.methods.get.response.$ref - resources.regionHealthAggregationPolicies.methods.get.scopes - resources.regionHealthAggregationPolicies.methods.insert.description - resources.regionHealthAggregationPolicies.methods.insert.flatPath - resources.regionHealthAggregationPolicies.methods.insert.httpMethod - resources.regionHealthAggregationPolicies.methods.insert.id - resources.regionHealthAggregationPolicies.methods.insert.parameterOrder - resources.regionHealthAggregationPolicies.methods.insert.parameters.project.description - resources.regionHealthAggregationPolicies.methods.insert.parameters.project.location - resources.regionHealthAggregationPolicies.methods.insert.parameters.project.pattern - resources.regionHealthAggregationPolicies.methods.insert.parameters.project.required - resources.regionHealthAggregationPolicies.methods.insert.parameters.project.type - resources.regionHealthAggregationPolicies.methods.insert.parameters.region.description - resources.regionHealthAggregationPolicies.methods.insert.parameters.region.location - resources.regionHealthAggregationPolicies.methods.insert.parameters.region.pattern - resources.regionHealthAggregationPolicies.methods.insert.parameters.region.required - resources.regionHealthAggregationPolicies.methods.insert.parameters.region.type - resources.regionHealthAggregationPolicies.methods.insert.parameters.requestId.description - resources.regionHealthAggregationPolicies.methods.insert.parameters.requestId.location - resources.regionHealthAggregationPolicies.methods.insert.parameters.requestId.type - resources.regionHealthAggregationPolicies.methods.insert.path - resources.regionHealthAggregationPolicies.methods.insert.request.$ref - resources.regionHealthAggregationPolicies.methods.insert.response.$ref - resources.regionHealthAggregationPolicies.methods.insert.scopes - resources.regionHealthAggregationPolicies.methods.list.description - resources.regionHealthAggregationPolicies.methods.list.flatPath - resources.regionHealthAggregationPolicies.methods.list.httpMethod - resources.regionHealthAggregationPolicies.methods.list.id - resources.regionHealthAggregationPolicies.methods.list.parameterOrder - resources.regionHealthAggregationPolicies.methods.list.parameters.filter.description - resources.regionHealthAggregationPolicies.methods.list.parameters.filter.location - resources.regionHealthAggregationPolicies.methods.list.parameters.filter.type - resources.regionHealthAggregationPolicies.methods.list.parameters.maxResults.default - resources.regionHealthAggregationPolicies.methods.list.parameters.maxResults.description - resources.regionHealthAggregationPolicies.methods.list.parameters.maxResults.format - resources.regionHealthAggregationPolicies.methods.list.parameters.maxResults.location - resources.regionHealthAggregationPolicies.methods.list.parameters.maxResults.minimum - resources.regionHealthAggregationPolicies.methods.list.parameters.maxResults.type - resources.regionHealthAggregationPolicies.methods.list.parameters.orderBy.description - resources.regionHealthAggregationPolicies.methods.list.parameters.orderBy.location - resources.regionHealthAggregationPolicies.methods.list.parameters.orderBy.type - resources.regionHealthAggregationPolicies.methods.list.parameters.pageToken.description - resources.regionHealthAggregationPolicies.methods.list.parameters.pageToken.location - resources.regionHealthAggregationPolicies.methods.list.parameters.pageToken.type - resources.regionHealthAggregationPolicies.methods.list.parameters.project.description - resources.regionHealthAggregationPolicies.methods.list.parameters.project.location - resources.regionHealthAggregationPolicies.methods.list.parameters.project.pattern - resources.regionHealthAggregationPolicies.methods.list.parameters.project.required - resources.regionHealthAggregationPolicies.methods.list.parameters.project.type - resources.regionHealthAggregationPolicies.methods.list.parameters.region.description - resources.regionHealthAggregationPolicies.methods.list.parameters.region.location - resources.regionHealthAggregationPolicies.methods.list.parameters.region.pattern - resources.regionHealthAggregationPolicies.methods.list.parameters.region.required - resources.regionHealthAggregationPolicies.methods.list.parameters.region.type - resources.regionHealthAggregationPolicies.methods.list.parameters.returnPartialSuccess.description - resources.regionHealthAggregationPolicies.methods.list.parameters.returnPartialSuccess.location - resources.regionHealthAggregationPolicies.methods.list.parameters.returnPartialSuccess.type - resources.regionHealthAggregationPolicies.methods.list.path - resources.regionHealthAggregationPolicies.methods.list.response.$ref - resources.regionHealthAggregationPolicies.methods.list.scopes - resources.regionHealthAggregationPolicies.methods.patch.description - resources.regionHealthAggregationPolicies.methods.patch.flatPath - resources.regionHealthAggregationPolicies.methods.patch.httpMethod - resources.regionHealthAggregationPolicies.methods.patch.id - resources.regionHealthAggregationPolicies.methods.patch.parameterOrder - resources.regionHealthAggregationPolicies.methods.patch.parameters.healthAggregationPolicy.description - resources.regionHealthAggregationPolicies.methods.patch.parameters.healthAggregationPolicy.location - resources.regionHealthAggregationPolicies.methods.patch.parameters.healthAggregationPolicy.required - resources.regionHealthAggregationPolicies.methods.patch.parameters.healthAggregationPolicy.type - resources.regionHealthAggregationPolicies.methods.patch.parameters.project.description - resources.regionHealthAggregationPolicies.methods.patch.parameters.project.location - resources.regionHealthAggregationPolicies.methods.patch.parameters.project.pattern - resources.regionHealthAggregationPolicies.methods.patch.parameters.project.required - resources.regionHealthAggregationPolicies.methods.patch.parameters.project.type - resources.regionHealthAggregationPolicies.methods.patch.parameters.region.description - resources.regionHealthAggregationPolicies.methods.patch.parameters.region.location - resources.regionHealthAggregationPolicies.methods.patch.parameters.region.pattern - resources.regionHealthAggregationPolicies.methods.patch.parameters.region.required - resources.regionHealthAggregationPolicies.methods.patch.parameters.region.type - resources.regionHealthAggregationPolicies.methods.patch.parameters.requestId.description - resources.regionHealthAggregationPolicies.methods.patch.parameters.requestId.location - resources.regionHealthAggregationPolicies.methods.patch.parameters.requestId.type - resources.regionHealthAggregationPolicies.methods.patch.path - resources.regionHealthAggregationPolicies.methods.patch.request.$ref - resources.regionHealthAggregationPolicies.methods.patch.response.$ref - resources.regionHealthAggregationPolicies.methods.patch.scopes - resources.regionHealthAggregationPolicies.methods.testIamPermissions.description - resources.regionHealthAggregationPolicies.methods.testIamPermissions.flatPath - resources.regionHealthAggregationPolicies.methods.testIamPermissions.httpMethod - resources.regionHealthAggregationPolicies.methods.testIamPermissions.id - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameterOrder - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.project.description - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.project.location - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.project.pattern - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.project.required - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.project.type - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.region.description - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.region.location - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.region.pattern - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.region.required - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.region.type - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.resource.description - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.resource.location - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.resource.pattern - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.resource.required - resources.regionHealthAggregationPolicies.methods.testIamPermissions.parameters.resource.type - resources.regionHealthAggregationPolicies.methods.testIamPermissions.path - resources.regionHealthAggregationPolicies.methods.testIamPermissions.request.$ref - resources.regionHealthAggregationPolicies.methods.testIamPermissions.response.$ref - resources.regionHealthAggregationPolicies.methods.testIamPermissions.scopes - resources.regionHealthSources.methods.aggregatedList.description - resources.regionHealthSources.methods.aggregatedList.flatPath - resources.regionHealthSources.methods.aggregatedList.httpMethod - resources.regionHealthSources.methods.aggregatedList.id - resources.regionHealthSources.methods.aggregatedList.parameterOrder - resources.regionHealthSources.methods.aggregatedList.parameters.filter.description - resources.regionHealthSources.methods.aggregatedList.parameters.filter.location - resources.regionHealthSources.methods.aggregatedList.parameters.filter.type - resources.regionHealthSources.methods.aggregatedList.parameters.includeAllScopes.description - resources.regionHealthSources.methods.aggregatedList.parameters.includeAllScopes.location - resources.regionHealthSources.methods.aggregatedList.parameters.includeAllScopes.type - resources.regionHealthSources.methods.aggregatedList.parameters.maxResults.default - resources.regionHealthSources.methods.aggregatedList.parameters.maxResults.description - resources.regionHealthSources.methods.aggregatedList.parameters.maxResults.format - resources.regionHealthSources.methods.aggregatedList.parameters.maxResults.location - resources.regionHealthSources.methods.aggregatedList.parameters.maxResults.minimum - resources.regionHealthSources.methods.aggregatedList.parameters.maxResults.type - resources.regionHealthSources.methods.aggregatedList.parameters.orderBy.description - resources.regionHealthSources.methods.aggregatedList.parameters.orderBy.location - resources.regionHealthSources.methods.aggregatedList.parameters.orderBy.type - resources.regionHealthSources.methods.aggregatedList.parameters.pageToken.description - resources.regionHealthSources.methods.aggregatedList.parameters.pageToken.location - resources.regionHealthSources.methods.aggregatedList.parameters.pageToken.type - resources.regionHealthSources.methods.aggregatedList.parameters.project.description - resources.regionHealthSources.methods.aggregatedList.parameters.project.location - resources.regionHealthSources.methods.aggregatedList.parameters.project.pattern - resources.regionHealthSources.methods.aggregatedList.parameters.project.required - resources.regionHealthSources.methods.aggregatedList.parameters.project.type - resources.regionHealthSources.methods.aggregatedList.parameters.returnPartialSuccess.description - resources.regionHealthSources.methods.aggregatedList.parameters.returnPartialSuccess.location - resources.regionHealthSources.methods.aggregatedList.parameters.returnPartialSuccess.type - resources.regionHealthSources.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.regionHealthSources.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.regionHealthSources.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.regionHealthSources.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.regionHealthSources.methods.aggregatedList.path - resources.regionHealthSources.methods.aggregatedList.response.$ref - resources.regionHealthSources.methods.aggregatedList.scopes - resources.regionHealthSources.methods.delete.description - resources.regionHealthSources.methods.delete.flatPath - resources.regionHealthSources.methods.delete.httpMethod - resources.regionHealthSources.methods.delete.id - resources.regionHealthSources.methods.delete.parameterOrder - resources.regionHealthSources.methods.delete.parameters.healthSource.description - resources.regionHealthSources.methods.delete.parameters.healthSource.location - resources.regionHealthSources.methods.delete.parameters.healthSource.pattern - resources.regionHealthSources.methods.delete.parameters.healthSource.required - resources.regionHealthSources.methods.delete.parameters.healthSource.type - resources.regionHealthSources.methods.delete.parameters.project.description - resources.regionHealthSources.methods.delete.parameters.project.location - resources.regionHealthSources.methods.delete.parameters.project.pattern - resources.regionHealthSources.methods.delete.parameters.project.required - resources.regionHealthSources.methods.delete.parameters.project.type - resources.regionHealthSources.methods.delete.parameters.region.description - resources.regionHealthSources.methods.delete.parameters.region.location - resources.regionHealthSources.methods.delete.parameters.region.pattern - resources.regionHealthSources.methods.delete.parameters.region.required - resources.regionHealthSources.methods.delete.parameters.region.type - resources.regionHealthSources.methods.delete.parameters.requestId.description - resources.regionHealthSources.methods.delete.parameters.requestId.location - resources.regionHealthSources.methods.delete.parameters.requestId.type - resources.regionHealthSources.methods.delete.path - resources.regionHealthSources.methods.delete.response.$ref - resources.regionHealthSources.methods.delete.scopes - resources.regionHealthSources.methods.get.description - resources.regionHealthSources.methods.get.flatPath - resources.regionHealthSources.methods.get.httpMethod - resources.regionHealthSources.methods.get.id - resources.regionHealthSources.methods.get.parameterOrder - resources.regionHealthSources.methods.get.parameters.healthSource.description - resources.regionHealthSources.methods.get.parameters.healthSource.location - resources.regionHealthSources.methods.get.parameters.healthSource.pattern - resources.regionHealthSources.methods.get.parameters.healthSource.required - resources.regionHealthSources.methods.get.parameters.healthSource.type - resources.regionHealthSources.methods.get.parameters.project.description - resources.regionHealthSources.methods.get.parameters.project.location - resources.regionHealthSources.methods.get.parameters.project.pattern - resources.regionHealthSources.methods.get.parameters.project.required - resources.regionHealthSources.methods.get.parameters.project.type - resources.regionHealthSources.methods.get.parameters.region.description - resources.regionHealthSources.methods.get.parameters.region.location - resources.regionHealthSources.methods.get.parameters.region.pattern - resources.regionHealthSources.methods.get.parameters.region.required - resources.regionHealthSources.methods.get.parameters.region.type - resources.regionHealthSources.methods.get.path - resources.regionHealthSources.methods.get.response.$ref - resources.regionHealthSources.methods.get.scopes - resources.regionHealthSources.methods.insert.description - resources.regionHealthSources.methods.insert.flatPath - resources.regionHealthSources.methods.insert.httpMethod - resources.regionHealthSources.methods.insert.id - resources.regionHealthSources.methods.insert.parameterOrder - resources.regionHealthSources.methods.insert.parameters.project.description - resources.regionHealthSources.methods.insert.parameters.project.location - resources.regionHealthSources.methods.insert.parameters.project.pattern - resources.regionHealthSources.methods.insert.parameters.project.required - resources.regionHealthSources.methods.insert.parameters.project.type - resources.regionHealthSources.methods.insert.parameters.region.description - resources.regionHealthSources.methods.insert.parameters.region.location - resources.regionHealthSources.methods.insert.parameters.region.pattern - resources.regionHealthSources.methods.insert.parameters.region.required - resources.regionHealthSources.methods.insert.parameters.region.type - resources.regionHealthSources.methods.insert.parameters.requestId.description - resources.regionHealthSources.methods.insert.parameters.requestId.location - resources.regionHealthSources.methods.insert.parameters.requestId.type - resources.regionHealthSources.methods.insert.path - resources.regionHealthSources.methods.insert.request.$ref - resources.regionHealthSources.methods.insert.response.$ref - resources.regionHealthSources.methods.insert.scopes - resources.regionHealthSources.methods.list.description - resources.regionHealthSources.methods.list.flatPath - resources.regionHealthSources.methods.list.httpMethod - resources.regionHealthSources.methods.list.id - resources.regionHealthSources.methods.list.parameterOrder - resources.regionHealthSources.methods.list.parameters.filter.description - resources.regionHealthSources.methods.list.parameters.filter.location - resources.regionHealthSources.methods.list.parameters.filter.type - resources.regionHealthSources.methods.list.parameters.maxResults.default - resources.regionHealthSources.methods.list.parameters.maxResults.description - resources.regionHealthSources.methods.list.parameters.maxResults.format - resources.regionHealthSources.methods.list.parameters.maxResults.location - resources.regionHealthSources.methods.list.parameters.maxResults.minimum - resources.regionHealthSources.methods.list.parameters.maxResults.type - resources.regionHealthSources.methods.list.parameters.orderBy.description - resources.regionHealthSources.methods.list.parameters.orderBy.location - resources.regionHealthSources.methods.list.parameters.orderBy.type - resources.regionHealthSources.methods.list.parameters.pageToken.description - resources.regionHealthSources.methods.list.parameters.pageToken.location - resources.regionHealthSources.methods.list.parameters.pageToken.type - resources.regionHealthSources.methods.list.parameters.project.description - resources.regionHealthSources.methods.list.parameters.project.location - resources.regionHealthSources.methods.list.parameters.project.pattern - resources.regionHealthSources.methods.list.parameters.project.required - resources.regionHealthSources.methods.list.parameters.project.type - resources.regionHealthSources.methods.list.parameters.region.description - resources.regionHealthSources.methods.list.parameters.region.location - resources.regionHealthSources.methods.list.parameters.region.pattern - resources.regionHealthSources.methods.list.parameters.region.required - resources.regionHealthSources.methods.list.parameters.region.type - resources.regionHealthSources.methods.list.parameters.returnPartialSuccess.description - resources.regionHealthSources.methods.list.parameters.returnPartialSuccess.location - resources.regionHealthSources.methods.list.parameters.returnPartialSuccess.type - resources.regionHealthSources.methods.list.path - resources.regionHealthSources.methods.list.response.$ref - resources.regionHealthSources.methods.list.scopes - resources.regionHealthSources.methods.patch.description - resources.regionHealthSources.methods.patch.flatPath - resources.regionHealthSources.methods.patch.httpMethod - resources.regionHealthSources.methods.patch.id - resources.regionHealthSources.methods.patch.parameterOrder - resources.regionHealthSources.methods.patch.parameters.healthSource.description - resources.regionHealthSources.methods.patch.parameters.healthSource.location - resources.regionHealthSources.methods.patch.parameters.healthSource.required - resources.regionHealthSources.methods.patch.parameters.healthSource.type - resources.regionHealthSources.methods.patch.parameters.project.description - resources.regionHealthSources.methods.patch.parameters.project.location - resources.regionHealthSources.methods.patch.parameters.project.pattern - resources.regionHealthSources.methods.patch.parameters.project.required - resources.regionHealthSources.methods.patch.parameters.project.type - resources.regionHealthSources.methods.patch.parameters.region.description - resources.regionHealthSources.methods.patch.parameters.region.location - resources.regionHealthSources.methods.patch.parameters.region.pattern - resources.regionHealthSources.methods.patch.parameters.region.required - resources.regionHealthSources.methods.patch.parameters.region.type - resources.regionHealthSources.methods.patch.parameters.requestId.description - resources.regionHealthSources.methods.patch.parameters.requestId.location - resources.regionHealthSources.methods.patch.parameters.requestId.type - resources.regionHealthSources.methods.patch.path - resources.regionHealthSources.methods.patch.request.$ref - resources.regionHealthSources.methods.patch.response.$ref - resources.regionHealthSources.methods.patch.scopes - resources.regionHealthSources.methods.testIamPermissions.description - resources.regionHealthSources.methods.testIamPermissions.flatPath - resources.regionHealthSources.methods.testIamPermissions.httpMethod - resources.regionHealthSources.methods.testIamPermissions.id - resources.regionHealthSources.methods.testIamPermissions.parameterOrder - resources.regionHealthSources.methods.testIamPermissions.parameters.project.description - resources.regionHealthSources.methods.testIamPermissions.parameters.project.location - resources.regionHealthSources.methods.testIamPermissions.parameters.project.pattern - resources.regionHealthSources.methods.testIamPermissions.parameters.project.required - resources.regionHealthSources.methods.testIamPermissions.parameters.project.type - resources.regionHealthSources.methods.testIamPermissions.parameters.region.description - resources.regionHealthSources.methods.testIamPermissions.parameters.region.location - resources.regionHealthSources.methods.testIamPermissions.parameters.region.pattern - resources.regionHealthSources.methods.testIamPermissions.parameters.region.required - resources.regionHealthSources.methods.testIamPermissions.parameters.region.type - resources.regionHealthSources.methods.testIamPermissions.parameters.resource.description - resources.regionHealthSources.methods.testIamPermissions.parameters.resource.location - resources.regionHealthSources.methods.testIamPermissions.parameters.resource.pattern - resources.regionHealthSources.methods.testIamPermissions.parameters.resource.required - resources.regionHealthSources.methods.testIamPermissions.parameters.resource.type - resources.regionHealthSources.methods.testIamPermissions.path - resources.regionHealthSources.methods.testIamPermissions.request.$ref - resources.regionHealthSources.methods.testIamPermissions.response.$ref - resources.regionHealthSources.methods.testIamPermissions.scopes - resources.regionMultiMigMembers.methods.get.description - resources.regionMultiMigMembers.methods.get.flatPath - resources.regionMultiMigMembers.methods.get.httpMethod - resources.regionMultiMigMembers.methods.get.id - resources.regionMultiMigMembers.methods.get.parameterOrder - resources.regionMultiMigMembers.methods.get.parameters.multiMig.description - resources.regionMultiMigMembers.methods.get.parameters.multiMig.location - resources.regionMultiMigMembers.methods.get.parameters.multiMig.pattern - resources.regionMultiMigMembers.methods.get.parameters.multiMig.required - resources.regionMultiMigMembers.methods.get.parameters.multiMig.type - resources.regionMultiMigMembers.methods.get.parameters.multiMigMember.description - resources.regionMultiMigMembers.methods.get.parameters.multiMigMember.location - resources.regionMultiMigMembers.methods.get.parameters.multiMigMember.pattern - resources.regionMultiMigMembers.methods.get.parameters.multiMigMember.required - resources.regionMultiMigMembers.methods.get.parameters.multiMigMember.type - resources.regionMultiMigMembers.methods.get.parameters.project.description - resources.regionMultiMigMembers.methods.get.parameters.project.location - resources.regionMultiMigMembers.methods.get.parameters.project.pattern - resources.regionMultiMigMembers.methods.get.parameters.project.required - resources.regionMultiMigMembers.methods.get.parameters.project.type - resources.regionMultiMigMembers.methods.get.parameters.region.description - resources.regionMultiMigMembers.methods.get.parameters.region.location - resources.regionMultiMigMembers.methods.get.parameters.region.pattern - resources.regionMultiMigMembers.methods.get.parameters.region.required - resources.regionMultiMigMembers.methods.get.parameters.region.type - resources.regionMultiMigMembers.methods.get.path - resources.regionMultiMigMembers.methods.get.response.$ref - resources.regionMultiMigMembers.methods.get.scopes - resources.regionMultiMigMembers.methods.list.description - resources.regionMultiMigMembers.methods.list.flatPath - resources.regionMultiMigMembers.methods.list.httpMethod - resources.regionMultiMigMembers.methods.list.id - resources.regionMultiMigMembers.methods.list.parameterOrder - resources.regionMultiMigMembers.methods.list.parameters.filter.description - resources.regionMultiMigMembers.methods.list.parameters.filter.location - resources.regionMultiMigMembers.methods.list.parameters.filter.type - resources.regionMultiMigMembers.methods.list.parameters.maxResults.default - resources.regionMultiMigMembers.methods.list.parameters.maxResults.description - resources.regionMultiMigMembers.methods.list.parameters.maxResults.format - resources.regionMultiMigMembers.methods.list.parameters.maxResults.location - resources.regionMultiMigMembers.methods.list.parameters.maxResults.minimum - resources.regionMultiMigMembers.methods.list.parameters.maxResults.type - resources.regionMultiMigMembers.methods.list.parameters.multiMig.description - resources.regionMultiMigMembers.methods.list.parameters.multiMig.location - resources.regionMultiMigMembers.methods.list.parameters.multiMig.required - resources.regionMultiMigMembers.methods.list.parameters.multiMig.type - resources.regionMultiMigMembers.methods.list.parameters.orderBy.description - resources.regionMultiMigMembers.methods.list.parameters.orderBy.location - resources.regionMultiMigMembers.methods.list.parameters.orderBy.type - resources.regionMultiMigMembers.methods.list.parameters.pageToken.description - resources.regionMultiMigMembers.methods.list.parameters.pageToken.location - resources.regionMultiMigMembers.methods.list.parameters.pageToken.type - resources.regionMultiMigMembers.methods.list.parameters.project.description - resources.regionMultiMigMembers.methods.list.parameters.project.location - resources.regionMultiMigMembers.methods.list.parameters.project.required - resources.regionMultiMigMembers.methods.list.parameters.project.type - resources.regionMultiMigMembers.methods.list.parameters.region.description - resources.regionMultiMigMembers.methods.list.parameters.region.location - resources.regionMultiMigMembers.methods.list.parameters.region.pattern - resources.regionMultiMigMembers.methods.list.parameters.region.required - resources.regionMultiMigMembers.methods.list.parameters.region.type - resources.regionMultiMigMembers.methods.list.parameters.returnPartialSuccess.description - resources.regionMultiMigMembers.methods.list.parameters.returnPartialSuccess.location - resources.regionMultiMigMembers.methods.list.parameters.returnPartialSuccess.type - resources.regionMultiMigMembers.methods.list.path - resources.regionMultiMigMembers.methods.list.response.$ref - resources.regionMultiMigMembers.methods.list.scopes - schemas.AllocationResourceStatus.properties.aggregateAllocation.$ref - schemas.AllocationResourceStatus.properties.aggregateAllocation.description - schemas.AllocationResourceStatusAggregateAllocation.description - schemas.AllocationResourceStatusAggregateAllocation.id - schemas.AllocationResourceStatusAggregateAllocation.properties.utilizations.additionalProperties.format - schemas.AllocationResourceStatusAggregateAllocation.properties.utilizations.additionalProperties.type - schemas.AllocationResourceStatusAggregateAllocation.properties.utilizations.description - schemas.AllocationResourceStatusAggregateAllocation.properties.utilizations.type - schemas.AllocationResourceStatusAggregateAllocation.type - schemas.BackendService.properties.dynamicForwarding.$ref - schemas.BackendService.properties.dynamicForwarding.description - schemas.BackendServiceDynamicForwarding.description - schemas.BackendServiceDynamicForwarding.id - schemas.BackendServiceDynamicForwarding.properties.ipPortSelection.$ref - schemas.BackendServiceDynamicForwarding.properties.ipPortSelection.description - schemas.BackendServiceDynamicForwarding.type - schemas.BackendServiceDynamicForwardingIpPortSelection.description - schemas.BackendServiceDynamicForwardingIpPortSelection.id - schemas.BackendServiceDynamicForwardingIpPortSelection.properties.enabled.description - schemas.BackendServiceDynamicForwardingIpPortSelection.properties.enabled.type - schemas.BackendServiceDynamicForwardingIpPortSelection.type - schemas.BulkSetLabelsRequest.id - schemas.BulkSetLabelsRequest.properties.labelFingerprint.description - schemas.BulkSetLabelsRequest.properties.labelFingerprint.format - schemas.BulkSetLabelsRequest.properties.labelFingerprint.type - schemas.BulkSetLabelsRequest.properties.labels.additionalProperties.type - schemas.BulkSetLabelsRequest.properties.labels.description - schemas.BulkSetLabelsRequest.properties.labels.type - schemas.BulkSetLabelsRequest.type - schemas.BulkZoneSetLabelsRequest.id - schemas.BulkZoneSetLabelsRequest.properties.requests.items.$ref - schemas.BulkZoneSetLabelsRequest.properties.requests.type - schemas.BulkZoneSetLabelsRequest.type - schemas.CompositeHealthCheck.description - schemas.CompositeHealthCheck.id - schemas.CompositeHealthCheck.properties.creationTimestamp.description - schemas.CompositeHealthCheck.properties.creationTimestamp.type - schemas.CompositeHealthCheck.properties.description.description - schemas.CompositeHealthCheck.properties.description.type - schemas.CompositeHealthCheck.properties.fingerprint.description - schemas.CompositeHealthCheck.properties.fingerprint.format - schemas.CompositeHealthCheck.properties.fingerprint.type - schemas.CompositeHealthCheck.properties.healthDestination.description - schemas.CompositeHealthCheck.properties.healthDestination.type - schemas.CompositeHealthCheck.properties.healthSources.description - schemas.CompositeHealthCheck.properties.healthSources.items.type - schemas.CompositeHealthCheck.properties.healthSources.type - schemas.CompositeHealthCheck.properties.id.description - schemas.CompositeHealthCheck.properties.id.format - schemas.CompositeHealthCheck.properties.id.type - schemas.CompositeHealthCheck.properties.kind.default - schemas.CompositeHealthCheck.properties.kind.description - schemas.CompositeHealthCheck.properties.kind.type - schemas.CompositeHealthCheck.properties.name.description - schemas.CompositeHealthCheck.properties.name.pattern - schemas.CompositeHealthCheck.properties.name.type - schemas.CompositeHealthCheck.properties.region.description - schemas.CompositeHealthCheck.properties.region.type - schemas.CompositeHealthCheck.properties.selfLink.description - schemas.CompositeHealthCheck.properties.selfLink.type - schemas.CompositeHealthCheck.properties.selfLinkWithId.description - schemas.CompositeHealthCheck.properties.selfLinkWithId.type - schemas.CompositeHealthCheck.type - schemas.CompositeHealthCheckAggregatedList.description - schemas.CompositeHealthCheckAggregatedList.id - schemas.CompositeHealthCheckAggregatedList.properties.etag.type - schemas.CompositeHealthCheckAggregatedList.properties.id.description - schemas.CompositeHealthCheckAggregatedList.properties.id.type - schemas.CompositeHealthCheckAggregatedList.properties.items.additionalProperties.$ref - schemas.CompositeHealthCheckAggregatedList.properties.items.additionalProperties.description - schemas.CompositeHealthCheckAggregatedList.properties.items.description - schemas.CompositeHealthCheckAggregatedList.properties.items.type - schemas.CompositeHealthCheckAggregatedList.properties.kind.default - schemas.CompositeHealthCheckAggregatedList.properties.kind.description - schemas.CompositeHealthCheckAggregatedList.properties.kind.type - schemas.CompositeHealthCheckAggregatedList.properties.nextPageToken.description - schemas.CompositeHealthCheckAggregatedList.properties.nextPageToken.type - schemas.CompositeHealthCheckAggregatedList.properties.selfLink.description - schemas.CompositeHealthCheckAggregatedList.properties.selfLink.type - schemas.CompositeHealthCheckAggregatedList.properties.unreachables.description - schemas.CompositeHealthCheckAggregatedList.properties.unreachables.items.type - schemas.CompositeHealthCheckAggregatedList.properties.unreachables.type - schemas.CompositeHealthCheckAggregatedList.properties.warning.description - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.code.description - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.code.enum - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.code.enumDeprecated - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.code.enumDescriptions - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.code.type - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.data.description - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.data.items.properties.key.description - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.data.items.properties.key.type - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.data.items.properties.value.description - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.data.items.properties.value.type - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.data.items.type - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.data.type - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.message.description - schemas.CompositeHealthCheckAggregatedList.properties.warning.properties.message.type - schemas.CompositeHealthCheckAggregatedList.properties.warning.type - schemas.CompositeHealthCheckAggregatedList.type - schemas.CompositeHealthCheckList.id - schemas.CompositeHealthCheckList.properties.etag.type - schemas.CompositeHealthCheckList.properties.id.description - schemas.CompositeHealthCheckList.properties.id.type - schemas.CompositeHealthCheckList.properties.items.description - schemas.CompositeHealthCheckList.properties.items.items.$ref - schemas.CompositeHealthCheckList.properties.items.type - schemas.CompositeHealthCheckList.properties.kind.default - schemas.CompositeHealthCheckList.properties.kind.description - schemas.CompositeHealthCheckList.properties.kind.type - schemas.CompositeHealthCheckList.properties.nextPageToken.description - schemas.CompositeHealthCheckList.properties.nextPageToken.type - schemas.CompositeHealthCheckList.properties.selfLink.description - schemas.CompositeHealthCheckList.properties.selfLink.type - schemas.CompositeHealthCheckList.properties.unreachables.description - schemas.CompositeHealthCheckList.properties.unreachables.items.type - schemas.CompositeHealthCheckList.properties.unreachables.type - schemas.CompositeHealthCheckList.properties.warning.description - schemas.CompositeHealthCheckList.properties.warning.properties.code.description - schemas.CompositeHealthCheckList.properties.warning.properties.code.enum - schemas.CompositeHealthCheckList.properties.warning.properties.code.enumDeprecated - schemas.CompositeHealthCheckList.properties.warning.properties.code.enumDescriptions - schemas.CompositeHealthCheckList.properties.warning.properties.code.type - schemas.CompositeHealthCheckList.properties.warning.properties.data.description - schemas.CompositeHealthCheckList.properties.warning.properties.data.items.properties.key.description - schemas.CompositeHealthCheckList.properties.warning.properties.data.items.properties.key.type - schemas.CompositeHealthCheckList.properties.warning.properties.data.items.properties.value.description - schemas.CompositeHealthCheckList.properties.warning.properties.data.items.properties.value.type - schemas.CompositeHealthCheckList.properties.warning.properties.data.items.type - schemas.CompositeHealthCheckList.properties.warning.properties.data.type - schemas.CompositeHealthCheckList.properties.warning.properties.message.description - schemas.CompositeHealthCheckList.properties.warning.properties.message.type - schemas.CompositeHealthCheckList.properties.warning.type - schemas.CompositeHealthCheckList.type - schemas.CompositeHealthChecksScopedList.id - schemas.CompositeHealthChecksScopedList.properties.resources.description - schemas.CompositeHealthChecksScopedList.properties.resources.items.$ref - schemas.CompositeHealthChecksScopedList.properties.resources.type - schemas.CompositeHealthChecksScopedList.properties.warning.description - schemas.CompositeHealthChecksScopedList.properties.warning.properties.code.description - schemas.CompositeHealthChecksScopedList.properties.warning.properties.code.enum - schemas.CompositeHealthChecksScopedList.properties.warning.properties.code.enumDeprecated - schemas.CompositeHealthChecksScopedList.properties.warning.properties.code.enumDescriptions - schemas.CompositeHealthChecksScopedList.properties.warning.properties.code.type - schemas.CompositeHealthChecksScopedList.properties.warning.properties.data.description - schemas.CompositeHealthChecksScopedList.properties.warning.properties.data.items.properties.key.description - schemas.CompositeHealthChecksScopedList.properties.warning.properties.data.items.properties.key.type - schemas.CompositeHealthChecksScopedList.properties.warning.properties.data.items.properties.value.description - schemas.CompositeHealthChecksScopedList.properties.warning.properties.data.items.properties.value.type - schemas.CompositeHealthChecksScopedList.properties.warning.properties.data.items.type - schemas.CompositeHealthChecksScopedList.properties.warning.properties.data.type - schemas.CompositeHealthChecksScopedList.properties.warning.properties.message.description - schemas.CompositeHealthChecksScopedList.properties.warning.properties.message.type - schemas.CompositeHealthChecksScopedList.properties.warning.type - schemas.CompositeHealthChecksScopedList.type - schemas.ConfidentialInstanceConfig.properties.confidentialParavisorConfig.$ref - schemas.ConfidentialInstanceConfig.properties.confidentialParavisorConfig.description - schemas.ConfidentialParavisorConfig.description - schemas.ConfidentialParavisorConfig.id - schemas.ConfidentialParavisorConfig.properties.confidentialTpmType.enum - schemas.ConfidentialParavisorConfig.properties.confidentialTpmType.enumDescriptions - schemas.ConfidentialParavisorConfig.properties.confidentialTpmType.type - schemas.ConfidentialParavisorConfig.properties.sevSnpIrqMode.enum - schemas.ConfidentialParavisorConfig.properties.sevSnpIrqMode.enumDescriptions - schemas.ConfidentialParavisorConfig.properties.sevSnpIrqMode.type - schemas.ConfidentialParavisorConfig.type - schemas.DiskSettingsAccessLocation.properties.policy.description - schemas.DiskSettingsAccessLocation.properties.policy.enum - schemas.DiskSettingsAccessLocation.properties.policy.enumDescriptions - schemas.DiskSettingsAccessLocation.properties.policy.type - schemas.HealthAggregationPolicy.description - schemas.HealthAggregationPolicy.id - schemas.HealthAggregationPolicy.properties.creationTimestamp.description - schemas.HealthAggregationPolicy.properties.creationTimestamp.type - schemas.HealthAggregationPolicy.properties.description.description - schemas.HealthAggregationPolicy.properties.description.type - schemas.HealthAggregationPolicy.properties.fingerprint.description - schemas.HealthAggregationPolicy.properties.fingerprint.format - schemas.HealthAggregationPolicy.properties.fingerprint.type - schemas.HealthAggregationPolicy.properties.healthyPercentThreshold.description - schemas.HealthAggregationPolicy.properties.healthyPercentThreshold.format - schemas.HealthAggregationPolicy.properties.healthyPercentThreshold.type - schemas.HealthAggregationPolicy.properties.id.description - schemas.HealthAggregationPolicy.properties.id.format - schemas.HealthAggregationPolicy.properties.id.type - schemas.HealthAggregationPolicy.properties.kind.default - schemas.HealthAggregationPolicy.properties.kind.description - schemas.HealthAggregationPolicy.properties.kind.type - schemas.HealthAggregationPolicy.properties.minHealthyThreshold.description - schemas.HealthAggregationPolicy.properties.minHealthyThreshold.format - schemas.HealthAggregationPolicy.properties.minHealthyThreshold.type - schemas.HealthAggregationPolicy.properties.name.description - schemas.HealthAggregationPolicy.properties.name.pattern - schemas.HealthAggregationPolicy.properties.name.type - schemas.HealthAggregationPolicy.properties.policyType.description - schemas.HealthAggregationPolicy.properties.policyType.enum - schemas.HealthAggregationPolicy.properties.policyType.enumDescriptions - schemas.HealthAggregationPolicy.properties.policyType.type - schemas.HealthAggregationPolicy.properties.region.description - schemas.HealthAggregationPolicy.properties.region.type - schemas.HealthAggregationPolicy.properties.selfLink.description - schemas.HealthAggregationPolicy.properties.selfLink.type - schemas.HealthAggregationPolicy.properties.selfLinkWithId.description - schemas.HealthAggregationPolicy.properties.selfLinkWithId.type - schemas.HealthAggregationPolicy.type - schemas.HealthAggregationPolicyList.id - schemas.HealthAggregationPolicyList.properties.etag.type - schemas.HealthAggregationPolicyList.properties.id.description - schemas.HealthAggregationPolicyList.properties.id.type - schemas.HealthAggregationPolicyList.properties.items.description - schemas.HealthAggregationPolicyList.properties.items.items.$ref - schemas.HealthAggregationPolicyList.properties.items.type - schemas.HealthAggregationPolicyList.properties.kind.default - schemas.HealthAggregationPolicyList.properties.kind.description - schemas.HealthAggregationPolicyList.properties.kind.type - schemas.HealthAggregationPolicyList.properties.nextPageToken.description - schemas.HealthAggregationPolicyList.properties.nextPageToken.type - schemas.HealthAggregationPolicyList.properties.selfLink.description - schemas.HealthAggregationPolicyList.properties.selfLink.type - schemas.HealthAggregationPolicyList.properties.unreachables.description - schemas.HealthAggregationPolicyList.properties.unreachables.items.type - schemas.HealthAggregationPolicyList.properties.unreachables.type - schemas.HealthAggregationPolicyList.properties.warning.description - schemas.HealthAggregationPolicyList.properties.warning.properties.code.description - schemas.HealthAggregationPolicyList.properties.warning.properties.code.enum - schemas.HealthAggregationPolicyList.properties.warning.properties.code.enumDeprecated - schemas.HealthAggregationPolicyList.properties.warning.properties.code.enumDescriptions - schemas.HealthAggregationPolicyList.properties.warning.properties.code.type - schemas.HealthAggregationPolicyList.properties.warning.properties.data.description - schemas.HealthAggregationPolicyList.properties.warning.properties.data.items.properties.key.description - schemas.HealthAggregationPolicyList.properties.warning.properties.data.items.properties.key.type - schemas.HealthAggregationPolicyList.properties.warning.properties.data.items.properties.value.description - schemas.HealthAggregationPolicyList.properties.warning.properties.data.items.properties.value.type - schemas.HealthAggregationPolicyList.properties.warning.properties.data.items.type - schemas.HealthAggregationPolicyList.properties.warning.properties.data.type - schemas.HealthAggregationPolicyList.properties.warning.properties.message.description - schemas.HealthAggregationPolicyList.properties.warning.properties.message.type - schemas.HealthAggregationPolicyList.properties.warning.type - schemas.HealthAggregationPolicyList.type - schemas.HealthSource.description - schemas.HealthSource.id - schemas.HealthSource.properties.creationTimestamp.description - schemas.HealthSource.properties.creationTimestamp.type - schemas.HealthSource.properties.description.description - schemas.HealthSource.properties.description.type - schemas.HealthSource.properties.fingerprint.description - schemas.HealthSource.properties.fingerprint.format - schemas.HealthSource.properties.fingerprint.type - schemas.HealthSource.properties.healthAggregationPolicy.description - schemas.HealthSource.properties.healthAggregationPolicy.type - schemas.HealthSource.properties.id.description - schemas.HealthSource.properties.id.format - schemas.HealthSource.properties.id.type - schemas.HealthSource.properties.kind.default - schemas.HealthSource.properties.kind.description - schemas.HealthSource.properties.kind.type - schemas.HealthSource.properties.name.description - schemas.HealthSource.properties.name.pattern - schemas.HealthSource.properties.name.type - schemas.HealthSource.properties.region.description - schemas.HealthSource.properties.region.type - schemas.HealthSource.properties.selfLink.description - schemas.HealthSource.properties.selfLink.type - schemas.HealthSource.properties.selfLinkWithId.description - schemas.HealthSource.properties.selfLinkWithId.type - schemas.HealthSource.properties.sourceType.description - schemas.HealthSource.properties.sourceType.enum - schemas.HealthSource.properties.sourceType.enumDescriptions - schemas.HealthSource.properties.sourceType.type - schemas.HealthSource.properties.sources.description - schemas.HealthSource.properties.sources.items.type - schemas.HealthSource.properties.sources.type - schemas.HealthSource.type - schemas.HealthSourceAggregatedList.description - schemas.HealthSourceAggregatedList.id - schemas.HealthSourceAggregatedList.properties.etag.type - schemas.HealthSourceAggregatedList.properties.id.description - schemas.HealthSourceAggregatedList.properties.id.type - schemas.HealthSourceAggregatedList.properties.items.additionalProperties.$ref - schemas.HealthSourceAggregatedList.properties.items.additionalProperties.description - schemas.HealthSourceAggregatedList.properties.items.description - schemas.HealthSourceAggregatedList.properties.items.type - schemas.HealthSourceAggregatedList.properties.kind.default - schemas.HealthSourceAggregatedList.properties.kind.description - schemas.HealthSourceAggregatedList.properties.kind.type - schemas.HealthSourceAggregatedList.properties.nextPageToken.description - schemas.HealthSourceAggregatedList.properties.nextPageToken.type - schemas.HealthSourceAggregatedList.properties.selfLink.description - schemas.HealthSourceAggregatedList.properties.selfLink.type - schemas.HealthSourceAggregatedList.properties.unreachables.description - schemas.HealthSourceAggregatedList.properties.unreachables.items.type - schemas.HealthSourceAggregatedList.properties.unreachables.type - schemas.HealthSourceAggregatedList.properties.warning.description - schemas.HealthSourceAggregatedList.properties.warning.properties.code.description - schemas.HealthSourceAggregatedList.properties.warning.properties.code.enum - schemas.HealthSourceAggregatedList.properties.warning.properties.code.enumDeprecated - schemas.HealthSourceAggregatedList.properties.warning.properties.code.enumDescriptions - schemas.HealthSourceAggregatedList.properties.warning.properties.code.type - schemas.HealthSourceAggregatedList.properties.warning.properties.data.description - schemas.HealthSourceAggregatedList.properties.warning.properties.data.items.properties.key.description - schemas.HealthSourceAggregatedList.properties.warning.properties.data.items.properties.key.type - schemas.HealthSourceAggregatedList.properties.warning.properties.data.items.properties.value.description - schemas.HealthSourceAggregatedList.properties.warning.properties.data.items.properties.value.type - schemas.HealthSourceAggregatedList.properties.warning.properties.data.items.type - schemas.HealthSourceAggregatedList.properties.warning.properties.data.type - schemas.HealthSourceAggregatedList.properties.warning.properties.message.description - schemas.HealthSourceAggregatedList.properties.warning.properties.message.type - schemas.HealthSourceAggregatedList.properties.warning.type - schemas.HealthSourceAggregatedList.type - schemas.HealthSourceList.id - schemas.HealthSourceList.properties.etag.type - schemas.HealthSourceList.properties.id.description - schemas.HealthSourceList.properties.id.type - schemas.HealthSourceList.properties.items.description - schemas.HealthSourceList.properties.items.items.$ref - schemas.HealthSourceList.properties.items.type - schemas.HealthSourceList.properties.kind.default - schemas.HealthSourceList.properties.kind.description - schemas.HealthSourceList.properties.kind.type - schemas.HealthSourceList.properties.nextPageToken.description - schemas.HealthSourceList.properties.nextPageToken.type - schemas.HealthSourceList.properties.selfLink.description - schemas.HealthSourceList.properties.selfLink.type - schemas.HealthSourceList.properties.unreachables.description - schemas.HealthSourceList.properties.unreachables.items.type - schemas.HealthSourceList.properties.unreachables.type - schemas.HealthSourceList.properties.warning.description - schemas.HealthSourceList.properties.warning.properties.code.description - schemas.HealthSourceList.properties.warning.properties.code.enum - schemas.HealthSourceList.properties.warning.properties.code.enumDeprecated - schemas.HealthSourceList.properties.warning.properties.code.enumDescriptions - schemas.HealthSourceList.properties.warning.properties.code.type - schemas.HealthSourceList.properties.warning.properties.data.description - schemas.HealthSourceList.properties.warning.properties.data.items.properties.key.description - schemas.HealthSourceList.properties.warning.properties.data.items.properties.key.type - schemas.HealthSourceList.properties.warning.properties.data.items.properties.value.description - schemas.HealthSourceList.properties.warning.properties.data.items.properties.value.type - schemas.HealthSourceList.properties.warning.properties.data.items.type - schemas.HealthSourceList.properties.warning.properties.data.type - schemas.HealthSourceList.properties.warning.properties.message.description - schemas.HealthSourceList.properties.warning.properties.message.type - schemas.HealthSourceList.properties.warning.type - schemas.HealthSourceList.type - schemas.HealthSourcesScopedList.id - schemas.HealthSourcesScopedList.properties.resources.description - schemas.HealthSourcesScopedList.properties.resources.items.$ref - schemas.HealthSourcesScopedList.properties.resources.type - schemas.HealthSourcesScopedList.properties.warning.description - schemas.HealthSourcesScopedList.properties.warning.properties.code.description - schemas.HealthSourcesScopedList.properties.warning.properties.code.enum - schemas.HealthSourcesScopedList.properties.warning.properties.code.enumDeprecated - schemas.HealthSourcesScopedList.properties.warning.properties.code.enumDescriptions - schemas.HealthSourcesScopedList.properties.warning.properties.code.type - schemas.HealthSourcesScopedList.properties.warning.properties.data.description - schemas.HealthSourcesScopedList.properties.warning.properties.data.items.properties.key.description - schemas.HealthSourcesScopedList.properties.warning.properties.data.items.properties.key.type - schemas.HealthSourcesScopedList.properties.warning.properties.data.items.properties.value.description - schemas.HealthSourcesScopedList.properties.warning.properties.data.items.properties.value.type - schemas.HealthSourcesScopedList.properties.warning.properties.data.items.type - schemas.HealthSourcesScopedList.properties.warning.properties.data.type - schemas.HealthSourcesScopedList.properties.warning.properties.message.description - schemas.HealthSourcesScopedList.properties.warning.properties.message.type - schemas.HealthSourcesScopedList.properties.warning.type - schemas.HealthSourcesScopedList.type - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.description - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.enum - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.enumDescriptions - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.type - schemas.InterconnectAttachmentGroupsCreateMembers.id - schemas.InterconnectAttachmentGroupsCreateMembers.properties.attachments.description - schemas.InterconnectAttachmentGroupsCreateMembers.properties.attachments.items.$ref - schemas.InterconnectAttachmentGroupsCreateMembers.properties.attachments.type - schemas.InterconnectAttachmentGroupsCreateMembers.properties.intentMismatchBehavior.description - schemas.InterconnectAttachmentGroupsCreateMembers.properties.intentMismatchBehavior.enum - schemas.InterconnectAttachmentGroupsCreateMembers.properties.intentMismatchBehavior.enumDescriptions - schemas.InterconnectAttachmentGroupsCreateMembers.properties.intentMismatchBehavior.type - schemas.InterconnectAttachmentGroupsCreateMembers.properties.templateAttachment.$ref - schemas.InterconnectAttachmentGroupsCreateMembers.properties.templateAttachment.description - schemas.InterconnectAttachmentGroupsCreateMembers.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.id - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.adminEnabled.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.adminEnabled.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.bandwidth.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.bandwidth.enum - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.bandwidth.enumDescriptions - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.bandwidth.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateCloudRouterIpAddress.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateCloudRouterIpAddress.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateCloudRouterIpv6Address.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateCloudRouterIpv6Address.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateCustomerRouterIpAddress.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateCustomerRouterIpAddress.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateCustomerRouterIpv6Address.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateCustomerRouterIpv6Address.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateIpv6Subnets.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateIpv6Subnets.items.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateIpv6Subnets.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateSubnets.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateSubnets.items.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.candidateSubnets.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.cloudRouterIpv6InterfaceId.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.cloudRouterIpv6InterfaceId.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.customerRouterIpv6InterfaceId.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.customerRouterIpv6InterfaceId.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.description.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.description.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.edgeAvailabilityDomain.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.edgeAvailabilityDomain.enum - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.edgeAvailabilityDomain.enumDescriptions - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.edgeAvailabilityDomain.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.encryption.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.encryption.enum - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.encryption.enumDescriptions - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.encryption.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.interconnect.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.interconnect.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.ipsecInternalAddresses.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.ipsecInternalAddresses.items.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.ipsecInternalAddresses.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.l2Forwarding.$ref - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.l2Forwarding.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.mtu.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.mtu.format - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.mtu.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.multicastEnabled.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.multicastEnabled.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.name.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.name.pattern - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.name.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.pairingKey.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.pairingKey.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.partnerAsn.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.partnerAsn.format - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.partnerAsn.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.partnerMetadata.$ref - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.partnerMetadata.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.region.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.region.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.router.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.router.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.stackType.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.stackType.enum - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.stackType.enumDescriptions - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.stackType.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.subnetLength.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.subnetLength.format - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.subnetLength.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.type.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.type.enum - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.type.enumDescriptions - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.type.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.vlanTag8021q.description - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.vlanTag8021q.format - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.properties.vlanTag8021q.type - schemas.InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput.type - schemas.InterconnectAttachmentGroupsCreateMembersRequest.id - schemas.InterconnectAttachmentGroupsCreateMembersRequest.properties.request.$ref - schemas.InterconnectAttachmentGroupsCreateMembersRequest.type - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.attachmentStatuses.items.$ref - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.attachmentStatuses.type - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.configured.$ref - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.intent.$ref - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.operational.$ref - schemas.InterconnectAttachmentGroupsOperationalStatus.properties.operational.description - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.description - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.id - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.adminEnabled.description - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.adminEnabled.type - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.attachment.description - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.attachment.type - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.isActive.description - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.isActive.enum - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.isActive.enumDescriptions - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.isActive.type - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.status.description - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.status.enum - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.status.enumDescriptions - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.properties.status.type - schemas.InterconnectAttachmentGroupsOperationalStatusAttachmentStatus.type - schemas.InterconnectGroupsCreateMembers.id - schemas.InterconnectGroupsCreateMembers.properties.intentMismatchBehavior.description - schemas.InterconnectGroupsCreateMembers.properties.intentMismatchBehavior.enum - schemas.InterconnectGroupsCreateMembers.properties.intentMismatchBehavior.enumDescriptions - schemas.InterconnectGroupsCreateMembers.properties.intentMismatchBehavior.type - schemas.InterconnectGroupsCreateMembers.properties.interconnects.items.$ref - schemas.InterconnectGroupsCreateMembers.properties.interconnects.type - schemas.InterconnectGroupsCreateMembers.properties.templateInterconnect.$ref - schemas.InterconnectGroupsCreateMembers.properties.templateInterconnect.description - schemas.InterconnectGroupsCreateMembers.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.id - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.adminEnabled.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.adminEnabled.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.customerName.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.customerName.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.description.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.description.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.facility.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.facility.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.interconnectType.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.interconnectType.enum - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.interconnectType.enumDescriptions - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.interconnectType.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.linkType.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.linkType.enum - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.linkType.enumDescriptions - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.linkType.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.name.annotations.required - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.name.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.name.pattern - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.name.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.nocContactEmail.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.nocContactEmail.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.remoteLocation.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.remoteLocation.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.requestedFeatures.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.requestedFeatures.items.enum - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.requestedFeatures.items.enumDescriptions - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.requestedFeatures.items.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.requestedFeatures.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.requestedLinkCount.description - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.requestedLinkCount.format - schemas.InterconnectGroupsCreateMembersInterconnectInput.properties.requestedLinkCount.type - schemas.InterconnectGroupsCreateMembersInterconnectInput.type - schemas.InterconnectGroupsCreateMembersRequest.id - schemas.InterconnectGroupsCreateMembersRequest.properties.request.$ref - schemas.InterconnectGroupsCreateMembersRequest.type - schemas.MachineImage.properties.params.$ref - schemas.MachineImage.properties.params.description - schemas.MachineImageParams.description - schemas.MachineImageParams.id - schemas.MachineImageParams.properties.excludedDisks.description - schemas.MachineImageParams.properties.excludedDisks.items.type - schemas.MachineImageParams.properties.excludedDisks.type - schemas.MachineImageParams.properties.includedDisks.description - schemas.MachineImageParams.properties.includedDisks.items.type - schemas.MachineImageParams.properties.includedDisks.type - schemas.MachineImageParams.type - schemas.MultiMigMember.description - schemas.MultiMigMember.id - schemas.MultiMigMember.properties.creationTimestamp.description - schemas.MultiMigMember.properties.creationTimestamp.type - schemas.MultiMigMember.properties.description.description - schemas.MultiMigMember.properties.description.type - schemas.MultiMigMember.properties.id.description - schemas.MultiMigMember.properties.id.format - schemas.MultiMigMember.properties.id.type - schemas.MultiMigMember.properties.kind.default - schemas.MultiMigMember.properties.kind.description - schemas.MultiMigMember.properties.kind.type - schemas.MultiMigMember.properties.name.description - schemas.MultiMigMember.properties.name.type - schemas.MultiMigMember.properties.region.description - schemas.MultiMigMember.properties.region.type - schemas.MultiMigMember.properties.selfLink.description - schemas.MultiMigMember.properties.selfLink.type - schemas.MultiMigMember.properties.selfLinkWithId.description - schemas.MultiMigMember.properties.selfLinkWithId.type - schemas.MultiMigMember.properties.status.$ref - schemas.MultiMigMember.properties.status.description - schemas.MultiMigMember.type - schemas.MultiMigMemberList.id - schemas.MultiMigMemberList.properties.id.description - schemas.MultiMigMemberList.properties.id.type - schemas.MultiMigMemberList.properties.items.description - schemas.MultiMigMemberList.properties.items.items.$ref - schemas.MultiMigMemberList.properties.items.type - schemas.MultiMigMemberList.properties.kind.default - schemas.MultiMigMemberList.properties.kind.description - schemas.MultiMigMemberList.properties.kind.type - schemas.MultiMigMemberList.properties.nextPageToken.description - schemas.MultiMigMemberList.properties.nextPageToken.type - schemas.MultiMigMemberList.properties.selfLink.description - schemas.MultiMigMemberList.properties.selfLink.type - schemas.MultiMigMemberList.properties.warning.description - schemas.MultiMigMemberList.properties.warning.properties.code.description - schemas.MultiMigMemberList.properties.warning.properties.code.enum - schemas.MultiMigMemberList.properties.warning.properties.code.enumDeprecated - schemas.MultiMigMemberList.properties.warning.properties.code.enumDescriptions - schemas.MultiMigMemberList.properties.warning.properties.code.type - schemas.MultiMigMemberList.properties.warning.properties.data.description - schemas.MultiMigMemberList.properties.warning.properties.data.items.properties.key.description - schemas.MultiMigMemberList.properties.warning.properties.data.items.properties.key.type - schemas.MultiMigMemberList.properties.warning.properties.data.items.properties.value.description - schemas.MultiMigMemberList.properties.warning.properties.data.items.properties.value.type - schemas.MultiMigMemberList.properties.warning.properties.data.items.type - schemas.MultiMigMemberList.properties.warning.properties.data.type - schemas.MultiMigMemberList.properties.warning.properties.message.description - schemas.MultiMigMemberList.properties.warning.properties.message.type - schemas.MultiMigMemberList.properties.warning.type - schemas.MultiMigMemberList.type - schemas.MultiMigMemberStatus.id - schemas.MultiMigMemberStatus.properties.instanceGroupManager.description - schemas.MultiMigMemberStatus.properties.instanceGroupManager.type - schemas.MultiMigMemberStatus.type - schemas.Reservation.properties.reservationMode.description - schemas.Reservation.properties.reservationMode.enum - schemas.Reservation.properties.reservationMode.enumDescriptions - schemas.Reservation.properties.reservationMode.type - schemas.ResourcePolicySnapshotSchedulePolicySnapshotProperties.properties.region.description - schemas.ResourcePolicySnapshotSchedulePolicySnapshotProperties.properties.region.type - schemas.ResourcePolicyWorkloadPolicy.properties.acceleratorTopology.type - schemas.ResourcePolicyWorkloadPolicy.properties.maxTopologyDistance.enum - schemas.ResourcePolicyWorkloadPolicy.properties.maxTopologyDistance.enumDescriptions - schemas.ResourcePolicyWorkloadPolicy.properties.maxTopologyDistance.type - schemas.ResourceStatus.properties.effectiveInstanceMetadata.$ref - schemas.ResourceStatus.properties.effectiveInstanceMetadata.description - schemas.ResourceStatusEffectiveInstanceMetadata.description - schemas.ResourceStatusEffectiveInstanceMetadata.id - schemas.ResourceStatusEffectiveInstanceMetadata.properties.enableOsloginMetadataValue.description - schemas.ResourceStatusEffectiveInstanceMetadata.properties.enableOsloginMetadataValue.type - schemas.ResourceStatusEffectiveInstanceMetadata.properties.vmDnsSettingMetadataValue.description - schemas.ResourceStatusEffectiveInstanceMetadata.properties.vmDnsSettingMetadataValue.type - schemas.ResourceStatusEffectiveInstanceMetadata.type - schemas.RouterStatus.properties.nccGateway.description - schemas.RouterStatus.properties.nccGateway.type - schemas.SnapshotSettingsAccessLocation.properties.policy.description - schemas.SnapshotSettingsAccessLocation.properties.policy.enum - schemas.SnapshotSettingsAccessLocation.properties.policy.enumDescriptions - schemas.SnapshotSettingsAccessLocation.properties.policy.type - schemas.VpnTunnel.properties.cipherSuite.$ref - schemas.VpnTunnel.properties.cipherSuite.description - schemas.VpnTunnelCipherSuite.id - schemas.VpnTunnelCipherSuite.properties.phase1.$ref - schemas.VpnTunnelCipherSuite.properties.phase2.$ref - schemas.VpnTunnelCipherSuite.type - schemas.VpnTunnelPhase1Algorithms.id - schemas.VpnTunnelPhase1Algorithms.properties.dh.items.type - schemas.VpnTunnelPhase1Algorithms.properties.dh.type - schemas.VpnTunnelPhase1Algorithms.properties.encryption.items.type - schemas.VpnTunnelPhase1Algorithms.properties.encryption.type - schemas.VpnTunnelPhase1Algorithms.properties.integrity.items.type - schemas.VpnTunnelPhase1Algorithms.properties.integrity.type - schemas.VpnTunnelPhase1Algorithms.properties.prf.items.type - schemas.VpnTunnelPhase1Algorithms.properties.prf.type - schemas.VpnTunnelPhase1Algorithms.type - schemas.VpnTunnelPhase2Algorithms.id - schemas.VpnTunnelPhase2Algorithms.properties.encryption.items.type - schemas.VpnTunnelPhase2Algorithms.properties.encryption.type - schemas.VpnTunnelPhase2Algorithms.properties.integrity.items.type - schemas.VpnTunnelPhase2Algorithms.properties.integrity.type - schemas.VpnTunnelPhase2Algorithms.properties.pfs.items.type - schemas.VpnTunnelPhase2Algorithms.properties.pfs.type - schemas.VpnTunnelPhase2Algorithms.type The following keys were changed: - resources.organizationSecurityPolicies.methods.addAssociation.description - resources.organizationSecurityPolicies.methods.copyRules.description - resources.organizationSecurityPolicies.methods.delete.description - resources.organizationSecurityPolicies.methods.get.description - resources.organizationSecurityPolicies.methods.getAssociation.description - resources.organizationSecurityPolicies.methods.getRule.description - resources.organizationSecurityPolicies.methods.insert.description - resources.organizationSecurityPolicies.methods.list.description - resources.organizationSecurityPolicies.methods.listAssociations.description - resources.organizationSecurityPolicies.methods.move.description - resources.organizationSecurityPolicies.methods.patch.description - resources.organizationSecurityPolicies.methods.patchRule.description - resources.organizationSecurityPolicies.methods.removeAssociation.description - resources.regionCommitments.methods.update.description - resources.regionCommitments.methods.update.parameters.commitment.description - resources.regionCommitments.methods.updateReservations.description - resources.regionCommitments.methods.updateReservations.parameters.commitment.description - schemas.AllocationAggregateReservation.properties.vmFamily.enum - schemas.AllocationAggregateReservation.properties.vmFamily.enumDescriptions - schemas.BackendCustomMetric.properties.name.description - schemas.BackendServiceCustomMetric.properties.name.description - schemas.CacheInvalidationRule.properties.cacheTags.description - schemas.Commitment.description - schemas.Commitment.properties.autoRenew.description - schemas.Commitment.properties.category.description - schemas.Commitment.properties.customEndTimestamp.description - schemas.Commitment.properties.description.description - schemas.Commitment.properties.mergeSourceCommitments.description - schemas.Commitment.properties.name.description - schemas.Commitment.properties.plan.description - schemas.Commitment.properties.region.description - schemas.Commitment.properties.reservations.description - schemas.Commitment.properties.resources.description - schemas.Commitment.properties.splitSourceCommitment.description - schemas.Commitment.properties.status.description - schemas.Commitment.properties.type.description - schemas.Commitment.properties.type.enum - schemas.Commitment.properties.type.enumDescriptions - schemas.CommitmentsScopedList.properties.commitments.description - schemas.DiskPairReplicationState.properties.dataReplicationState.description - schemas.DiskPairReplicationState.properties.dataReplicationState.enum - schemas.DiskPairReplicationState.properties.dataReplicationState.enumDescriptions - schemas.FutureResourcesSpecAggregateResources.properties.vmFamily.enum - schemas.FutureResourcesSpecAggregateResources.properties.vmFamily.enumDescriptions - schemas.InstanceGroupManagerInstanceLifecyclePolicy.properties.onFailedHealthCheck.description - schemas.Interconnect.properties.availableFeatures.items.enumDescriptions - schemas.Interconnect.properties.requestedFeatures.items.enumDescriptions - schemas.InterconnectLocation.properties.availableFeatures.items.enumDescriptions - schemas.InterconnectLocation.properties.crossSiteInterconnectInfos.description - schemas.InterconnectLocationCrossSiteInterconnectInfo.description - schemas.InterconnectLocationCrossSiteInterconnectInfo.properties.city.description - schemas.LicenseResourceCommitment.properties.amount.description - schemas.LicenseResourceCommitment.properties.coresPerLicense.description - schemas.LicenseResourceCommitment.properties.license.description - schemas.ManagedInstanceInstanceFlexibilityOverride.properties.provisioningModel.enum - schemas.ManagedInstanceInstanceFlexibilityOverride.properties.provisioningModel.enumDescriptions - schemas.ManagedInstancePropertiesFromFlexibilityPolicy.properties.provisioningModel.enum - schemas.ManagedInstancePropertiesFromFlexibilityPolicy.properties.provisioningModel.enumDescriptions - schemas.NetworkInterface.properties.vlan.description - schemas.RegionCommitmentsUpdateReservationsRequest.properties.reservations.description - schemas.ResourceCommitment.description - schemas.ResourceCommitment.properties.acceleratorType.description - schemas.ResourceCommitment.properties.amount.description - schemas.ResourceCommitment.properties.type.description - schemas.RouterBgpPeer.properties.exportPolicies.description - schemas.RouterBgpPeer.properties.importPolicies.description - schemas.RouterInterface.properties.ipRange.description - schemas.Scheduling.properties.provisioningModel.enum - schemas.Scheduling.properties.provisioningModel.enumDescriptions - schemas.Snapshot.properties.sourceInstantSnapshotId.description - schemas.Subnetwork.properties.purpose.description - schemas.TargetHttpsProxy.properties.serverTlsPolicy.description - schemas.UsableSubnetwork.properties.purpose.description - schemas.WireGroupEndpointInterconnect.properties.vlanTags.description - schemas.WireProperties.properties.bandwidthUnmetered.description - schemas.WireProperties.properties.networkServiceClass.enumDescriptions #### compute:beta The following keys were deleted: - schemas.Commitment.properties.existingReservations.description - schemas.NetworkProfile.properties.zone.description - schemas.NetworkProfile.properties.zone.type The following keys were added: - resources.advice.methods.calendarMode.description - resources.advice.methods.calendarMode.flatPath - resources.advice.methods.calendarMode.httpMethod - resources.advice.methods.calendarMode.id - resources.advice.methods.calendarMode.parameterOrder - resources.advice.methods.calendarMode.parameters.project.description - resources.advice.methods.calendarMode.parameters.project.location - resources.advice.methods.calendarMode.parameters.project.pattern - resources.advice.methods.calendarMode.parameters.project.required - resources.advice.methods.calendarMode.parameters.project.type - resources.advice.methods.calendarMode.parameters.region.description - resources.advice.methods.calendarMode.parameters.region.location - resources.advice.methods.calendarMode.parameters.region.pattern - resources.advice.methods.calendarMode.parameters.region.required - resources.advice.methods.calendarMode.parameters.region.type - resources.advice.methods.calendarMode.path - resources.advice.methods.calendarMode.request.$ref - resources.advice.methods.calendarMode.response.$ref - resources.advice.methods.calendarMode.scopes - resources.backendBuckets.methods.listUsable.description - resources.backendBuckets.methods.listUsable.flatPath - resources.backendBuckets.methods.listUsable.httpMethod - resources.backendBuckets.methods.listUsable.id - resources.backendBuckets.methods.listUsable.parameterOrder - resources.backendBuckets.methods.listUsable.parameters.filter.description - resources.backendBuckets.methods.listUsable.parameters.filter.location - resources.backendBuckets.methods.listUsable.parameters.filter.type - resources.backendBuckets.methods.listUsable.parameters.maxResults.default - resources.backendBuckets.methods.listUsable.parameters.maxResults.description - resources.backendBuckets.methods.listUsable.parameters.maxResults.format - resources.backendBuckets.methods.listUsable.parameters.maxResults.location - resources.backendBuckets.methods.listUsable.parameters.maxResults.minimum - resources.backendBuckets.methods.listUsable.parameters.maxResults.type - resources.backendBuckets.methods.listUsable.parameters.orderBy.description - resources.backendBuckets.methods.listUsable.parameters.orderBy.location - resources.backendBuckets.methods.listUsable.parameters.orderBy.type - resources.backendBuckets.methods.listUsable.parameters.pageToken.description - resources.backendBuckets.methods.listUsable.parameters.pageToken.location - resources.backendBuckets.methods.listUsable.parameters.pageToken.type - resources.backendBuckets.methods.listUsable.parameters.project.description - resources.backendBuckets.methods.listUsable.parameters.project.location - resources.backendBuckets.methods.listUsable.parameters.project.pattern - resources.backendBuckets.methods.listUsable.parameters.project.required - resources.backendBuckets.methods.listUsable.parameters.project.type - resources.backendBuckets.methods.listUsable.parameters.returnPartialSuccess.description - resources.backendBuckets.methods.listUsable.parameters.returnPartialSuccess.location - resources.backendBuckets.methods.listUsable.parameters.returnPartialSuccess.type - resources.backendBuckets.methods.listUsable.path - resources.backendBuckets.methods.listUsable.response.$ref - resources.backendBuckets.methods.listUsable.scopes - resources.crossSiteNetworks.methods.delete.description - resources.crossSiteNetworks.methods.delete.flatPath - resources.crossSiteNetworks.methods.delete.httpMethod - resources.crossSiteNetworks.methods.delete.id - resources.crossSiteNetworks.methods.delete.parameterOrder - resources.crossSiteNetworks.methods.delete.parameters.crossSiteNetwork.description - resources.crossSiteNetworks.methods.delete.parameters.crossSiteNetwork.location - resources.crossSiteNetworks.methods.delete.parameters.crossSiteNetwork.pattern - resources.crossSiteNetworks.methods.delete.parameters.crossSiteNetwork.required - resources.crossSiteNetworks.methods.delete.parameters.crossSiteNetwork.type - resources.crossSiteNetworks.methods.delete.parameters.project.description - resources.crossSiteNetworks.methods.delete.parameters.project.location - resources.crossSiteNetworks.methods.delete.parameters.project.pattern - resources.crossSiteNetworks.methods.delete.parameters.project.required - resources.crossSiteNetworks.methods.delete.parameters.project.type - resources.crossSiteNetworks.methods.delete.parameters.requestId.description - resources.crossSiteNetworks.methods.delete.parameters.requestId.location - resources.crossSiteNetworks.methods.delete.parameters.requestId.type - resources.crossSiteNetworks.methods.delete.path - resources.crossSiteNetworks.methods.delete.response.$ref - resources.crossSiteNetworks.methods.delete.scopes - resources.crossSiteNetworks.methods.get.description - resources.crossSiteNetworks.methods.get.flatPath - resources.crossSiteNetworks.methods.get.httpMethod - resources.crossSiteNetworks.methods.get.id - resources.crossSiteNetworks.methods.get.parameterOrder - resources.crossSiteNetworks.methods.get.parameters.crossSiteNetwork.description - resources.crossSiteNetworks.methods.get.parameters.crossSiteNetwork.location - resources.crossSiteNetworks.methods.get.parameters.crossSiteNetwork.pattern - resources.crossSiteNetworks.methods.get.parameters.crossSiteNetwork.required - resources.crossSiteNetworks.methods.get.parameters.crossSiteNetwork.type - resources.crossSiteNetworks.methods.get.parameters.project.description - resources.crossSiteNetworks.methods.get.parameters.project.location - resources.crossSiteNetworks.methods.get.parameters.project.pattern - resources.crossSiteNetworks.methods.get.parameters.project.required - resources.crossSiteNetworks.methods.get.parameters.project.type - resources.crossSiteNetworks.methods.get.path - resources.crossSiteNetworks.methods.get.response.$ref - resources.crossSiteNetworks.methods.get.scopes - resources.crossSiteNetworks.methods.insert.description - resources.crossSiteNetworks.methods.insert.flatPath - resources.crossSiteNetworks.methods.insert.httpMethod - resources.crossSiteNetworks.methods.insert.id - resources.crossSiteNetworks.methods.insert.parameterOrder - resources.crossSiteNetworks.methods.insert.parameters.project.description - resources.crossSiteNetworks.methods.insert.parameters.project.location - resources.crossSiteNetworks.methods.insert.parameters.project.pattern - resources.crossSiteNetworks.methods.insert.parameters.project.required - resources.crossSiteNetworks.methods.insert.parameters.project.type - resources.crossSiteNetworks.methods.insert.parameters.requestId.description - resources.crossSiteNetworks.methods.insert.parameters.requestId.location - resources.crossSiteNetworks.methods.insert.parameters.requestId.type - resources.crossSiteNetworks.methods.insert.parameters.validateOnly.description - resources.crossSiteNetworks.methods.insert.parameters.validateOnly.location - resources.crossSiteNetworks.methods.insert.parameters.validateOnly.type - resources.crossSiteNetworks.methods.insert.path - resources.crossSiteNetworks.methods.insert.request.$ref - resources.crossSiteNetworks.methods.insert.response.$ref - resources.crossSiteNetworks.methods.insert.scopes - resources.crossSiteNetworks.methods.list.description - resources.crossSiteNetworks.methods.list.flatPath - resources.crossSiteNetworks.methods.list.httpMethod - resources.crossSiteNetworks.methods.list.id - resources.crossSiteNetworks.methods.list.parameterOrder - resources.crossSiteNetworks.methods.list.parameters.filter.description - resources.crossSiteNetworks.methods.list.parameters.filter.location - resources.crossSiteNetworks.methods.list.parameters.filter.type - resources.crossSiteNetworks.methods.list.parameters.maxResults.default - resources.crossSiteNetworks.methods.list.parameters.maxResults.description - resources.crossSiteNetworks.methods.list.parameters.maxResults.format - resources.crossSiteNetworks.methods.list.parameters.maxResults.location - resources.crossSiteNetworks.methods.list.parameters.maxResults.minimum - resources.crossSiteNetworks.methods.list.parameters.maxResults.type - resources.crossSiteNetworks.methods.list.parameters.orderBy.description - resources.crossSiteNetworks.methods.list.parameters.orderBy.location - resources.crossSiteNetworks.methods.list.parameters.orderBy.type - resources.crossSiteNetworks.methods.list.parameters.pageToken.description - resources.crossSiteNetworks.methods.list.parameters.pageToken.location - resources.crossSiteNetworks.methods.list.parameters.pageToken.type - resources.crossSiteNetworks.methods.list.parameters.project.description - resources.crossSiteNetworks.methods.list.parameters.project.location - resources.crossSiteNetworks.methods.list.parameters.project.pattern - resources.crossSiteNetworks.methods.list.parameters.project.required - resources.crossSiteNetworks.methods.list.parameters.project.type - resources.crossSiteNetworks.methods.list.parameters.returnPartialSuccess.description - resources.crossSiteNetworks.methods.list.parameters.returnPartialSuccess.location - resources.crossSiteNetworks.methods.list.parameters.returnPartialSuccess.type - resources.crossSiteNetworks.methods.list.path - resources.crossSiteNetworks.methods.list.response.$ref - resources.crossSiteNetworks.methods.list.scopes - resources.crossSiteNetworks.methods.patch.description - resources.crossSiteNetworks.methods.patch.flatPath - resources.crossSiteNetworks.methods.patch.httpMethod - resources.crossSiteNetworks.methods.patch.id - resources.crossSiteNetworks.methods.patch.parameterOrder - resources.crossSiteNetworks.methods.patch.parameters.crossSiteNetwork.description - resources.crossSiteNetworks.methods.patch.parameters.crossSiteNetwork.location - resources.crossSiteNetworks.methods.patch.parameters.crossSiteNetwork.pattern - resources.crossSiteNetworks.methods.patch.parameters.crossSiteNetwork.required - resources.crossSiteNetworks.methods.patch.parameters.crossSiteNetwork.type - resources.crossSiteNetworks.methods.patch.parameters.project.description - resources.crossSiteNetworks.methods.patch.parameters.project.location - resources.crossSiteNetworks.methods.patch.parameters.project.pattern - resources.crossSiteNetworks.methods.patch.parameters.project.required - resources.crossSiteNetworks.methods.patch.parameters.project.type - resources.crossSiteNetworks.methods.patch.parameters.requestId.description - resources.crossSiteNetworks.methods.patch.parameters.requestId.location - resources.crossSiteNetworks.methods.patch.parameters.requestId.type - resources.crossSiteNetworks.methods.patch.parameters.updateMask.description - resources.crossSiteNetworks.methods.patch.parameters.updateMask.format - resources.crossSiteNetworks.methods.patch.parameters.updateMask.location - resources.crossSiteNetworks.methods.patch.parameters.updateMask.type - resources.crossSiteNetworks.methods.patch.parameters.validateOnly.description - resources.crossSiteNetworks.methods.patch.parameters.validateOnly.location - resources.crossSiteNetworks.methods.patch.parameters.validateOnly.type - resources.crossSiteNetworks.methods.patch.path - resources.crossSiteNetworks.methods.patch.request.$ref - resources.crossSiteNetworks.methods.patch.response.$ref - resources.crossSiteNetworks.methods.patch.scopes - resources.diskSettings.methods.get.description - resources.diskSettings.methods.get.flatPath - resources.diskSettings.methods.get.httpMethod - resources.diskSettings.methods.get.id - resources.diskSettings.methods.get.parameterOrder - resources.diskSettings.methods.get.parameters.project.description - resources.diskSettings.methods.get.parameters.project.location - resources.diskSettings.methods.get.parameters.project.pattern - resources.diskSettings.methods.get.parameters.project.required - resources.diskSettings.methods.get.parameters.project.type - resources.diskSettings.methods.get.parameters.zone.description - resources.diskSettings.methods.get.parameters.zone.location - resources.diskSettings.methods.get.parameters.zone.pattern - resources.diskSettings.methods.get.parameters.zone.required - resources.diskSettings.methods.get.parameters.zone.type - resources.diskSettings.methods.get.path - resources.diskSettings.methods.get.response.$ref - resources.diskSettings.methods.get.scopes - resources.diskSettings.methods.patch.description - resources.diskSettings.methods.patch.flatPath - resources.diskSettings.methods.patch.httpMethod - resources.diskSettings.methods.patch.id - resources.diskSettings.methods.patch.parameterOrder - resources.diskSettings.methods.patch.parameters.project.description - resources.diskSettings.methods.patch.parameters.project.location - resources.diskSettings.methods.patch.parameters.project.pattern - resources.diskSettings.methods.patch.parameters.project.required - resources.diskSettings.methods.patch.parameters.project.type - resources.diskSettings.methods.patch.parameters.requestId.description - resources.diskSettings.methods.patch.parameters.requestId.location - resources.diskSettings.methods.patch.parameters.requestId.type - resources.diskSettings.methods.patch.parameters.updateMask.description - resources.diskSettings.methods.patch.parameters.updateMask.format - resources.diskSettings.methods.patch.parameters.updateMask.location - resources.diskSettings.methods.patch.parameters.updateMask.type - resources.diskSettings.methods.patch.parameters.zone.description - resources.diskSettings.methods.patch.parameters.zone.location - resources.diskSettings.methods.patch.parameters.zone.pattern - resources.diskSettings.methods.patch.parameters.zone.required - resources.diskSettings.methods.patch.parameters.zone.type - resources.diskSettings.methods.patch.path - resources.diskSettings.methods.patch.request.$ref - resources.diskSettings.methods.patch.response.$ref - resources.diskSettings.methods.patch.scopes - resources.instances.methods.addNetworkInterface.description - resources.instances.methods.addNetworkInterface.flatPath - resources.instances.methods.addNetworkInterface.httpMethod - resources.instances.methods.addNetworkInterface.id - resources.instances.methods.addNetworkInterface.parameterOrder - resources.instances.methods.addNetworkInterface.parameters.instance.description - resources.instances.methods.addNetworkInterface.parameters.instance.location - resources.instances.methods.addNetworkInterface.parameters.instance.required - resources.instances.methods.addNetworkInterface.parameters.instance.type - resources.instances.methods.addNetworkInterface.parameters.project.description - resources.instances.methods.addNetworkInterface.parameters.project.location - resources.instances.methods.addNetworkInterface.parameters.project.pattern - resources.instances.methods.addNetworkInterface.parameters.project.required - resources.instances.methods.addNetworkInterface.parameters.project.type - resources.instances.methods.addNetworkInterface.parameters.requestId.description - resources.instances.methods.addNetworkInterface.parameters.requestId.location - resources.instances.methods.addNetworkInterface.parameters.requestId.type - resources.instances.methods.addNetworkInterface.parameters.zone.description - resources.instances.methods.addNetworkInterface.parameters.zone.location - resources.instances.methods.addNetworkInterface.parameters.zone.pattern - resources.instances.methods.addNetworkInterface.parameters.zone.required - resources.instances.methods.addNetworkInterface.parameters.zone.type - resources.instances.methods.addNetworkInterface.path - resources.instances.methods.addNetworkInterface.request.$ref - resources.instances.methods.addNetworkInterface.response.$ref - resources.instances.methods.addNetworkInterface.scopes - resources.instances.methods.deleteNetworkInterface.description - resources.instances.methods.deleteNetworkInterface.flatPath - resources.instances.methods.deleteNetworkInterface.httpMethod - resources.instances.methods.deleteNetworkInterface.id - resources.instances.methods.deleteNetworkInterface.parameterOrder - resources.instances.methods.deleteNetworkInterface.parameters.instance.description - resources.instances.methods.deleteNetworkInterface.parameters.instance.location - resources.instances.methods.deleteNetworkInterface.parameters.instance.required - resources.instances.methods.deleteNetworkInterface.parameters.instance.type - resources.instances.methods.deleteNetworkInterface.parameters.networkInterfaceName.description - resources.instances.methods.deleteNetworkInterface.parameters.networkInterfaceName.location - resources.instances.methods.deleteNetworkInterface.parameters.networkInterfaceName.required - resources.instances.methods.deleteNetworkInterface.parameters.networkInterfaceName.type - resources.instances.methods.deleteNetworkInterface.parameters.project.description - resources.instances.methods.deleteNetworkInterface.parameters.project.location - resources.instances.methods.deleteNetworkInterface.parameters.project.pattern - resources.instances.methods.deleteNetworkInterface.parameters.project.required - resources.instances.methods.deleteNetworkInterface.parameters.project.type - resources.instances.methods.deleteNetworkInterface.parameters.requestId.description - resources.instances.methods.deleteNetworkInterface.parameters.requestId.location - resources.instances.methods.deleteNetworkInterface.parameters.requestId.type - resources.instances.methods.deleteNetworkInterface.parameters.zone.description - resources.instances.methods.deleteNetworkInterface.parameters.zone.location - resources.instances.methods.deleteNetworkInterface.parameters.zone.pattern - resources.instances.methods.deleteNetworkInterface.parameters.zone.required - resources.instances.methods.deleteNetworkInterface.parameters.zone.type - resources.instances.methods.deleteNetworkInterface.path - resources.instances.methods.deleteNetworkInterface.response.$ref - resources.instances.methods.deleteNetworkInterface.scopes - resources.instances.methods.reportHostAsFaulty.description - resources.instances.methods.reportHostAsFaulty.flatPath - resources.instances.methods.reportHostAsFaulty.httpMethod - resources.instances.methods.reportHostAsFaulty.id - resources.instances.methods.reportHostAsFaulty.parameterOrder - resources.instances.methods.reportHostAsFaulty.parameters.instance.description - resources.instances.methods.reportHostAsFaulty.parameters.instance.location - resources.instances.methods.reportHostAsFaulty.parameters.instance.pattern - resources.instances.methods.reportHostAsFaulty.parameters.instance.required - resources.instances.methods.reportHostAsFaulty.parameters.instance.type - resources.instances.methods.reportHostAsFaulty.parameters.project.description - resources.instances.methods.reportHostAsFaulty.parameters.project.location - resources.instances.methods.reportHostAsFaulty.parameters.project.pattern - resources.instances.methods.reportHostAsFaulty.parameters.project.required - resources.instances.methods.reportHostAsFaulty.parameters.project.type - resources.instances.methods.reportHostAsFaulty.parameters.requestId.description - resources.instances.methods.reportHostAsFaulty.parameters.requestId.location - resources.instances.methods.reportHostAsFaulty.parameters.requestId.type - resources.instances.methods.reportHostAsFaulty.parameters.zone.description - resources.instances.methods.reportHostAsFaulty.parameters.zone.location - resources.instances.methods.reportHostAsFaulty.parameters.zone.pattern - resources.instances.methods.reportHostAsFaulty.parameters.zone.required - resources.instances.methods.reportHostAsFaulty.parameters.zone.type - resources.instances.methods.reportHostAsFaulty.path - resources.instances.methods.reportHostAsFaulty.request.$ref - resources.instances.methods.reportHostAsFaulty.response.$ref - resources.instances.methods.reportHostAsFaulty.scopes - resources.regionDiskSettings.methods.get.description - resources.regionDiskSettings.methods.get.flatPath - resources.regionDiskSettings.methods.get.httpMethod - resources.regionDiskSettings.methods.get.id - resources.regionDiskSettings.methods.get.parameterOrder - resources.regionDiskSettings.methods.get.parameters.project.description - resources.regionDiskSettings.methods.get.parameters.project.location - resources.regionDiskSettings.methods.get.parameters.project.pattern - resources.regionDiskSettings.methods.get.parameters.project.required - resources.regionDiskSettings.methods.get.parameters.project.type - resources.regionDiskSettings.methods.get.parameters.region.description - resources.regionDiskSettings.methods.get.parameters.region.location - resources.regionDiskSettings.methods.get.parameters.region.pattern - resources.regionDiskSettings.methods.get.parameters.region.required - resources.regionDiskSettings.methods.get.parameters.region.type - resources.regionDiskSettings.methods.get.path - resources.regionDiskSettings.methods.get.response.$ref - resources.regionDiskSettings.methods.get.scopes - resources.regionDiskSettings.methods.patch.description - resources.regionDiskSettings.methods.patch.flatPath - resources.regionDiskSettings.methods.patch.httpMethod - resources.regionDiskSettings.methods.patch.id - resources.regionDiskSettings.methods.patch.parameterOrder - resources.regionDiskSettings.methods.patch.parameters.project.description - resources.regionDiskSettings.methods.patch.parameters.project.location - resources.regionDiskSettings.methods.patch.parameters.project.pattern - resources.regionDiskSettings.methods.patch.parameters.project.required - resources.regionDiskSettings.methods.patch.parameters.project.type - resources.regionDiskSettings.methods.patch.parameters.region.description - resources.regionDiskSettings.methods.patch.parameters.region.location - resources.regionDiskSettings.methods.patch.parameters.region.pattern - resources.regionDiskSettings.methods.patch.parameters.region.required - resources.regionDiskSettings.methods.patch.parameters.region.type - resources.regionDiskSettings.methods.patch.parameters.requestId.description - resources.regionDiskSettings.methods.patch.parameters.requestId.location - resources.regionDiskSettings.methods.patch.parameters.requestId.type - resources.regionDiskSettings.methods.patch.parameters.updateMask.description - resources.regionDiskSettings.methods.patch.parameters.updateMask.format - resources.regionDiskSettings.methods.patch.parameters.updateMask.location - resources.regionDiskSettings.methods.patch.parameters.updateMask.type - resources.regionDiskSettings.methods.patch.path - resources.regionDiskSettings.methods.patch.request.$ref - resources.regionDiskSettings.methods.patch.response.$ref - resources.regionDiskSettings.methods.patch.scopes - resources.regionSnapshotSettings.methods.get.description - resources.regionSnapshotSettings.methods.get.flatPath - resources.regionSnapshotSettings.methods.get.httpMethod - resources.regionSnapshotSettings.methods.get.id - resources.regionSnapshotSettings.methods.get.parameterOrder - resources.regionSnapshotSettings.methods.get.parameters.project.description - resources.regionSnapshotSettings.methods.get.parameters.project.location - resources.regionSnapshotSettings.methods.get.parameters.project.pattern - resources.regionSnapshotSettings.methods.get.parameters.project.required - resources.regionSnapshotSettings.methods.get.parameters.project.type - resources.regionSnapshotSettings.methods.get.parameters.region.description - resources.regionSnapshotSettings.methods.get.parameters.region.location - resources.regionSnapshotSettings.methods.get.parameters.region.pattern - resources.regionSnapshotSettings.methods.get.parameters.region.required - resources.regionSnapshotSettings.methods.get.parameters.region.type - resources.regionSnapshotSettings.methods.get.path - resources.regionSnapshotSettings.methods.get.response.$ref - resources.regionSnapshotSettings.methods.get.scopes - resources.regionSnapshotSettings.methods.patch.description - resources.regionSnapshotSettings.methods.patch.flatPath - resources.regionSnapshotSettings.methods.patch.httpMethod - resources.regionSnapshotSettings.methods.patch.id - resources.regionSnapshotSettings.methods.patch.parameterOrder - resources.regionSnapshotSettings.methods.patch.parameters.project.description - resources.regionSnapshotSettings.methods.patch.parameters.project.location - resources.regionSnapshotSettings.methods.patch.parameters.project.pattern - resources.regionSnapshotSettings.methods.patch.parameters.project.required - resources.regionSnapshotSettings.methods.patch.parameters.project.type - resources.regionSnapshotSettings.methods.patch.parameters.region.description - resources.regionSnapshotSettings.methods.patch.parameters.region.location - resources.regionSnapshotSettings.methods.patch.parameters.region.pattern - resources.regionSnapshotSettings.methods.patch.parameters.region.required - resources.regionSnapshotSettings.methods.patch.parameters.region.type - resources.regionSnapshotSettings.methods.patch.parameters.requestId.description - resources.regionSnapshotSettings.methods.patch.parameters.requestId.location - resources.regionSnapshotSettings.methods.patch.parameters.requestId.type - resources.regionSnapshotSettings.methods.patch.parameters.updateMask.description - resources.regionSnapshotSettings.methods.patch.parameters.updateMask.format - resources.regionSnapshotSettings.methods.patch.parameters.updateMask.location - resources.regionSnapshotSettings.methods.patch.parameters.updateMask.type - resources.regionSnapshotSettings.methods.patch.path - resources.regionSnapshotSettings.methods.patch.request.$ref - resources.regionSnapshotSettings.methods.patch.response.$ref - resources.regionSnapshotSettings.methods.patch.scopes - resources.regionSnapshots.methods.delete.description - resources.regionSnapshots.methods.delete.flatPath - resources.regionSnapshots.methods.delete.httpMethod - resources.regionSnapshots.methods.delete.id - resources.regionSnapshots.methods.delete.parameterOrder - resources.regionSnapshots.methods.delete.parameters.project.description - resources.regionSnapshots.methods.delete.parameters.project.location - resources.regionSnapshots.methods.delete.parameters.project.pattern - resources.regionSnapshots.methods.delete.parameters.project.required - resources.regionSnapshots.methods.delete.parameters.project.type - resources.regionSnapshots.methods.delete.parameters.region.description - resources.regionSnapshots.methods.delete.parameters.region.location - resources.regionSnapshots.methods.delete.parameters.region.pattern - resources.regionSnapshots.methods.delete.parameters.region.required - resources.regionSnapshots.methods.delete.parameters.region.type - resources.regionSnapshots.methods.delete.parameters.requestId.description - resources.regionSnapshots.methods.delete.parameters.requestId.location - resources.regionSnapshots.methods.delete.parameters.requestId.type - resources.regionSnapshots.methods.delete.parameters.snapshot.description - resources.regionSnapshots.methods.delete.parameters.snapshot.location - resources.regionSnapshots.methods.delete.parameters.snapshot.pattern - resources.regionSnapshots.methods.delete.parameters.snapshot.required - resources.regionSnapshots.methods.delete.parameters.snapshot.type - resources.regionSnapshots.methods.delete.path - resources.regionSnapshots.methods.delete.response.$ref - resources.regionSnapshots.methods.delete.scopes - resources.regionSnapshots.methods.get.description - resources.regionSnapshots.methods.get.flatPath - resources.regionSnapshots.methods.get.httpMethod - resources.regionSnapshots.methods.get.id - resources.regionSnapshots.methods.get.parameterOrder - resources.regionSnapshots.methods.get.parameters.project.description - resources.regionSnapshots.methods.get.parameters.project.location - resources.regionSnapshots.methods.get.parameters.project.pattern - resources.regionSnapshots.methods.get.parameters.project.required - resources.regionSnapshots.methods.get.parameters.project.type - resources.regionSnapshots.methods.get.parameters.region.description - resources.regionSnapshots.methods.get.parameters.region.location - resources.regionSnapshots.methods.get.parameters.region.pattern - resources.regionSnapshots.methods.get.parameters.region.required - resources.regionSnapshots.methods.get.parameters.region.type - resources.regionSnapshots.methods.get.parameters.snapshot.description - resources.regionSnapshots.methods.get.parameters.snapshot.location - resources.regionSnapshots.methods.get.parameters.snapshot.pattern - resources.regionSnapshots.methods.get.parameters.snapshot.required - resources.regionSnapshots.methods.get.parameters.snapshot.type - resources.regionSnapshots.methods.get.path - resources.regionSnapshots.methods.get.response.$ref - resources.regionSnapshots.methods.get.scopes - resources.regionSnapshots.methods.getIamPolicy.description - resources.regionSnapshots.methods.getIamPolicy.flatPath - resources.regionSnapshots.methods.getIamPolicy.httpMethod - resources.regionSnapshots.methods.getIamPolicy.id - resources.regionSnapshots.methods.getIamPolicy.parameterOrder - resources.regionSnapshots.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.description - resources.regionSnapshots.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.format - resources.regionSnapshots.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.location - resources.regionSnapshots.methods.getIamPolicy.parameters.optionsRequestedPolicyVersion.type - resources.regionSnapshots.methods.getIamPolicy.parameters.project.description - resources.regionSnapshots.methods.getIamPolicy.parameters.project.location - resources.regionSnapshots.methods.getIamPolicy.parameters.project.pattern - resources.regionSnapshots.methods.getIamPolicy.parameters.project.required - resources.regionSnapshots.methods.getIamPolicy.parameters.project.type - resources.regionSnapshots.methods.getIamPolicy.parameters.region.description - resources.regionSnapshots.methods.getIamPolicy.parameters.region.location - resources.regionSnapshots.methods.getIamPolicy.parameters.region.pattern - resources.regionSnapshots.methods.getIamPolicy.parameters.region.required - resources.regionSnapshots.methods.getIamPolicy.parameters.region.type - resources.regionSnapshots.methods.getIamPolicy.parameters.resource.description - resources.regionSnapshots.methods.getIamPolicy.parameters.resource.location - resources.regionSnapshots.methods.getIamPolicy.parameters.resource.pattern - resources.regionSnapshots.methods.getIamPolicy.parameters.resource.required - resources.regionSnapshots.methods.getIamPolicy.parameters.resource.type - resources.regionSnapshots.methods.getIamPolicy.path - resources.regionSnapshots.methods.getIamPolicy.response.$ref - resources.regionSnapshots.methods.getIamPolicy.scopes - resources.regionSnapshots.methods.insert.description - resources.regionSnapshots.methods.insert.flatPath - resources.regionSnapshots.methods.insert.httpMethod - resources.regionSnapshots.methods.insert.id - resources.regionSnapshots.methods.insert.parameterOrder - resources.regionSnapshots.methods.insert.parameters.project.description - resources.regionSnapshots.methods.insert.parameters.project.location - resources.regionSnapshots.methods.insert.parameters.project.pattern - resources.regionSnapshots.methods.insert.parameters.project.required - resources.regionSnapshots.methods.insert.parameters.project.type - resources.regionSnapshots.methods.insert.parameters.region.description - resources.regionSnapshots.methods.insert.parameters.region.location - resources.regionSnapshots.methods.insert.parameters.region.pattern - resources.regionSnapshots.methods.insert.parameters.region.required - resources.regionSnapshots.methods.insert.parameters.region.type - resources.regionSnapshots.methods.insert.parameters.requestId.description - resources.regionSnapshots.methods.insert.parameters.requestId.location - resources.regionSnapshots.methods.insert.parameters.requestId.type - resources.regionSnapshots.methods.insert.path - resources.regionSnapshots.methods.insert.request.$ref - resources.regionSnapshots.methods.insert.response.$ref - resources.regionSnapshots.methods.insert.scopes - resources.regionSnapshots.methods.list.description - resources.regionSnapshots.methods.list.flatPath - resources.regionSnapshots.methods.list.httpMethod - resources.regionSnapshots.methods.list.id - resources.regionSnapshots.methods.list.parameterOrder - resources.regionSnapshots.methods.list.parameters.filter.description - resources.regionSnapshots.methods.list.parameters.filter.location - resources.regionSnapshots.methods.list.parameters.filter.type - resources.regionSnapshots.methods.list.parameters.maxResults.default - resources.regionSnapshots.methods.list.parameters.maxResults.description - resources.regionSnapshots.methods.list.parameters.maxResults.format - resources.regionSnapshots.methods.list.parameters.maxResults.location - resources.regionSnapshots.methods.list.parameters.maxResults.minimum - resources.regionSnapshots.methods.list.parameters.maxResults.type - resources.regionSnapshots.methods.list.parameters.orderBy.description - resources.regionSnapshots.methods.list.parameters.orderBy.location - resources.regionSnapshots.methods.list.parameters.orderBy.type - resources.regionSnapshots.methods.list.parameters.pageToken.description - resources.regionSnapshots.methods.list.parameters.pageToken.location - resources.regionSnapshots.methods.list.parameters.pageToken.type - resources.regionSnapshots.methods.list.parameters.project.description - resources.regionSnapshots.methods.list.parameters.project.location - resources.regionSnapshots.methods.list.parameters.project.pattern - resources.regionSnapshots.methods.list.parameters.project.required - resources.regionSnapshots.methods.list.parameters.project.type - resources.regionSnapshots.methods.list.parameters.region.description - resources.regionSnapshots.methods.list.parameters.region.location - resources.regionSnapshots.methods.list.parameters.region.pattern - resources.regionSnapshots.methods.list.parameters.region.required - resources.regionSnapshots.methods.list.parameters.region.type - resources.regionSnapshots.methods.list.parameters.returnPartialSuccess.description - resources.regionSnapshots.methods.list.parameters.returnPartialSuccess.location - resources.regionSnapshots.methods.list.parameters.returnPartialSuccess.type - resources.regionSnapshots.methods.list.path - resources.regionSnapshots.methods.list.response.$ref - resources.regionSnapshots.methods.list.scopes - resources.regionSnapshots.methods.setIamPolicy.description - resources.regionSnapshots.methods.setIamPolicy.flatPath - resources.regionSnapshots.methods.setIamPolicy.httpMethod - resources.regionSnapshots.methods.setIamPolicy.id - resources.regionSnapshots.methods.setIamPolicy.parameterOrder - resources.regionSnapshots.methods.setIamPolicy.parameters.project.description - resources.regionSnapshots.methods.setIamPolicy.parameters.project.location - resources.regionSnapshots.methods.setIamPolicy.parameters.project.pattern - resources.regionSnapshots.methods.setIamPolicy.parameters.project.required - resources.regionSnapshots.methods.setIamPolicy.parameters.project.type - resources.regionSnapshots.methods.setIamPolicy.parameters.region.description - resources.regionSnapshots.methods.setIamPolicy.parameters.region.location - resources.regionSnapshots.methods.setIamPolicy.parameters.region.pattern - resources.regionSnapshots.methods.setIamPolicy.parameters.region.required - resources.regionSnapshots.methods.setIamPolicy.parameters.region.type - resources.regionSnapshots.methods.setIamPolicy.parameters.resource.description - resources.regionSnapshots.methods.setIamPolicy.parameters.resource.location - resources.regionSnapshots.methods.setIamPolicy.parameters.resource.pattern - resources.regionSnapshots.methods.setIamPolicy.parameters.resource.required - resources.regionSnapshots.methods.setIamPolicy.parameters.resource.type - resources.regionSnapshots.methods.setIamPolicy.path - resources.regionSnapshots.methods.setIamPolicy.request.$ref - resources.regionSnapshots.methods.setIamPolicy.response.$ref - resources.regionSnapshots.methods.setIamPolicy.scopes - resources.regionSnapshots.methods.setLabels.description - resources.regionSnapshots.methods.setLabels.flatPath - resources.regionSnapshots.methods.setLabels.httpMethod - resources.regionSnapshots.methods.setLabels.id - resources.regionSnapshots.methods.setLabels.parameterOrder - resources.regionSnapshots.methods.setLabels.parameters.project.description - resources.regionSnapshots.methods.setLabels.parameters.project.location - resources.regionSnapshots.methods.setLabels.parameters.project.pattern - resources.regionSnapshots.methods.setLabels.parameters.project.required - resources.regionSnapshots.methods.setLabels.parameters.project.type - resources.regionSnapshots.methods.setLabels.parameters.region.description - resources.regionSnapshots.methods.setLabels.parameters.region.location - resources.regionSnapshots.methods.setLabels.parameters.region.pattern - resources.regionSnapshots.methods.setLabels.parameters.region.required - resources.regionSnapshots.methods.setLabels.parameters.region.type - resources.regionSnapshots.methods.setLabels.parameters.requestId.description - resources.regionSnapshots.methods.setLabels.parameters.requestId.location - resources.regionSnapshots.methods.setLabels.parameters.requestId.type - resources.regionSnapshots.methods.setLabels.parameters.resource.description - resources.regionSnapshots.methods.setLabels.parameters.resource.location - resources.regionSnapshots.methods.setLabels.parameters.resource.pattern - resources.regionSnapshots.methods.setLabels.parameters.resource.required - resources.regionSnapshots.methods.setLabels.parameters.resource.type - resources.regionSnapshots.methods.setLabels.path - resources.regionSnapshots.methods.setLabels.request.$ref - resources.regionSnapshots.methods.setLabels.response.$ref - resources.regionSnapshots.methods.setLabels.scopes - resources.regionSnapshots.methods.testIamPermissions.description - resources.regionSnapshots.methods.testIamPermissions.flatPath - resources.regionSnapshots.methods.testIamPermissions.httpMethod - resources.regionSnapshots.methods.testIamPermissions.id - resources.regionSnapshots.methods.testIamPermissions.parameterOrder - resources.regionSnapshots.methods.testIamPermissions.parameters.project.description - resources.regionSnapshots.methods.testIamPermissions.parameters.project.location - resources.regionSnapshots.methods.testIamPermissions.parameters.project.pattern - resources.regionSnapshots.methods.testIamPermissions.parameters.project.required - resources.regionSnapshots.methods.testIamPermissions.parameters.project.type - resources.regionSnapshots.methods.testIamPermissions.parameters.region.description - resources.regionSnapshots.methods.testIamPermissions.parameters.region.location - resources.regionSnapshots.methods.testIamPermissions.parameters.region.pattern - resources.regionSnapshots.methods.testIamPermissions.parameters.region.required - resources.regionSnapshots.methods.testIamPermissions.parameters.region.type - resources.regionSnapshots.methods.testIamPermissions.parameters.resource.description - resources.regionSnapshots.methods.testIamPermissions.parameters.resource.location - resources.regionSnapshots.methods.testIamPermissions.parameters.resource.pattern - resources.regionSnapshots.methods.testIamPermissions.parameters.resource.required - resources.regionSnapshots.methods.testIamPermissions.parameters.resource.type - resources.regionSnapshots.methods.testIamPermissions.path - resources.regionSnapshots.methods.testIamPermissions.request.$ref - resources.regionSnapshots.methods.testIamPermissions.response.$ref - resources.regionSnapshots.methods.testIamPermissions.scopes - resources.reservationBlocks.methods.performMaintenance.description - resources.reservationBlocks.methods.performMaintenance.flatPath - resources.reservationBlocks.methods.performMaintenance.httpMethod - resources.reservationBlocks.methods.performMaintenance.id - resources.reservationBlocks.methods.performMaintenance.parameterOrder - resources.reservationBlocks.methods.performMaintenance.parameters.project.description - resources.reservationBlocks.methods.performMaintenance.parameters.project.location - resources.reservationBlocks.methods.performMaintenance.parameters.project.required - resources.reservationBlocks.methods.performMaintenance.parameters.project.type - resources.reservationBlocks.methods.performMaintenance.parameters.requestId.description - resources.reservationBlocks.methods.performMaintenance.parameters.requestId.location - resources.reservationBlocks.methods.performMaintenance.parameters.requestId.type - resources.reservationBlocks.methods.performMaintenance.parameters.reservation.description - resources.reservationBlocks.methods.performMaintenance.parameters.reservation.location - resources.reservationBlocks.methods.performMaintenance.parameters.reservation.pattern - resources.reservationBlocks.methods.performMaintenance.parameters.reservation.required - resources.reservationBlocks.methods.performMaintenance.parameters.reservation.type - resources.reservationBlocks.methods.performMaintenance.parameters.reservationBlock.description - resources.reservationBlocks.methods.performMaintenance.parameters.reservationBlock.location - resources.reservationBlocks.methods.performMaintenance.parameters.reservationBlock.pattern - resources.reservationBlocks.methods.performMaintenance.parameters.reservationBlock.required - resources.reservationBlocks.methods.performMaintenance.parameters.reservationBlock.type - resources.reservationBlocks.methods.performMaintenance.parameters.zone.description - resources.reservationBlocks.methods.performMaintenance.parameters.zone.location - resources.reservationBlocks.methods.performMaintenance.parameters.zone.required - resources.reservationBlocks.methods.performMaintenance.parameters.zone.type - resources.reservationBlocks.methods.performMaintenance.path - resources.reservationBlocks.methods.performMaintenance.request.$ref - resources.reservationBlocks.methods.performMaintenance.response.$ref - resources.reservationBlocks.methods.performMaintenance.scopes - resources.reservations.methods.performMaintenance.description - resources.reservations.methods.performMaintenance.flatPath - resources.reservations.methods.performMaintenance.httpMethod - resources.reservations.methods.performMaintenance.id - resources.reservations.methods.performMaintenance.parameterOrder - resources.reservations.methods.performMaintenance.parameters.project.description - resources.reservations.methods.performMaintenance.parameters.project.location - resources.reservations.methods.performMaintenance.parameters.project.required - resources.reservations.methods.performMaintenance.parameters.project.type - resources.reservations.methods.performMaintenance.parameters.requestId.description - resources.reservations.methods.performMaintenance.parameters.requestId.location - resources.reservations.methods.performMaintenance.parameters.requestId.type - resources.reservations.methods.performMaintenance.parameters.reservation.description - resources.reservations.methods.performMaintenance.parameters.reservation.location - resources.reservations.methods.performMaintenance.parameters.reservation.pattern - resources.reservations.methods.performMaintenance.parameters.reservation.required - resources.reservations.methods.performMaintenance.parameters.reservation.type - resources.reservations.methods.performMaintenance.parameters.zone.description - resources.reservations.methods.performMaintenance.parameters.zone.location - resources.reservations.methods.performMaintenance.parameters.zone.required - resources.reservations.methods.performMaintenance.parameters.zone.type - resources.reservations.methods.performMaintenance.path - resources.reservations.methods.performMaintenance.request.$ref - resources.reservations.methods.performMaintenance.response.$ref - resources.reservations.methods.performMaintenance.scopes - resources.snapshots.methods.aggregatedList.description - resources.snapshots.methods.aggregatedList.flatPath - resources.snapshots.methods.aggregatedList.httpMethod - resources.snapshots.methods.aggregatedList.id - resources.snapshots.methods.aggregatedList.parameterOrder - resources.snapshots.methods.aggregatedList.parameters.filter.description - resources.snapshots.methods.aggregatedList.parameters.filter.location - resources.snapshots.methods.aggregatedList.parameters.filter.type - resources.snapshots.methods.aggregatedList.parameters.includeAllScopes.description - resources.snapshots.methods.aggregatedList.parameters.includeAllScopes.location - resources.snapshots.methods.aggregatedList.parameters.includeAllScopes.type - resources.snapshots.methods.aggregatedList.parameters.maxResults.default - resources.snapshots.methods.aggregatedList.parameters.maxResults.description - resources.snapshots.methods.aggregatedList.parameters.maxResults.format - resources.snapshots.methods.aggregatedList.parameters.maxResults.location - resources.snapshots.methods.aggregatedList.parameters.maxResults.minimum - resources.snapshots.methods.aggregatedList.parameters.maxResults.type - resources.snapshots.methods.aggregatedList.parameters.orderBy.description - resources.snapshots.methods.aggregatedList.parameters.orderBy.location - resources.snapshots.methods.aggregatedList.parameters.orderBy.type - resources.snapshots.methods.aggregatedList.parameters.pageToken.description - resources.snapshots.methods.aggregatedList.parameters.pageToken.location - resources.snapshots.methods.aggregatedList.parameters.pageToken.type - resources.snapshots.methods.aggregatedList.parameters.project.description - resources.snapshots.methods.aggregatedList.parameters.project.location - resources.snapshots.methods.aggregatedList.parameters.project.pattern - resources.snapshots.methods.aggregatedList.parameters.project.required - resources.snapshots.methods.aggregatedList.parameters.project.type - resources.snapshots.methods.aggregatedList.parameters.returnPartialSuccess.description - resources.snapshots.methods.aggregatedList.parameters.returnPartialSuccess.location - resources.snapshots.methods.aggregatedList.parameters.returnPartialSuccess.type - resources.snapshots.methods.aggregatedList.parameters.serviceProjectNumber.description - resources.snapshots.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.snapshots.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.snapshots.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.snapshots.methods.aggregatedList.path - resources.snapshots.methods.aggregatedList.response.$ref - resources.snapshots.methods.aggregatedList.scopes - resources.wireGroups.methods.delete.description - resources.wireGroups.methods.delete.flatPath - resources.wireGroups.methods.delete.httpMethod - resources.wireGroups.methods.delete.id - resources.wireGroups.methods.delete.parameterOrder - resources.wireGroups.methods.delete.parameters.crossSiteNetwork.location - resources.wireGroups.methods.delete.parameters.crossSiteNetwork.pattern - resources.wireGroups.methods.delete.parameters.crossSiteNetwork.required - resources.wireGroups.methods.delete.parameters.crossSiteNetwork.type - resources.wireGroups.methods.delete.parameters.project.description - resources.wireGroups.methods.delete.parameters.project.location - resources.wireGroups.methods.delete.parameters.project.pattern - resources.wireGroups.methods.delete.parameters.project.required - resources.wireGroups.methods.delete.parameters.project.type - resources.wireGroups.methods.delete.parameters.requestId.description - resources.wireGroups.methods.delete.parameters.requestId.location - resources.wireGroups.methods.delete.parameters.requestId.type - resources.wireGroups.methods.delete.parameters.wireGroup.description - resources.wireGroups.methods.delete.parameters.wireGroup.location - resources.wireGroups.methods.delete.parameters.wireGroup.pattern - resources.wireGroups.methods.delete.parameters.wireGroup.required - resources.wireGroups.methods.delete.parameters.wireGroup.type - resources.wireGroups.methods.delete.path - resources.wireGroups.methods.delete.response.$ref - resources.wireGroups.methods.delete.scopes - resources.wireGroups.methods.get.description - resources.wireGroups.methods.get.flatPath - resources.wireGroups.methods.get.httpMethod - resources.wireGroups.methods.get.id - resources.wireGroups.methods.get.parameterOrder - resources.wireGroups.methods.get.parameters.crossSiteNetwork.location - resources.wireGroups.methods.get.parameters.crossSiteNetwork.pattern - resources.wireGroups.methods.get.parameters.crossSiteNetwork.required - resources.wireGroups.methods.get.parameters.crossSiteNetwork.type - resources.wireGroups.methods.get.parameters.project.description - resources.wireGroups.methods.get.parameters.project.location - resources.wireGroups.methods.get.parameters.project.pattern - resources.wireGroups.methods.get.parameters.project.required - resources.wireGroups.methods.get.parameters.project.type - resources.wireGroups.methods.get.parameters.wireGroup.description - resources.wireGroups.methods.get.parameters.wireGroup.location - resources.wireGroups.methods.get.parameters.wireGroup.pattern - resources.wireGroups.methods.get.parameters.wireGroup.required - resources.wireGroups.methods.get.parameters.wireGroup.type - resources.wireGroups.methods.get.path - resources.wireGroups.methods.get.response.$ref - resources.wireGroups.methods.get.scopes - resources.wireGroups.methods.insert.description - resources.wireGroups.methods.insert.flatPath - resources.wireGroups.methods.insert.httpMethod - resources.wireGroups.methods.insert.id - resources.wireGroups.methods.insert.parameterOrder - resources.wireGroups.methods.insert.parameters.crossSiteNetwork.location - resources.wireGroups.methods.insert.parameters.crossSiteNetwork.pattern - resources.wireGroups.methods.insert.parameters.crossSiteNetwork.required - resources.wireGroups.methods.insert.parameters.crossSiteNetwork.type - resources.wireGroups.methods.insert.parameters.project.description - resources.wireGroups.methods.insert.parameters.project.location - resources.wireGroups.methods.insert.parameters.project.pattern - resources.wireGroups.methods.insert.parameters.project.required - resources.wireGroups.methods.insert.parameters.project.type - resources.wireGroups.methods.insert.parameters.requestId.description - resources.wireGroups.methods.insert.parameters.requestId.location - resources.wireGroups.methods.insert.parameters.requestId.type - resources.wireGroups.methods.insert.parameters.validateOnly.description - resources.wireGroups.methods.insert.parameters.validateOnly.location - resources.wireGroups.methods.insert.parameters.validateOnly.type - resources.wireGroups.methods.insert.path - resources.wireGroups.methods.insert.request.$ref - resources.wireGroups.methods.insert.response.$ref - resources.wireGroups.methods.insert.scopes - resources.wireGroups.methods.list.description - resources.wireGroups.methods.list.flatPath - resources.wireGroups.methods.list.httpMethod - resources.wireGroups.methods.list.id - resources.wireGroups.methods.list.parameterOrder - resources.wireGroups.methods.list.parameters.crossSiteNetwork.location - resources.wireGroups.methods.list.parameters.crossSiteNetwork.pattern - resources.wireGroups.methods.list.parameters.crossSiteNetwork.required - resources.wireGroups.methods.list.parameters.crossSiteNetwork.type - resources.wireGroups.methods.list.parameters.filter.description - resources.wireGroups.methods.list.parameters.filter.location - resources.wireGroups.methods.list.parameters.filter.type - resources.wireGroups.methods.list.parameters.maxResults.default - resources.wireGroups.methods.list.parameters.maxResults.description - resources.wireGroups.methods.list.parameters.maxResults.format - resources.wireGroups.methods.list.parameters.maxResults.location - resources.wireGroups.methods.list.parameters.maxResults.minimum - resources.wireGroups.methods.list.parameters.maxResults.type - resources.wireGroups.methods.list.parameters.orderBy.description - resources.wireGroups.methods.list.parameters.orderBy.location - resources.wireGroups.methods.list.parameters.orderBy.type - resources.wireGroups.methods.list.parameters.pageToken.description - resources.wireGroups.methods.list.parameters.pageToken.location - resources.wireGroups.methods.list.parameters.pageToken.type - resources.wireGroups.methods.list.parameters.project.description - resources.wireGroups.methods.list.parameters.project.location - resources.wireGroups.methods.list.parameters.project.pattern - resources.wireGroups.methods.list.parameters.project.required - resources.wireGroups.methods.list.parameters.project.type - resources.wireGroups.methods.list.parameters.returnPartialSuccess.description - resources.wireGroups.methods.list.parameters.returnPartialSuccess.location - resources.wireGroups.methods.list.parameters.returnPartialSuccess.type - resources.wireGroups.methods.list.path - resources.wireGroups.methods.list.response.$ref - resources.wireGroups.methods.list.scopes - resources.wireGroups.methods.patch.description - resources.wireGroups.methods.patch.flatPath - resources.wireGroups.methods.patch.httpMethod - resources.wireGroups.methods.patch.id - resources.wireGroups.methods.patch.parameterOrder - resources.wireGroups.methods.patch.parameters.crossSiteNetwork.location - resources.wireGroups.methods.patch.parameters.crossSiteNetwork.pattern - resources.wireGroups.methods.patch.parameters.crossSiteNetwork.required - resources.wireGroups.methods.patch.parameters.crossSiteNetwork.type - resources.wireGroups.methods.patch.parameters.project.description - resources.wireGroups.methods.patch.parameters.project.location - resources.wireGroups.methods.patch.parameters.project.pattern - resources.wireGroups.methods.patch.parameters.project.required - resources.wireGroups.methods.patch.parameters.project.type - resources.wireGroups.methods.patch.parameters.requestId.description - resources.wireGroups.methods.patch.parameters.requestId.location - resources.wireGroups.methods.patch.parameters.requestId.type - resources.wireGroups.methods.patch.parameters.updateMask.description - resources.wireGroups.methods.patch.parameters.updateMask.format - resources.wireGroups.methods.patch.parameters.updateMask.location - resources.wireGroups.methods.patch.parameters.updateMask.type - resources.wireGroups.methods.patch.parameters.validateOnly.description - resources.wireGroups.methods.patch.parameters.validateOnly.location - resources.wireGroups.methods.patch.parameters.validateOnly.type - resources.wireGroups.methods.patch.parameters.wireGroup.description - resources.wireGroups.methods.patch.parameters.wireGroup.location - resources.wireGroups.methods.patch.parameters.wireGroup.pattern - resources.wireGroups.methods.patch.parameters.wireGroup.required - resources.wireGroups.methods.patch.parameters.wireGroup.type - resources.wireGroups.methods.patch.path - resources.wireGroups.methods.patch.request.$ref - resources.wireGroups.methods.patch.response.$ref - resources.wireGroups.methods.patch.scopes - schemas.BackendBucketListUsable.id - schemas.BackendBucketListUsable.properties.id.description - schemas.BackendBucketListUsable.properties.id.type - schemas.BackendBucketListUsable.properties.items.description - schemas.BackendBucketListUsable.properties.items.items.$ref - schemas.BackendBucketListUsable.properties.items.type - schemas.BackendBucketListUsable.properties.kind.default - schemas.BackendBucketListUsable.properties.kind.description - schemas.BackendBucketListUsable.properties.kind.type - schemas.BackendBucketListUsable.properties.nextPageToken.description - schemas.BackendBucketListUsable.properties.nextPageToken.type - schemas.BackendBucketListUsable.properties.selfLink.description - schemas.BackendBucketListUsable.properties.selfLink.type - schemas.BackendBucketListUsable.properties.warning.description - schemas.BackendBucketListUsable.properties.warning.properties.code.description - schemas.BackendBucketListUsable.properties.warning.properties.code.enum - schemas.BackendBucketListUsable.properties.warning.properties.code.enumDeprecated - schemas.BackendBucketListUsable.properties.warning.properties.code.enumDescriptions - schemas.BackendBucketListUsable.properties.warning.properties.code.type - schemas.BackendBucketListUsable.properties.warning.properties.data.description - schemas.BackendBucketListUsable.properties.warning.properties.data.items.properties.key.description - schemas.BackendBucketListUsable.properties.warning.properties.data.items.properties.key.type - schemas.BackendBucketListUsable.properties.warning.properties.data.items.properties.value.description - schemas.BackendBucketListUsable.properties.warning.properties.data.items.properties.value.type - schemas.BackendBucketListUsable.properties.warning.properties.data.items.type - schemas.BackendBucketListUsable.properties.warning.properties.data.type - schemas.BackendBucketListUsable.properties.warning.properties.message.description - schemas.BackendBucketListUsable.properties.warning.properties.message.type - schemas.BackendBucketListUsable.properties.warning.type - schemas.BackendBucketListUsable.type - schemas.BackendService.properties.dynamicForwarding.$ref - schemas.BackendService.properties.dynamicForwarding.description - schemas.BackendService.properties.networkPassThroughLbTrafficPolicy.$ref - schemas.BackendService.properties.networkPassThroughLbTrafficPolicy.description - schemas.BackendServiceDynamicForwarding.description - schemas.BackendServiceDynamicForwarding.id - schemas.BackendServiceDynamicForwarding.properties.ipPortSelection.$ref - schemas.BackendServiceDynamicForwarding.properties.ipPortSelection.description - schemas.BackendServiceDynamicForwarding.type - schemas.BackendServiceDynamicForwardingIpPortSelection.description - schemas.BackendServiceDynamicForwardingIpPortSelection.id - schemas.BackendServiceDynamicForwardingIpPortSelection.properties.enabled.description - schemas.BackendServiceDynamicForwardingIpPortSelection.properties.enabled.type - schemas.BackendServiceDynamicForwardingIpPortSelection.type - schemas.BackendServiceNetworkPassThroughLbTrafficPolicy.id - schemas.BackendServiceNetworkPassThroughLbTrafficPolicy.properties.zonalAffinity.$ref - schemas.BackendServiceNetworkPassThroughLbTrafficPolicy.properties.zonalAffinity.description - schemas.BackendServiceNetworkPassThroughLbTrafficPolicy.type - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.id - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.properties.spillover.description - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.properties.spillover.enum - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.properties.spillover.enumDescriptions - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.properties.spillover.type - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.properties.spilloverRatio.description - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.properties.spilloverRatio.format - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.properties.spilloverRatio.type - schemas.BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.type - schemas.CacheInvalidationRule.properties.cacheTags.description - schemas.CacheInvalidationRule.properties.cacheTags.items.type - schemas.CacheInvalidationRule.properties.cacheTags.type - schemas.CalendarModeAdviceRequest.description - schemas.CalendarModeAdviceRequest.id - schemas.CalendarModeAdviceRequest.properties.futureResourcesSpecs.additionalProperties.$ref - schemas.CalendarModeAdviceRequest.properties.futureResourcesSpecs.description - schemas.CalendarModeAdviceRequest.properties.futureResourcesSpecs.type - schemas.CalendarModeAdviceRequest.type - schemas.CalendarModeAdviceResponse.description - schemas.CalendarModeAdviceResponse.id - schemas.CalendarModeAdviceResponse.properties.recommendations.description - schemas.CalendarModeAdviceResponse.properties.recommendations.items.$ref - schemas.CalendarModeAdviceResponse.properties.recommendations.type - schemas.CalendarModeAdviceResponse.type - schemas.CalendarModeRecommendation.description - schemas.CalendarModeRecommendation.id - schemas.CalendarModeRecommendation.properties.recommendationsPerSpec.additionalProperties.$ref - schemas.CalendarModeRecommendation.properties.recommendationsPerSpec.description - schemas.CalendarModeRecommendation.properties.recommendationsPerSpec.type - schemas.CalendarModeRecommendation.type - schemas.CrossSiteNetwork.description - schemas.CrossSiteNetwork.id - schemas.CrossSiteNetwork.properties.creationTimestamp.description - schemas.CrossSiteNetwork.properties.creationTimestamp.type - schemas.CrossSiteNetwork.properties.description.description - schemas.CrossSiteNetwork.properties.description.type - schemas.CrossSiteNetwork.properties.id.description - schemas.CrossSiteNetwork.properties.id.format - schemas.CrossSiteNetwork.properties.id.type - schemas.CrossSiteNetwork.properties.kind.default - schemas.CrossSiteNetwork.properties.kind.description - schemas.CrossSiteNetwork.properties.kind.type - schemas.CrossSiteNetwork.properties.name.description - schemas.CrossSiteNetwork.properties.name.pattern - schemas.CrossSiteNetwork.properties.name.type - schemas.CrossSiteNetwork.properties.selfLink.description - schemas.CrossSiteNetwork.properties.selfLink.type - schemas.CrossSiteNetwork.properties.selfLinkWithId.description - schemas.CrossSiteNetwork.properties.selfLinkWithId.type - schemas.CrossSiteNetwork.type - schemas.CrossSiteNetworkList.description - schemas.CrossSiteNetworkList.id - schemas.CrossSiteNetworkList.properties.etag.type - schemas.CrossSiteNetworkList.properties.id.description - schemas.CrossSiteNetworkList.properties.id.type - schemas.CrossSiteNetworkList.properties.items.description - schemas.CrossSiteNetworkList.properties.items.items.$ref - schemas.CrossSiteNetworkList.properties.items.type - schemas.CrossSiteNetworkList.properties.kind.default - schemas.CrossSiteNetworkList.properties.kind.description - schemas.CrossSiteNetworkList.properties.kind.type - schemas.CrossSiteNetworkList.properties.nextPageToken.description - schemas.CrossSiteNetworkList.properties.nextPageToken.type - schemas.CrossSiteNetworkList.properties.selfLink.description - schemas.CrossSiteNetworkList.properties.selfLink.type - schemas.CrossSiteNetworkList.properties.unreachables.description - schemas.CrossSiteNetworkList.properties.unreachables.items.type - schemas.CrossSiteNetworkList.properties.unreachables.type - schemas.CrossSiteNetworkList.properties.warning.description - schemas.CrossSiteNetworkList.properties.warning.properties.code.description - schemas.CrossSiteNetworkList.properties.warning.properties.code.enum - schemas.CrossSiteNetworkList.properties.warning.properties.code.enumDeprecated - schemas.CrossSiteNetworkList.properties.warning.properties.code.enumDescriptions - schemas.CrossSiteNetworkList.properties.warning.properties.code.type - schemas.CrossSiteNetworkList.properties.warning.properties.data.description - schemas.CrossSiteNetworkList.properties.warning.properties.data.items.properties.key.description - schemas.CrossSiteNetworkList.properties.warning.properties.data.items.properties.key.type - schemas.CrossSiteNetworkList.properties.warning.properties.data.items.properties.value.description - schemas.CrossSiteNetworkList.properties.warning.properties.data.items.properties.value.type - schemas.CrossSiteNetworkList.properties.warning.properties.data.items.type - schemas.CrossSiteNetworkList.properties.warning.properties.data.type - schemas.CrossSiteNetworkList.properties.warning.properties.message.description - schemas.CrossSiteNetworkList.properties.warning.properties.message.type - schemas.CrossSiteNetworkList.properties.warning.type - schemas.CrossSiteNetworkList.type - schemas.DiskSettings.id - schemas.DiskSettings.properties.accessLocation.$ref - schemas.DiskSettings.properties.accessLocation.description - schemas.DiskSettings.type - schemas.DiskSettingsAccessLocation.id - schemas.DiskSettingsAccessLocation.properties.locations.additionalProperties.$ref - schemas.DiskSettingsAccessLocation.properties.locations.type - schemas.DiskSettingsAccessLocation.properties.policy.enum - schemas.DiskSettingsAccessLocation.properties.policy.enumDescriptions - schemas.DiskSettingsAccessLocation.properties.policy.type - schemas.DiskSettingsAccessLocation.type - schemas.DiskSettingsAccessLocationAccessLocationPreference.id - schemas.DiskSettingsAccessLocationAccessLocationPreference.properties.region.type - schemas.DiskSettingsAccessLocationAccessLocationPreference.type - schemas.FlexibleTimeRange.description - schemas.FlexibleTimeRange.id - schemas.FlexibleTimeRange.properties.endTimeNotEarlierThan.format - schemas.FlexibleTimeRange.properties.endTimeNotEarlierThan.type - schemas.FlexibleTimeRange.properties.endTimeNotLaterThan.format - schemas.FlexibleTimeRange.properties.endTimeNotLaterThan.type - schemas.FlexibleTimeRange.properties.maxDuration.format - schemas.FlexibleTimeRange.properties.maxDuration.type - schemas.FlexibleTimeRange.properties.minDuration.format - schemas.FlexibleTimeRange.properties.minDuration.type - schemas.FlexibleTimeRange.properties.startTimeNotEarlierThan.format - schemas.FlexibleTimeRange.properties.startTimeNotEarlierThan.type - schemas.FlexibleTimeRange.properties.startTimeNotLaterThan.format - schemas.FlexibleTimeRange.properties.startTimeNotLaterThan.type - schemas.FlexibleTimeRange.type - schemas.FutureReservation.properties.aggregateReservation.$ref - schemas.FutureReservation.properties.aggregateReservation.description - schemas.FutureReservation.properties.reservationMode.description - schemas.FutureReservation.properties.reservationMode.enum - schemas.FutureReservation.properties.reservationMode.enumDescriptions - schemas.FutureReservation.properties.reservationMode.type - schemas.FutureResourcesRecommendation.description - schemas.FutureResourcesRecommendation.id - schemas.FutureResourcesRecommendation.properties.endTime.format - schemas.FutureResourcesRecommendation.properties.endTime.type - schemas.FutureResourcesRecommendation.properties.location.description - schemas.FutureResourcesRecommendation.properties.location.type - schemas.FutureResourcesRecommendation.properties.otherLocations.additionalProperties.$ref - schemas.FutureResourcesRecommendation.properties.otherLocations.description - schemas.FutureResourcesRecommendation.properties.otherLocations.type - schemas.FutureResourcesRecommendation.properties.recommendationId.description - schemas.FutureResourcesRecommendation.properties.recommendationId.type - schemas.FutureResourcesRecommendation.properties.recommendationType.description - schemas.FutureResourcesRecommendation.properties.recommendationType.enum - schemas.FutureResourcesRecommendation.properties.recommendationType.enumDescriptions - schemas.FutureResourcesRecommendation.properties.recommendationType.type - schemas.FutureResourcesRecommendation.properties.startTime.format - schemas.FutureResourcesRecommendation.properties.startTime.type - schemas.FutureResourcesRecommendation.type - schemas.FutureResourcesRecommendationOtherLocation.description - schemas.FutureResourcesRecommendationOtherLocation.id - schemas.FutureResourcesRecommendationOtherLocation.properties.details.description - schemas.FutureResourcesRecommendationOtherLocation.properties.details.type - schemas.FutureResourcesRecommendationOtherLocation.properties.status.description - schemas.FutureResourcesRecommendationOtherLocation.properties.status.enum - schemas.FutureResourcesRecommendationOtherLocation.properties.status.enumDescriptions - schemas.FutureResourcesRecommendationOtherLocation.properties.status.type - schemas.FutureResourcesRecommendationOtherLocation.type - schemas.FutureResourcesSpec.description - schemas.FutureResourcesSpec.id - schemas.FutureResourcesSpec.properties.deploymentType.description - schemas.FutureResourcesSpec.properties.deploymentType.enum - schemas.FutureResourcesSpec.properties.deploymentType.enumDescriptions - schemas.FutureResourcesSpec.properties.deploymentType.type - schemas.FutureResourcesSpec.properties.locationPolicy.$ref - schemas.FutureResourcesSpec.properties.locationPolicy.description - schemas.FutureResourcesSpec.properties.targetResources.$ref - schemas.FutureResourcesSpec.properties.targetResources.description - schemas.FutureResourcesSpec.properties.timeRangeSpec.$ref - schemas.FutureResourcesSpec.properties.timeRangeSpec.description - schemas.FutureResourcesSpec.type - schemas.FutureResourcesSpecAggregateResources.id - schemas.FutureResourcesSpecAggregateResources.properties.acceleratorCount.description - schemas.FutureResourcesSpecAggregateResources.properties.acceleratorCount.format - schemas.FutureResourcesSpecAggregateResources.properties.acceleratorCount.type - schemas.FutureResourcesSpecAggregateResources.properties.vmFamily.description - schemas.FutureResourcesSpecAggregateResources.properties.vmFamily.enum - schemas.FutureResourcesSpecAggregateResources.properties.vmFamily.enumDescriptions - schemas.FutureResourcesSpecAggregateResources.properties.vmFamily.type - schemas.FutureResourcesSpecAggregateResources.properties.workloadType.description - schemas.FutureResourcesSpecAggregateResources.properties.workloadType.enum - schemas.FutureResourcesSpecAggregateResources.properties.workloadType.enumDescriptions - schemas.FutureResourcesSpecAggregateResources.properties.workloadType.type - schemas.FutureResourcesSpecAggregateResources.type - schemas.FutureResourcesSpecLocalSsdPartition.id - schemas.FutureResourcesSpecLocalSsdPartition.properties.diskInterface.description - schemas.FutureResourcesSpecLocalSsdPartition.properties.diskInterface.enum - schemas.FutureResourcesSpecLocalSsdPartition.properties.diskInterface.enumDescriptions - schemas.FutureResourcesSpecLocalSsdPartition.properties.diskInterface.type - schemas.FutureResourcesSpecLocalSsdPartition.properties.diskSizeGb.description - schemas.FutureResourcesSpecLocalSsdPartition.properties.diskSizeGb.format - schemas.FutureResourcesSpecLocalSsdPartition.properties.diskSizeGb.type - schemas.FutureResourcesSpecLocalSsdPartition.type - schemas.FutureResourcesSpecLocationPolicy.description - schemas.FutureResourcesSpecLocationPolicy.id - schemas.FutureResourcesSpecLocationPolicy.properties.locations.additionalProperties.$ref - schemas.FutureResourcesSpecLocationPolicy.properties.locations.description - schemas.FutureResourcesSpecLocationPolicy.properties.locations.type - schemas.FutureResourcesSpecLocationPolicy.type - schemas.FutureResourcesSpecLocationPolicyLocation.description - schemas.FutureResourcesSpecLocationPolicyLocation.id - schemas.FutureResourcesSpecLocationPolicyLocation.properties.preference.description - schemas.FutureResourcesSpecLocationPolicyLocation.properties.preference.enum - schemas.FutureResourcesSpecLocationPolicyLocation.properties.preference.enumDescriptions - schemas.FutureResourcesSpecLocationPolicyLocation.properties.preference.type - schemas.FutureResourcesSpecLocationPolicyLocation.type - schemas.FutureResourcesSpecSpecificSKUResources.id - schemas.FutureResourcesSpecSpecificSKUResources.properties.instanceCount.description - schemas.FutureResourcesSpecSpecificSKUResources.properties.instanceCount.format - schemas.FutureResourcesSpecSpecificSKUResources.properties.instanceCount.type - schemas.FutureResourcesSpecSpecificSKUResources.properties.localSsdPartitions.description - schemas.FutureResourcesSpecSpecificSKUResources.properties.localSsdPartitions.items.$ref - schemas.FutureResourcesSpecSpecificSKUResources.properties.localSsdPartitions.type - schemas.FutureResourcesSpecSpecificSKUResources.properties.machineType.description - schemas.FutureResourcesSpecSpecificSKUResources.properties.machineType.type - schemas.FutureResourcesSpecSpecificSKUResources.type - schemas.FutureResourcesSpecTargetResources.description - schemas.FutureResourcesSpecTargetResources.id - schemas.FutureResourcesSpecTargetResources.properties.aggregateResources.$ref - schemas.FutureResourcesSpecTargetResources.properties.specificSkuResources.$ref - schemas.FutureResourcesSpecTargetResources.type - schemas.InstanceGroupManagerInstanceLifecyclePolicy.properties.onFailedHealthCheck.description - schemas.InstanceGroupManagerInstanceLifecyclePolicy.properties.onFailedHealthCheck.enum - schemas.InstanceGroupManagerInstanceLifecyclePolicy.properties.onFailedHealthCheck.enumDescriptions - schemas.InstanceGroupManagerInstanceLifecyclePolicy.properties.onFailedHealthCheck.type - schemas.InstancesReportHostAsFaultyRequest.id - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.description - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.enum - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.enumDescriptions - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.type - schemas.InstancesReportHostAsFaultyRequest.properties.faultReasons.items.$ref - schemas.InstancesReportHostAsFaultyRequest.properties.faultReasons.type - schemas.InstancesReportHostAsFaultyRequest.type - schemas.InstancesReportHostAsFaultyRequestFaultReason.id - schemas.InstancesReportHostAsFaultyRequestFaultReason.properties.behavior.enum - schemas.InstancesReportHostAsFaultyRequestFaultReason.properties.behavior.enumDescriptions - schemas.InstancesReportHostAsFaultyRequestFaultReason.properties.behavior.type - schemas.InstancesReportHostAsFaultyRequestFaultReason.properties.description.type - schemas.InstancesReportHostAsFaultyRequestFaultReason.type - schemas.Interconnect.properties.wireGroups.description - schemas.Interconnect.properties.wireGroups.items.type - schemas.Interconnect.properties.wireGroups.type - schemas.InterconnectLocation.properties.crossSiteInterconnectInfos.description - schemas.InterconnectLocation.properties.crossSiteInterconnectInfos.items.$ref - schemas.InterconnectLocation.properties.crossSiteInterconnectInfos.type - schemas.InterconnectLocationCrossSiteInterconnectInfo.description - schemas.InterconnectLocationCrossSiteInterconnectInfo.id - schemas.InterconnectLocationCrossSiteInterconnectInfo.properties.city.description - schemas.InterconnectLocationCrossSiteInterconnectInfo.properties.city.type - schemas.InterconnectLocationCrossSiteInterconnectInfo.type - schemas.NetworkInterface.properties.parentNicName.description - schemas.NetworkInterface.properties.parentNicName.type - schemas.NetworkInterface.properties.vlan.description - schemas.NetworkInterface.properties.vlan.format - schemas.NetworkInterface.properties.vlan.type - schemas.NodeType.properties.maxVms.description - schemas.NodeType.properties.maxVms.format - schemas.NodeType.properties.maxVms.type - schemas.Reservation.properties.reservationMode.description - schemas.Reservation.properties.reservationMode.enum - schemas.Reservation.properties.reservationMode.enumDescriptions - schemas.Reservation.properties.reservationMode.type - schemas.ReservationsBlocksPerformMaintenanceRequest.id - schemas.ReservationsBlocksPerformMaintenanceRequest.properties.maintenanceScope.description - schemas.ReservationsBlocksPerformMaintenanceRequest.properties.maintenanceScope.enum - schemas.ReservationsBlocksPerformMaintenanceRequest.properties.maintenanceScope.enumDescriptions - schemas.ReservationsBlocksPerformMaintenanceRequest.properties.maintenanceScope.type - schemas.ReservationsBlocksPerformMaintenanceRequest.type - schemas.ReservationsPerformMaintenanceRequest.id - schemas.ReservationsPerformMaintenanceRequest.properties.maintenanceScope.description - schemas.ReservationsPerformMaintenanceRequest.properties.maintenanceScope.enum - schemas.ReservationsPerformMaintenanceRequest.properties.maintenanceScope.enumDescriptions - schemas.ReservationsPerformMaintenanceRequest.properties.maintenanceScope.type - schemas.ReservationsPerformMaintenanceRequest.type - schemas.ResourcePolicyGroupPlacementPolicy.properties.gpuTopology.description - schemas.ResourcePolicyGroupPlacementPolicy.properties.gpuTopology.type - schemas.ResourcePolicyWorkloadPolicy.properties.acceleratorTopology.type - schemas.ResourcePolicyWorkloadPolicy.properties.maxTopologyDistance.enum - schemas.ResourcePolicyWorkloadPolicy.properties.maxTopologyDistance.enumDescriptions - schemas.ResourcePolicyWorkloadPolicy.properties.maxTopologyDistance.type - schemas.Snapshot.properties.region.description - schemas.Snapshot.properties.region.type - schemas.SnapshotAggregatedList.id - schemas.SnapshotAggregatedList.properties.etag.type - schemas.SnapshotAggregatedList.properties.id.description - schemas.SnapshotAggregatedList.properties.id.type - schemas.SnapshotAggregatedList.properties.items.additionalProperties.$ref - schemas.SnapshotAggregatedList.properties.items.additionalProperties.description - schemas.SnapshotAggregatedList.properties.items.description - schemas.SnapshotAggregatedList.properties.items.type - schemas.SnapshotAggregatedList.properties.kind.default - schemas.SnapshotAggregatedList.properties.kind.description - schemas.SnapshotAggregatedList.properties.kind.type - schemas.SnapshotAggregatedList.properties.nextPageToken.description - schemas.SnapshotAggregatedList.properties.nextPageToken.type - schemas.SnapshotAggregatedList.properties.selfLink.description - schemas.SnapshotAggregatedList.properties.selfLink.type - schemas.SnapshotAggregatedList.properties.unreachables.description - schemas.SnapshotAggregatedList.properties.unreachables.items.type - schemas.SnapshotAggregatedList.properties.unreachables.type - schemas.SnapshotAggregatedList.properties.warning.description - schemas.SnapshotAggregatedList.properties.warning.properties.code.description - schemas.SnapshotAggregatedList.properties.warning.properties.code.enum - schemas.SnapshotAggregatedList.properties.warning.properties.code.enumDeprecated - schemas.SnapshotAggregatedList.properties.warning.properties.code.enumDescriptions - schemas.SnapshotAggregatedList.properties.warning.properties.code.type - schemas.SnapshotAggregatedList.properties.warning.properties.data.description - schemas.SnapshotAggregatedList.properties.warning.properties.data.items.properties.key.description - schemas.SnapshotAggregatedList.properties.warning.properties.data.items.properties.key.type - schemas.SnapshotAggregatedList.properties.warning.properties.data.items.properties.value.description - schemas.SnapshotAggregatedList.properties.warning.properties.data.items.properties.value.type - schemas.SnapshotAggregatedList.properties.warning.properties.data.items.type - schemas.SnapshotAggregatedList.properties.warning.properties.data.type - schemas.SnapshotAggregatedList.properties.warning.properties.message.description - schemas.SnapshotAggregatedList.properties.warning.properties.message.type - schemas.SnapshotAggregatedList.properties.warning.type - schemas.SnapshotAggregatedList.type - schemas.SnapshotSettings.properties.accessLocation.$ref - schemas.SnapshotSettings.properties.accessLocation.description - schemas.SnapshotSettingsAccessLocation.id - schemas.SnapshotSettingsAccessLocation.properties.locations.additionalProperties.$ref - schemas.SnapshotSettingsAccessLocation.properties.locations.description - schemas.SnapshotSettingsAccessLocation.properties.locations.type - schemas.SnapshotSettingsAccessLocation.properties.policy.description - schemas.SnapshotSettingsAccessLocation.properties.policy.enum - schemas.SnapshotSettingsAccessLocation.properties.policy.enumDescriptions - schemas.SnapshotSettingsAccessLocation.properties.policy.type - schemas.SnapshotSettingsAccessLocation.type - schemas.SnapshotSettingsAccessLocationAccessLocationPreference.description - schemas.SnapshotSettingsAccessLocationAccessLocationPreference.id - schemas.SnapshotSettingsAccessLocationAccessLocationPreference.properties.region.description - schemas.SnapshotSettingsAccessLocationAccessLocationPreference.properties.region.type - schemas.SnapshotSettingsAccessLocationAccessLocationPreference.type - schemas.SnapshotsScopedList.id - schemas.SnapshotsScopedList.properties.snapshots.description - schemas.SnapshotsScopedList.properties.snapshots.items.$ref - schemas.SnapshotsScopedList.properties.snapshots.type - schemas.SnapshotsScopedList.properties.warning.description - schemas.SnapshotsScopedList.properties.warning.properties.code.description - schemas.SnapshotsScopedList.properties.warning.properties.code.enum - schemas.SnapshotsScopedList.properties.warning.properties.code.enumDeprecated - schemas.SnapshotsScopedList.properties.warning.properties.code.enumDescriptions - schemas.SnapshotsScopedList.properties.warning.properties.code.type - schemas.SnapshotsScopedList.properties.warning.properties.data.description - schemas.SnapshotsScopedList.properties.warning.properties.data.items.properties.key.description - schemas.SnapshotsScopedList.properties.warning.properties.data.items.properties.key.type - schemas.SnapshotsScopedList.properties.warning.properties.data.items.properties.value.description - schemas.SnapshotsScopedList.properties.warning.properties.data.items.properties.value.type - schemas.SnapshotsScopedList.properties.warning.properties.data.items.type - schemas.SnapshotsScopedList.properties.warning.properties.data.type - schemas.SnapshotsScopedList.properties.warning.properties.message.description - schemas.SnapshotsScopedList.properties.warning.properties.message.type - schemas.SnapshotsScopedList.properties.warning.type - schemas.SnapshotsScopedList.type - schemas.Wire.description - schemas.Wire.id - schemas.Wire.properties.adminEnabled.description - schemas.Wire.properties.adminEnabled.type - schemas.Wire.properties.endpoints.description - schemas.Wire.properties.endpoints.items.$ref - schemas.Wire.properties.endpoints.type - schemas.Wire.properties.label.description - schemas.Wire.properties.label.type - schemas.Wire.properties.wireProperties.$ref - schemas.Wire.properties.wireProperties.description - schemas.Wire.type - schemas.WireEndpoint.description - schemas.WireEndpoint.id - schemas.WireEndpoint.properties.interconnect.type - schemas.WireEndpoint.properties.vlanTag.format - schemas.WireEndpoint.properties.vlanTag.type - schemas.WireEndpoint.type - schemas.WireGroup.description - schemas.WireGroup.id - schemas.WireGroup.properties.adminEnabled.description - schemas.WireGroup.properties.adminEnabled.type - schemas.WireGroup.properties.creationTimestamp.description - schemas.WireGroup.properties.creationTimestamp.type - schemas.WireGroup.properties.description.description - schemas.WireGroup.properties.description.type - schemas.WireGroup.properties.endpoints.additionalProperties.$ref - schemas.WireGroup.properties.endpoints.description - schemas.WireGroup.properties.endpoints.type - schemas.WireGroup.properties.id.description - schemas.WireGroup.properties.id.format - schemas.WireGroup.properties.id.type - schemas.WireGroup.properties.kind.default - schemas.WireGroup.properties.kind.description - schemas.WireGroup.properties.kind.type - schemas.WireGroup.properties.name.description - schemas.WireGroup.properties.name.pattern - schemas.WireGroup.properties.name.type - schemas.WireGroup.properties.selfLink.description - schemas.WireGroup.properties.selfLink.type - schemas.WireGroup.properties.selfLinkWithId.type - schemas.WireGroup.properties.topology.$ref - schemas.WireGroup.properties.topology.description - schemas.WireGroup.properties.wireGroupProperties.$ref - schemas.WireGroup.properties.wireGroupProperties.description - schemas.WireGroup.properties.wireProperties.$ref - schemas.WireGroup.properties.wireProperties.description - schemas.WireGroup.properties.wires.description - schemas.WireGroup.properties.wires.items.$ref - schemas.WireGroup.properties.wires.type - schemas.WireGroup.type - schemas.WireGroupEndpoint.description - schemas.WireGroupEndpoint.id - schemas.WireGroupEndpoint.properties.interconnects.additionalProperties.$ref - schemas.WireGroupEndpoint.properties.interconnects.description - schemas.WireGroupEndpoint.properties.interconnects.type - schemas.WireGroupEndpoint.type - schemas.WireGroupEndpointInterconnect.description - schemas.WireGroupEndpointInterconnect.id - schemas.WireGroupEndpointInterconnect.properties.interconnect.description - schemas.WireGroupEndpointInterconnect.properties.interconnect.type - schemas.WireGroupEndpointInterconnect.properties.vlanTags.description - schemas.WireGroupEndpointInterconnect.properties.vlanTags.items.format - schemas.WireGroupEndpointInterconnect.properties.vlanTags.items.type - schemas.WireGroupEndpointInterconnect.properties.vlanTags.type - schemas.WireGroupEndpointInterconnect.type - schemas.WireGroupList.description - schemas.WireGroupList.id - schemas.WireGroupList.properties.etag.type - schemas.WireGroupList.properties.id.description - schemas.WireGroupList.properties.id.type - schemas.WireGroupList.properties.items.description - schemas.WireGroupList.properties.items.items.$ref - schemas.WireGroupList.properties.items.type - schemas.WireGroupList.properties.kind.default - schemas.WireGroupList.properties.kind.description - schemas.WireGroupList.properties.kind.type - schemas.WireGroupList.properties.nextPageToken.description - schemas.WireGroupList.properties.nextPageToken.type - schemas.WireGroupList.properties.selfLink.description - schemas.WireGroupList.properties.selfLink.type - schemas.WireGroupList.properties.unreachables.description - schemas.WireGroupList.properties.unreachables.items.type - schemas.WireGroupList.properties.unreachables.type - schemas.WireGroupList.properties.warning.description - schemas.WireGroupList.properties.warning.properties.code.description - schemas.WireGroupList.properties.warning.properties.code.enum - schemas.WireGroupList.properties.warning.properties.code.enumDeprecated - schemas.WireGroupList.properties.warning.properties.code.enumDescriptions - schemas.WireGroupList.properties.warning.properties.code.type - schemas.WireGroupList.properties.warning.properties.data.description - schemas.WireGroupList.properties.warning.properties.data.items.properties.key.description - schemas.WireGroupList.properties.warning.properties.data.items.properties.key.type - schemas.WireGroupList.properties.warning.properties.data.items.properties.value.description - schemas.WireGroupList.properties.warning.properties.data.items.properties.value.type - schemas.WireGroupList.properties.warning.properties.data.items.type - schemas.WireGroupList.properties.warning.properties.data.type - schemas.WireGroupList.properties.warning.properties.message.description - schemas.WireGroupList.properties.warning.properties.message.type - schemas.WireGroupList.properties.warning.type - schemas.WireGroupList.type - schemas.WireGroupProperties.description - schemas.WireGroupProperties.id - schemas.WireGroupProperties.properties.type.description - schemas.WireGroupProperties.properties.type.enum - schemas.WireGroupProperties.properties.type.enumDescriptions - schemas.WireGroupProperties.properties.type.type - schemas.WireGroupProperties.type - schemas.WireGroupTopology.description - schemas.WireGroupTopology.id - schemas.WireGroupTopology.properties.endpoints.description - schemas.WireGroupTopology.properties.endpoints.items.$ref - schemas.WireGroupTopology.properties.endpoints.type - schemas.WireGroupTopology.type - schemas.WireGroupTopologyEndpoint.description - schemas.WireGroupTopologyEndpoint.id - schemas.WireGroupTopologyEndpoint.properties.city.description - schemas.WireGroupTopologyEndpoint.properties.city.type - schemas.WireGroupTopologyEndpoint.properties.label.description - schemas.WireGroupTopologyEndpoint.properties.label.type - schemas.WireGroupTopologyEndpoint.type - schemas.WireProperties.description - schemas.WireProperties.id - schemas.WireProperties.properties.bandwidthUnmetered.description - schemas.WireProperties.properties.bandwidthUnmetered.format - schemas.WireProperties.properties.bandwidthUnmetered.type - schemas.WireProperties.properties.faultResponse.description - schemas.WireProperties.properties.faultResponse.enum - schemas.WireProperties.properties.faultResponse.enumDescriptions - schemas.WireProperties.properties.faultResponse.type - schemas.WireProperties.type The following keys were changed: - resources.organizationSecurityPolicies.methods.addAssociation.description - resources.organizationSecurityPolicies.methods.copyRules.description - resources.organizationSecurityPolicies.methods.delete.description - resources.organizationSecurityPolicies.methods.get.description - resources.organizationSecurityPolicies.methods.getAssociation.description - resources.organizationSecurityPolicies.methods.getRule.description - resources.organizationSecurityPolicies.methods.insert.description - resources.organizationSecurityPolicies.methods.list.description - resources.organizationSecurityPolicies.methods.listAssociations.description - resources.organizationSecurityPolicies.methods.move.description - resources.organizationSecurityPolicies.methods.patch.description - resources.organizationSecurityPolicies.methods.patchRule.description - resources.organizationSecurityPolicies.methods.removeAssociation.description - resources.regionCommitments.methods.update.description - resources.regionCommitments.methods.update.parameters.commitment.description - resources.regionCommitments.methods.updateReservations.description - resources.regionCommitments.methods.updateReservations.parameters.commitment.description - schemas.AllocationAggregateReservation.properties.vmFamily.enum - schemas.AllocationAggregateReservation.properties.vmFamily.enumDescriptions - schemas.BackendCustomMetric.properties.name.description - schemas.BackendServiceCustomMetric.properties.name.description - schemas.Commitment.description - schemas.Commitment.properties.autoRenew.description - schemas.Commitment.properties.category.description - schemas.Commitment.properties.customEndTimestamp.description - schemas.Commitment.properties.description.description - schemas.Commitment.properties.mergeSourceCommitments.description - schemas.Commitment.properties.name.description - schemas.Commitment.properties.plan.description - schemas.Commitment.properties.region.description - schemas.Commitment.properties.reservations.description - schemas.Commitment.properties.resources.description - schemas.Commitment.properties.splitSourceCommitment.description - schemas.Commitment.properties.status.description - schemas.Commitment.properties.type.description - schemas.Commitment.properties.type.enum - schemas.Commitment.properties.type.enumDescriptions - schemas.CommitmentsScopedList.properties.commitments.description - schemas.Interconnect.properties.availableFeatures.items.enum - schemas.Interconnect.properties.availableFeatures.items.enumDescriptions - schemas.Interconnect.properties.requestedFeatures.items.enum - schemas.Interconnect.properties.requestedFeatures.items.enumDescriptions - schemas.InterconnectLocation.properties.availableFeatures.items.enum - schemas.InterconnectLocation.properties.availableFeatures.items.enumDescriptions - schemas.LicenseResourceCommitment.properties.amount.description - schemas.LicenseResourceCommitment.properties.coresPerLicense.description - schemas.LicenseResourceCommitment.properties.license.description - schemas.ManagedInstancePropertiesFromFlexibilityPolicy.properties.provisioningModel.enum - schemas.ManagedInstancePropertiesFromFlexibilityPolicy.properties.provisioningModel.enumDescriptions - schemas.RegionCommitmentsUpdateReservationsRequest.properties.reservations.description - schemas.ResourceCommitment.description - schemas.ResourceCommitment.properties.acceleratorType.description - schemas.ResourceCommitment.properties.amount.description - schemas.ResourceCommitment.properties.type.description - schemas.RouterBgpPeer.properties.exportPolicies.description - schemas.RouterBgpPeer.properties.importPolicies.description - schemas.RouterInterface.properties.ipRange.description - schemas.Scheduling.properties.provisioningModel.enum - schemas.Scheduling.properties.provisioningModel.enumDescriptions - schemas.Snapshot.properties.sourceInstantSnapshotId.description - schemas.Subnetwork.properties.purpose.description - schemas.TargetHttpsProxy.properties.serverTlsPolicy.description - schemas.UsableSubnetwork.properties.purpose.description #### compute:v1 The following keys were deleted: - schemas.Commitment.properties.existingReservations.description - schemas.NetworkProfile.properties.zone.description - schemas.NetworkProfile.properties.zone.type The following keys were added: - resources.instances.methods.reportHostAsFaulty.description - resources.instances.methods.reportHostAsFaulty.flatPath - resources.instances.methods.reportHostAsFaulty.httpMethod - resources.instances.methods.reportHostAsFaulty.id - resources.instances.methods.reportHostAsFaulty.parameterOrder - resources.instances.methods.reportHostAsFaulty.parameters.instance.description - resources.instances.methods.reportHostAsFaulty.parameters.instance.location - resources.instances.methods.reportHostAsFaulty.parameters.instance.pattern - resources.instances.methods.reportHostAsFaulty.parameters.instance.required - resources.instances.methods.reportHostAsFaulty.parameters.instance.type - resources.instances.methods.reportHostAsFaulty.parameters.project.description - resources.instances.methods.reportHostAsFaulty.parameters.project.location - resources.instances.methods.reportHostAsFaulty.parameters.project.pattern - resources.instances.methods.reportHostAsFaulty.parameters.project.required - resources.instances.methods.reportHostAsFaulty.parameters.project.type - resources.instances.methods.reportHostAsFaulty.parameters.requestId.description - resources.instances.methods.reportHostAsFaulty.parameters.requestId.location - resources.instances.methods.reportHostAsFaulty.parameters.requestId.type - resources.instances.methods.reportHostAsFaulty.parameters.zone.description - resources.instances.methods.reportHostAsFaulty.parameters.zone.location - resources.instances.methods.reportHostAsFaulty.parameters.zone.pattern - resources.instances.methods.reportHostAsFaulty.parameters.zone.required - resources.instances.methods.reportHostAsFaulty.parameters.zone.type - resources.instances.methods.reportHostAsFaulty.path - resources.instances.methods.reportHostAsFaulty.request.$ref - resources.instances.methods.reportHostAsFaulty.response.$ref - resources.instances.methods.reportHostAsFaulty.scopes - resources.networkFirewallPolicies.methods.addPacketMirroringRule.description - resources.networkFirewallPolicies.methods.addPacketMirroringRule.flatPath - resources.networkFirewallPolicies.methods.addPacketMirroringRule.httpMethod - resources.networkFirewallPolicies.methods.addPacketMirroringRule.id - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameterOrder - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.firewallPolicy.description - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.firewallPolicy.location - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.firewallPolicy.pattern - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.firewallPolicy.required - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.firewallPolicy.type - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.maxPriority.description - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.maxPriority.format - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.maxPriority.location - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.maxPriority.type - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.minPriority.description - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.minPriority.format - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.minPriority.location - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.minPriority.type - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.project.description - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.project.location - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.project.pattern - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.project.required - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.project.type - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.requestId.description - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.requestId.location - resources.networkFirewallPolicies.methods.addPacketMirroringRule.parameters.requestId.type - resources.networkFirewallPolicies.methods.addPacketMirroringRule.path - resources.networkFirewallPolicies.methods.addPacketMirroringRule.request.$ref - resources.networkFirewallPolicies.methods.addPacketMirroringRule.response.$ref - resources.networkFirewallPolicies.methods.addPacketMirroringRule.scopes - resources.networkFirewallPolicies.methods.getPacketMirroringRule.description - resources.networkFirewallPolicies.methods.getPacketMirroringRule.flatPath - resources.networkFirewallPolicies.methods.getPacketMirroringRule.httpMethod - resources.networkFirewallPolicies.methods.getPacketMirroringRule.id - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameterOrder - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.firewallPolicy.description - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.firewallPolicy.location - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.firewallPolicy.pattern - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.firewallPolicy.required - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.firewallPolicy.type - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.priority.description - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.priority.format - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.priority.location - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.priority.type - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.project.description - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.project.location - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.project.pattern - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.project.required - resources.networkFirewallPolicies.methods.getPacketMirroringRule.parameters.project.type - resources.networkFirewallPolicies.methods.getPacketMirroringRule.path - resources.networkFirewallPolicies.methods.getPacketMirroringRule.response.$ref - resources.networkFirewallPolicies.methods.getPacketMirroringRule.scopes - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.description - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.flatPath - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.httpMethod - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.id - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameterOrder - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.firewallPolicy.description - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.firewallPolicy.location - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.firewallPolicy.pattern - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.firewallPolicy.required - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.firewallPolicy.type - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.priority.description - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.priority.format - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.priority.location - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.priority.type - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.project.description - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.project.location - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.project.pattern - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.project.required - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.project.type - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.requestId.description - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.requestId.location - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.parameters.requestId.type - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.path - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.request.$ref - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.response.$ref - resources.networkFirewallPolicies.methods.patchPacketMirroringRule.scopes - resources.networkFirewallPolicies.methods.removePacketMirroringRule.description - resources.networkFirewallPolicies.methods.removePacketMirroringRule.flatPath - resources.networkFirewallPolicies.methods.removePacketMirroringRule.httpMethod - resources.networkFirewallPolicies.methods.removePacketMirroringRule.id - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameterOrder - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.firewallPolicy.description - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.firewallPolicy.location - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.firewallPolicy.pattern - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.firewallPolicy.required - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.firewallPolicy.type - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.priority.description - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.priority.format - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.priority.location - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.priority.type - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.project.description - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.project.location - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.project.pattern - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.project.required - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.project.type - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.requestId.description - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.requestId.location - resources.networkFirewallPolicies.methods.removePacketMirroringRule.parameters.requestId.type - resources.networkFirewallPolicies.methods.removePacketMirroringRule.path - resources.networkFirewallPolicies.methods.removePacketMirroringRule.response.$ref - resources.networkFirewallPolicies.methods.removePacketMirroringRule.scopes - resources.routers.methods.deleteRoutePolicy.description - resources.routers.methods.deleteRoutePolicy.flatPath - resources.routers.methods.deleteRoutePolicy.httpMethod - resources.routers.methods.deleteRoutePolicy.id - resources.routers.methods.deleteRoutePolicy.parameterOrder - resources.routers.methods.deleteRoutePolicy.parameters.policy.description - resources.routers.methods.deleteRoutePolicy.parameters.policy.location - resources.routers.methods.deleteRoutePolicy.parameters.policy.type - resources.routers.methods.deleteRoutePolicy.parameters.project.description - resources.routers.methods.deleteRoutePolicy.parameters.project.location - resources.routers.methods.deleteRoutePolicy.parameters.project.pattern - resources.routers.methods.deleteRoutePolicy.parameters.project.required - resources.routers.methods.deleteRoutePolicy.parameters.project.type - resources.routers.methods.deleteRoutePolicy.parameters.region.description - resources.routers.methods.deleteRoutePolicy.parameters.region.location - resources.routers.methods.deleteRoutePolicy.parameters.region.pattern - resources.routers.methods.deleteRoutePolicy.parameters.region.required - resources.routers.methods.deleteRoutePolicy.parameters.region.type - resources.routers.methods.deleteRoutePolicy.parameters.requestId.description - resources.routers.methods.deleteRoutePolicy.parameters.requestId.location - resources.routers.methods.deleteRoutePolicy.parameters.requestId.type - resources.routers.methods.deleteRoutePolicy.parameters.router.description - resources.routers.methods.deleteRoutePolicy.parameters.router.location - resources.routers.methods.deleteRoutePolicy.parameters.router.pattern - resources.routers.methods.deleteRoutePolicy.parameters.router.required - resources.routers.methods.deleteRoutePolicy.parameters.router.type - resources.routers.methods.deleteRoutePolicy.path - resources.routers.methods.deleteRoutePolicy.response.$ref - resources.routers.methods.deleteRoutePolicy.scopes - resources.routers.methods.getRoutePolicy.description - resources.routers.methods.getRoutePolicy.flatPath - resources.routers.methods.getRoutePolicy.httpMethod - resources.routers.methods.getRoutePolicy.id - resources.routers.methods.getRoutePolicy.parameterOrder - resources.routers.methods.getRoutePolicy.parameters.policy.description - resources.routers.methods.getRoutePolicy.parameters.policy.location - resources.routers.methods.getRoutePolicy.parameters.policy.type - resources.routers.methods.getRoutePolicy.parameters.project.description - resources.routers.methods.getRoutePolicy.parameters.project.location - resources.routers.methods.getRoutePolicy.parameters.project.pattern - resources.routers.methods.getRoutePolicy.parameters.project.required - resources.routers.methods.getRoutePolicy.parameters.project.type - resources.routers.methods.getRoutePolicy.parameters.region.description - resources.routers.methods.getRoutePolicy.parameters.region.location - resources.routers.methods.getRoutePolicy.parameters.region.pattern - resources.routers.methods.getRoutePolicy.parameters.region.required - resources.routers.methods.getRoutePolicy.parameters.region.type - resources.routers.methods.getRoutePolicy.parameters.router.description - resources.routers.methods.getRoutePolicy.parameters.router.location - resources.routers.methods.getRoutePolicy.parameters.router.required - resources.routers.methods.getRoutePolicy.parameters.router.type - resources.routers.methods.getRoutePolicy.path - resources.routers.methods.getRoutePolicy.response.$ref - resources.routers.methods.getRoutePolicy.scopes - resources.routers.methods.listBgpRoutes.description - resources.routers.methods.listBgpRoutes.flatPath - resources.routers.methods.listBgpRoutes.httpMethod - resources.routers.methods.listBgpRoutes.id - resources.routers.methods.listBgpRoutes.parameterOrder - resources.routers.methods.listBgpRoutes.parameters.addressFamily.default - resources.routers.methods.listBgpRoutes.parameters.addressFamily.description - resources.routers.methods.listBgpRoutes.parameters.addressFamily.enum - resources.routers.methods.listBgpRoutes.parameters.addressFamily.enumDescriptions - resources.routers.methods.listBgpRoutes.parameters.addressFamily.location - resources.routers.methods.listBgpRoutes.parameters.addressFamily.type - resources.routers.methods.listBgpRoutes.parameters.destinationPrefix.description - resources.routers.methods.listBgpRoutes.parameters.destinationPrefix.location - resources.routers.methods.listBgpRoutes.parameters.destinationPrefix.type - resources.routers.methods.listBgpRoutes.parameters.filter.description - resources.routers.methods.listBgpRoutes.parameters.filter.location - resources.routers.methods.listBgpRoutes.parameters.filter.type - resources.routers.methods.listBgpRoutes.parameters.maxResults.default - resources.routers.methods.listBgpRoutes.parameters.maxResults.description - resources.routers.methods.listBgpRoutes.parameters.maxResults.format - resources.routers.methods.listBgpRoutes.parameters.maxResults.location - resources.routers.methods.listBgpRoutes.parameters.maxResults.minimum - resources.routers.methods.listBgpRoutes.parameters.maxResults.type - resources.routers.methods.listBgpRoutes.parameters.orderBy.description - resources.routers.methods.listBgpRoutes.parameters.orderBy.location - resources.routers.methods.listBgpRoutes.parameters.orderBy.type - resources.routers.methods.listBgpRoutes.parameters.pageToken.description - resources.routers.methods.listBgpRoutes.parameters.pageToken.location - resources.routers.methods.listBgpRoutes.parameters.pageToken.type - resources.routers.methods.listBgpRoutes.parameters.peer.description - resources.routers.methods.listBgpRoutes.parameters.peer.location - resources.routers.methods.listBgpRoutes.parameters.peer.type - resources.routers.methods.listBgpRoutes.parameters.policyApplied.default - resources.routers.methods.listBgpRoutes.parameters.policyApplied.description - resources.routers.methods.listBgpRoutes.parameters.policyApplied.location - resources.routers.methods.listBgpRoutes.parameters.policyApplied.type - resources.routers.methods.listBgpRoutes.parameters.project.description - resources.routers.methods.listBgpRoutes.parameters.project.location - resources.routers.methods.listBgpRoutes.parameters.project.pattern - resources.routers.methods.listBgpRoutes.parameters.project.required - resources.routers.methods.listBgpRoutes.parameters.project.type - resources.routers.methods.listBgpRoutes.parameters.region.description - resources.routers.methods.listBgpRoutes.parameters.region.location - resources.routers.methods.listBgpRoutes.parameters.region.pattern - resources.routers.methods.listBgpRoutes.parameters.region.required - resources.routers.methods.listBgpRoutes.parameters.region.type - resources.routers.methods.listBgpRoutes.parameters.returnPartialSuccess.description - resources.routers.methods.listBgpRoutes.parameters.returnPartialSuccess.location - resources.routers.methods.listBgpRoutes.parameters.returnPartialSuccess.type - resources.routers.methods.listBgpRoutes.parameters.routeType.default - resources.routers.methods.listBgpRoutes.parameters.routeType.description - resources.routers.methods.listBgpRoutes.parameters.routeType.enum - resources.routers.methods.listBgpRoutes.parameters.routeType.enumDescriptions - resources.routers.methods.listBgpRoutes.parameters.routeType.location - resources.routers.methods.listBgpRoutes.parameters.routeType.type - resources.routers.methods.listBgpRoutes.parameters.router.description - resources.routers.methods.listBgpRoutes.parameters.router.location - resources.routers.methods.listBgpRoutes.parameters.router.pattern - resources.routers.methods.listBgpRoutes.parameters.router.required - resources.routers.methods.listBgpRoutes.parameters.router.type - resources.routers.methods.listBgpRoutes.path - resources.routers.methods.listBgpRoutes.response.$ref - resources.routers.methods.listBgpRoutes.scopes - resources.routers.methods.listRoutePolicies.description - resources.routers.methods.listRoutePolicies.flatPath - resources.routers.methods.listRoutePolicies.httpMethod - resources.routers.methods.listRoutePolicies.id - resources.routers.methods.listRoutePolicies.parameterOrder - resources.routers.methods.listRoutePolicies.parameters.filter.description - resources.routers.methods.listRoutePolicies.parameters.filter.location - resources.routers.methods.listRoutePolicies.parameters.filter.type - resources.routers.methods.listRoutePolicies.parameters.maxResults.default - resources.routers.methods.listRoutePolicies.parameters.maxResults.description - resources.routers.methods.listRoutePolicies.parameters.maxResults.format - resources.routers.methods.listRoutePolicies.parameters.maxResults.location - resources.routers.methods.listRoutePolicies.parameters.maxResults.minimum - resources.routers.methods.listRoutePolicies.parameters.maxResults.type - resources.routers.methods.listRoutePolicies.parameters.orderBy.description - resources.routers.methods.listRoutePolicies.parameters.orderBy.location - resources.routers.methods.listRoutePolicies.parameters.orderBy.type - resources.routers.methods.listRoutePolicies.parameters.pageToken.description - resources.routers.methods.listRoutePolicies.parameters.pageToken.location - resources.routers.methods.listRoutePolicies.parameters.pageToken.type - resources.routers.methods.listRoutePolicies.parameters.project.description - resources.routers.methods.listRoutePolicies.parameters.project.location - resources.routers.methods.listRoutePolicies.parameters.project.pattern - resources.routers.methods.listRoutePolicies.parameters.project.required - resources.routers.methods.listRoutePolicies.parameters.project.type - resources.routers.methods.listRoutePolicies.parameters.region.description - resources.routers.methods.listRoutePolicies.parameters.region.location - resources.routers.methods.listRoutePolicies.parameters.region.pattern - resources.routers.methods.listRoutePolicies.parameters.region.required - resources.routers.methods.listRoutePolicies.parameters.region.type - resources.routers.methods.listRoutePolicies.parameters.returnPartialSuccess.description - resources.routers.methods.listRoutePolicies.parameters.returnPartialSuccess.location - resources.routers.methods.listRoutePolicies.parameters.returnPartialSuccess.type - resources.routers.methods.listRoutePolicies.parameters.router.description - resources.routers.methods.listRoutePolicies.parameters.router.location - resources.routers.methods.listRoutePolicies.parameters.router.pattern - resources.routers.methods.listRoutePolicies.parameters.router.required - resources.routers.methods.listRoutePolicies.parameters.router.type - resources.routers.methods.listRoutePolicies.path - resources.routers.methods.listRoutePolicies.response.$ref - resources.routers.methods.listRoutePolicies.scopes - resources.routers.methods.patchRoutePolicy.description - resources.routers.methods.patchRoutePolicy.flatPath - resources.routers.methods.patchRoutePolicy.httpMethod - resources.routers.methods.patchRoutePolicy.id - resources.routers.methods.patchRoutePolicy.parameterOrder - resources.routers.methods.patchRoutePolicy.parameters.project.description - resources.routers.methods.patchRoutePolicy.parameters.project.location - resources.routers.methods.patchRoutePolicy.parameters.project.pattern - resources.routers.methods.patchRoutePolicy.parameters.project.required - resources.routers.methods.patchRoutePolicy.parameters.project.type - resources.routers.methods.patchRoutePolicy.parameters.region.description - resources.routers.methods.patchRoutePolicy.parameters.region.location - resources.routers.methods.patchRoutePolicy.parameters.region.pattern - resources.routers.methods.patchRoutePolicy.parameters.region.required - resources.routers.methods.patchRoutePolicy.parameters.region.type - resources.routers.methods.patchRoutePolicy.parameters.requestId.description - resources.routers.methods.patchRoutePolicy.parameters.requestId.location - resources.routers.methods.patchRoutePolicy.parameters.requestId.type - resources.routers.methods.patchRoutePolicy.parameters.router.description - resources.routers.methods.patchRoutePolicy.parameters.router.location - resources.routers.methods.patchRoutePolicy.parameters.router.pattern - resources.routers.methods.patchRoutePolicy.parameters.router.required - resources.routers.methods.patchRoutePolicy.parameters.router.type - resources.routers.methods.patchRoutePolicy.path - resources.routers.methods.patchRoutePolicy.request.$ref - resources.routers.methods.patchRoutePolicy.response.$ref - resources.routers.methods.patchRoutePolicy.scopes - resources.routers.methods.updateRoutePolicy.description - resources.routers.methods.updateRoutePolicy.flatPath - resources.routers.methods.updateRoutePolicy.httpMethod - resources.routers.methods.updateRoutePolicy.id - resources.routers.methods.updateRoutePolicy.parameterOrder - resources.routers.methods.updateRoutePolicy.parameters.project.description - resources.routers.methods.updateRoutePolicy.parameters.project.location - resources.routers.methods.updateRoutePolicy.parameters.project.pattern - resources.routers.methods.updateRoutePolicy.parameters.project.required - resources.routers.methods.updateRoutePolicy.parameters.project.type - resources.routers.methods.updateRoutePolicy.parameters.region.description - resources.routers.methods.updateRoutePolicy.parameters.region.location - resources.routers.methods.updateRoutePolicy.parameters.region.pattern - resources.routers.methods.updateRoutePolicy.parameters.region.required - resources.routers.methods.updateRoutePolicy.parameters.region.type - resources.routers.methods.updateRoutePolicy.parameters.requestId.description - resources.routers.methods.updateRoutePolicy.parameters.requestId.location - resources.routers.methods.updateRoutePolicy.parameters.requestId.type - resources.routers.methods.updateRoutePolicy.parameters.router.description - resources.routers.methods.updateRoutePolicy.parameters.router.location - resources.routers.methods.updateRoutePolicy.parameters.router.pattern - resources.routers.methods.updateRoutePolicy.parameters.router.required - resources.routers.methods.updateRoutePolicy.parameters.router.type - resources.routers.methods.updateRoutePolicy.path - resources.routers.methods.updateRoutePolicy.request.$ref - resources.routers.methods.updateRoutePolicy.response.$ref - resources.routers.methods.updateRoutePolicy.scopes - schemas.AllocationReservationSharingPolicy.id - schemas.AllocationReservationSharingPolicy.properties.serviceShareType.description - schemas.AllocationReservationSharingPolicy.properties.serviceShareType.enum - schemas.AllocationReservationSharingPolicy.properties.serviceShareType.enumDescriptions - schemas.AllocationReservationSharingPolicy.properties.serviceShareType.type - schemas.AllocationReservationSharingPolicy.type - schemas.AllocationResourceStatusSpecificSKUAllocation.properties.utilizations.additionalProperties.format - schemas.AllocationResourceStatusSpecificSKUAllocation.properties.utilizations.additionalProperties.type - schemas.AllocationResourceStatusSpecificSKUAllocation.properties.utilizations.description - schemas.AllocationResourceStatusSpecificSKUAllocation.properties.utilizations.type - schemas.Backend.properties.customMetrics.description - schemas.Backend.properties.customMetrics.items.$ref - schemas.Backend.properties.customMetrics.type - schemas.BackendCustomMetric.description - schemas.BackendCustomMetric.id - schemas.BackendCustomMetric.properties.dryRun.description - schemas.BackendCustomMetric.properties.dryRun.type - schemas.BackendCustomMetric.properties.maxUtilization.description - schemas.BackendCustomMetric.properties.maxUtilization.format - schemas.BackendCustomMetric.properties.maxUtilization.type - schemas.BackendCustomMetric.properties.name.description - schemas.BackendCustomMetric.properties.name.type - schemas.BackendCustomMetric.type - schemas.BackendService.properties.customMetrics.description - schemas.BackendService.properties.customMetrics.items.$ref - schemas.BackendService.properties.customMetrics.type - schemas.BackendServiceCustomMetric.description - schemas.BackendServiceCustomMetric.id - schemas.BackendServiceCustomMetric.properties.dryRun.description - schemas.BackendServiceCustomMetric.properties.dryRun.type - schemas.BackendServiceCustomMetric.properties.name.description - schemas.BackendServiceCustomMetric.properties.name.type - schemas.BackendServiceCustomMetric.type - schemas.BgpRoute.id - schemas.BgpRoute.properties.asPaths.description - schemas.BgpRoute.properties.asPaths.items.$ref - schemas.BgpRoute.properties.asPaths.type - schemas.BgpRoute.properties.communities.description - schemas.BgpRoute.properties.communities.items.type - schemas.BgpRoute.properties.communities.type - schemas.BgpRoute.properties.destination.$ref - schemas.BgpRoute.properties.destination.description - schemas.BgpRoute.properties.med.description - schemas.BgpRoute.properties.med.format - schemas.BgpRoute.properties.med.type - schemas.BgpRoute.properties.origin.description - schemas.BgpRoute.properties.origin.enum - schemas.BgpRoute.properties.origin.enumDescriptions - schemas.BgpRoute.properties.origin.type - schemas.BgpRoute.type - schemas.BgpRouteAsPath.id - schemas.BgpRouteAsPath.properties.asns.description - schemas.BgpRouteAsPath.properties.asns.items.format - schemas.BgpRouteAsPath.properties.asns.items.type - schemas.BgpRouteAsPath.properties.asns.type - schemas.BgpRouteAsPath.properties.type.description - schemas.BgpRouteAsPath.properties.type.enum - schemas.BgpRouteAsPath.properties.type.enumDescriptions - schemas.BgpRouteAsPath.properties.type.type - schemas.BgpRouteAsPath.type - schemas.BgpRouteNetworkLayerReachabilityInformation.description - schemas.BgpRouteNetworkLayerReachabilityInformation.id - schemas.BgpRouteNetworkLayerReachabilityInformation.properties.pathId.description - schemas.BgpRouteNetworkLayerReachabilityInformation.properties.pathId.format - schemas.BgpRouteNetworkLayerReachabilityInformation.properties.pathId.type - schemas.BgpRouteNetworkLayerReachabilityInformation.properties.prefix.description - schemas.BgpRouteNetworkLayerReachabilityInformation.properties.prefix.type - schemas.BgpRouteNetworkLayerReachabilityInformation.type - schemas.FirewallPolicy.properties.packetMirroringRules.description - schemas.FirewallPolicy.properties.packetMirroringRules.items.$ref - schemas.FirewallPolicy.properties.packetMirroringRules.type - schemas.InstanceGroupManager.properties.resourcePolicies.$ref - schemas.InstanceGroupManager.properties.resourcePolicies.description - schemas.InstanceGroupManagerResourcePolicies.id - schemas.InstanceGroupManagerResourcePolicies.properties.workloadPolicy.description - schemas.InstanceGroupManagerResourcePolicies.properties.workloadPolicy.type - schemas.InstanceGroupManagerResourcePolicies.type - schemas.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.description - schemas.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.items.$ref - schemas.InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.type - schemas.InstancesReportHostAsFaultyRequest.id - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.description - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.enum - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.enumDescriptions - schemas.InstancesReportHostAsFaultyRequest.properties.disruptionSchedule.type - schemas.InstancesReportHostAsFaultyRequest.properties.faultReasons.items.$ref - schemas.InstancesReportHostAsFaultyRequest.properties.faultReasons.type - schemas.InstancesReportHostAsFaultyRequest.type - schemas.InstancesReportHostAsFaultyRequestFaultReason.id - schemas.InstancesReportHostAsFaultyRequestFaultReason.properties.behavior.enum - schemas.InstancesReportHostAsFaultyRequestFaultReason.properties.behavior.enumDescriptions - schemas.InstancesReportHostAsFaultyRequestFaultReason.properties.behavior.type - schemas.InstancesReportHostAsFaultyRequestFaultReason.properties.description.type - schemas.InstancesReportHostAsFaultyRequestFaultReason.type - schemas.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.description - schemas.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.items.$ref - schemas.NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.type - schemas.NodeType.properties.maxVms.description - schemas.NodeType.properties.maxVms.format - schemas.NodeType.properties.maxVms.type - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.description - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.items.$ref - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.packetMirroringRules.type - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.priority.description - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.priority.format - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.priority.type - schemas.Reservation.properties.reservationSharingPolicy.$ref - schemas.Reservation.properties.reservationSharingPolicy.description - schemas.ResourceStatus.properties.physicalHostTopology.$ref - schemas.ResourceStatus.properties.physicalHostTopology.description - schemas.ResourceStatusPhysicalHostTopology.description - schemas.ResourceStatusPhysicalHostTopology.id - schemas.ResourceStatusPhysicalHostTopology.properties.block.description - schemas.ResourceStatusPhysicalHostTopology.properties.block.type - schemas.ResourceStatusPhysicalHostTopology.properties.cluster.description - schemas.ResourceStatusPhysicalHostTopology.properties.cluster.type - schemas.ResourceStatusPhysicalHostTopology.properties.host.description - schemas.ResourceStatusPhysicalHostTopology.properties.host.type - schemas.ResourceStatusPhysicalHostTopology.properties.subblock.description - schemas.ResourceStatusPhysicalHostTopology.properties.subblock.type - schemas.ResourceStatusPhysicalHostTopology.type - schemas.RoutePolicy.id - schemas.RoutePolicy.properties.description.description - schemas.RoutePolicy.properties.description.type - schemas.RoutePolicy.properties.fingerprint.description - schemas.RoutePolicy.properties.fingerprint.format - schemas.RoutePolicy.properties.fingerprint.type - schemas.RoutePolicy.properties.name.description - schemas.RoutePolicy.properties.name.type - schemas.RoutePolicy.properties.terms.description - schemas.RoutePolicy.properties.terms.items.$ref - schemas.RoutePolicy.properties.terms.type - schemas.RoutePolicy.properties.type.enum - schemas.RoutePolicy.properties.type.enumDescriptions - schemas.RoutePolicy.properties.type.type - schemas.RoutePolicy.type - schemas.RoutePolicyPolicyTerm.id - schemas.RoutePolicyPolicyTerm.properties.actions.description - schemas.RoutePolicyPolicyTerm.properties.actions.items.$ref - schemas.RoutePolicyPolicyTerm.properties.actions.type - schemas.RoutePolicyPolicyTerm.properties.match.$ref - schemas.RoutePolicyPolicyTerm.properties.match.description - schemas.RoutePolicyPolicyTerm.properties.priority.description - schemas.RoutePolicyPolicyTerm.properties.priority.format - schemas.RoutePolicyPolicyTerm.properties.priority.type - schemas.RoutePolicyPolicyTerm.type - schemas.RoutersGetRoutePolicyResponse.id - schemas.RoutersGetRoutePolicyResponse.properties.resource.$ref - schemas.RoutersGetRoutePolicyResponse.type - schemas.RoutersListBgpRoutes.id - schemas.RoutersListBgpRoutes.properties.etag.type - schemas.RoutersListBgpRoutes.properties.id.description - schemas.RoutersListBgpRoutes.properties.id.type - schemas.RoutersListBgpRoutes.properties.kind.default - schemas.RoutersListBgpRoutes.properties.kind.description - schemas.RoutersListBgpRoutes.properties.kind.type - schemas.RoutersListBgpRoutes.properties.nextPageToken.description - schemas.RoutersListBgpRoutes.properties.nextPageToken.type - schemas.RoutersListBgpRoutes.properties.result.description - schemas.RoutersListBgpRoutes.properties.result.items.$ref - schemas.RoutersListBgpRoutes.properties.result.type - schemas.RoutersListBgpRoutes.properties.selfLink.description - schemas.RoutersListBgpRoutes.properties.selfLink.type - schemas.RoutersListBgpRoutes.properties.unreachables.description - schemas.RoutersListBgpRoutes.properties.unreachables.items.type - schemas.RoutersListBgpRoutes.properties.unreachables.type - schemas.RoutersListBgpRoutes.properties.warning.description - schemas.RoutersListBgpRoutes.properties.warning.properties.code.description - schemas.RoutersListBgpRoutes.properties.warning.properties.code.enum - schemas.RoutersListBgpRoutes.properties.warning.properties.code.enumDeprecated - schemas.RoutersListBgpRoutes.properties.warning.properties.code.enumDescriptions - schemas.RoutersListBgpRoutes.properties.warning.properties.code.type - schemas.RoutersListBgpRoutes.properties.warning.properties.data.description - schemas.RoutersListBgpRoutes.properties.warning.properties.data.items.properties.key.description - schemas.RoutersListBgpRoutes.properties.warning.properties.data.items.properties.key.type - schemas.RoutersListBgpRoutes.properties.warning.properties.data.items.properties.value.description - schemas.RoutersListBgpRoutes.properties.warning.properties.data.items.properties.value.type - schemas.RoutersListBgpRoutes.properties.warning.properties.data.items.type - schemas.RoutersListBgpRoutes.properties.warning.properties.data.type - schemas.RoutersListBgpRoutes.properties.warning.properties.message.description - schemas.RoutersListBgpRoutes.properties.warning.properties.message.type - schemas.RoutersListBgpRoutes.properties.warning.type - schemas.RoutersListBgpRoutes.type - schemas.RoutersListRoutePolicies.id - schemas.RoutersListRoutePolicies.properties.etag.type - schemas.RoutersListRoutePolicies.properties.id.description - schemas.RoutersListRoutePolicies.properties.id.type - schemas.RoutersListRoutePolicies.properties.kind.default - schemas.RoutersListRoutePolicies.properties.kind.description - schemas.RoutersListRoutePolicies.properties.kind.type - schemas.RoutersListRoutePolicies.properties.nextPageToken.description - schemas.RoutersListRoutePolicies.properties.nextPageToken.type - schemas.RoutersListRoutePolicies.properties.result.description - schemas.RoutersListRoutePolicies.properties.result.items.$ref - schemas.RoutersListRoutePolicies.properties.result.type - schemas.RoutersListRoutePolicies.properties.selfLink.description - schemas.RoutersListRoutePolicies.properties.selfLink.type - schemas.RoutersListRoutePolicies.properties.unreachables.description - schemas.RoutersListRoutePolicies.properties.unreachables.items.type - schemas.RoutersListRoutePolicies.properties.unreachables.type - schemas.RoutersListRoutePolicies.properties.warning.description - schemas.RoutersListRoutePolicies.properties.warning.properties.code.description - schemas.RoutersListRoutePolicies.properties.warning.properties.code.enum - schemas.RoutersListRoutePolicies.properties.warning.properties.code.enumDeprecated - schemas.RoutersListRoutePolicies.properties.warning.properties.code.enumDescriptions - schemas.RoutersListRoutePolicies.properties.warning.properties.code.type - schemas.RoutersListRoutePolicies.properties.warning.properties.data.description - schemas.RoutersListRoutePolicies.properties.warning.properties.data.items.properties.key.description - schemas.RoutersListRoutePolicies.properties.warning.properties.data.items.properties.key.type - schemas.RoutersListRoutePolicies.properties.warning.properties.data.items.properties.value.description - schemas.RoutersListRoutePolicies.properties.warning.properties.data.items.properties.value.type - schemas.RoutersListRoutePolicies.properties.warning.properties.data.items.type - schemas.RoutersListRoutePolicies.properties.warning.properties.data.type - schemas.RoutersListRoutePolicies.properties.warning.properties.message.description - schemas.RoutersListRoutePolicies.properties.warning.properties.message.type - schemas.RoutersListRoutePolicies.properties.warning.type - schemas.RoutersListRoutePolicies.type - schemas.Scheduling.properties.hostErrorTimeoutSeconds.description - schemas.Scheduling.properties.hostErrorTimeoutSeconds.format - schemas.Scheduling.properties.hostErrorTimeoutSeconds.type - schemas.Subnetwork.properties.ipCollection.description - schemas.Subnetwork.properties.ipCollection.type - schemas.Subnetwork.properties.ipv6GceEndpoint.description - schemas.Subnetwork.properties.ipv6GceEndpoint.enum - schemas.Subnetwork.properties.ipv6GceEndpoint.enumDescriptions - schemas.Subnetwork.properties.ipv6GceEndpoint.type The following keys were changed: - resources.regionCommitments.methods.update.description - resources.regionCommitments.methods.update.parameters.commitment.description - schemas.AllocationAggregateReservation.properties.vmFamily.enum - schemas.AllocationAggregateReservation.properties.vmFamily.enumDescriptions - schemas.Backend.properties.balancingMode.enum - schemas.Backend.properties.balancingMode.enumDescriptions - schemas.BackendService.properties.localityLbPolicy.enum - schemas.BackendService.properties.localityLbPolicy.enumDescriptions - schemas.BackendServiceLocalityLoadBalancingPolicyConfigPolicy.properties.name.enum - schemas.BackendServiceLocalityLoadBalancingPolicyConfigPolicy.properties.name.enumDescriptions - schemas.Commitment.description - schemas.Commitment.properties.autoRenew.description - schemas.Commitment.properties.category.description - schemas.Commitment.properties.customEndTimestamp.description - schemas.Commitment.properties.description.description - schemas.Commitment.properties.mergeSourceCommitments.description - schemas.Commitment.properties.name.description - schemas.Commitment.properties.plan.description - schemas.Commitment.properties.region.description - schemas.Commitment.properties.reservations.description - schemas.Commitment.properties.resources.description - schemas.Commitment.properties.splitSourceCommitment.description - schemas.Commitment.properties.status.description - schemas.Commitment.properties.type.description - schemas.Commitment.properties.type.enum - schemas.Commitment.properties.type.enumDescriptions - schemas.CommitmentsScopedList.properties.commitments.description - schemas.LicenseResourceCommitment.properties.amount.description - schemas.LicenseResourceCommitment.properties.coresPerLicense.description - schemas.LicenseResourceCommitment.properties.license.description - schemas.PublicDelegatedPrefix.properties.mode.enum - schemas.PublicDelegatedPrefix.properties.mode.enumDescriptions - schemas.PublicDelegatedPrefixPublicDelegatedSubPrefix.properties.mode.enum - schemas.PublicDelegatedPrefixPublicDelegatedSubPrefix.properties.mode.enumDescriptions - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.type.enum - schemas.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy.properties.type.enumDescriptions - schemas.ResourceCommitment.description - schemas.ResourceCommitment.properties.acceleratorType.description - schemas.ResourceCommitment.properties.amount.description - schemas.ResourceCommitment.properties.type.description - schemas.RouterBgpPeer.properties.exportPolicies.description - schemas.RouterBgpPeer.properties.importPolicies.description - schemas.RouterInterface.properties.ipRange.description - schemas.Scheduling.properties.provisioningModel.enum - schemas.Scheduling.properties.provisioningModel.enumDescriptions - schemas.SecurityPolicyDdosProtectionConfig.properties.ddosProtection.enum - schemas.SecurityPolicyDdosProtectionConfig.properties.ddosProtection.enumDescriptions - schemas.Snapshot.properties.sourceInstantSnapshotId.description - schemas.Subnetwork.properties.purpose.description - schemas.TargetHttpsProxy.properties.serverTlsPolicy.description - schemas.UsableSubnetwork.properties.purpose.description --- discovery/compute-alpha.json | 4169 +++++++++++++++++++-- discovery/compute-beta.json | 4712 +++++++++++++++++++---- discovery/compute-v1.json | 1454 ++++++- src/apis/compute/alpha.ts | 6870 ++++++++++++++++++++++++++-------- src/apis/compute/beta.ts | 5079 +++++++++++++++++++++++-- src/apis/compute/v1.ts | 1754 ++++++++- 6 files changed, 20861 insertions(+), 3177 deletions(-) diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index 3ca67bc7ea0..37b10adbb39 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -3083,6 +3083,54 @@ "https://www.googleapis.com/auth/compute" ] }, + "bulkSetLabels": { + "description": "Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/zones/{zone}/disks/bulkSetLabels", + "httpMethod": "POST", + "id": "compute.disks.bulkSetLabels", + "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" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "query", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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}/disks/bulkSetLabels", + "request": { + "$ref": "BulkZoneSetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "createSnapshot": { "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", @@ -15382,6 +15430,43 @@ }, "interconnectAttachmentGroups": { "methods": { + "createMembers": { + "description": "Create Interconnect Attachments with redundancy by creating them in a specified interconnect attachment group.", + "flatPath": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/createMembers", + "httpMethod": "POST", + "id": "compute.interconnectAttachmentGroups.createMembers", + "parameterOrder": [ + "project", + "interconnectAttachmentGroup" + ], + "parameters": { + "interconnectAttachmentGroup": { + "description": "Name of the group resource to create members for.", + "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" + } + }, + "path": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/createMembers", + "request": { + "$ref": "InterconnectAttachmentGroupsCreateMembersRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "delete": { "description": "Deletes the specified InterconnectAttachmentGroup in the given scope", "flatPath": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}", @@ -16258,6 +16343,43 @@ }, "interconnectGroups": { "methods": { + "createMembers": { + "description": "Create Interconnects with redundancy by creating them in a specified interconnect group.", + "flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers", + "httpMethod": "POST", + "id": "compute.interconnectGroups.createMembers", + "parameterOrder": [ + "project", + "interconnectGroup" + ], + "parameters": { + "interconnectGroup": { + "description": "Name of the group resource to create members for.", + "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" + } + }, + "path": "projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers", + "request": { + "$ref": "InterconnectGroupsCreateMembersRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "delete": { "description": "Deletes the specified InterconnectGroup in the given scope", "flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}", @@ -22610,7 +22732,7 @@ "organizationSecurityPolicies": { "methods": { "addAssociation": { - "description": "Inserts an association for the specified security policy.", + "description": "Inserts an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/addAssociation", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.addAssociation", @@ -22683,7 +22805,7 @@ ] }, "copyRules": { - "description": "Copies rules to the specified security policy.", + "description": "Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/copyRules", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.copyRules", @@ -22719,7 +22841,7 @@ ] }, "delete": { - "description": "Deletes the specified policy.", + "description": "Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}", "httpMethod": "DELETE", "id": "compute.organizationSecurityPolicies.delete", @@ -22750,7 +22872,7 @@ ] }, "get": { - "description": "List all of the ordered rules present in a single specified policy.", + "description": "List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.get", @@ -22777,7 +22899,7 @@ ] }, "getAssociation": { - "description": "Gets an association with the specified name.", + "description": "Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/getAssociation", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.getAssociation", @@ -22809,7 +22931,7 @@ ] }, "getRule": { - "description": "Gets a rule at the specified priority.", + "description": "Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/getRule", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.getRule", @@ -22842,7 +22964,7 @@ ] }, "insert": { - "description": "Creates a new policy in the specified project using the data included in the request.", + "description": "Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.", "flatPath": "locations/global/securityPolicies", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.insert", @@ -22871,7 +22993,7 @@ ] }, "list": { - "description": "List all the policies that have been configured for the specified project.", + "description": "List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.", "flatPath": "locations/global/securityPolicies", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.list", @@ -22921,7 +23043,7 @@ ] }, "listAssociations": { - "description": "Lists associations of a specified target, i.e., organization or folder.", + "description": "Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.", "flatPath": "locations/global/securityPolicies/listAssociations", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.listAssociations", @@ -22993,7 +23115,7 @@ ] }, "move": { - "description": "Moves the specified security policy.", + "description": "Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/move", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.move", @@ -23029,7 +23151,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request.", + "description": "Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "id": "compute.organizationSecurityPolicies.patch", @@ -23063,7 +23185,7 @@ ] }, "patchRule": { - "description": "Patches a rule at the specified priority.", + "description": "Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.patchRule", @@ -23103,7 +23225,7 @@ ] }, "removeAssociation": { - "description": "Removes an association for the specified security policy.", + "description": "Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/removeAssociation", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.removeAssociation", @@ -26095,7 +26217,7 @@ ] }, "update": { - "description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.", + "description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", "httpMethod": "PATCH", "id": "compute.regionCommitments.update", @@ -26106,7 +26228,7 @@ ], "parameters": { "commitment": { - "description": "Name of the commitment for which auto renew is being updated.", + "description": "Name of the commitment that you want to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -26156,7 +26278,7 @@ ] }, "updateReservations": { - "description": "Transfers GPUs or local SSDs between reservations within commitments.", + "description": "Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}/updateReservations", "httpMethod": "POST", "id": "compute.regionCommitments.updateReservations", @@ -26167,7 +26289,7 @@ ], "parameters": { "commitment": { - "description": "Name of the commitment for which the reservation is being updated.", + "description": "Name of the commitment for which the reservations are being updated.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -26207,6 +26329,366 @@ } } }, + "regionCompositeHealthChecks": { + "methods": { + "aggregatedList": { + "description": "Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/compositeHealthChecks", + "httpMethod": "GET", + "id": "compute.regionCompositeHealthChecks.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": "Name of the project scoping 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/compositeHealthChecks", + "response": { + "$ref": "CompositeHealthCheckAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified CompositeHealthCheck in the given region", + "flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", + "httpMethod": "DELETE", + "id": "compute.regionCompositeHealthChecks.delete", + "parameterOrder": [ + "project", + "region", + "compositeHealthCheck" + ], + "parameters": { + "compositeHealthCheck": { + "description": "Name of the CompositeHealthCheck 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": "Name of the region scoping 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}/compositeHealthChecks/{compositeHealthCheck}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified CompositeHealthCheck resource in the given region.", + "flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", + "httpMethod": "GET", + "id": "compute.regionCompositeHealthChecks.get", + "parameterOrder": [ + "project", + "region", + "compositeHealthCheck" + ], + "parameters": { + "compositeHealthCheck": { + "description": "Name of the CompositeHealthCheck 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 scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", + "response": { + "$ref": "CompositeHealthCheck" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.", + "flatPath": "projects/{project}/regions/{region}/compositeHealthChecks", + "httpMethod": "POST", + "id": "compute.regionCompositeHealthChecks.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 scoping 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}/compositeHealthChecks", + "request": { + "$ref": "CompositeHealthCheck" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Lists the CompositeHealthChecks for a project in the given region.", + "flatPath": "projects/{project}/regions/{region}/compositeHealthChecks", + "httpMethod": "GET", + "id": "compute.regionCompositeHealthChecks.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 scoping 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}/compositeHealthChecks", + "response": { + "$ref": "CompositeHealthCheckList" + }, + "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 regional CompositeHealthCheck 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}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", + "httpMethod": "PATCH", + "id": "compute.regionCompositeHealthChecks.patch", + "parameterOrder": [ + "project", + "region", + "compositeHealthCheck" + ], + "parameters": { + "compositeHealthCheck": { + "description": "Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping 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}/compositeHealthChecks/{compositeHealthCheck}", + "request": { + "$ref": "CompositeHealthCheck" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionCompositeHealthChecks.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regionDiskSettings": { "methods": { "get": { @@ -27335,6 +27817,300 @@ } } }, + "regionHealthAggregationPolicies": { + "methods": { + "delete": { + "description": "Deletes the specified HealthAggregationPolicy in the given region.", + "flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", + "httpMethod": "DELETE", + "id": "compute.regionHealthAggregationPolicies.delete", + "parameterOrder": [ + "project", + "region", + "healthAggregationPolicy" + ], + "parameters": { + "healthAggregationPolicy": { + "description": "Name of the HealthAggregationPolicy 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": "Name of the region scoping 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}/healthAggregationPolicies/{healthAggregationPolicy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified HealthAggregationPolicy resource in the given region.", + "flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", + "httpMethod": "GET", + "id": "compute.regionHealthAggregationPolicies.get", + "parameterOrder": [ + "project", + "region", + "healthAggregationPolicy" + ], + "parameters": { + "healthAggregationPolicy": { + "description": "Name of the HealthAggregationPolicy 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 scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", + "response": { + "$ref": "HealthAggregationPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Create a HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the request.", + "flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies", + "httpMethod": "POST", + "id": "compute.regionHealthAggregationPolicies.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 scoping 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}/healthAggregationPolicies", + "request": { + "$ref": "HealthAggregationPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Lists the HealthAggregationPolicies for a project in the given region.", + "flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies", + "httpMethod": "GET", + "id": "compute.regionHealthAggregationPolicies.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 scoping 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}/healthAggregationPolicies", + "response": { + "$ref": "HealthAggregationPolicyList" + }, + "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 regional HealthAggregationPolicy 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}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", + "httpMethod": "PATCH", + "id": "compute.regionHealthAggregationPolicies.patch", + "parameterOrder": [ + "project", + "region", + "healthAggregationPolicy" + ], + "parameters": { + "healthAggregationPolicy": { + "description": "Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping 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}/healthAggregationPolicies/{healthAggregationPolicy}", + "request": { + "$ref": "HealthAggregationPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionHealthAggregationPolicies.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regionHealthCheckServices": { "methods": { "aggregatedList": { @@ -28038,6 +28814,366 @@ } } }, + "regionHealthSources": { + "methods": { + "aggregatedList": { + "description": "Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/healthSources", + "httpMethod": "GET", + "id": "compute.regionHealthSources.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": "Name of the project scoping 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/healthSources", + "response": { + "$ref": "HealthSourceAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified HealthSource in the given region", + "flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "httpMethod": "DELETE", + "id": "compute.regionHealthSources.delete", + "parameterOrder": [ + "project", + "region", + "healthSource" + ], + "parameters": { + "healthSource": { + "description": "Name of the HealthSource 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": "Name of the region scoping 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}/healthSources/{healthSource}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified HealthSource resource in the given region.", + "flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "httpMethod": "GET", + "id": "compute.regionHealthSources.get", + "parameterOrder": [ + "project", + "region", + "healthSource" + ], + "parameters": { + "healthSource": { + "description": "Name of the HealthSource 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 scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/healthSources/{healthSource}", + "response": { + "$ref": "HealthSource" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Create a HealthSource in the specified project in the given region using the parameters that are included in the request.", + "flatPath": "projects/{project}/regions/{region}/healthSources", + "httpMethod": "POST", + "id": "compute.regionHealthSources.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 scoping 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}/healthSources", + "request": { + "$ref": "HealthSource" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Lists the HealthSources for a project in the given region.", + "flatPath": "projects/{project}/regions/{region}/healthSources", + "httpMethod": "GET", + "id": "compute.regionHealthSources.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 scoping 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}/healthSources", + "response": { + "$ref": "HealthSourceList" + }, + "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 regional HealthSource 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}/regions/{region}/healthSources/{healthSource}", + "httpMethod": "PATCH", + "id": "compute.regionHealthSources.patch", + "parameterOrder": [ + "project", + "region", + "healthSource" + ], + "parameters": { + "healthSource": { + "description": "Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping 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}/healthSources/{healthSource}", + "request": { + "$ref": "HealthSource" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionHealthSources.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regionInstanceGroupManagerResizeRequests": { "methods": { "cancel": { @@ -30947,6 +32083,130 @@ } } }, + "regionMultiMigMembers": { + "methods": { + "get": { + "description": "Retrieves information about the specified multi-MIG member.", + "flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers/{multiMigMember}", + "httpMethod": "GET", + "id": "compute.regionMultiMigMembers.get", + "parameterOrder": [ + "project", + "region", + "multiMig", + "multiMigMember" + ], + "parameters": { + "multiMig": { + "description": "The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "multiMigMember": { + "description": "The name of the multi-MIG member. Name should conform to RFC1035 or be a resource ID.", + "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. Region name should conform to RFC1035.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers/{multiMigMember}", + "response": { + "$ref": "MultiMigMember" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves a list of members of a specific multi-MIG.", + "flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}/multiMigMembers", + "httpMethod": "GET", + "id": "compute.regionMultiMigMembers.list", + "parameterOrder": [ + "project", + "region", + "multiMig" + ], + "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" + }, + "multiMig": { + "description": "The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "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", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request. Region name should conform to RFC1035.", + "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/{multiMig}/multiMigMembers", + "response": { + "$ref": "MultiMigMemberList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regionMultiMigs": { "methods": { "delete": { @@ -47599,7 +48859,7 @@ } } }, - "revision": "20250107", + "revision": "20250304", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48955,14 +50215,18 @@ "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_LITE_POD_SLICE_CT6E", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", - "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P" ], "enumDescriptions": [ "", "", "", "", + "", + "", "" ], "type": "string" @@ -49033,6 +50297,10 @@ "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", "properties": { + "aggregateAllocation": { + "$ref": "AllocationResourceStatusAggregateAllocation", + "description": "Properties of this aggregatereservation." + }, "reservationBlockCount": { "description": "The number of reservation blocks associated with this reservation.", "format": "int32", @@ -49049,6 +50317,21 @@ }, "type": "object" }, + "AllocationResourceStatusAggregateAllocation": { + "description": "Contains Properties set for the aggregate reservation.", + "id": "AllocationResourceStatusAggregateAllocation", + "properties": { + "utilizations": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", + "type": "object" + } + }, + "type": "object" + }, "AllocationResourceStatusSpecificSKUAllocation": { "description": "Contains Properties set for the reservation.", "id": "AllocationResourceStatusSpecificSKUAllocation", @@ -51055,7 +52338,7 @@ "type": "number" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-24 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.", + "description": "Name of a custom utilization signal. 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" } }, @@ -51136,6 +52419,10 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "dynamicForwarding": { + "$ref": "BackendServiceDynamicForwarding", + "description": "Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic." + }, "edgeSecurityPolicy": { "description": "[Output Only] The resource URL for the edge security policy associated with this backend service.", "type": "string" @@ -51756,12 +53043,34 @@ "type": "boolean" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-24 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.", + "description": "Name of a custom utilization signal. 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" }, + "BackendServiceDynamicForwarding": { + "description": "Defines a dynamic forwarding configuration for the backend service.", + "id": "BackendServiceDynamicForwarding", + "properties": { + "ipPortSelection": { + "$ref": "BackendServiceDynamicForwardingIpPortSelection", + "description": "IP:PORT based dynamic forwarding configuration." + } + }, + "type": "object" + }, + "BackendServiceDynamicForwardingIpPortSelection": { + "description": "Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges.", + "id": "BackendServiceDynamicForwardingIpPortSelection", + "properties": { + "enabled": { + "description": "A boolean flag enabling IP:PORT based dynamic forwarding.", + "type": "boolean" + } + }, + "type": "object" + }, "BackendServiceFailoverPolicy": { "description": "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). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).", "id": "BackendServiceFailoverPolicy", @@ -53062,6 +54371,36 @@ }, "type": "object" }, + "BulkSetLabelsRequest": { + "id": "BulkSetLabelsRequest", + "properties": { + "labelFingerprint": { + "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You may optionally provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels to set for this resource.", + "type": "object" + } + }, + "type": "object" + }, + "BulkZoneSetLabelsRequest": { + "id": "BulkZoneSetLabelsRequest", + "properties": { + "requests": { + "items": { + "$ref": "BulkSetLabelsRequest" + }, + "type": "array" + } + }, + "type": "object" + }, "BundledLocalSsds": { "id": "BundledLocalSsds", "properties": { @@ -53081,7 +54420,7 @@ "id": "CacheInvalidationRule", "properties": { "cacheTags": { - "description": "Not implemented.", + "description": "[Preview] A list of cache tags used to identify cached objects. - Cache tags are specified when the response is first cached, by setting the `Cache-Tag` response header at the origin. - Multiple cache tags in the same invalidation request are treated as Boolean `OR` - for example, `tag1 OR tag2 OR tag3`. - If other fields are also specified, these are treated as Boolean `AND` with any tags. Up to 10 tags can be specified in a single invalidation request.", "items": { "type": "string" }, @@ -53311,15 +54650,15 @@ "type": "object" }, "Commitment": { - "description": "Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.", + "description": "Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts", "id": "Commitment", "properties": { "autoRenew": { - "description": "Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.", + "description": "Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.", "type": "boolean" }, "category": { - "description": "The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.", + "description": "The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.", "enum": [ "CATEGORY_UNSPECIFIED", "LICENSE", @@ -53337,11 +54676,11 @@ "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.", + "description": "[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment'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.", + "description": "An optional description of the commitment. You can provide this property when you create the resource.", "type": "string" }, "endTimestamp": { @@ -53349,7 +54688,6 @@ "type": "string" }, "existingReservations": { - "description": "Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation ", "items": { "type": "string" }, @@ -53370,19 +54708,19 @@ "description": "The license specification required as part of a license commitment." }, "mergeSourceCommitments": { - "description": "List of source commitments to be merged into a new commitment.", + "description": "The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.", "items": { "type": "string" }, "type": "array" }, "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.", + "description": "Name of the commitment. You must specify a name when you purchase the commitment. 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" }, "plan": { - "description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", + "description": "The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", "enum": [ "INVALID", "THIRTY_SIX_MONTH", @@ -53396,11 +54734,11 @@ "type": "string" }, "region": { - "description": "[Output Only] URL of the region where this commitment may be used.", + "description": "[Output Only] URL of the region where the commitment and committed resources are located.", "type": "string" }, "reservations": { - "description": "List of create-on-create reservations for this commitment.", + "description": "The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.", "items": { "$ref": "Reservation" }, @@ -53411,7 +54749,7 @@ "description": "[Output Only] Status information for Commitment resource." }, "resources": { - "description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.", + "description": "The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.", "items": { "$ref": "ResourceCommitment" }, @@ -53426,7 +54764,7 @@ "type": "string" }, "splitSourceCommitment": { - "description": "Source commitment to be split into a new commitment.", + "description": "The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.", "type": "string" }, "startTimestamp": { @@ -53434,7 +54772,7 @@ "type": "string" }, "status": { - "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.", + "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED.", "enum": [ "ACTIVE", "CANCELED_EARLY_TERMINATION", @@ -53460,12 +54798,13 @@ "type": "string" }, "type": { - "description": "The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.", + "description": "The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", "ACCELERATOR_OPTIMIZED_A3_MEGA", "ACCELERATOR_OPTIMIZED_A3_ULTRA", + "ACCELERATOR_OPTIMIZED_A4", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", @@ -53517,7 +54856,8 @@ "", "", "", - "" + "", + "Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" } @@ -53886,7 +55226,7 @@ "id": "CommitmentsScopedList", "properties": { "commitments": { - "description": "[Output Only] A list of commitments contained in this scope.", + "description": "[Output Only] The list of commitments contained in this scope.", "items": { "$ref": "Commitment" }, @@ -54019,159 +55359,42 @@ }, "type": "object" }, - "ConfidentialInstanceConfig": { - "description": "A set of Confidential Instance options.", - "id": "ConfidentialInstanceConfig", + "CompositeHealthCheck": { + "description": "Represents a composite health check. A composite health check resource specifies the health source resources and the health destination resource to which the aggregated health result from the health source resources is delivered.", + "id": "CompositeHealthCheck", "properties": { - "confidentialInstanceType": { - "description": "Defines the type of technology used by the confidential instance.", - "enum": [ - "CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", - "SEV", - "SEV_SNP", - "TDX" - ], - "enumDescriptions": [ - "No type specified. Do not use this value.", - "AMD Secure Encrypted Virtualization.", - "AMD Secure Encrypted Virtualization - Secure Nested Paging.", - "Intel Trust Domain eXtension." - ], + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, - "enableConfidentialCompute": { - "description": "Defines whether the instance should have confidential compute enabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "ConnectionDraining": { - "description": "Message containing connection draining configuration.", - "id": "ConnectionDraining", - "properties": { - "drainingTimeoutSec": { - "description": "Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ConsistentHashLoadBalancerSettings": { - "description": "This message defines settings for a consistent hash style load balancer.", - "id": "ConsistentHashLoadBalancerSettings", - "properties": { - "httpCookie": { - "$ref": "ConsistentHashLoadBalancerSettingsHttpCookie", - "description": "Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. 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." - }, - "httpHeaderName": { - "description": "The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.", + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, - "minimumRingSize": { - "description": "The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "ConsistentHashLoadBalancerSettingsHttpCookie": { - "description": "The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.", - "id": "ConsistentHashLoadBalancerSettingsHttpCookie", - "properties": { - "name": { - "description": "Name of the cookie.", + "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 CompositeHealthCheck. An up-to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.", + "format": "byte", "type": "string" }, - "path": { - "description": "Path to set for the cookie.", + "healthDestination": { + "description": "URL to the destination resource. Must be set. Must be a ForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment for INTERNAL_MANAGED is not supported). Can be mutated.", "type": "string" }, - "ttl": { - "$ref": "Duration", - "description": "Lifetime of the cookie." - } - }, - "type": "object" - }, - "CorsPolicy": { - "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard.", - "id": "CorsPolicy", - "properties": { - "allowCredentials": { - "description": "In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false.", - "type": "boolean" - }, - "allowHeaders": { - "description": "Specifies the content for the Access-Control-Allow-Headers header.", - "items": { - "type": "string" - }, - "type": "array" - }, - "allowMethods": { - "description": "Specifies the content for the Access-Control-Allow-Methods header.", - "items": { - "type": "string" - }, - "type": "array" - }, - "allowOriginRegexes": { - "description": "Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", - "items": { - "type": "string" - }, - "type": "array" - }, - "allowOrigins": { - "description": "Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.", - "items": { - "type": "string" - }, - "type": "array" - }, - "disabled": { - "description": "If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.", - "type": "boolean" - }, - "exposeHeaders": { - "description": "Specifies the content for the Access-Control-Expose-Headers header.", + "healthSources": { + "description": "URLs to the HealthSource resources whose results are AND'ed. I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as the CompositeHealthCheck. Can be mutated.", "items": { "type": "string" }, "type": "array" }, - "maxAge": { - "description": "Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "CrossSiteNetwork": { - "description": "A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections.", - "id": "CrossSiteNetwork", - "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of the cross-site network.", - "type": "string" - }, "id": { - "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", "format": "uint64", "type": "string" }, "kind": { - "default": "compute#crossSiteNetwork", - "description": "[Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.", + "default": "compute#compositeHealthCheck", + "description": "[Output Only] Type of the resource. Always compute#compositeHealthCheck for composite health checks.", "type": "string" }, "name": { @@ -54179,20 +55402,24 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "region": { + "description": "[Output Only] URL of the region where the composite health check resides. This field applies only to the regional resource. 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" + }, "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.", + "description": "[Output Only] Server-defined URL with id for the resource.", "type": "string" } }, "type": "object" }, - "CrossSiteNetworkList": { - "description": "Response to the list request that contains a list of cross-site networks.", - "id": "CrossSiteNetworkList", + "CompositeHealthCheckAggregatedList": { + "description": "Contains a list of CompositeHealthChecksScopedList.", + "id": "CompositeHealthCheckAggregatedList", "properties": { "etag": { "type": "string" @@ -54202,15 +55429,16 @@ "type": "string" }, "items": { - "description": "A list of CrossSiteNetwork resources.", - "items": { - "$ref": "CrossSiteNetwork" + "additionalProperties": { + "$ref": "CompositeHealthChecksScopedList", + "description": "Name of the scope containing this set of CompositeHealthChecks." }, - "type": "array" + "description": "A list of CompositeHealthChecksScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#crossSiteNetwork", - "description": "[Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.", + "default": "compute#compositeHealthCheckAggregatedList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { @@ -54222,7 +55450,681 @@ "type": "string" }, "unreachables": { - "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "CompositeHealthCheckList": { + "id": "CompositeHealthCheckList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of CompositeHealthCheck resources.", + "items": { + "$ref": "CompositeHealthCheck" + }, + "type": "array" + }, + "kind": { + "default": "compute#compositeHealthCheckList", + "description": "[Output Only] Type of the resource. Always compute#compositeHealthCheck for composite health checks.", + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "CompositeHealthChecksScopedList": { + "id": "CompositeHealthChecksScopedList", + "properties": { + "resources": { + "description": "A list of CompositeHealthChecks contained in this scope.", + "items": { + "$ref": "CompositeHealthCheck" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of composite health checks 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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "ConfidentialInstanceConfig": { + "description": "A set of Confidential Instance options.", + "id": "ConfidentialInstanceConfig", + "properties": { + "confidentialInstanceType": { + "description": "Defines the type of technology used by the confidential instance.", + "enum": [ + "CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", + "SEV", + "SEV_SNP", + "TDX" + ], + "enumDescriptions": [ + "No type specified. Do not use this value.", + "AMD Secure Encrypted Virtualization.", + "AMD Secure Encrypted Virtualization - Secure Nested Paging.", + "Intel Trust Domain eXtension." + ], + "type": "string" + }, + "confidentialParavisorConfig": { + "$ref": "ConfidentialParavisorConfig", + "description": "Defines a set of Confidential Paravisor (SVSM) options." + }, + "enableConfidentialCompute": { + "description": "Defines whether the instance should have confidential compute enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "ConfidentialParavisorConfig": { + "description": "A set of Confidential Paravisor (SVSM) options.", + "id": "ConfidentialParavisorConfig", + "properties": { + "confidentialTpmType": { + "enum": [ + "CONFIDENTIAL_TPM_TYPE_UNSPECIFIED", + "EPHEMERAL", + "NO_CC_TPM" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "sevSnpIrqMode": { + "enum": [ + "RESTRICTED", + "SEV_SNP_IRQ_MODE_UNSPECIFIED", + "UNRESTRICTED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "ConnectionDraining": { + "description": "Message containing connection draining configuration.", + "id": "ConnectionDraining", + "properties": { + "drainingTimeoutSec": { + "description": "Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConsistentHashLoadBalancerSettings": { + "description": "This message defines settings for a consistent hash style load balancer.", + "id": "ConsistentHashLoadBalancerSettings", + "properties": { + "httpCookie": { + "$ref": "ConsistentHashLoadBalancerSettingsHttpCookie", + "description": "Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. 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." + }, + "httpHeaderName": { + "description": "The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.", + "type": "string" + }, + "minimumRingSize": { + "description": "The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ConsistentHashLoadBalancerSettingsHttpCookie": { + "description": "The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.", + "id": "ConsistentHashLoadBalancerSettingsHttpCookie", + "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" + }, + "CorsPolicy": { + "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard.", + "id": "CorsPolicy", + "properties": { + "allowCredentials": { + "description": "In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false.", + "type": "boolean" + }, + "allowHeaders": { + "description": "Specifies the content for the Access-Control-Allow-Headers header.", + "items": { + "type": "string" + }, + "type": "array" + }, + "allowMethods": { + "description": "Specifies the content for the Access-Control-Allow-Methods header.", + "items": { + "type": "string" + }, + "type": "array" + }, + "allowOriginRegexes": { + "description": "Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", + "items": { + "type": "string" + }, + "type": "array" + }, + "allowOrigins": { + "description": "Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.", + "items": { + "type": "string" + }, + "type": "array" + }, + "disabled": { + "description": "If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.", + "type": "boolean" + }, + "exposeHeaders": { + "description": "Specifies the content for the Access-Control-Expose-Headers header.", + "items": { + "type": "string" + }, + "type": "array" + }, + "maxAge": { + "description": "Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CrossSiteNetwork": { + "description": "A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections.", + "id": "CrossSiteNetwork", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of the cross-site network.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#crossSiteNetwork", + "description": "[Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.", + "type": "string" + }, + "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" + }, + "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" + }, + "CrossSiteNetworkList": { + "description": "Response to the list request that contains a list of cross-site networks.", + "id": "CrossSiteNetworkList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of CrossSiteNetwork resources.", + "items": { + "$ref": "CrossSiteNetwork" + }, + "type": "array" + }, + "kind": { + "default": "compute#crossSiteNetwork", + "description": "[Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.", + "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" }, @@ -55218,9 +57120,10 @@ "id": "DiskPairReplicationState", "properties": { "dataReplicationState": { - "description": "[Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. ", + "description": "[Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to the disk's change rate being above the supported limit. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_CG_HIGH_CHURN: The replication is lagging above the SLO limit for the disk in the consistency group due to disk's change rate being above the supported limit. ", "enum": [ "ASYNC_REPLICATION_STATE_INITIALIZING", + "ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_CG_HIGH_CHURN", "ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN", "ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING", "ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY", @@ -55231,6 +57134,7 @@ ], "enumDescriptions": [ "The device is doing the initial replication after starting the replication.", + "The replication is lagging behind (last_replication_time > RPO) for the disk in a consistency group because some other disk is writing the data at a rate above the supported limit.", "The replication is lagging behind (last_replication_time > RPO), because the disk's change rate is above the supported limit.", "The replication is lagging, and the RPO is not being met due to some internal issue.", "The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO.", @@ -55334,6 +57238,20 @@ }, "description": "List of regions that can create a regional snapshot from the current region", "type": "object" + }, + "policy": { + "description": "Policy of which location is allowed to access snapshot.", + "enum": [ + "ALL_REGIONS", + "POLICY_UNSPECIFIED", + "SPECIFIC_REGIONS" + ], + "enumDescriptions": [ + "Any regions will be able to access the source location.", + "", + "Only allowlisted regions will be able to create region scoped snapshots" + ], + "type": "string" } }, "type": "object" @@ -59496,14 +61414,18 @@ "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_LITE_POD_SLICE_CT6E", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", - "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P" ], "enumDescriptions": [ "", "", "", "", + "", + "", "" ], "type": "string" @@ -60081,90 +62003,323 @@ "description": "The request path of the HTTP health check request. The default value is /. Must comply with RFC3986.", "type": "string" }, - "response": { - "description": "Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http", + "response": { + "description": "Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http", + "type": "string" + }, + "weightReportMode": { + "description": "Weight report mode. used for weighted Load Balancing.", + "enum": [ + "DISABLE", + "DRY_RUN", + "ENABLE" + ], + "enumDescriptions": [ + "Health Checker will not parse the header field.", + "Health Checker will parse and report the weight in the header field, but load balancing will not be based on the weights and will use equal weights.", + "Health Checker will try to parse and report the weight in the header field, and load balancing will be based on the weights as long as all backends have a valid weight or only a subset of backends has the UNAVAILABLE_WEIGHT WeightError. The latter case is to continue the weighted load balancing while some backends are in TIMEOUT or UNKNOWN health status." + ], + "type": "string" + } + }, + "type": "object" + }, + "HTTPSHealthCheck": { + "id": "HTTPSHealthCheck", + "properties": { + "host": { + "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest", + "type": "string" + }, + "port": { + "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.", + "format": "int32", + "type": "integer" + }, + "portName": { + "description": "Not supported.", + "type": "string" + }, + "portSpecification": { + "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", + "enum": [ + "USE_FIXED_PORT", + "USE_NAMED_PORT", + "USE_SERVING_PORT" + ], + "enumDescriptions": [ + "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", + "Not supported.", + "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." + ], + "type": "string" + }, + "proxyHeader": { + "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", + "enum": [ + "NONE", + "PROXY_V1" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "requestPath": { + "description": "The request path of the HTTPS health check request. The default value is /. Must comply with RFC3986.", + "type": "string" + }, + "response": { + "description": "Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http", + "type": "string" + }, + "weightReportMode": { + "description": "Weight report mode. used for weighted Load Balancing.", + "enum": [ + "DISABLE", + "DRY_RUN", + "ENABLE" + ], + "enumDescriptions": [ + "Health Checker will not parse the header field.", + "Health Checker will parse and report the weight in the header field, but load balancing will not be based on the weights and will use equal weights.", + "Health Checker will try to parse and report the weight in the header field, and load balancing will be based on the weights as long as all backends have a valid weight or only a subset of backends has the UNAVAILABLE_WEIGHT WeightError. The latter case is to continue the weighted load balancing while some backends are in TIMEOUT or UNKNOWN health status." + ], + "type": "string" + } + }, + "type": "object" + }, + "HealthAggregationPolicy": { + "description": "Represents a health aggregation policy. A health aggregation policy resource defines a policy to aggregate health. For more information, see Health checks overview.", + "id": "HealthAggregationPolicy", + "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" + }, + "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 HealthAggregationPolicy. An up-to-date fingerprint must be provided in order to patch the HealthAggregationPolicy; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthAggregationPolicy.", + "format": "byte", + "type": "string" + }, + "healthyPercentThreshold": { + "description": "Can only be set if the policyType field is BACKEND_SERVICE_POLICY. Specifies the threshold (as a percentage) of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to 60. Must be in range [0, 100]. Not applicable if the policyType field is DNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and minHealthyThreshold must be satisfied in order for HEALTHY to be the aggregated result. \"Endpoints\" refers to network endpoints within a Network Endpoint Group or instances within an Instance Group.", + "format": "uint32", + "type": "integer" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#healthAggregationPolicy", + "description": "[Output Only] Type of the resource. Always compute#healthAggregationPolicy for health aggregation policies.", + "type": "string" + }, + "minHealthyThreshold": { + "description": "Can only be set if the policyType field is BACKEND_SERVICE_POLICY. Specifies the minimum number of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to 1. Must be positive. Not applicable if the policyType field is DNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and healthyPercentThreshold must be satisfied in order for HEALTHY to be the aggregated result. \"Endpoints\" refers to network endpoints within a Network Endpoint Group or instances within an Instance Group.", + "format": "uint32", + "type": "integer" + }, + "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" + }, + "policyType": { + "description": "Specifies the type of the healthAggregationPolicy. The only allowed value for global resources is DNS_PUBLIC_IP_POLICY. The only allowed value for regional resources is BACKEND_SERVICE_POLICY. Must be specified when the healthAggregationPolicy is created, and cannot be mutated.", + "enum": [ + "BACKEND_SERVICE_POLICY", + "DNS_PUBLIC_IP_POLICY" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the health aggregation policy resides. This field applies only to the regional resource. 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" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, - "weightReportMode": { - "description": "Weight report mode. used for weighted Load Balancing.", - "enum": [ - "DISABLE", - "DRY_RUN", - "ENABLE" - ], - "enumDescriptions": [ - "Health Checker will not parse the header field.", - "Health Checker will parse and report the weight in the header field, but load balancing will not be based on the weights and will use equal weights.", - "Health Checker will try to parse and report the weight in the header field, and load balancing will be based on the weights as long as all backends have a valid weight or only a subset of backends has the UNAVAILABLE_WEIGHT WeightError. The latter case is to continue the weighted load balancing while some backends are in TIMEOUT or UNKNOWN health status." - ], + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL with id for the resource.", "type": "string" } }, "type": "object" }, - "HTTPSHealthCheck": { - "id": "HTTPSHealthCheck", + "HealthAggregationPolicyList": { + "id": "HealthAggregationPolicyList", "properties": { - "host": { - "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest", + "etag": { "type": "string" }, - "port": { - "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.", - "format": "int32", - "type": "integer" - }, - "portName": { - "description": "Not supported.", + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, - "portSpecification": { - "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", - "enum": [ - "USE_FIXED_PORT", - "USE_NAMED_PORT", - "USE_SERVING_PORT" - ], - "enumDescriptions": [ - "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", - "Not supported.", - "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." - ], - "type": "string" + "items": { + "description": "A list of HealthAggregationPolicy resources.", + "items": { + "$ref": "HealthAggregationPolicy" + }, + "type": "array" }, - "proxyHeader": { - "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", - "enum": [ - "NONE", - "PROXY_V1" - ], - "enumDescriptions": [ - "", - "" - ], + "kind": { + "default": "compute#healthAggregationPolicyList", + "description": "[Output Only] Type of the resource. Always compute#healthAggregationPolicy for health aggregation policies.", "type": "string" }, - "requestPath": { - "description": "The request path of the HTTPS health check request. The default value is /. Must comply with RFC3986.", + "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" }, - "response": { - "description": "Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http", + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, - "weightReportMode": { - "description": "Weight report mode. used for weighted Load Balancing.", - "enum": [ - "DISABLE", - "DRY_RUN", - "ENABLE" - ], - "enumDescriptions": [ - "Health Checker will not parse the header field.", - "Health Checker will parse and report the weight in the header field, but load balancing will not be based on the weights and will use equal weights.", - "Health Checker will try to parse and report the weight in the header field, and load balancing will be based on the weights as long as all backends have a valid weight or only a subset of backends has the UNAVAILABLE_WEIGHT WeightError. The latter case is to continue the weighted load balancing while some backends are in TIMEOUT or UNKNOWN health status." - ], - "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" @@ -60724,33 +62879,325 @@ }, "type": "object" }, - "HealthCheckServiceReference": { - "description": "A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service ", - "id": "HealthCheckServiceReference", - "properties": { - "healthCheckService": { - "type": "string" - } - }, - "type": "object" - }, - "HealthCheckServicesList": { - "id": "HealthCheckServicesList", + "HealthCheckServiceReference": { + "description": "A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service ", + "id": "HealthCheckServiceReference", + "properties": { + "healthCheckService": { + "type": "string" + } + }, + "type": "object" + }, + "HealthCheckServicesList": { + "id": "HealthCheckServicesList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of HealthCheckService resources.", + "items": { + "$ref": "HealthCheckService" + }, + "type": "array" + }, + "kind": { + "default": "compute#healthCheckServicesList", + "description": "[Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.", + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "HealthCheckServicesScopedList": { + "id": "HealthCheckServicesScopedList", + "properties": { + "resources": { + "description": "A list of HealthCheckServices contained in this scope.", + "items": { + "$ref": "HealthCheckService" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of backend services 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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "HealthChecksAggregatedList": { + "id": "HealthChecksAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of HealthCheckService resources.", - "items": { - "$ref": "HealthCheckService" + "additionalProperties": { + "$ref": "HealthChecksScopedList", + "description": "Name of the scope containing this set of HealthChecks." }, - "type": "array" + "description": "A list of HealthChecksScopedList resources.", + "type": "object" }, "kind": { - "default": "compute#healthCheckServicesList", - "description": "[Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.", + "default": "compute#healthChecksAggregatedList", + "description": "Type of resource.", "type": "string" }, "nextPageToken": { @@ -60761,6 +63208,13 @@ "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": { @@ -60888,13 +63342,13 @@ }, "type": "object" }, - "HealthCheckServicesScopedList": { - "id": "HealthCheckServicesScopedList", + "HealthChecksScopedList": { + "id": "HealthChecksScopedList", "properties": { - "resources": { - "description": "A list of HealthCheckServices contained in this scope.", + "healthChecks": { + "description": "A list of HealthChecks contained in this scope.", "items": { - "$ref": "HealthCheckService" + "$ref": "HealthCheck" }, "type": "array" }, @@ -61025,23 +63479,95 @@ }, "type": "object" }, - "HealthChecksAggregatedList": { - "id": "HealthChecksAggregatedList", + "HealthSource": { + "description": "Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.", + "id": "HealthSource", + "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" + }, + "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 HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.", + "format": "byte", + "type": "string" + }, + "healthAggregationPolicy": { + "description": "URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.", + "type": "string" + }, + "id": { + "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#healthSource", + "description": "[Output Only] Type of the resource. Always compute#healthSource for health sources.", + "type": "string" + }, + "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" + }, + "region": { + "description": "[Output Only] URL of the region where the health source resides. This field applies only to the regional resource. 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" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL with id for the resource.", + "type": "string" + }, + "sourceType": { + "description": "Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.", + "enum": [ + "BACKEND_SERVICE" + ], + "enumDescriptions": [ + "" + ], + "type": "string" + }, + "sources": { + "description": "URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "HealthSourceAggregatedList": { + "description": "Contains a list of HealthSourcesScopedList.", + "id": "HealthSourceAggregatedList", "properties": { + "etag": { + "type": "string" + }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "additionalProperties": { - "$ref": "HealthChecksScopedList", - "description": "Name of the scope containing this set of HealthChecks." + "$ref": "HealthSourcesScopedList", + "description": "Name of the scope containing this set of HealthSources." }, - "description": "A list of HealthChecksScopedList resources.", + "description": "A list of HealthSourcesScopedList resources.", "type": "object" }, "kind": { - "default": "compute#healthChecksAggregatedList", + "default": "compute#healthSourceAggregatedList", "description": "Type of resource.", "type": "string" }, @@ -61187,18 +63713,182 @@ }, "type": "object" }, - "HealthChecksScopedList": { - "id": "HealthChecksScopedList", + "HealthSourceList": { + "id": "HealthSourceList", "properties": { - "healthChecks": { - "description": "A list of HealthChecks contained in this scope.", + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of HealthSource resources.", "items": { - "$ref": "HealthCheck" + "$ref": "HealthSource" + }, + "type": "array" + }, + "kind": { + "default": "compute#healthSourceList", + "description": "[Output Only] Type of the resource. Always compute#healthSource for health sources.", + "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": "Informational warning which replaces the list of backend services when the list is empty.", + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "HealthSourcesScopedList": { + "id": "HealthSourcesScopedList", + "properties": { + "resources": { + "description": "A list of HealthSources contained in this scope.", + "items": { + "$ref": "HealthSource" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of health sources 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.", @@ -64316,7 +67006,7 @@ "description": "The configuration for metadata based readiness signal sent by the instance during initialization when stopping / suspending an instance. The Instance Group Manager will wait for a signal that indicates successful initialization before stopping / suspending an instance. If a successful readiness signal is not sent before timeout, the corresponding instance will not be stopped / suspended. Instead, an error will be visible in the lastAttempt.errors field of the managed instance in the listmanagedinstances method. If metadataBasedReadinessSignal.timeoutSec is unset, the Instance Group Manager will directly proceed to suspend / stop instances, skipping initialization on them." }, "onFailedHealthCheck": { - "description": "The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see about repairing VMs in a MIG. ", + "description": "The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see About repairing VMs in a MIG. ", "enum": [ "DEFAULT_ACTION", "DO_NOTHING", @@ -67564,6 +70254,20 @@ ], "type": "string" }, + "disruptionSchedule": { + "description": "The disruption schedule for the VM. Default to IMMEDIATE.", + "enum": [ + "DISRUPTION_SCHEDULE_UNSPECIFIED", + "FUTURE", + "IMMEDIATE" + ], + "enumDescriptions": [ + "Not used. Required as per aip/126.", + "Delay disruption for caller control. Will be default soon.", + "Default value. Disrupt the VM immediately." + ], + "type": "string" + }, "faultReasons": { "items": { "$ref": "InstancesReportHostAsFaultyRequestFaultReason" @@ -68599,7 +71303,7 @@ "IF_MACSEC" ], "enumDescriptions": [ - "Cross Site Networking", + "Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -68761,7 +71465,7 @@ "IF_MACSEC" ], "enumDescriptions": [ - "Cross Site Networking", + "Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -69674,6 +72378,247 @@ }, "type": "object" }, + "InterconnectAttachmentGroupsCreateMembers": { + "id": "InterconnectAttachmentGroupsCreateMembers", + "properties": { + "attachments": { + "description": "Parameters for the specific Attachments to create.", + "items": { + "$ref": "InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput" + }, + "type": "array" + }, + "intentMismatchBehavior": { + "description": "How to behave when configured.availabilitySLA.effectiveSLA would not equal intent.availabilitySLA after this call.", + "enum": [ + "CREATE", + "REJECT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "templateAttachment": { + "$ref": "InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput", + "description": "Default parameters for the Attachments to create in this call." + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput": { + "description": "LINT.IfChange Parameters used to create an InterconnectAttachment. This is similar to InterconnectAttachment, but the region field used here is not output only and all other output only fields are excluded.", + "id": "InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput", + "properties": { + "adminEnabled": { + "description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.", + "type": "boolean" + }, + "bandwidth": { + "description": "Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s ", + "enum": [ + "BPS_100G", + "BPS_100M", + "BPS_10G", + "BPS_1G", + "BPS_200M", + "BPS_20G", + "BPS_2G", + "BPS_300M", + "BPS_400M", + "BPS_500M", + "BPS_50G", + "BPS_50M", + "BPS_5G" + ], + "enumDescriptions": [ + "100 Gbit/s", + "100 Mbit/s", + "10 Gbit/s", + "1 Gbit/s", + "200 Mbit/s", + "20 Gbit/s", + "2 Gbit/s", + "300 Mbit/s", + "400 Mbit/s", + "500 Mbit/s", + "50 Gbit/s", + "50 Mbit/s", + "5 Gbit/s" + ], + "type": "string" + }, + "candidateCloudRouterIpAddress": { + "description": "Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31. ", + "type": "string" + }, + "candidateCloudRouterIpv6Address": { + "description": "Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126. ", + "type": "string" + }, + "candidateCustomerRouterIpAddress": { + "description": "Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.", + "type": "string" + }, + "candidateCustomerRouterIpv6Address": { + "description": "Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.", + "type": "string" + }, + "candidateIpv6Subnets": { + "description": "This field is not available.", + "items": { + "type": "string" + }, + "type": "array" + }, + "candidateSubnets": { + "description": "Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.", + "items": { + "type": "string" + }, + "type": "array" + }, + "cloudRouterIpv6InterfaceId": { + "description": "This field is not available.", + "type": "string" + }, + "customerRouterIpv6InterfaceId": { + "description": "This field is not available.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource.", + "type": "string" + }, + "edgeAvailabilityDomain": { + "description": "Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.", + "enum": [ + "AVAILABILITY_DOMAIN_1", + "AVAILABILITY_DOMAIN_2", + "AVAILABILITY_DOMAIN_ANY" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "encryption": { + "description": "Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - alpha - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. ", + "enum": [ + "IPSEC", + "NONE" + ], + "enumDescriptions": [ + "The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.", + "This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment." + ], + "type": "string" + }, + "interconnect": { + "description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through.", + "type": "string" + }, + "ipsecInternalAddresses": { + "description": "A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.", + "items": { + "type": "string" + }, + "type": "array" + }, + "l2Forwarding": { + "$ref": "InterconnectAttachmentL2Forwarding", + "description": "L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance." + }, + "mtu": { + "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.", + "format": "int32", + "type": "integer" + }, + "multicastEnabled": { + "description": "Whether or not to permit multicast traffic for this attachment. Multicast packets will be dropped if this is not enabled.", + "type": "boolean" + }, + "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" + }, + "pairingKey": { + "description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\"", + "type": "string" + }, + "partnerAsn": { + "description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.", + "format": "int64", + "type": "string" + }, + "partnerMetadata": { + "$ref": "InterconnectAttachmentPartnerMetadata", + "description": "Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED." + }, + "region": { + "description": "The region that the Attachment is in.", + "type": "string" + }, + "router": { + "description": "URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.", + "type": "string" + }, + "stackType": { + "description": "The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.", + "enum": [ + "IPV4_IPV6", + "IPV4_ONLY" + ], + "enumDescriptions": [ + "The interconnect attachment can have both IPv4 and IPv6 addresses.", + "The interconnect attachment will only be assigned IPv4 addresses." + ], + "type": "string" + }, + "subnetLength": { + "description": "Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. ", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. ", + "enum": [ + "DEDICATED", + "L2_DEDICATED", + "PARTNER", + "PARTNER_PROVIDER" + ], + "enumDescriptions": [ + "Attachment to a dedicated interconnect.", + "Attachment to a L2 interconnect, created by the customer.", + "Attachment to a partner interconnect, created by the customer.", + "Attachment to a partner interconnect, created by the partner." + ], + "type": "string" + }, + "vlanTag8021q": { + "description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupsCreateMembersRequest": { + "id": "InterconnectAttachmentGroupsCreateMembersRequest", + "properties": { + "request": { + "$ref": "InterconnectAttachmentGroupsCreateMembers" + } + }, + "type": "object" + }, "InterconnectAttachmentGroupsGetOperationalStatusResponse": { "description": "Response for the InterconnectAttachmentGroupsGetOperationalStatusResponse.", "id": "InterconnectAttachmentGroupsGetOperationalStatusResponse", @@ -69853,6 +72798,15 @@ "InterconnectAttachmentGroupsOperationalStatus": { "id": "InterconnectAttachmentGroupsOperationalStatus", "properties": { + "attachmentStatuses": { + "items": { + "$ref": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus" + }, + "type": "array" + }, + "configured": { + "$ref": "InterconnectAttachmentGroupConfigured" + }, "groupStatus": { "description": "Summarizes the status of the group.", "enum": [ @@ -69868,6 +72822,80 @@ "" ], "type": "string" + }, + "intent": { + "$ref": "InterconnectAttachmentGroupIntent" + }, + "operational": { + "$ref": "InterconnectAttachmentGroupConfigured", + "description": "The operational state of the group, including only active Attachments." + } + }, + "type": "object" + }, + "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus": { + "description": "The status of one Attachment in the group. List order is arbitrary.", + "id": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus", + "properties": { + "adminEnabled": { + "description": "Whether this Attachment is enabled. This becomes false when the customer drains their Attachment.", + "type": "boolean" + }, + "attachment": { + "description": "The URL of the Attachment being described.", + "type": "string" + }, + "isActive": { + "description": "Whether this Attachment is participating in the redundant configuration. This will be ACTIVE if and only if the status below is CONNECTION_UP. Any INACTIVE Attachments are excluded from the analysis that generates operational.availabilitySLA.", + "enum": [ + "ACTIVE", + "INACTIVE", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "status": { + "description": "Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto", + "enum": [ + "ATTACHMENT_STATUS_UNKNOWN", + "CONNECTION_DISABLED", + "CONNECTION_DOWN", + "CONNECTION_UP", + "DEFUNCT", + "IPSEC_CONFIGURATION_NEEDED_STATUS", + "IPSET_READY_TO_RESUME_FLOW_STATUS", + "IPV4_DOWN_IPV6_UP", + "IPV4_UP_IPV6_DOWN", + "PARTNER_REQUEST_RECEIVED", + "PENDING_CUSTOMER", + "PENDING_PARTNER", + "PROVISIONED", + "ROUTER_CONFIGURATION_BROKEN", + "UNPROVISIONED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -70735,6 +73763,132 @@ }, "type": "object" }, + "InterconnectGroupsCreateMembers": { + "id": "InterconnectGroupsCreateMembers", + "properties": { + "intentMismatchBehavior": { + "description": "How to behave when configured.topologyCapability.supportedSLA would not equal intent.topologyCapability after this call.", + "enum": [ + "CREATE", + "REJECT", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "interconnects": { + "items": { + "$ref": "InterconnectGroupsCreateMembersInterconnectInput" + }, + "type": "array" + }, + "templateInterconnect": { + "$ref": "InterconnectGroupsCreateMembersInterconnectInput", + "description": "Parameters for the Interconnects to create." + } + }, + "type": "object" + }, + "InterconnectGroupsCreateMembersInterconnectInput": { + "description": "LINT.IfChange", + "id": "InterconnectGroupsCreateMembersInterconnectInput", + "properties": { + "adminEnabled": { + "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", + "type": "boolean" + }, + "customerName": { + "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "facility": { + "description": "A zone-free location to use for all Interconnects created in this call, like \"iad-1234\".", + "type": "string" + }, + "interconnectType": { + "description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.", + "enum": [ + "DEDICATED", + "IT_PRIVATE", + "PARTNER" + ], + "enumDescriptions": [ + "A dedicated physical interconnection with the customer.", + "[Deprecated] A private, physical interconnection with the customer.", + "A partner-managed interconnection shared between customers via partner." + ], + "type": "string" + }, + "linkType": { + "description": "Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.", + "enum": [ + "LINK_TYPE_ETHERNET_100G_LR", + "LINK_TYPE_ETHERNET_10G_LR" + ], + "enumDescriptions": [ + "100G Ethernet, LR Optics.", + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + ], + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.interconnects.insert" + ] + }, + "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" + }, + "nocContactEmail": { + "description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.", + "type": "string" + }, + "remoteLocation": { + "description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", + "type": "string" + }, + "requestedFeatures": { + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", + "items": { + "enum": [ + "IF_CROSS_SITE_NETWORK", + "IF_MACSEC" + ], + "enumDescriptions": [ + "Cross-Site Networking", + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, + "requestedLinkCount": { + "description": "Target number of physical links in the link bundle, as requested by the customer.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InterconnectGroupsCreateMembersRequest": { + "id": "InterconnectGroupsCreateMembersRequest", + "properties": { + "request": { + "$ref": "InterconnectGroupsCreateMembers" + } + }, + "type": "object" + }, "InterconnectGroupsGetOperationalStatusResponse": { "description": "Response for the InterconnectGroupsGetOperationalStatusResponse.", "id": "InterconnectGroupsGetOperationalStatusResponse", @@ -71160,7 +74314,7 @@ "IF_MACSEC" ], "enumDescriptions": [ - "Cross Site Networking", + "Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -71219,7 +74373,7 @@ "type": "string" }, "crossSiteInterconnectInfos": { - "description": "[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Interconnect metros.", + "description": "[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed.", "items": { "$ref": "InterconnectLocationCrossSiteInterconnectInfo" }, @@ -71290,11 +74444,11 @@ "type": "object" }, "InterconnectLocationCrossSiteInterconnectInfo": { - "description": "Information about any potential WireGroups between an Interconnect at a specific InterconnectLocation, and an Interconnect in another metro.", + "description": "Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location.", "id": "InterconnectLocationCrossSiteInterconnectInfo", "properties": { "city": { - "description": "Metropolitan area designator", + "description": "The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations.", "type": "string" }, "maxSingleFlowGbps": { @@ -72675,16 +75829,16 @@ "id": "LicenseResourceCommitment", "properties": { "amount": { - "description": "The number of licenses purchased.", + "description": "The number of licenses you plan to purchase.", "format": "int64", "type": "string" }, "coresPerLicense": { - "description": "Specifies the core range of the instance for which this license applies.", + "description": "The number of cores per license.", "type": "string" }, "license": { - "description": "Any applicable license URI.", + "description": "The applicable license URI.", "type": "string" } }, @@ -73170,6 +76324,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "params": { + "$ref": "MachineImageParams", + "description": "Input only. [Input Only] Additional parameters that are passed in the request, but are not persisted in the resource." + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -73397,6 +76555,27 @@ }, "type": "object" }, + "MachineImageParams": { + "description": "Machine Image parameters", + "id": "MachineImageParams", + "properties": { + "excludedDisks": { + "description": "Input only. [Input Only] Specifies the list of disk device names that must be excluded from the new machine image.", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedDisks": { + "description": "Input only. [Input Only] Specifies the list of disk device names that must be included with the new machine image.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "MachineType": { "description": "Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.", "id": "MachineType", @@ -74176,11 +77355,13 @@ "provisioningModel": { "description": "The provisioning model to be used for this instance.", "enum": [ + "FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ + "Instance is provisioned with DWS Flex Start and have limited max run duration.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." @@ -74295,11 +77476,13 @@ "provisioningModel": { "description": "The provisioning model to be used for this instance.", "enum": [ + "FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ + "Instance is provisioned with DWS Flex Start and have limited max run duration.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." @@ -74499,6 +77682,215 @@ }, "type": "object" }, + "MultiMigMember": { + "description": "Represents a Multi-MIG member resource.", + "id": "MultiMigMember", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp of this multi-MIG member in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource.", + "type": "string" + }, + "id": { + "description": "[Output only] The unique identifier for this resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#multiMigMember", + "description": "Type of the resource. Always compute#multiMigMember for a list of multi-MIG members.", + "type": "string" + }, + "name": { + "description": "[Output Only] The name of this multi-MIG member generated by Google Compute Engine.", + "type": "string" + }, + "region": { + "description": "[Output Only] The URL of the region where the multi-MIG resides.", + "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" + }, + "status": { + "$ref": "MultiMigMemberStatus", + "description": "[Output Only] The status of this multi-MIG member" + } + }, + "type": "object" + }, + "MultiMigMemberList": { + "id": "MultiMigMemberList", + "properties": { + "id": { + "description": "Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of multi-MIG member resources.", + "items": { + "$ref": "MultiMigMember" + }, + "type": "array" + }, + "kind": { + "default": "compute#multiMigMemberList", + "description": "Type of the resource. Always compute#multiMigMember for a list of multi-MIG members.", + "type": "string" + }, + "nextPageToken": { + "description": "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": "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "MultiMigMemberStatus": { + "id": "MultiMigMemberStatus", + "properties": { + "instanceGroupManager": { + "description": "[Output Only] URL of member instance group manager", + "type": "string" + } + }, + "type": "object" + }, "MultiMigResourcePolicies": { "description": "Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG.", "id": "MultiMigResourcePolicies", @@ -75921,10 +79313,6 @@ "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.", "format": "int32", "type": "integer" - }, - "zone": { - "description": "The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group.", - "type": "string" } }, "type": "object" @@ -77188,7 +80576,7 @@ "type": "string" }, "vlan": { - "description": "VLAN tag of a dynamic network interface, must be in range from 2 to 4094 inclusively.", + "description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", "format": "int32", "type": "integer" } @@ -77528,10 +80916,6 @@ "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" - }, - "zone": { - "description": "[Output Only] Zone to which the network is restricted.", - "type": "string" } }, "type": "object" @@ -85468,7 +88852,7 @@ "id": "RegionCommitmentsUpdateReservationsRequest", "properties": { "reservations": { - "description": "A list of two reservations to transfer GPUs and local SSD between.", + "description": "A list of two reservations to transfer GPUs and Local SSD disks between.", "items": { "$ref": "Reservation" }, @@ -87237,6 +90621,20 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "reservationMode": { + "description": "[Output only] Indicates the reservation mode of the reservation.", + "enum": [ + "CALENDAR", + "DEFAULT", + "RESERVATION_MODE_UNSPECIFIED" + ], + "enumDescriptions": [ + "The delivered reservations terminate at specified endtime along with terminating VMs running on it. The price for this reservation is different from on-demand. Currently offered for A3+ GPUs and TPUs only.", + "The delivered reservations do not terminate VMs at the end of reservations. On-demand pricing and available for all VM families. This is default mode.", + "" + ], + "type": "string" + }, "reservationSharingPolicy": { "$ref": "AllocationReservationSharingPolicy", "description": "Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services." @@ -88103,20 +91501,20 @@ "type": "object" }, "ResourceCommitment": { - "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", + "description": "Commitment for a particular hardware resource (a commitment is composed of one or more of these).", "id": "ResourceCommitment", "properties": { "acceleratorType": { - "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", + "description": "Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.", "type": "string" }, "amount": { - "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", + "description": "The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. ", "format": "int64", "type": "string" }, "type": { - "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", + "description": "The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type.", "enum": [ "ACCELERATOR", "LOCAL_SSD", @@ -88962,6 +92360,10 @@ "description": "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.", "type": "object" }, + "region": { + "description": "Region where the snapshot is scoped to.", + "type": "string" + }, "storageLocations": { "description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).", "items": { @@ -89062,6 +92464,22 @@ "description": "Represents the workload policy.", "id": "ResourcePolicyWorkloadPolicy", "properties": { + "acceleratorTopology": { + "type": "string" + }, + "maxTopologyDistance": { + "enum": [ + "BLOCK", + "CLUSTER", + "SUBBLOCK" + ], + "enumDescriptions": [ + "VMs must be provisioned in the same block.", + "VMs must be provisioned in the same cluster.", + "VMs must be provisioned in the same subblock." + ], + "type": "string" + }, "type": { "enum": [ "HIGH_AVAILABILITY", @@ -89087,6 +92505,10 @@ }, "type": "array" }, + "effectiveInstanceMetadata": { + "$ref": "ResourceStatusEffectiveInstanceMetadata", + "description": "[Output Only] Effective metadata is a field that consolidates project, zonal instance settings, and instance-level predefined metadata keys to provide the overridden value for those metadata keys at the instance level." + }, "lastInstanceTerminationDetails": { "$ref": "ResourceStatusLastInstanceTerminationDetails", "description": "[Output Only] Contains last termination details why the instance was terminated." @@ -89183,6 +92605,21 @@ }, "type": "object" }, + "ResourceStatusEffectiveInstanceMetadata": { + "description": "Effective values of predefined metadata keys for an instance.", + "id": "ResourceStatusEffectiveInstanceMetadata", + "properties": { + "enableOsloginMetadataValue": { + "description": "Effective enable-oslogin value at Instance level.", + "type": "boolean" + }, + "vmDnsSettingMetadataValue": { + "description": "Effective VM DNS setting at Instance level.", + "type": "string" + } + }, + "type": "object" + }, "ResourceStatusLastInstanceTerminationDetails": { "id": "ResourceStatusLastInstanceTerminationDetails", "properties": { @@ -90340,14 +93777,14 @@ "type": "boolean" }, "exportPolicies": { - "description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", + "description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type.", "items": { "type": "string" }, "type": "array" }, "importPolicies": { - "description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", + "description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type.", "items": { "type": "string" }, @@ -90504,7 +93941,7 @@ "id": "RouterInterface", "properties": { "ipRange": { - "description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", + "description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", "type": "string" }, "ipVersion": { @@ -91080,6 +94517,10 @@ }, "type": "array" }, + "nccGateway": { + "description": "URI of the ncc_gateway to which this router associated.", + "type": "string" + }, "network": { "description": "URI of the network to which this router belongs.", "type": "string" @@ -92331,11 +95772,13 @@ "provisioningModel": { "description": "Specifies the provisioning model of the instance.", "enum": [ + "FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ + "Instance is provisioned with DWS Flex Start and have limited max run duration.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." @@ -95346,7 +98789,7 @@ "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." }, "sourceInstantSnapshotId": { - "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", + "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", "type": "string" }, "sourceSnapshotSchedulePolicy": { @@ -95763,6 +99206,20 @@ }, "description": "List of regions that can restore a regional snapshot from the current region", "type": "object" + }, + "policy": { + "description": "Policy of which location is allowed to access snapshot.", + "enum": [ + "ALL_REGIONS", + "POLICY_UNSPECIFIED", + "SPECIFIC_REGIONS" + ], + "enumDescriptions": [ + "Any regions will be able to access the source location.", + "", + "Only allowlisted regions will be able to restore region scoped snapshots" + ], + "type": "string" } }, "type": "object" @@ -99152,7 +102609,7 @@ "type": "string" }, "purpose": { - "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", + "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "AGGREGATE", "CLOUD_EXTENSION", @@ -101036,7 +104493,7 @@ "type": "string" }, "serverTlsPolicy": { - "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.", + "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED or INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy attached to regional forwardingRules with the loadBalancingScheme set to EXTERNAL_MANAGED or INTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, INTERNAL_MANAGED, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.", "type": "string" }, "sslCertificates": { @@ -104892,7 +108349,7 @@ "type": "string" }, "purpose": { - "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", + "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "AGGREGATE", "CLOUD_EXTENSION", @@ -106090,6 +109547,10 @@ "description": "Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.", "id": "VpnTunnel", "properties": { + "cipherSuite": { + "$ref": "VpnTunnelCipherSuite", + "description": "User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol." + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -106402,6 +109863,18 @@ }, "type": "object" }, + "VpnTunnelCipherSuite": { + "id": "VpnTunnelCipherSuite", + "properties": { + "phase1": { + "$ref": "VpnTunnelPhase1Algorithms" + }, + "phase2": { + "$ref": "VpnTunnelPhase2Algorithms" + } + }, + "type": "object" + }, "VpnTunnelList": { "description": "Contains a list of VpnTunnel resources.", "id": "VpnTunnelList", @@ -106557,6 +110030,60 @@ }, "type": "object" }, + "VpnTunnelPhase1Algorithms": { + "id": "VpnTunnelPhase1Algorithms", + "properties": { + "dh": { + "items": { + "type": "string" + }, + "type": "array" + }, + "encryption": { + "items": { + "type": "string" + }, + "type": "array" + }, + "integrity": { + "items": { + "type": "string" + }, + "type": "array" + }, + "prf": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "VpnTunnelPhase2Algorithms": { + "id": "VpnTunnelPhase2Algorithms", + "properties": { + "encryption": { + "items": { + "type": "string" + }, + "type": "array" + }, + "integrity": { + "items": { + "type": "string" + }, + "type": "array" + }, + "pfs": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "VpnTunnelsScopedList": { "id": "VpnTunnelsScopedList", "properties": { @@ -106904,7 +110431,7 @@ "type": "string" }, "vlanTags": { - "description": "To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints. ", + "description": "To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. ", "items": { "format": "int32", "type": "integer" @@ -107189,7 +110716,7 @@ "type": "string" }, "bandwidthUnmetered": { - "description": "The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10.", + "description": "The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps.", "format": "int64", "type": "string" }, @@ -107212,8 +110739,8 @@ "GOLD" ], "enumDescriptions": [ - "The default service class.", - "A higher service class." + "The lowest service class.", + "The highest service class." ], "type": "string" } diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 23346b4efaa..f2b1f559588 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -710,6 +710,47 @@ } } }, + "advice": { + "methods": { + "calendarMode": { + "description": "Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits. The method recommends creating future reservations for the requested resources.", + "flatPath": "projects/{project}/regions/{region}/advice/calendarMode", + "httpMethod": "POST", + "id": "compute.advice.calendarMode", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/advice/calendarMode", + "request": { + "$ref": "CalendarModeAdviceRequest" + }, + "response": { + "$ref": "CalendarModeAdviceResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "autoscalers": { "methods": { "aggregatedList": { @@ -1409,6 +1450,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}", @@ -2339,43 +2435,23 @@ } } }, - "diskTypes": { + "crossSiteNetworks": { "methods": { - "aggregatedList": { - "description": "Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/diskTypes", - "httpMethod": "GET", - "id": "compute.diskTypes.aggregatedList", + "delete": { + "description": "Deletes the specified cross-site network in the given scope.", + "flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", + "httpMethod": "DELETE", + "id": "compute.crossSiteNetworks.delete", "parameterOrder": [ - "project" + "project", + "crossSiteNetwork" ], "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", + "crossSiteNetwork": { + "description": "Name of the cross-site network 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": { @@ -2385,41 +2461,33 @@ "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", + "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). end_interface: MixerMutationRequestBuilder", "location": "query", "type": "string" } }, - "path": "projects/{project}/aggregated/diskTypes", + "path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", "response": { - "$ref": "DiskTypeAggregatedList" + "$ref": "Operation" }, "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": { - "description": "Returns the specified disk type.", - "flatPath": "projects/{project}/zones/{zone}/diskTypes/{diskType}", + "description": "Returns the specified cross-site network in the given scope.", + "flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", "httpMethod": "GET", - "id": "compute.diskTypes.get", + "id": "compute.crossSiteNetworks.get", "parameterOrder": [ "project", - "zone", - "diskType" + "crossSiteNetwork" ], "parameters": { - "diskType": { - "description": "Name of the disk type to return.", + "crossSiteNetwork": { + "description": "Name of the cross-site network to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -2431,18 +2499,11 @@ "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}/diskTypes/{diskType}", + "path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", "response": { - "$ref": "DiskType" + "$ref": "CrossSiteNetwork" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -2450,91 +2511,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "list": { - "description": "Retrieves a list of disk types available to the specified project.", - "flatPath": "projects/{project}/zones/{zone}/diskTypes", - "httpMethod": "GET", - "id": "compute.diskTypes.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}/diskTypes", - "response": { - "$ref": "DiskTypeList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - } - } - }, - "disks": { - "methods": { - "addResourcePolicies": { - "description": "Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.", - "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", + "insert": { + "description": "Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.", + "flatPath": "projects/{project}/global/crossSiteNetworks", "httpMethod": "POST", - "id": "compute.disks.addResourcePolicies", + "id": "compute.crossSiteNetworks.insert", "parameterOrder": [ - "project", - "zone", - "disk" + "project" ], "parameters": { - "disk": { - "description": "The disk name for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -2543,21 +2528,19 @@ "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).", + "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). end_interface: MixerMutationRequestBuilder", "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" + "validateOnly": { + "description": "[Input Only] Validate the new configuration, but don't create it.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", + "path": "projects/{project}/global/crossSiteNetworks", "request": { - "$ref": "DisksAddResourcePoliciesRequest" + "$ref": "CrossSiteNetwork" }, "response": { "$ref": "Operation" @@ -2567,11 +2550,11 @@ "https://www.googleapis.com/auth/compute" ] }, - "aggregatedList": { - "description": "Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/disks", + "list": { + "description": "Lists the cross-site networks for a project in the given scope.", + "flatPath": "projects/{project}/global/crossSiteNetworks", "httpMethod": "GET", - "id": "compute.disks.aggregatedList", + "id": "compute.crossSiteNetworks.list", "parameterOrder": [ "project" ], @@ -2581,11 +2564,436 @@ "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" + } + }, + "path": "projects/{project}/global/crossSiteNetworks", + "response": { + "$ref": "CrossSiteNetworkList" + }, + "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 cross-site network 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/crossSiteNetworks/{crossSiteNetwork}", + "httpMethod": "PATCH", + "id": "compute.crossSiteNetworks.patch", + "parameterOrder": [ + "project", + "crossSiteNetwork" + ], + "parameters": { + "crossSiteNetwork": { + "description": "Name of the cross-site network 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" + }, + "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). end_interface: MixerMutationRequestBuilder", + "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" + }, + "validateOnly": { + "description": "[Input Only] Validate the new configuration, but don't update it.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}", + "request": { + "$ref": "CrossSiteNetwork" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "diskSettings": { + "methods": { + "get": { + "description": "Get Zonal Disk Settings.", + "flatPath": "projects/{project}/zones/{zone}/diskSettings", + "httpMethod": "GET", + "id": "compute.diskSettings.get", + "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" + }, + "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}/diskSettings", + "response": { + "$ref": "DiskSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Patch Zonal Disk Settings", + "flatPath": "projects/{project}/zones/{zone}/diskSettings", + "httpMethod": "PATCH", + "id": "compute.diskSettings.patch", + "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" + }, + "updateMask": { + "description": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "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}/diskSettings", + "request": { + "$ref": "DiskSettings" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "diskTypes": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/diskTypes", + "httpMethod": "GET", + "id": "compute.diskTypes.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/diskTypes", + "response": { + "$ref": "DiskTypeAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "get": { + "description": "Returns the specified disk type.", + "flatPath": "projects/{project}/zones/{zone}/diskTypes/{diskType}", + "httpMethod": "GET", + "id": "compute.diskTypes.get", + "parameterOrder": [ + "project", + "zone", + "diskType" + ], + "parameters": { + "diskType": { + "description": "Name of the disk type 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}/diskTypes/{diskType}", + "response": { + "$ref": "DiskType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves a list of disk types available to the specified project.", + "flatPath": "projects/{project}/zones/{zone}/diskTypes", + "httpMethod": "GET", + "id": "compute.diskTypes.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}/diskTypes", + "response": { + "$ref": "DiskTypeList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "disks": { + "methods": { + "addResourcePolicies": { + "description": "Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.", + "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", + "httpMethod": "POST", + "id": "compute.disks.addResourcePolicies", + "parameterOrder": [ + "project", + "zone", + "disk" + ], + "parameters": { + "disk": { + "description": "The disk name for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "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}/disks/{disk}/addResourcePolicies", + "request": { + "$ref": "DisksAddResourcePoliciesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "aggregatedList": { + "description": "Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/disks", + "httpMethod": "GET", + "id": "compute.disks.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`)", @@ -11166,6 +11574,55 @@ "https://www.googleapis.com/auth/compute" ] }, + "addNetworkInterface": { + "description": "Adds one dynamic network interface to an active instance.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface", + "httpMethod": "POST", + "id": "compute.instances.addNetworkInterface", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "parameters": { + "instance": { + "description": "The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer.", + "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": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface", + "request": { + "$ref": "NetworkInterface" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "addResourcePolicies": { "description": "Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies", @@ -11492,6 +11949,59 @@ "https://www.googleapis.com/auth/compute" ] }, + "deleteNetworkInterface": { + "description": "Deletes one dynamic network interface from an active instance. InstancesDeleteNetworkInterfaceRequest indicates: - instance from which to delete, using project+zone+resource_id fields; - dynamic network interface to be deleted, using network_interface_name field;", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface", + "httpMethod": "POST", + "id": "compute.instances.deleteNetworkInterface", + "parameterOrder": [ + "project", + "zone", + "instance", + "networkInterfaceName" + ], + "parameters": { + "instance": { + "description": "The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer.", + "location": "path", + "required": true, + "type": "string" + }, + "networkInterfaceName": { + "description": "The name of the dynamic network interface to be deleted from the instance.", + "location": "query", + "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}/instances/{instance}/deleteNetworkInterface", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "detachDisk": { "description": "Detaches a disk from an instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk", @@ -12339,11 +12849,11 @@ "https://www.googleapis.com/auth/compute" ] }, - "reset": { - "description": "Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset", + "reportHostAsFaulty": { + "description": "Mark the host as faulty and try to restart the instance on a new host.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty", "httpMethod": "POST", - "id": "compute.instances.reset", + "id": "compute.instances.reportHostAsFaulty", "parameterOrder": [ "project", "zone", @@ -12377,56 +12887,9 @@ "type": "string" } }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/reset", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "resume": { - "description": "Resumes an instance that was suspended using the instances().suspend method.", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume", - "httpMethod": "POST", - "id": "compute.instances.resume", - "parameterOrder": [ - "project", - "zone", - "instance" - ], - "parameters": { - "instance": { - "description": "Name of the instance resource to resume.", - "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}/instances/{instance}/resume", + "path": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty", "request": { - "$ref": "InstancesResumeRequest" + "$ref": "InstancesReportHostAsFaultyRequest" }, "response": { "$ref": "Operation" @@ -12436,11 +12899,11 @@ "https://www.googleapis.com/auth/compute" ] }, - "sendDiagnosticInterrupt": { - "description": "Sends diagnostic interrupt to the instance.", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt", + "reset": { + "description": "Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset", "httpMethod": "POST", - "id": "compute.instances.sendDiagnosticInterrupt", + "id": "compute.instances.reset", "parameterOrder": [ "project", "zone", @@ -12461,113 +12924,6 @@ "required": true, "type": "string" }, - "zone": { - "description": "The name of the zone for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "setDeletionProtection": { - "description": "Sets deletion protection on the instance.", - "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection", - "httpMethod": "POST", - "id": "compute.instances.setDeletionProtection", - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "parameters": { - "deletionProtection": { - "default": "true", - "description": "Whether the resource should be protected against deletion.", - "location": "query", - "type": "boolean" - }, - "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" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the zone for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "setDiskAutoDelete": { - "description": "Sets the auto-delete flag for a disk attached to an instance.", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete", - "httpMethod": "POST", - "id": "compute.instances.setDiskAutoDelete", - "parameterOrder": [ - "project", - "zone", - "instance", - "autoDelete", - "deviceName" - ], - "parameters": { - "autoDelete": { - "description": "Whether to auto-delete the disk when the instance is deleted.", - "location": "query", - "required": true, - "type": "boolean" - }, - "deviceName": { - "description": "The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.", - "location": "query", - "pattern": "\\w[\\w.-]{0,254}", - "required": true, - "type": "string" - }, - "instance": { - "description": "The instance name for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "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", @@ -12581,7 +12937,7 @@ "type": "string" } }, - "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete", + "path": "projects/{project}/zones/{zone}/instances/{instance}/reset", "response": { "$ref": "Operation" }, @@ -12590,56 +12946,11 @@ "https://www.googleapis.com/auth/compute" ] }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", - "httpMethod": "POST", - "id": "compute.instances.setIamPolicy", - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the zone for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", - "request": { - "$ref": "ZoneSetPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "setLabels": { - "description": "Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels", + "resume": { + "description": "Resumes an instance that was suspended using the instances().suspend method.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume", "httpMethod": "POST", - "id": "compute.instances.setLabels", + "id": "compute.instances.resume", "parameterOrder": [ "project", "zone", @@ -12647,7 +12958,256 @@ ], "parameters": { "instance": { - "description": "Name of the instance scoping this request.", + "description": "Name of the instance resource to resume.", + "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}/instances/{instance}/resume", + "request": { + "$ref": "InstancesResumeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "sendDiagnosticInterrupt": { + "description": "Sends diagnostic interrupt to the instance.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt", + "httpMethod": "POST", + "id": "compute.instances.sendDiagnosticInterrupt", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "parameters": { + "instance": { + "description": "Name of the instance scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setDeletionProtection": { + "description": "Sets deletion protection on the instance.", + "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection", + "httpMethod": "POST", + "id": "compute.instances.setDeletionProtection", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "deletionProtection": { + "default": "true", + "description": "Whether the resource should be protected against deletion.", + "location": "query", + "type": "boolean" + }, + "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" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setDiskAutoDelete": { + "description": "Sets the auto-delete flag for a disk attached to an instance.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete", + "httpMethod": "POST", + "id": "compute.instances.setDiskAutoDelete", + "parameterOrder": [ + "project", + "zone", + "instance", + "autoDelete", + "deviceName" + ], + "parameters": { + "autoDelete": { + "description": "Whether to auto-delete the disk when the instance is deleted.", + "location": "query", + "required": true, + "type": "boolean" + }, + "deviceName": { + "description": "The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.", + "location": "query", + "pattern": "\\w[\\w.-]{0,254}", + "required": true, + "type": "string" + }, + "instance": { + "description": "The instance name for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "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}/instances/{instance}/setDiskAutoDelete", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.instances.setIamPolicy", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", + "request": { + "$ref": "ZoneSetPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setLabels": { + "description": "Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels", + "httpMethod": "POST", + "id": "compute.instances.setLabels", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "parameters": { + "instance": { + "description": "Name of the instance scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -20261,7 +20821,7 @@ "organizationSecurityPolicies": { "methods": { "addAssociation": { - "description": "Inserts an association for the specified security policy.", + "description": "Inserts an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/addAssociation", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.addAssociation", @@ -20334,7 +20894,7 @@ ] }, "copyRules": { - "description": "Copies rules to the specified security policy.", + "description": "Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/copyRules", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.copyRules", @@ -20370,7 +20930,7 @@ ] }, "delete": { - "description": "Deletes the specified policy.", + "description": "Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}", "httpMethod": "DELETE", "id": "compute.organizationSecurityPolicies.delete", @@ -20401,7 +20961,7 @@ ] }, "get": { - "description": "List all of the ordered rules present in a single specified policy.", + "description": "List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.get", @@ -20428,7 +20988,7 @@ ] }, "getAssociation": { - "description": "Gets an association with the specified name.", + "description": "Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/getAssociation", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.getAssociation", @@ -20460,7 +21020,7 @@ ] }, "getRule": { - "description": "Gets a rule at the specified priority.", + "description": "Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/getRule", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.getRule", @@ -20493,7 +21053,7 @@ ] }, "insert": { - "description": "Creates a new policy in the specified project using the data included in the request.", + "description": "Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.", "flatPath": "locations/global/securityPolicies", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.insert", @@ -20522,7 +21082,7 @@ ] }, "list": { - "description": "List all the policies that have been configured for the specified project.", + "description": "List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.", "flatPath": "locations/global/securityPolicies", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.list", @@ -20572,7 +21132,7 @@ ] }, "listAssociations": { - "description": "Lists associations of a specified target, i.e., organization or folder.", + "description": "Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.", "flatPath": "locations/global/securityPolicies/listAssociations", "httpMethod": "GET", "id": "compute.organizationSecurityPolicies.listAssociations", @@ -20644,7 +21204,7 @@ ] }, "move": { - "description": "Moves the specified security policy.", + "description": "Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/move", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.move", @@ -20680,7 +21240,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request.", + "description": "Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "id": "compute.organizationSecurityPolicies.patch", @@ -20714,7 +21274,7 @@ ] }, "patchRule": { - "description": "Patches a rule at the specified priority.", + "description": "Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.patchRule", @@ -20754,7 +21314,7 @@ ] }, "removeAssociation": { - "description": "Removes an association for the specified security policy.", + "description": "Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.", "flatPath": "locations/global/securityPolicies/{securityPolicy}/removeAssociation", "httpMethod": "POST", "id": "compute.organizationSecurityPolicies.removeAssociation", @@ -23618,7 +24178,7 @@ ] }, "update": { - "description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.", + "description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", "httpMethod": "PATCH", "id": "compute.regionCommitments.update", @@ -23629,7 +24189,7 @@ ], "parameters": { "commitment": { - "description": "Name of the commitment for which auto renew is being updated.", + "description": "Name of the commitment that you want to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -23679,7 +24239,7 @@ ] }, "updateReservations": { - "description": "Transfers GPUs or local SSDs between reservations within commitments.", + "description": "Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}/updateReservations", "httpMethod": "POST", "id": "compute.regionCommitments.updateReservations", @@ -23690,7 +24250,7 @@ ], "parameters": { "commitment": { - "description": "Name of the commitment for which the reservation is being updated.", + "description": "Name of the commitment for which the reservations are being updated.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -23730,6 +24290,93 @@ } } }, + "regionDiskSettings": { + "methods": { + "get": { + "description": "Get Regional Disk Settings.", + "flatPath": "projects/{project}/regions/{region}/diskSettings", + "httpMethod": "GET", + "id": "compute.regionDiskSettings.get", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/diskSettings", + "response": { + "$ref": "DiskSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Patch Regional Disk Settings", + "flatPath": "projects/{project}/regions/{region}/diskSettings", + "httpMethod": "PATCH", + "id": "compute.regionDiskSettings.patch", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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" + } + }, + "path": "projects/{project}/regions/{region}/diskSettings", + "request": { + "$ref": "DiskSettings" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "regionDiskTypes": { "methods": { "get": { @@ -30247,6 +30894,482 @@ } } }, + "regionSnapshotSettings": { + "methods": { + "get": { + "description": "Get region snapshot settings.", + "flatPath": "projects/{project}/regions/{region}/snapshotSettings", + "httpMethod": "GET", + "id": "compute.regionSnapshotSettings.get", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshotSettings", + "response": { + "$ref": "SnapshotSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Patch region snapshot settings.", + "flatPath": "projects/{project}/regions/{region}/snapshotSettings", + "httpMethod": "PATCH", + "id": "compute.regionSnapshotSettings.patch", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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" + } + }, + "path": "projects/{project}/regions/{region}/snapshotSettings", + "request": { + "$ref": "SnapshotSettings" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "regionSnapshots": { + "methods": { + "delete": { + "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "httpMethod": "DELETE", + "id": "compute.regionSnapshots.delete", + "parameterOrder": [ + "project", + "region", + "snapshot" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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" + }, + "snapshot": { + "description": "Name of the snapshot resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified Snapshot resource.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "httpMethod": "GET", + "id": "compute.regionSnapshots.get", + "parameterOrder": [ + "project", + "region", + "snapshot" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "snapshot": { + "description": "Name of the Snapshot resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshots/{snapshot}", + "response": { + "$ref": "Snapshot" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.regionSnapshots.getIamPolicy", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a snapshot in the specified region using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/snapshots", + "httpMethod": "POST", + "id": "compute.regionSnapshots.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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}/snapshots", + "request": { + "$ref": "Snapshot" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves the list of Snapshot resources contained within the specified region.", + "flatPath": "projects/{project}/regions/{region}/snapshots", + "httpMethod": "GET", + "id": "compute.regionSnapshots.list", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most 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}/snapshots", + "response": { + "$ref": "SnapshotList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.regionSnapshots.setIamPolicy", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", + "request": { + "$ref": "RegionSetPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setLabels": { + "description": "Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.regionSnapshots.setLabels", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", + "request": { + "$ref": "RegionSetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionSnapshots.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regionSslCertificates": { "methods": { "delete": { @@ -32499,6 +33622,62 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] + }, + "performMaintenance": { + "description": "Allows customers to perform maintenance on a reservation block", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", + "httpMethod": "POST", + "id": "compute.reservationBlocks.performMaintenance", + "parameterOrder": [ + "project", + "zone", + "reservation", + "reservationBlock" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "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" + }, + "reservation": { + "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "reservationBlock": { + "description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request. Zone name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", + "request": { + "$ref": "ReservationsBlocksPerformMaintenanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -32553,53 +33732,249 @@ "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/reservations", - "response": { - "$ref": "ReservationAggregatedList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "delete": { - "description": "Deletes the specified reservation.", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", - "httpMethod": "DELETE", - "id": "compute.reservations.delete", - "parameterOrder": [ - "project", - "zone", - "reservation" - ], - "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" - }, - "reservation": { - "description": "Name of the reservation 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" - }, + "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/reservations", + "response": { + "$ref": "ReservationAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified reservation.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", + "httpMethod": "DELETE", + "id": "compute.reservations.delete", + "parameterOrder": [ + "project", + "zone", + "reservation" + ], + "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" + }, + "reservation": { + "description": "Name of the reservation 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" + }, + "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}/reservations/{reservation}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Retrieves information about the specified reservation.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", + "httpMethod": "GET", + "id": "compute.reservations.get", + "parameterOrder": [ + "project", + "zone", + "reservation" + ], + "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" + }, + "reservation": { + "description": "Name of the reservation to retrieve.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "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}/reservations/{reservation}", + "response": { + "$ref": "Reservation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.reservations.getIamPolicy", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new reservation. For more information, read Reserving zonal resources.", + "flatPath": "projects/{project}/zones/{zone}/reservations", + "httpMethod": "POST", + "id": "compute.reservations.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.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations", + "request": { + "$ref": "Reservation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "A list of all the reservations that have been configured for the specified project in specified zone.", + "flatPath": "projects/{project}/zones/{zone}/reservations", + "httpMethod": "GET", + "id": "compute.reservations.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.", "location": "path", @@ -32608,20 +33983,21 @@ "type": "string" } }, - "path": "projects/{project}/zones/{zone}/reservations/{reservation}", + "path": "projects/{project}/zones/{zone}/reservations", "response": { - "$ref": "Operation" + "$ref": "ReservationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "get": { - "description": "Retrieves information about the specified reservation.", - "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", - "httpMethod": "GET", - "id": "compute.reservations.get", + "performMaintenance": { + "description": "Perform maintenance on an extended reservation", + "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance", + "httpMethod": "POST", + "id": "compute.reservations.performMaintenance", "parameterOrder": [ "project", "zone", @@ -32631,117 +34007,31 @@ "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" }, - "reservation": { - "description": "Name of the reservation to retrieve.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "zone": { - "description": "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}/reservations/{reservation}", - "response": { - "$ref": "Reservation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", - "httpMethod": "GET", - "id": "compute.reservations.getIamPolicy", - "parameterOrder": [ - "project", - "zone", - "resource" - ], - "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "format": "int32", + "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": "integer" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", + "reservation": { + "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, "zone": { - "description": "The name of the zone for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "insert": { - "description": "Creates a new reservation. For more information, read Reserving zonal resources.", - "flatPath": "projects/{project}/zones/{zone}/reservations", - "httpMethod": "POST", - "id": "compute.reservations.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.", + "description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, - "path": "projects/{project}/zones/{zone}/reservations", + "path": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance", "request": { - "$ref": "Reservation" + "$ref": "ReservationsPerformMaintenanceRequest" }, "response": { "$ref": "Operation" @@ -32751,69 +34041,6 @@ "https://www.googleapis.com/auth/compute" ] }, - "list": { - "description": "A list of all the reservations that have been configured for the specified project in specified zone.", - "flatPath": "projects/{project}/zones/{zone}/reservations", - "httpMethod": "GET", - "id": "compute.reservations.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.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/zones/{zone}/reservations", - "response": { - "$ref": "ReservationList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, "resize": { "description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", @@ -35815,6 +37042,72 @@ }, "snapshots": { "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of all of the snapshots in your project across all regions and global scope. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/snapshots", + "httpMethod": "GET", + "id": "compute.snapshots.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/snapshots", + "response": { + "$ref": "SnapshotAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "delete": { "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", "flatPath": "projects/{project}/global/snapshots/{snapshot}", @@ -42448,22 +43741,318 @@ "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" - }, + "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}/vpnTunnels", + "response": { + "$ref": "VpnTunnelList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "setLabels": { + "description": "Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", + "httpMethod": "POST", + "id": "compute.vpnTunnels.setLabels", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", + "request": { + "$ref": "RegionSetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.vpnTunnels.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "wireGroups": { + "methods": { + "delete": { + "description": "Deletes the specified wire group in the given scope.", + "flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", + "httpMethod": "DELETE", + "id": "compute.wireGroups.delete", + "parameterOrder": [ + "project", + "crossSiteNetwork", + "wireGroup" + ], + "parameters": { + "crossSiteNetwork": { + "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). end_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + }, + "wireGroup": { + "description": "Name of the wire group resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Gets the specified wire group resource in the given scope.", + "flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", + "httpMethod": "GET", + "id": "compute.wireGroups.get", + "parameterOrder": [ + "project", + "crossSiteNetwork", + "wireGroup" + ], + "parameters": { + "crossSiteNetwork": { + "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" + }, + "wireGroup": { + "description": "Name of the wire group resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", + "response": { + "$ref": "WireGroup" + }, + "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 wire group in the specified project in the given scope using the parameters that are included in the request.", + "flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups", + "httpMethod": "POST", + "id": "compute.wireGroups.insert", + "parameterOrder": [ + "project", + "crossSiteNetwork" + ], + "parameters": { + "crossSiteNetwork": { + "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). end_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "[Input Only] Validate the new configuration, but don't create it.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups", + "request": { + "$ref": "WireGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Lists the wire groups for a project in the given scope.", + "flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups", + "httpMethod": "GET", + "id": "compute.wireGroups.list", + "parameterOrder": [ + "project", + "crossSiteNetwork" + ], + "parameters": { + "crossSiteNetwork": { + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "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}/regions/{region}/vpnTunnels", + "path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups", "response": { - "$ref": "VpnTunnelList" + "$ref": "WireGroupList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -42471,100 +44060,64 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "setLabels": { - "description": "Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", - "httpMethod": "POST", - "id": "compute.vpnTunnels.setLabels", + "patch": { + "description": "Updates the specified wire group resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", + "httpMethod": "PATCH", + "id": "compute.wireGroups.patch", "parameterOrder": [ "project", - "region", - "resource" + "crossSiteNetwork", + "wireGroup" ], "parameters": { - "project": { - "description": "Project ID for this request.", + "crossSiteNetwork": { "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, - "region": { - "description": "The region for this request.", + "project": { + "description": "Project ID for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "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).", + "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). end_interface: MixerMutationRequestBuilder", "location": "query", "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", - "request": { - "$ref": "RegionSetLabelsRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.vpnTunnels.testIamPermissions", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, + "updateMask": { + "description": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "location": "query", "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" + "validateOnly": { + "description": "[Input Only] Validate the new configuration, but don't update it.", + "location": "query", + "type": "boolean" }, - "resource": { - "description": "Name or id of the resource for this request.", + "wireGroup": { + "description": "Name of the WireGroups resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/testIamPermissions", + "path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}", "request": { - "$ref": "TestPermissionsRequest" + "$ref": "WireGroup" }, "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Operation" }, "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" ] } } @@ -42856,7 +44409,7 @@ } } }, - "revision": "20250107", + "revision": "20250302", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -44179,14 +45732,18 @@ "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_LITE_POD_SLICE_CT6E", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", - "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P" ], "enumDescriptions": [ "", "", "", "", + "", + "", "" ], "type": "string" @@ -45999,6 +47556,160 @@ }, "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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": { @@ -46023,7 +47734,7 @@ "type": "number" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-24 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.", + "description": "Name of a custom utilization signal. 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" } }, @@ -46104,6 +47815,10 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "dynamicForwarding": { + "$ref": "BackendServiceDynamicForwarding", + "description": "Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic." + }, "edgeSecurityPolicy": { "description": "[Output Only] The resource URL for the edge security policy associated with this backend service.", "type": "string" @@ -46254,6 +47969,10 @@ "description": "The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.", "type": "string" }, + "networkPassThroughLbTrafficPolicy": { + "$ref": "BackendServiceNetworkPassThroughLbTrafficPolicy", + "description": "Configures traffic steering properties of internal passthrough Network Load Balancers." + }, "outlierDetection": { "$ref": "OutlierDetection", "description": "Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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." @@ -46698,12 +48417,34 @@ "type": "boolean" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-24 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.", + "description": "Name of a custom utilization signal. 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" }, + "BackendServiceDynamicForwarding": { + "description": "Defines a dynamic forwarding configuration for the backend service.", + "id": "BackendServiceDynamicForwarding", + "properties": { + "ipPortSelection": { + "$ref": "BackendServiceDynamicForwardingIpPortSelection", + "description": "IP:PORT based dynamic forwarding configuration." + } + }, + "type": "object" + }, + "BackendServiceDynamicForwardingIpPortSelection": { + "description": "Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges.", + "id": "BackendServiceDynamicForwardingIpPortSelection", + "properties": { + "enabled": { + "description": "A boolean flag enabling IP:PORT based dynamic forwarding.", + "type": "boolean" + } + }, + "type": "object" + }, "BackendServiceFailoverPolicy": { "description": "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). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).", "id": "BackendServiceFailoverPolicy", @@ -47199,6 +48940,41 @@ }, "type": "object" }, + "BackendServiceNetworkPassThroughLbTrafficPolicy": { + "id": "BackendServiceNetworkPassThroughLbTrafficPolicy", + "properties": { + "zonalAffinity": { + "$ref": "BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity", + "description": "When configured, new connections are load balanced across healthy backend endpoints in the local zone." + } + }, + "type": "object" + }, + "BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity": { + "id": "BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity", + "properties": { + "spillover": { + "description": "This field indicates whether zonal affinity is enabled or not. The possible values are: - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity is disabled. The load balancer distributes new connections to all healthy backend endpoints across all zones. - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is enabled. The load balancer distributes new connections to all healthy backend endpoints in the local zone only. If there are no healthy backend endpoints in the local zone, the load balancer distributes new connections to all backend endpoints in the local zone. - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is enabled. The load balancer distributes new connections to all healthy backend endpoints in the local zone only. If there aren't enough healthy backend endpoints in the local zone, the load balancer distributes new connections to all healthy backend endpoints across all zones. ", + "enum": [ + "ZONAL_AFFINITY_DISABLED", + "ZONAL_AFFINITY_SPILL_CROSS_ZONE", + "ZONAL_AFFINITY_STAY_WITHIN_ZONE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "spilloverRatio": { + "description": "The value of the field must be in [0, 1]. When the ratio of the count of healthy backend endpoints in a zone to the count of backend endpoints in that same zone is equal to or above this threshold, the load balancer distributes new connections to all healthy endpoints in the local zone only. When the ratio of the count of healthy backend endpoints in a zone to the count of backend endpoints in that same zone is below this threshold, the load balancer distributes all new connections to all healthy endpoints across all zones.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "BackendServiceReference": { "id": "BackendServiceReference", "properties": { @@ -47880,6 +49656,13 @@ "CacheInvalidationRule": { "id": "CacheInvalidationRule", "properties": { + "cacheTags": { + "description": "[Preview] A list of cache tags used to identify cached objects. - Cache tags are specified when the response is first cached, by setting the `Cache-Tag` response header at the origin. - Multiple cache tags in the same invalidation request are treated as Boolean `OR` - for example, `tag1 OR tag2 OR tag3`. - If other fields are also specified, these are treated as Boolean `AND` with any tags. Up to 10 tags can be specified in a single invalidation request.", + "items": { + "type": "string" + }, + "type": "array" + }, "host": { "description": "If set, this invalidation rule will only apply to requests with a Host header matching host.", "type": "string" @@ -47937,6 +49720,48 @@ }, "type": "object" }, + "CalendarModeAdviceRequest": { + "description": "A request to recommend the best way to consume the specified resources in the future.", + "id": "CalendarModeAdviceRequest", + "properties": { + "futureResourcesSpecs": { + "additionalProperties": { + "$ref": "FutureResourcesSpec" + }, + "description": "Specification of resources to create in the future. The key of the map is an arbitrary string specified by the caller. Value of the map is a specification of required resources and their constraints. Currently only one value is allowed in this map.", + "type": "object" + } + }, + "type": "object" + }, + "CalendarModeAdviceResponse": { + "description": "A response containing the recommended way of creating the specified resources in the future. It contains (will contain) multiple recommendations that can be analyzed by the customer and the best one can be picked.", + "id": "CalendarModeAdviceResponse", + "properties": { + "recommendations": { + "description": "Recommendations where, how and when to create the requested resources in order to maximize their obtainability and minimize cost.", + "items": { + "$ref": "CalendarModeRecommendation" + }, + "type": "array" + } + }, + "type": "object" + }, + "CalendarModeRecommendation": { + "description": "A single recommendation to create requested resources. Contains detailed recommendations for every future resources specification specified in CalendarModeAdviceRequest.", + "id": "CalendarModeRecommendation", + "properties": { + "recommendationsPerSpec": { + "additionalProperties": { + "$ref": "FutureResourcesRecommendation" + }, + "description": "Recommendations for every future resource specification passed in CalendarModeAdviceRequest. Keys of the map correspond to keys specified in the request.", + "type": "object" + } + }, + "type": "object" + }, "CircuitBreakers": { "description": "Settings controlling the volume of requests, connections and retries to this backend service.", "id": "CircuitBreakers", @@ -47974,15 +49799,15 @@ "type": "object" }, "Commitment": { - "description": "Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.", + "description": "Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts", "id": "Commitment", "properties": { "autoRenew": { - "description": "Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.", + "description": "Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.", "type": "boolean" }, "category": { - "description": "The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.", + "description": "The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.", "enum": [ "CATEGORY_UNSPECIFIED", "LICENSE", @@ -48000,11 +49825,11 @@ "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.", + "description": "[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment'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.", + "description": "An optional description of the commitment. You can provide this property when you create the resource.", "type": "string" }, "endTimestamp": { @@ -48012,7 +49837,6 @@ "type": "string" }, "existingReservations": { - "description": "Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation ", "items": { "type": "string" }, @@ -48033,19 +49857,19 @@ "description": "The license specification required as part of a license commitment." }, "mergeSourceCommitments": { - "description": "List of source commitments to be merged into a new commitment.", + "description": "The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.", "items": { "type": "string" }, "type": "array" }, "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.", + "description": "Name of the commitment. You must specify a name when you purchase the commitment. 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" }, "plan": { - "description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", + "description": "The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", "enum": [ "INVALID", "THIRTY_SIX_MONTH", @@ -48059,11 +49883,11 @@ "type": "string" }, "region": { - "description": "[Output Only] URL of the region where this commitment may be used.", + "description": "[Output Only] URL of the region where the commitment and committed resources are located.", "type": "string" }, "reservations": { - "description": "List of create-on-create reservations for this commitment.", + "description": "The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.", "items": { "$ref": "Reservation" }, @@ -48074,7 +49898,7 @@ "description": "[Output Only] Status information for Commitment resource." }, "resources": { - "description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.", + "description": "The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.", "items": { "$ref": "ResourceCommitment" }, @@ -48085,7 +49909,7 @@ "type": "string" }, "splitSourceCommitment": { - "description": "Source commitment to be split into a new commitment.", + "description": "The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.", "type": "string" }, "startTimestamp": { @@ -48093,7 +49917,7 @@ "type": "string" }, "status": { - "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.", + "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED.", "enum": [ "ACTIVE", "CANCELLED", @@ -48115,11 +49939,12 @@ "type": "string" }, "type": { - "description": "The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.", + "description": "The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", "ACCELERATOR_OPTIMIZED_A3_MEGA", + "ACCELERATOR_OPTIMIZED_A3_ULTRA", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", @@ -48136,6 +49961,7 @@ "GRAPHICS_OPTIMIZED", "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", + "MEMORY_OPTIMIZED_M4", "MEMORY_OPTIMIZED_X4_16TB", "MEMORY_OPTIMIZED_X4_24TB", "MEMORY_OPTIMIZED_X4_32TB", @@ -48166,7 +49992,9 @@ "", "", "", - "" + "", + "", + "Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" } @@ -48505,7 +50333,7 @@ "id": "CommitmentsScopedList", "properties": { "commitments": { - "description": "[Output Only] A list of commitments contained in this scope.", + "description": "[Output Only] The list of commitments contained in this scope.", "items": { "$ref": "Commitment" }, @@ -48771,6 +50599,209 @@ }, "type": "object" }, + "CrossSiteNetwork": { + "description": "A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections.", + "id": "CrossSiteNetwork", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of the cross-site network.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#crossSiteNetwork", + "description": "[Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.", + "type": "string" + }, + "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" + }, + "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" + }, + "CrossSiteNetworkList": { + "description": "Response to the list request that contains a list of cross-site networks.", + "id": "CrossSiteNetworkList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of CrossSiteNetwork resources.", + "items": { + "$ref": "CrossSiteNetwork" + }, + "type": "array" + }, + "kind": { + "default": "compute#crossSiteNetwork", + "description": "[Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks.", + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, "CustomErrorResponsePolicy": { "description": "Specifies the custom error response policy that must be applied when the backend service or backend bucket responds with an error.", "id": "CustomErrorResponsePolicy", @@ -49681,6 +51712,50 @@ }, "type": "object" }, + "DiskSettings": { + "id": "DiskSettings", + "properties": { + "accessLocation": { + "$ref": "DiskSettingsAccessLocation", + "description": "Policy of which locations are allowed to create regional snapshots." + } + }, + "type": "object" + }, + "DiskSettingsAccessLocation": { + "id": "DiskSettingsAccessLocation", + "properties": { + "locations": { + "additionalProperties": { + "$ref": "DiskSettingsAccessLocationAccessLocationPreference" + }, + "type": "object" + }, + "policy": { + "enum": [ + "ALL_REGIONS", + "POLICY_UNSPECIFIED", + "SPECIFIC_REGIONS" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "DiskSettingsAccessLocationAccessLocationPreference": { + "id": "DiskSettingsAccessLocationAccessLocationPreference", + "properties": { + "region": { + "type": "string" + } + }, + "type": "object" + }, "DiskType": { "description": "Represents a Disk Type resource. Google Compute Engine has two Disk Type resources: * [Regional](/compute/docs/reference/rest/beta/regionDiskTypes) * [Zonal](/compute/docs/reference/rest/beta/diskTypes) You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks.", "id": "DiskType", @@ -52005,6 +54080,37 @@ }, "type": "object" }, + "FlexibleTimeRange": { + "description": "A flexible specification of a time range that has 3 points of flexibility: (1) a flexible start time, (2) a flexible end time, (3) a flexible duration. It is possible to specify a contradictory time range that cannot be matched by any Interval. This causes a validation error.", + "id": "FlexibleTimeRange", + "properties": { + "endTimeNotEarlierThan": { + "format": "google-datetime", + "type": "string" + }, + "endTimeNotLaterThan": { + "format": "google-datetime", + "type": "string" + }, + "maxDuration": { + "format": "google-duration", + "type": "string" + }, + "minDuration": { + "format": "google-duration", + "type": "string" + }, + "startTimeNotEarlierThan": { + "format": "google-datetime", + "type": "string" + }, + "startTimeNotLaterThan": { + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "ForwardingRule": { "description": "Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/globalForwardingRules) * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.", "id": "ForwardingRule", @@ -52753,6 +54859,10 @@ "FutureReservation": { "id": "FutureReservation", "properties": { + "aggregateReservation": { + "$ref": "AllocationAggregateReservation", + "description": "Aggregate reservation details for the future reservation." + }, "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" @@ -52829,6 +54939,20 @@ ], "type": "string" }, + "reservationMode": { + "description": "The reservation mode which determines reservation-termination behavior and expected pricing.", + "enum": [ + "CALENDAR", + "DEFAULT", + "RESERVATION_MODE_UNSPECIFIED" + ], + "enumDescriptions": [ + "The delivered reservations will delivered at specified start time and terminated at specified end time along with terminating the VMs running on it.", + "The delivered reservations do not terminate VMs at the end of reservations. This is default mode.", + "" + ], + "type": "string" + }, "reservationName": { "description": "Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix.", "type": "string" @@ -53610,6 +55734,250 @@ }, "type": "object" }, + "FutureResourcesRecommendation": { + "description": "Recommendation for single resources specification, to be created in the future.", + "id": "FutureResourcesRecommendation", + "properties": { + "endTime": { + "format": "google-datetime", + "type": "string" + }, + "location": { + "description": "The advised location for resource usage. When a zone, in format 'zones/'. If not set, it means that no location is recommended - see other_locations for details.", + "type": "string" + }, + "otherLocations": { + "additionalProperties": { + "$ref": "FutureResourcesRecommendationOtherLocation" + }, + "description": "List of locations in the request scope that were not recommended. Keys of the map are zones, in format 'zones/'. The values are status information indicating the recommendation status.", + "type": "object" + }, + "recommendationId": { + "description": "Unique id of the recommendation, a UUID string generated by the API.", + "type": "string" + }, + "recommendationType": { + "description": "Type of recommendation. Currently only FUTURE_RESERVATION is supported.", + "enum": [ + "FUTURE_RESERVATION", + "RECOMMENDATION_TYPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "A Future Reservation is recommended.", + "Default value, unused." + ], + "type": "string" + }, + "startTime": { + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "FutureResourcesRecommendationOtherLocation": { + "description": "Information about recommendation status for locations that were allowed but not used by the response.", + "id": "FutureResourcesRecommendationOtherLocation", + "properties": { + "details": { + "description": "Details (human readable) describing the situation. For example, if status is CONDITION_NOT_MET, then details contain information about the parameters of the time window that did not meet the required conditions.", + "type": "string" + }, + "status": { + "description": "Status of recommendation in this location.", + "enum": [ + "CONDITIONS_NOT_MET", + "NOT_SUPPORTED", + "NO_CAPACITY", + "OTHER_LOCATION_STATUS_UNDEFINED", + "RECOMMENDED" + ], + "enumDescriptions": [ + "The requested resources are offered in this location but the requested time window is does not meet the required conditions.", + "The requested resources are not offered in this location. Retrying the request will not change this status.", + "The requested resources are offered in this location and the requested time window is accepted but there is no capacity within the requested time window.", + "Default value, unused.", + "The requested resources are offered in this location and it is possible to request them. However, another location was better and was recommended." + ], + "type": "string" + } + }, + "type": "object" + }, + "FutureResourcesSpec": { + "description": "Specification of resources to be created at some time in the future within an optionally specified set of locations, and within the specified time range.", + "id": "FutureResourcesSpec", + "properties": { + "deploymentType": { + "description": "Indicates if the reservation allocation strategy is static (DENSE) or dynamic (STANDARD). Defaults to DENSE.", + "enum": [ + "DENSE", + "DEPLOYMENT_TYPE_UNSPECIFIED", + "FLEXIBLE" + ], + "enumDescriptions": [ + "The reserved capacity is made up of densely deployed reservation blocks.", + "", + "The reserved capacity is made up of highly flexible, logical reservation blocks." + ], + "type": "string" + }, + "locationPolicy": { + "$ref": "FutureResourcesSpecLocationPolicy", + "description": "Optional location policy allowing to exclude some zone(s) in which the resources must not be created." + }, + "targetResources": { + "$ref": "FutureResourcesSpecTargetResources", + "description": "Specification of the reserved resources." + }, + "timeRangeSpec": { + "$ref": "FlexibleTimeRange", + "description": "Specification of a time range in which the resources may be created. The time range specifies start of resource use and planned end of resource use." + } + }, + "type": "object" + }, + "FutureResourcesSpecAggregateResources": { + "id": "FutureResourcesSpecAggregateResources", + "properties": { + "acceleratorCount": { + "description": "Size of the request, in accelerator (chip) count.", + "format": "int64", + "type": "string" + }, + "vmFamily": { + "description": "The VM family that all instances scheduled against this reservation must belong to. Use for TPU reservations.", + "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_LITE_POD_SLICE_CT6E", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "workloadType": { + "description": "Workload type. Use for TPU reservations.", + "enum": [ + "BATCH", + "SERVING", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Reserved resources will be optimized for BATCH workloads, such as ML training.", + "Reserved resources will be optimized for SERVING workloads, such as ML inference.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "FutureResourcesSpecLocalSsdPartition": { + "id": "FutureResourcesSpecLocalSsdPartition", + "properties": { + "diskInterface": { + "description": "Disk interface. Defaults to SCSI.", + "enum": [ + "NVME", + "SCSI" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "diskSizeGb": { + "description": "The size of the disk in GB.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "FutureResourcesSpecLocationPolicy": { + "description": "Specification of locations to create resources in.", + "id": "FutureResourcesSpecLocationPolicy", + "properties": { + "locations": { + "additionalProperties": { + "$ref": "FutureResourcesSpecLocationPolicyLocation" + }, + "description": "Preferences for specified locations. Keys of the map are locations - zones, in format of 'zones/'. Values are preferences for the zones. If a zone is not specified in this map, it is ALLOWed.", + "type": "object" + } + }, + "type": "object" + }, + "FutureResourcesSpecLocationPolicyLocation": { + "description": "Preference for a single specified location.", + "id": "FutureResourcesSpecLocationPolicyLocation", + "properties": { + "preference": { + "description": "Preference for this location.", + "enum": [ + "ALLOW", + "DENY", + "PREFERENCE_UNSPECIFIED" + ], + "enumDescriptions": [ + "Location is allowed for use.", + "Location is prohibited.", + "Default value, unused." + ], + "type": "string" + } + }, + "type": "object" + }, + "FutureResourcesSpecSpecificSKUResources": { + "id": "FutureResourcesSpecSpecificSKUResources", + "properties": { + "instanceCount": { + "description": "Size of the request, in instance count.", + "format": "int64", + "type": "string" + }, + "localSsdPartitions": { + "description": "Local SSD partitions. You do not have to include SSD partitions that are built in the machine type.", + "items": { + "$ref": "FutureResourcesSpecLocalSsdPartition" + }, + "type": "array" + }, + "machineType": { + "description": "The machine type to use for instances that will use the reservation. This field only accepts machine type names. e.g. n2-standard-4 and does not accept machine type full or partial url. e.g. projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4. Use for GPU reservations.", + "type": "string" + } + }, + "type": "object" + }, + "FutureResourcesSpecTargetResources": { + "description": "Specification of reserved resources.", + "id": "FutureResourcesSpecTargetResources", + "properties": { + "aggregateResources": { + "$ref": "FutureResourcesSpecAggregateResources" + }, + "specificSkuResources": { + "$ref": "FutureResourcesSpecSpecificSKUResources" + } + }, + "type": "object" + }, "GRPCHealthCheck": { "id": "GRPCHealthCheck", "properties": { @@ -57760,6 +60128,20 @@ "" ], "type": "string" + }, + "onFailedHealthCheck": { + "description": "The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see About repairing VMs in a MIG. ", + "enum": [ + "DEFAULT_ACTION", + "DO_NOTHING", + "REPAIR" + ], + "enumDescriptions": [ + "(Default) MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field.", + "MIG doesn't repair an unhealthy VM.", + "MIG automatically repairs an unhealthy VM by recreating it." + ], + "type": "string" } }, "type": "object" @@ -60797,6 +63179,56 @@ }, "type": "object" }, + "InstancesReportHostAsFaultyRequest": { + "id": "InstancesReportHostAsFaultyRequest", + "properties": { + "disruptionSchedule": { + "description": "The disruption schedule for the VM. Default to IMMEDIATE.", + "enum": [ + "DISRUPTION_SCHEDULE_UNSPECIFIED", + "FUTURE", + "IMMEDIATE" + ], + "enumDescriptions": [ + "Not used. Required as per aip/126.", + "Delay disruption for caller control. Will be default soon.", + "Default value. Disrupt the VM immediately." + ], + "type": "string" + }, + "faultReasons": { + "items": { + "$ref": "InstancesReportHostAsFaultyRequestFaultReason" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstancesReportHostAsFaultyRequestFaultReason": { + "id": "InstancesReportHostAsFaultyRequestFaultReason", + "properties": { + "behavior": { + "enum": [ + "BEHAVIOR_UNSPECIFIED", + "PERFORMANCE", + "SILENT_DATA_CORRUPTION", + "UNRECOVERABLE_GPU_ERROR" + ], + "enumDescriptions": [ + "Public reportable behaviors", + "", + "", + "" + ], + "type": "string" + }, + "description": { + "type": "string" + } + }, + "type": "object" + }, "InstancesResumeRequest": { "id": "InstancesResumeRequest", "properties": { @@ -61680,9 +64112,11 @@ "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { "enum": [ + "IF_CROSS_SITE_NETWORK", "IF_MACSEC" ], "enumDescriptions": [ + "Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -61833,9 +64267,11 @@ "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", "items": { "enum": [ + "IF_CROSS_SITE_NETWORK", "IF_MACSEC" ], "enumDescriptions": [ + "Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -61866,6 +64302,13 @@ "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." ], "type": "string" + }, + "wireGroups": { + "description": "[Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -63124,9 +65567,11 @@ "description": "[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - IF_MACSEC ", "items": { "enum": [ + "IF_CROSS_SITE_NETWORK", "IF_MACSEC" ], "enumDescriptions": [ + "Cross-Site Networking", "Media Access Control security (MACsec)" ], "type": "string" @@ -63184,6 +65629,13 @@ "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, + "crossSiteInterconnectInfos": { + "description": "[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed.", + "items": { + "$ref": "InterconnectLocationCrossSiteInterconnectInfo" + }, + "type": "array" + }, "description": { "description": "[Output Only] An optional description of the resource.", "type": "string" @@ -63244,6 +65696,17 @@ }, "type": "object" }, + "InterconnectLocationCrossSiteInterconnectInfo": { + "description": "Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location.", + "id": "InterconnectLocationCrossSiteInterconnectInfo", + "properties": { + "city": { + "description": "The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations.", + "type": "string" + } + }, + "type": "object" + }, "InterconnectLocationList": { "description": "Response to the list request, and contains a list of interconnect locations.", "id": "InterconnectLocationList", @@ -64083,16 +66546,16 @@ "id": "LicenseResourceCommitment", "properties": { "amount": { - "description": "The number of licenses purchased.", + "description": "The number of licenses you plan to purchase.", "format": "int64", "type": "string" }, "coresPerLicense": { - "description": "Specifies the core range of the instance for which this license applies.", + "description": "The number of cores per license.", "type": "string" }, "license": { - "description": "Any applicable license URI.", + "description": "The applicable license URI.", "type": "string" } }, @@ -65420,11 +67883,13 @@ "provisioningModel": { "description": "The provisioning model to be used for this instance.", "enum": [ + "FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ + "Instance is provisioned using the Flex Start provisioning model and has a limited runtime.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." @@ -68134,6 +70599,10 @@ ], "type": "string" }, + "parentNicName": { + "description": "Name of the parent network interface of a dynamic network interface.", + "type": "string" + }, "queueCount": { "description": "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", @@ -68156,6 +70625,11 @@ "subnetwork": { "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", "type": "string" + }, + "vlan": { + "description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -68446,10 +70920,6 @@ "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" - }, - "zone": { - "description": "[Output Only] Zone to which the network is restricted.", - "type": "string" } }, "type": "object" @@ -70689,6 +73159,11 @@ "format": "int32", "type": "integer" }, + "maxVms": { + "description": "[Output Only] Maximum number of VMs that can be created for this node type.", + "format": "int32", + "type": "integer" + }, "memoryMb": { "description": "[Output Only] The amount of physical memory available to the node type, defined in MB.", "format": "int32", @@ -75175,7 +77650,7 @@ "id": "RegionCommitmentsUpdateReservationsRequest", "properties": { "reservations": { - "description": "A list of two reservations to transfer GPUs and local SSD between.", + "description": "A list of two reservations to transfer GPUs and Local SSD disks between.", "items": { "$ref": "Reservation" }, @@ -76888,6 +79363,20 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "reservationMode": { + "description": "[Output only] Indicates the reservation mode of the reservation.", + "enum": [ + "CALENDAR", + "DEFAULT", + "RESERVATION_MODE_UNSPECIFIED" + ], + "enumDescriptions": [ + "The delivered reservations terminate at specified endtime along with terminating VMs running on it. The price for this reservation is different from on-demand. Currently offered for A3+ GPUs and TPUs only.", + "The delivered reservations do not terminate VMs at the end of reservations. On-demand pricing and available for all VM families. This is default mode.", + "" + ], + "type": "string" + }, "reservationSharingPolicy": { "$ref": "AllocationReservationSharingPolicy", "description": "Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services." @@ -77552,6 +80041,50 @@ }, "type": "object" }, + "ReservationsBlocksPerformMaintenanceRequest": { + "id": "ReservationsBlocksPerformMaintenanceRequest", + "properties": { + "maintenanceScope": { + "description": "Specifies if all, running or unused hosts are in scope for this request.", + "enum": [ + "ALL", + "MAINTENANCE_SCOPE_UNSPECIFIED", + "RUNNING_VMS", + "UNUSED_CAPACITY" + ], + "enumDescriptions": [ + "Trigger maintenance for all hosts belonging to this reservation irrespective of whether VMs are running on them or not.", + "Internal only", + "Trigger maintenance only on the hosts belonging to this reservation which have VMs running on them.", + "Trigger maintenance only on the hosts belonging to this reservation which do not have any VMs running on them. This is not allowed for Standard ExR" + ], + "type": "string" + } + }, + "type": "object" + }, + "ReservationsPerformMaintenanceRequest": { + "id": "ReservationsPerformMaintenanceRequest", + "properties": { + "maintenanceScope": { + "description": "Specifies if all, running or unused hosts are in scope for this request.", + "enum": [ + "ALL", + "MAINTENANCE_SCOPE_UNSPECIFIED", + "RUNNING_VMS", + "UNUSED_CAPACITY" + ], + "enumDescriptions": [ + "Trigger maintenance for all hosts belonging to this reservation irrespective of whether VMs are running on them or not.", + "Internal only", + "Trigger maintenance only on the hosts belonging to this reservation which have VMs running on them.", + "Trigger maintenance only on the hosts belonging to this reservation which do not have any VMs running on them. This is not allowed for Standard ExR" + ], + "type": "string" + } + }, + "type": "object" + }, "ReservationsResizeRequest": { "id": "ReservationsResizeRequest", "properties": { @@ -77701,20 +80234,20 @@ "type": "object" }, "ResourceCommitment": { - "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", + "description": "Commitment for a particular hardware resource (a commitment is composed of one or more of these).", "id": "ResourceCommitment", "properties": { "acceleratorType": { - "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", + "description": "Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.", "type": "string" }, "amount": { - "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", + "description": "The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. ", "format": "int64", "type": "string" }, "type": { - "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", + "description": "The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type.", "enum": [ "ACCELERATOR", "LOCAL_SSD", @@ -78176,6 +80709,10 @@ ], "type": "string" }, + "gpuTopology": { + "description": "Specifies the shape of the GPU slice, in slice based GPU families eg. A4X.", + "type": "string" + }, "maxDistance": { "description": "Specifies the number of max logical switches.", "format": "int32", @@ -78584,6 +81121,22 @@ "description": "Represents the workload policy.", "id": "ResourcePolicyWorkloadPolicy", "properties": { + "acceleratorTopology": { + "type": "string" + }, + "maxTopologyDistance": { + "enum": [ + "BLOCK", + "CLUSTER", + "SUBBLOCK" + ], + "enumDescriptions": [ + "VMs must be provisioned in the same block.", + "VMs must be provisioned in the same cluster.", + "VMs must be provisioned in the same subblock." + ], + "type": "string" + }, "type": { "enum": [ "HIGH_AVAILABILITY", @@ -79658,14 +82211,14 @@ "type": "boolean" }, "exportPolicies": { - "description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", + "description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type.", "items": { "type": "string" }, "type": "array" }, "importPolicies": { - "description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", + "description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type.", "items": { "type": "string" }, @@ -79791,7 +82344,7 @@ "id": "RouterInterface", "properties": { "ipRange": { - "description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", + "description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", "type": "string" }, "ipVersion": { @@ -81419,11 +83972,13 @@ "provisioningModel": { "description": "Specifies the provisioning model of the instance.", "enum": [ + "FLEX_START", "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ + "Instance is provisioned using the Flex Start provisioning model and has a limited runtime.", "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." @@ -84141,6 +86696,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "region": { + "description": "[Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.", + "type": "string" + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -84195,7 +86754,7 @@ "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." }, "sourceInstantSnapshotId": { - "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", + "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", "type": "string" }, "sourceSnapshotSchedulePolicy": { @@ -84258,6 +86817,171 @@ }, "type": "object" }, + "SnapshotAggregatedList": { + "id": "SnapshotAggregatedList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "SnapshotsScopedList", + "description": "[Output Only] Name of the scope containing this set of snapshots." + }, + "description": "A list of SnapshotsScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#snapshotAggregatedList", + "description": "[Output Only] Type of resource. Always compute#snapshotAggregatedList for aggregated lists of snapshots.", + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, "SnapshotList": { "description": "Contains a list of Snapshot resources.", "id": "SnapshotList", @@ -84416,6 +87140,10 @@ "SnapshotSettings": { "id": "SnapshotSettings", "properties": { + "accessLocation": { + "$ref": "SnapshotSettingsAccessLocation", + "description": "(Regional snapshots use only)Policy of which location is allowed to access snapshot." + }, "storageLocation": { "$ref": "SnapshotSettingsStorageLocationSettings", "description": "Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out." @@ -84423,6 +87151,44 @@ }, "type": "object" }, + "SnapshotSettingsAccessLocation": { + "id": "SnapshotSettingsAccessLocation", + "properties": { + "locations": { + "additionalProperties": { + "$ref": "SnapshotSettingsAccessLocationAccessLocationPreference" + }, + "description": "List of regions that can restore a regional snapshot from the current region", + "type": "object" + }, + "policy": { + "description": "Policy of which location is allowed to access snapshot.", + "enum": [ + "ALL_REGIONS", + "POLICY_UNSPECIFIED", + "SPECIFIC_REGIONS" + ], + "enumDescriptions": [ + "Any regions will be able to access the source location.", + "", + "Only allowlisted regions will be able to restore region scoped snapshots" + ], + "type": "string" + } + }, + "type": "object" + }, + "SnapshotSettingsAccessLocationAccessLocationPreference": { + "description": "A structure for specifying an allowed target region.", + "id": "SnapshotSettingsAccessLocationAccessLocationPreference", + "properties": { + "region": { + "description": "Accessible region name", + "type": "string" + } + }, + "type": "object" + }, "SnapshotSettingsStorageLocationSettings": { "id": "SnapshotSettingsStorageLocationSettings", "properties": { @@ -84463,6 +87229,143 @@ }, "type": "object" }, + "SnapshotsScopedList": { + "id": "SnapshotsScopedList", + "properties": { + "snapshots": { + "description": "[Output Only] A list of snapshots contained in this scope.", + "items": { + "$ref": "Snapshot" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning which replaces the list of snapshots 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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, "SourceDiskEncryptionKey": { "id": "SourceDiskEncryptionKey", "properties": { @@ -87552,7 +90455,7 @@ "type": "string" }, "purpose": { - "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", + "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", @@ -89276,7 +92179,7 @@ "type": "string" }, "serverTlsPolicy": { - "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.", + "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED or INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy attached to regional forwardingRules with the loadBalancingScheme set to EXTERNAL_MANAGED or INTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, INTERNAL_MANAGED, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.", "type": "string" }, "sslCertificates": { @@ -92979,7 +95882,7 @@ "type": "string" }, "purpose": { - "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", + "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", @@ -94820,6 +97723,385 @@ }, "type": "object" }, + "Wire": { + "description": "A pseudowire that connects two Interconnect connections.", + "id": "Wire", + "properties": { + "adminEnabled": { + "description": "[Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.", + "type": "boolean" + }, + "endpoints": { + "description": "Wire endpoints are specific Interconnect connections.", + "items": { + "$ref": "WireEndpoint" + }, + "type": "array" + }, + "label": { + "description": "[Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: - ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects. - CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects. ", + "type": "string" + }, + "wireProperties": { + "$ref": "WireProperties", + "description": "[Output Only] Properties of the wire." + } + }, + "type": "object" + }, + "WireEndpoint": { + "description": "Wire endpoints are specific Interconnect connections.", + "id": "WireEndpoint", + "properties": { + "interconnect": { + "type": "string" + }, + "vlanTag": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "WireGroup": { + "description": "A resource that represents a group of redundant wires.", + "id": "WireGroup", + "properties": { + "adminEnabled": { + "description": "Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of `adminEnabled` to false, a given wire is enabled. Defaults to true.", + "type": "boolean" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of the wire group.", + "type": "string" + }, + "endpoints": { + "additionalProperties": { + "$ref": "WireGroupEndpoint" + }, + "description": "A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object. ", + "type": "object" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#wireGroup", + "description": "[Output Only] Type of the resource. Always compute#wireGroups for wire groups.", + "type": "string" + }, + "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" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "type": "string" + }, + "topology": { + "$ref": "WireGroupTopology", + "description": "Topology details for the wire group configuration." + }, + "wireGroupProperties": { + "$ref": "WireGroupProperties", + "description": "Properties of the wire group." + }, + "wireProperties": { + "$ref": "WireProperties", + "description": "Properties for all wires in the wire group." + }, + "wires": { + "description": "The single/redundant wire(s) managed by the wire group.", + "items": { + "$ref": "Wire" + }, + "type": "array" + } + }, + "type": "object" + }, + "WireGroupEndpoint": { + "description": "A logical endpoint for the wire group. An endpoint represents a metro that contains redundant Interconnect connections. A wire group is created between two endpoints.", + "id": "WireGroupEndpoint", + "properties": { + "interconnects": { + "additionalProperties": { + "$ref": "WireGroupEndpointInterconnect" + }, + "description": "A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object. ", + "type": "object" + } + }, + "type": "object" + }, + "WireGroupEndpointInterconnect": { + "description": "The redundant Interconnect connections for this endpoint.", + "id": "WireGroupEndpointInterconnect", + "properties": { + "interconnect": { + "description": "An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME ", + "type": "string" + }, + "vlanTags": { + "description": "To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. ", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "WireGroupList": { + "description": "Response for the list request.", + "id": "WireGroupList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of wire group resources.", + "items": { + "$ref": "WireGroup" + }, + "type": "array" + }, + "kind": { + "default": "compute#wireGroup", + "description": "[Output Only] Type of the resource. Always compute#wireGroups for wire groups.", + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "WireGroupProperties": { + "description": "The properties of a wire group. These properties determine how a group of redundant wires are created and managed.", + "id": "WireGroupProperties", + "properties": { + "type": { + "description": "The type of the wire group, one of the following: - WIRE: a single pseudowire over two Interconnect connections with no redundancy. - REDUNDANT: two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros. - BOX_AND_CROSS: four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros. ", + "enum": [ + "BOX_AND_CROSS", + "REDUNDANT", + "WIRE" + ], + "enumDescriptions": [ + "Four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros.", + "Two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros.", + "A single pseudowire over two Interconnect connections with no redundancy." + ], + "type": "string" + } + }, + "type": "object" + }, + "WireGroupTopology": { + "description": "Topology details for the wire group.", + "id": "WireGroupTopology", + "properties": { + "endpoints": { + "description": "Topology details for all endpoints in the wire group.", + "items": { + "$ref": "WireGroupTopologyEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "WireGroupTopologyEndpoint": { + "description": "Topology details for a single wire group endpoint.", + "id": "WireGroupTopologyEndpoint", + "properties": { + "city": { + "description": "The InterconnectLocation.city (metropolitan area designator) that all interconnects are located in.", + "type": "string" + }, + "label": { + "description": "Endpoint label from the wire group.", + "type": "string" + } + }, + "type": "object" + }, + "WireProperties": { + "description": "The properties of a wire.", + "id": "WireProperties", + "properties": { + "bandwidthUnmetered": { + "description": "The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps.", + "format": "int64", + "type": "string" + }, + "faultResponse": { + "description": "Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. ", + "enum": [ + "DISABLE_PORT", + "NONE" + ], + "enumDescriptions": [ + "Set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.", + "Default." + ], + "type": "string" + } + }, + "type": "object" + }, "XpnHostList": { "id": "XpnHostList", "properties": { diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index 3ad9ae79d59..c2067b7eca8 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -10987,6 +10987,56 @@ "https://www.googleapis.com/auth/compute" ] }, + "reportHostAsFaulty": { + "description": "Mark the host as faulty and try to restart the instance on a new host.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty", + "httpMethod": "POST", + "id": "compute.instances.reportHostAsFaulty", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "parameters": { + "instance": { + "description": "Name of the instance scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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}/instances/{instance}/reportHostAsFaulty", + "request": { + "$ref": "InstancesReportHostAsFaultyRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "reset": { "description": "Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset", @@ -15829,6 +15879,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", @@ -16148,6 +16252,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", @@ -16320,6 +16465,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", @@ -16412,6 +16605,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", @@ -21152,7 +21390,7 @@ ] }, "update": { - "description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.", + "description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", "httpMethod": "PATCH", "id": "compute.regionCommitments.update", @@ -21163,7 +21401,7 @@ ], "parameters": { "commitment": { - "description": "Name of the commitment for which auto renew is being updated.", + "description": "Name of the commitment that you want to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -29757,6 +29995,58 @@ "https://www.googleapis.com/auth/compute" ] }, + "deleteRoutePolicy": { + "description": "Deletes Route Policy", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", + "httpMethod": "POST", + "id": "compute.routers.deleteRoutePolicy", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "policy": { + "description": "The Policy name for this request. Name must conform to RFC1035", + "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" + }, + "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" + }, + "router": { + "description": "Name of the Router resource where Route Policy is defined.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "get": { "description": "Returns the specified Router resource.", "flatPath": "projects/{project}/regions/{region}/routers/{router}", @@ -29923,6 +30213,53 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getRoutePolicy": { + "description": "Returns specified Route Policy", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", + "httpMethod": "GET", + "id": "compute.routers.getRoutePolicy", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "policy": { + "description": "The Policy name for this request. Name must conform to RFC1035", + "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" + }, + "router": { + "description": "Name of the Router resource to query for the route policy. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", + "response": { + "$ref": "RoutersGetRoutePolicyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "getRouterStatus": { "description": "Retrieves runtime information of the specified router.", "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", @@ -30071,6 +30408,196 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "listBgpRoutes": { + "description": "Retrieves a list of router bgp routes available to the specified project.", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes", + "httpMethod": "GET", + "id": "compute.routers.listBgpRoutes", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "addressFamily": { + "default": "UNSPECIFIED_IP_VERSION", + "description": "(Required) limit results to this address family (either IPv4 or IPv6)", + "enum": [ + "IPV4", + "IPV6", + "UNSPECIFIED_IP_VERSION" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "destinationPrefix": { + "description": "Limit results to destinations that are subnets of this CIDR range", + "location": "query", + "type": "string" + }, + "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" + }, + "peer": { + "description": "(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.", + "location": "query", + "type": "string" + }, + "policyApplied": { + "default": "true", + "description": "When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.", + "location": "query", + "type": "boolean" + }, + "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" + }, + "routeType": { + "default": "UNSPECIFIED_ROUTE_TYPE", + "description": "(Required) limit results to this type of route (either LEARNED or ADVERTISED)", + "enum": [ + "ADVERTISED", + "LEARNED", + "UNSPECIFIED_ROUTE_TYPE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "router": { + "description": "Name or id of the resource for this request. Name should conform to RFC1035.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes", + "response": { + "$ref": "RoutersListBgpRoutes" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "listRoutePolicies": { + "description": "Retrieves a list of router route policy subresources available to the specified project.", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", + "httpMethod": "GET", + "id": "compute.routers.listRoutePolicies", + "parameterOrder": [ + "project", + "region", + "router" + ], + "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" + }, + "router": { + "description": "Name or id of the resource for this request. Name should conform to RFC1035.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", + "response": { + "$ref": "RoutersListRoutePolicies" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "patch": { "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", "flatPath": "projects/{project}/regions/{region}/routers/{router}", @@ -30121,6 +30648,56 @@ "https://www.googleapis.com/auth/compute" ] }, + "patchRoutePolicy": { + "description": "Patches Route Policy", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", + "httpMethod": "POST", + "id": "compute.routers.patchRoutePolicy", + "parameterOrder": [ + "project", + "region", + "router" + ], + "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" + }, + "router": { + "description": "Name of the Router resource where Route Policy is defined.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", + "request": { + "$ref": "RoutePolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "preview": { "description": "Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.", "flatPath": "projects/{project}/regions/{region}/routers/{router}/preview", @@ -30216,6 +30793,56 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "updateRoutePolicy": { + "description": "Updates or creates new Route Policy", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", + "httpMethod": "POST", + "id": "compute.routers.updateRoutePolicy", + "parameterOrder": [ + "project", + "region", + "router" + ], + "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" + }, + "router": { + "description": "Name of the Router resource where Route Policy is defined.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", + "request": { + "$ref": "RoutePolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -38015,7 +38642,7 @@ } } }, - "revision": "20250107", + "revision": "20250302", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -39338,14 +39965,18 @@ "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_LITE_POD_SLICE_CT6E", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", - "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P" ], "enumDescriptions": [ "", "", "", "", + "", + "", "" ], "type": "string" @@ -39392,6 +40023,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", @@ -39410,6 +40061,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" @@ -40596,11 +41255,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." ], @@ -40611,6 +41272,13 @@ "format": "float", "type": "number" }, + "customMetrics": { + "description": "List of custom metrics that are used for CUSTOM_METRICS BalancingMode.", + "items": { + "$ref": "BackendCustomMetric" + }, + "type": "array" + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -41046,6 +41714,26 @@ }, "type": "object" }, + "BackendCustomMetric": { + "description": "Custom Metrics are used for CUSTOM_METRICS balancing_mode.", + "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 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/v1/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services.", "id": "BackendService", @@ -41096,6 +41784,13 @@ "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, + "customMetrics": { + "description": "List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy.", + "items": { + "$ref": "BackendServiceCustomMetric" + }, + "type": "array" + }, "customRequestHeaders": { "description": "Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).", "items": { @@ -41205,7 +41900,8 @@ "RANDOM", "RING_HASH", "ROUND_ROBIN", - "WEIGHTED_MAGLEV" + "WEIGHTED_MAGLEV", + "WEIGHTED_ROUND_ROBIN" ], "enumDescriptions": [ "", @@ -41215,7 +41911,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" }, @@ -41672,6 +42369,21 @@ }, "type": "object" }, + "BackendServiceCustomMetric": { + "description": "Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy.", + "id": "BackendServiceCustomMetric", + "properties": { + "dryRun": { + "description": "If true, the metric data is not used for load balancing.", + "type": "boolean" + }, + "name": { + "description": "Name of a custom utilization signal. 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" + }, "BackendServiceFailoverPolicy": { "description": "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). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).", "id": "BackendServiceFailoverPolicy", @@ -42111,7 +42823,8 @@ "RANDOM", "RING_HASH", "ROUND_ROBIN", - "WEIGHTED_MAGLEV" + "WEIGHTED_MAGLEV", + "WEIGHTED_ROUND_ROBIN" ], "enumDescriptions": [ "", @@ -42121,7 +42834,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" } @@ -42564,6 +43278,91 @@ }, "type": "object" }, + "BgpRoute": { + "id": "BgpRoute", + "properties": { + "asPaths": { + "description": "[Output only] AS-PATH for the route", + "items": { + "$ref": "BgpRouteAsPath" + }, + "type": "array" + }, + "communities": { + "description": "[Output only] BGP communities in human-readable A:B format.", + "items": { + "type": "string" + }, + "type": "array" + }, + "destination": { + "$ref": "BgpRouteNetworkLayerReachabilityInformation", + "description": "[Output only] Destination IP range for the route, in human-readable CIDR format" + }, + "med": { + "description": "[Output only] BGP multi-exit discriminator", + "format": "uint32", + "type": "integer" + }, + "origin": { + "description": "[Output only] BGP origin (EGP, IGP or INCOMPLETE)", + "enum": [ + "BGP_ORIGIN_EGP", + "BGP_ORIGIN_IGP", + "BGP_ORIGIN_INCOMPLETE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "BgpRouteAsPath": { + "id": "BgpRouteAsPath", + "properties": { + "asns": { + "description": "[Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "type": { + "description": "[Output only] Type of AS-PATH segment (SEQUENCE or SET)", + "enum": [ + "AS_PATH_TYPE_SEQUENCE", + "AS_PATH_TYPE_SET" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "BgpRouteNetworkLayerReachabilityInformation": { + "description": "Network Layer Reachability Information (NLRI) for a route.", + "id": "BgpRouteNetworkLayerReachabilityInformation", + "properties": { + "pathId": { + "description": "If the BGP session supports multiple paths (RFC 7911), the path identifier for this route.", + "format": "uint32", + "type": "integer" + }, + "prefix": { + "description": "Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16.", + "type": "string" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -42787,15 +43586,15 @@ "type": "object" }, "Commitment": { - "description": "Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.", + "description": "Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts", "id": "Commitment", "properties": { "autoRenew": { - "description": "Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.", + "description": "Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.", "type": "boolean" }, "category": { - "description": "The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.", + "description": "The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.", "enum": [ "CATEGORY_UNSPECIFIED", "LICENSE", @@ -42813,11 +43612,11 @@ "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.", + "description": "[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment'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.", + "description": "An optional description of the commitment. You can provide this property when you create the resource.", "type": "string" }, "endTimestamp": { @@ -42825,7 +43624,6 @@ "type": "string" }, "existingReservations": { - "description": "Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation ", "items": { "type": "string" }, @@ -42846,19 +43644,19 @@ "description": "The license specification required as part of a license commitment." }, "mergeSourceCommitments": { - "description": "List of source commitments to be merged into a new commitment.", + "description": "The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.", "items": { "type": "string" }, "type": "array" }, "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.", + "description": "Name of the commitment. You must specify a name when you purchase the commitment. 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" }, "plan": { - "description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", + "description": "The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", "enum": [ "INVALID", "THIRTY_SIX_MONTH", @@ -42872,11 +43670,11 @@ "type": "string" }, "region": { - "description": "[Output Only] URL of the region where this commitment may be used.", + "description": "[Output Only] URL of the region where the commitment and committed resources are located.", "type": "string" }, "reservations": { - "description": "List of create-on-create reservations for this commitment.", + "description": "The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.", "items": { "$ref": "Reservation" }, @@ -42887,7 +43685,7 @@ "description": "[Output Only] Status information for Commitment resource." }, "resources": { - "description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.", + "description": "The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.", "items": { "$ref": "ResourceCommitment" }, @@ -42898,7 +43696,7 @@ "type": "string" }, "splitSourceCommitment": { - "description": "Source commitment to be split into a new commitment.", + "description": "The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.", "type": "string" }, "startTimestamp": { @@ -42906,7 +43704,7 @@ "type": "string" }, "status": { - "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.", + "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED.", "enum": [ "ACTIVE", "CANCELLED", @@ -42928,11 +43726,12 @@ "type": "string" }, "type": { - "description": "The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.", + "description": "The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", "ACCELERATOR_OPTIMIZED_A3_MEGA", + "ACCELERATOR_OPTIMIZED_A3_ULTRA", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", @@ -42949,6 +43748,7 @@ "GRAPHICS_OPTIMIZED", "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", + "MEMORY_OPTIMIZED_M4", "MEMORY_OPTIMIZED_X4_16TB", "MEMORY_OPTIMIZED_X4_24TB", "MEMORY_OPTIMIZED_X4_32TB", @@ -42979,7 +43779,9 @@ "", "", "", - "" + "", + "", + "Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" } @@ -43318,7 +44120,7 @@ "id": "CommitmentsScopedList", "properties": { "commitments": { - "description": "[Output Only] A list of commitments contained in this scope.", + "description": "[Output Only] The list of commitments contained in this scope.", "items": { "$ref": "Commitment" }, @@ -46259,6 +47061,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" @@ -51018,6 +51827,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" @@ -51909,6 +52722,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": { @@ -54242,6 +55065,13 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "packetMirroringRules": { + "description": "[Output Only] The packet mirroring rules that apply to the instance.", + "items": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" + }, "priority": { "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", "format": "int32", @@ -54294,6 +55124,56 @@ }, "type": "object" }, + "InstancesReportHostAsFaultyRequest": { + "id": "InstancesReportHostAsFaultyRequest", + "properties": { + "disruptionSchedule": { + "description": "The disruption schedule for the VM. Default to IMMEDIATE.", + "enum": [ + "DISRUPTION_SCHEDULE_UNSPECIFIED", + "FUTURE", + "IMMEDIATE" + ], + "enumDescriptions": [ + "Not used. Required as per aip/126.", + "Delay disruption for caller control. Will be default soon.", + "Default value. Disrupt the VM immediately." + ], + "type": "string" + }, + "faultReasons": { + "items": { + "$ref": "InstancesReportHostAsFaultyRequestFaultReason" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstancesReportHostAsFaultyRequestFaultReason": { + "id": "InstancesReportHostAsFaultyRequestFaultReason", + "properties": { + "behavior": { + "enum": [ + "BEHAVIOR_UNSPECIFIED", + "PERFORMANCE", + "SILENT_DATA_CORRUPTION", + "UNRECOVERABLE_GPU_ERROR" + ], + "enumDescriptions": [ + "Public reportable behaviors", + "", + "", + "" + ], + "type": "string" + }, + "description": { + "type": "string" + } + }, + "type": "object" + }, "InstancesScopedList": { "id": "InstancesScopedList", "properties": { @@ -57480,16 +58360,16 @@ "id": "LicenseResourceCommitment", "properties": { "amount": { - "description": "The number of licenses purchased.", + "description": "The number of licenses you plan to purchase.", "format": "int64", "type": "string" }, "coresPerLicense": { - "description": "Specifies the core range of the instance for which this license applies.", + "description": "The number of cores per license.", "type": "string" }, "license": { - "description": "Any applicable license URI.", + "description": "The applicable license URI.", "type": "string" } }, @@ -61517,10 +62397,6 @@ "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" - }, - "zone": { - "description": "[Output Only] Zone to which the network is restricted.", - "type": "string" } }, "type": "object" @@ -62136,6 +63012,13 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "packetMirroringRules": { + "description": "[Output Only] The packet mirroring rules that apply to the network.", + "items": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" + }, "priority": { "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", "format": "int32", @@ -63725,6 +64608,11 @@ "format": "int32", "type": "integer" }, + "maxVms": { + "description": "[Output Only] Maximum number of VMs that can be created for this node type.", + "format": "int32", + "type": "integer" + }, "memoryMb": { "description": "[Output Only] The amount of physical memory available to the node type, defined in MB.", "format": "int32", @@ -66772,11 +67660,13 @@ "description": "The public delegated prefix mode for IPv6 only.", "enum": [ "DELEGATION", - "EXTERNAL_IPV6_FORWARDING_RULE_CREATION" + "EXTERNAL_IPV6_FORWARDING_RULE_CREATION", + "EXTERNAL_IPV6_SUBNETWORK_CREATION" ], "enumDescriptions": [ "The public delegated prefix is used for further sub-delegation only. Such prefixes cannot set allocatablePrefixLength.", - "The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes." + "The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes.", + "The public delegated prefix is used for creating dual-mode subnetworks only. Such prefixes cannot set publicDelegatedSubPrefixes." ], "type": "string" }, @@ -67177,11 +68067,13 @@ "description": "The PublicDelegatedSubPrefix mode for IPv6 only.", "enum": [ "DELEGATION", - "EXTERNAL_IPV6_FORWARDING_RULE_CREATION" + "EXTERNAL_IPV6_FORWARDING_RULE_CREATION", + "EXTERNAL_IPV6_SUBNETWORK_CREATION" ], "enumDescriptions": [ "The public delegated prefix is used for further sub-delegation only. Such prefixes cannot set allocatablePrefixLength.", - "The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes." + "The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes.", + "The public delegated prefix is used for creating dual-mode subnetworks only. Such prefixes cannot set publicDelegatedSubPrefixes." ], "type": "string" }, @@ -69460,6 +70352,18 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "packetMirroringRules": { + "description": "[Output only] The packet mirroring rules that apply to the network.", + "items": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" + }, + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, "rules": { "description": "[Output only] The rules that apply to the network.", "items": { @@ -69473,9 +70377,13 @@ "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", + "SYSTEM_GLOBAL", + "SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ + "", + "", "", "", "", @@ -69600,6 +70508,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" @@ -70156,20 +71068,20 @@ "type": "object" }, "ResourceCommitment": { - "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).", + "description": "Commitment for a particular hardware resource (a commitment is composed of one or more of these).", "id": "ResourceCommitment", "properties": { "acceleratorType": { - "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.", + "description": "Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.", "type": "string" }, "amount": { - "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.", + "description": "The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. ", "format": "int64", "type": "string" }, "type": { - "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.", + "description": "The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type.", "enum": [ "ACCELERATOR", "LOCAL_SSD", @@ -71026,6 +71938,10 @@ "description": "[Output Only] The precise location of your instance within the zone's data center, including the block, sub-block, and host. The field is formatted as follows: blockId/subBlockId/hostId.", "type": "string" }, + "physicalHostTopology": { + "$ref": "ResourceStatusPhysicalHostTopology", + "description": "[Output Only] A series of fields containing the global name of the Compute Engine cluster, as well as the ID of the block, sub-block, and host on which the running instance is located." + }, "scheduling": { "$ref": "ResourceStatusScheduling" }, @@ -71035,6 +71951,29 @@ }, "type": "object" }, + "ResourceStatusPhysicalHostTopology": { + "description": "Represents the physical host topology of the host on which the VM is running.", + "id": "ResourceStatusPhysicalHostTopology", + "properties": { + "block": { + "description": "[Output Only] The ID of the block in which the running instance is located. Instances within the same block experience low network latency.", + "type": "string" + }, + "cluster": { + "description": "[Output Only] The global name of the Compute Engine cluster where the running instance is located.", + "type": "string" + }, + "host": { + "description": "[Output Only] The ID of the host on which the running instance is located. Instances on the same host experience the lowest possible network latency.", + "type": "string" + }, + "subblock": { + "description": "[Output Only] The ID of the sub-block in which the running instance is located. Instances in the same sub-block experience lower network latency than instances in the same block.", + "type": "string" + } + }, + "type": "object" + }, "ResourceStatusScheduling": { "id": "ResourceStatusScheduling", "properties": { @@ -71532,6 +72471,65 @@ }, "type": "object" }, + "RoutePolicy": { + "id": "RoutePolicy", + "properties": { + "description": { + "description": "An optional description of route policy.", + "type": "string" + }, + "fingerprint": { + "description": "A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.", + "format": "byte", + "type": "string" + }, + "name": { + "description": "Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.", + "type": "string" + }, + "terms": { + "description": "List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.", + "items": { + "$ref": "RoutePolicyPolicyTerm" + }, + "type": "array" + }, + "type": { + "enum": [ + "ROUTE_POLICY_TYPE_EXPORT", + "ROUTE_POLICY_TYPE_IMPORT" + ], + "enumDescriptions": [ + "The Route Policy is an Export Policy.", + "The Route Policy is an Import Policy." + ], + "type": "string" + } + }, + "type": "object" + }, + "RoutePolicyPolicyTerm": { + "id": "RoutePolicyPolicyTerm", + "properties": { + "actions": { + "description": "CEL expressions to evaluate to modify a route when this term matches.", + "items": { + "$ref": "Expr" + }, + "type": "array" + }, + "match": { + "$ref": "Expr", + "description": "CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes." + }, + "priority": { + "description": "The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Router": { "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.", "id": "Router", @@ -71928,14 +72926,14 @@ "type": "boolean" }, "exportPolicies": { - "description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", + "description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type.", "items": { "type": "string" }, "type": "array" }, "importPolicies": { - "description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.", + "description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type.", "items": { "type": "string" }, @@ -72061,7 +73059,7 @@ "id": "RouterInterface", "properties": { "ipRange": { - "description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", + "description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", "type": "string" }, "ipVersion": { @@ -72836,6 +73834,343 @@ }, "type": "object" }, + "RoutersGetRoutePolicyResponse": { + "id": "RoutersGetRoutePolicyResponse", + "properties": { + "resource": { + "$ref": "RoutePolicy" + } + }, + "type": "object" + }, + "RoutersListBgpRoutes": { + "id": "RoutersListBgpRoutes", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "type": "string" + }, + "kind": { + "default": "compute#routersListBgpRoutes", + "description": "[Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes.", + "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" + }, + "result": { + "description": "[Output Only] A list of bgp routes.", + "items": { + "$ref": "BgpRoute" + }, + "type": "array" + }, + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "RoutersListRoutePolicies": { + "id": "RoutersListRoutePolicies", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "type": "string" + }, + "kind": { + "default": "compute#routersListRoutePolicies", + "description": "[Output Only] Type of resource. Always compute#routersListRoutePolicies for lists of route policies.", + "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" + }, + "result": { + "description": "[Output Only] A list of route policies.", + "items": { + "$ref": "RoutePolicy" + }, + "type": "array" + }, + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, "RoutersPreviewResponse": { "id": "RoutersPreviewResponse", "properties": { @@ -73235,6 +74570,11 @@ "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", + "type": "integer" + }, "instanceTerminationAction": { "description": "Specifies the termination action for the instance.", "enum": [ @@ -73295,10 +74635,12 @@ "provisioningModel": { "description": "Specifies the provisioning model of the instance.", "enum": [ + "RESERVATION_BOUND", "SPOT", "STANDARD" ], "enumDescriptions": [ + "Bound to the lifecycle of the reservation in which it is provisioned.", "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." ], @@ -73961,9 +75303,11 @@ "ddosProtection": { "enum": [ "ADVANCED", + "ADVANCED_PREVIEW", "STANDARD" ], "enumDescriptions": [ + "", "", "" ], @@ -75715,7 +77059,7 @@ "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot." }, "sourceInstantSnapshotId": { - "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", + "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", "type": "string" }, "sourceSnapshotSchedulePolicy": { @@ -78965,6 +80309,10 @@ "description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.", "type": "string" }, + "ipCollection": { + "description": "Reference to the source of IP, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack subnetwork with external access using BYOIP: - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/sub-pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/ sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name ", + "type": "string" + }, "ipv6AccessType": { "description": "The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.", "enum": [ @@ -78981,6 +80329,18 @@ "description": "[Output Only] This field is for internal use.", "type": "string" }, + "ipv6GceEndpoint": { + "description": "[Output Only] Possible endpoints of this subnetwork. It can be one of the following: - VM_ONLY: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb. - VM_AND_FR: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly. ", + "enum": [ + "VM_AND_FR", + "VM_ONLY" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "kind": { "default": "compute#subnetwork", "description": "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.", @@ -79018,7 +80378,7 @@ "type": "string" }, "purpose": { - "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", + "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", @@ -80589,7 +81949,7 @@ "type": "string" }, "serverTlsPolicy": { - "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.", + "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED or INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy attached to regional forwardingRules with the loadBalancingScheme set to EXTERNAL_MANAGED or INTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, INTERNAL_MANAGED, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.", "type": "string" }, "sslCertificates": { @@ -84292,7 +85652,7 @@ "type": "string" }, "purpose": { - "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", + "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "enum": [ "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index f60a560cdb6..2abb66b9dfa 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -177,11 +177,14 @@ export namespace compute_alpha { regionAutoscalers: Resource$Regionautoscalers; regionBackendServices: Resource$Regionbackendservices; regionCommitments: Resource$Regioncommitments; + regionCompositeHealthChecks: Resource$Regioncompositehealthchecks; regionDisks: Resource$Regiondisks; regionDiskSettings: Resource$Regiondisksettings; regionDiskTypes: Resource$Regiondisktypes; + regionHealthAggregationPolicies: Resource$Regionhealthaggregationpolicies; regionHealthChecks: Resource$Regionhealthchecks; regionHealthCheckServices: Resource$Regionhealthcheckservices; + regionHealthSources: Resource$Regionhealthsources; regionInstanceGroupManagerResizeRequests: Resource$Regioninstancegroupmanagerresizerequests; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; @@ -189,6 +192,7 @@ export namespace compute_alpha { regionInstanceTemplates: Resource$Regioninstancetemplates; regionInstantSnapshotGroups: Resource$Regioninstantsnapshotgroups; regionInstantSnapshots: Resource$Regioninstantsnapshots; + regionMultiMigMembers: Resource$Regionmultimigmembers; regionMultiMigs: Resource$Regionmultimigs; regionNetworkEndpointGroups: Resource$Regionnetworkendpointgroups; regionNetworkFirewallPolicies: Resource$Regionnetworkfirewallpolicies; @@ -330,13 +334,18 @@ export namespace compute_alpha { this.context ); this.regionCommitments = new Resource$Regioncommitments(this.context); + this.regionCompositeHealthChecks = + new Resource$Regioncompositehealthchecks(this.context); this.regionDisks = new Resource$Regiondisks(this.context); this.regionDiskSettings = new Resource$Regiondisksettings(this.context); this.regionDiskTypes = new Resource$Regiondisktypes(this.context); + this.regionHealthAggregationPolicies = + new Resource$Regionhealthaggregationpolicies(this.context); this.regionHealthChecks = new Resource$Regionhealthchecks(this.context); this.regionHealthCheckServices = new Resource$Regionhealthcheckservices( this.context ); + this.regionHealthSources = new Resource$Regionhealthsources(this.context); this.regionInstanceGroupManagerResizeRequests = new Resource$Regioninstancegroupmanagerresizerequests(this.context); this.regionInstanceGroupManagers = @@ -353,6 +362,9 @@ export namespace compute_alpha { this.regionInstantSnapshots = new Resource$Regioninstantsnapshots( this.context ); + this.regionMultiMigMembers = new Resource$Regionmultimigmembers( + this.context + ); this.regionMultiMigs = new Resource$Regionmultimigs(this.context); this.regionNetworkEndpointGroups = new Resource$Regionnetworkendpointgroups(this.context); @@ -875,6 +887,10 @@ export namespace compute_alpha { * [Output Only] Contains output only fields. */ export interface Schema$AllocationResourceStatus { + /** + * Properties of this aggregatereservation. + */ + aggregateAllocation?: Schema$AllocationResourceStatusAggregateAllocation; /** * The number of reservation blocks associated with this reservation. */ @@ -888,6 +904,15 @@ export namespace compute_alpha { */ specificSkuAllocation?: Schema$AllocationResourceStatusSpecificSKUAllocation; } + /** + * Contains Properties set for the aggregate reservation. + */ + export interface Schema$AllocationResourceStatusAggregateAllocation { + /** + * Per service utilization breakdown. The Key is the Google Cloud managed service name. + */ + utilizations?: {[key: string]: string} | null; + } /** * Contains Properties set for the reservation. */ @@ -1833,7 +1858,7 @@ export namespace compute_alpha { */ maxUtilization?: number | null; /** - * Name of a custom utilization signal. The name must be 1-24 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 of a custom utilization signal. 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; } @@ -1887,6 +1912,10 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + */ + dynamicForwarding?: Schema$BackendServiceDynamicForwarding; /** * [Output Only] The resource URL for the edge security policy associated with this backend service. */ @@ -2183,10 +2212,28 @@ export namespace compute_alpha { */ dryRun?: boolean | null; /** - * Name of a custom utilization signal. The name must be 1-24 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 of a custom utilization signal. 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; } + /** + * Defines a dynamic forwarding configuration for the backend service. + */ + export interface Schema$BackendServiceDynamicForwarding { + /** + * IP:PORT based dynamic forwarding configuration. + */ + ipPortSelection?: Schema$BackendServiceDynamicForwardingIpPortSelection; + } + /** + * Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. + */ + export interface Schema$BackendServiceDynamicForwardingIpPortSelection { + /** + * A boolean flag enabling IP:PORT based dynamic forwarding. + */ + enabled?: boolean | null; + } /** * 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). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). */ @@ -2778,6 +2825,19 @@ export namespace compute_alpha { */ targetVmCount?: number | null; } + export interface Schema$BulkSetLabelsRequest { + /** + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You may optionally provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. + */ + labelFingerprint?: string | null; + /** + * The labels to set for this resource. + */ + labels?: {[key: string]: string} | null; + } + export interface Schema$BulkZoneSetLabelsRequest { + requests?: Schema$BulkSetLabelsRequest[]; + } export interface Schema$BundledLocalSsds { /** * The default disk interface if the interface is not specified. @@ -2790,7 +2850,7 @@ export namespace compute_alpha { } export interface Schema$CacheInvalidationRule { /** - * Not implemented. + * [Preview] A list of cache tags used to identify cached objects. - Cache tags are specified when the response is first cached, by setting the `Cache-Tag` response header at the origin. - Multiple cache tags in the same invalidation request are treated as Boolean `OR` - for example, `tag1 OR tag2 OR tag3`. - If other fields are also specified, these are treated as Boolean `AND` with any tags. Up to 10 tags can be specified in a single invalidation request. */ cacheTags?: string[] | null; /** @@ -2938,15 +2998,15 @@ export namespace compute_alpha { subjectAltNames?: string[] | null; } /** - * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. + * Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts */ export interface Schema$Commitment { /** - * Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. + * Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. */ autoRenew?: boolean | null; /** - * The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + * The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. */ category?: string | null; /** @@ -2954,20 +3014,17 @@ export namespace compute_alpha { */ 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. + * [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment'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. + * An optional description of the commitment. You can provide this property when you create the resource. */ description?: string | null; /** * [Output Only] Commitment end time in RFC3339 text format. */ endTimestamp?: string | null; - /** - * Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation - */ existingReservations?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. @@ -2982,27 +3039,27 @@ export namespace compute_alpha { */ licenseResource?: Schema$LicenseResourceCommitment; /** - * List of source commitments to be merged into a new commitment. + * The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. */ mergeSourceCommitments?: string[] | null; /** - * 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 of the commitment. You must specify a name when you purchase the commitment. 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; /** - * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + * The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). */ plan?: string | null; /** - * [Output Only] URL of the region where this commitment may be used. + * [Output Only] URL of the region where the commitment and committed resources are located. */ region?: string | null; /** - * List of create-on-create reservations for this commitment. + * The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. */ reservations?: Schema$Reservation[]; /** - * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. + * The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. */ resources?: Schema$ResourceCommitment[]; /** @@ -3018,7 +3075,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string | null; /** - * Source commitment to be split into a new commitment. + * The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. */ splitSourceCommitment?: string | null; /** @@ -3026,7 +3083,7 @@ export namespace compute_alpha { */ startTimestamp?: string | null; /** - * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. */ status?: string | null; /** @@ -3034,7 +3091,7 @@ export namespace compute_alpha { */ statusMessage?: string | null; /** - * The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + * The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. */ type?: string | null; } @@ -3142,7 +3199,7 @@ export namespace compute_alpha { } export interface Schema$CommitmentsScopedList { /** - * [Output Only] A list of commitments contained in this scope. + * [Output Only] The list of commitments contained in this scope. */ commitments?: Schema$Commitment[]; /** @@ -3154,6 +3211,142 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Represents a composite health check. A composite health check resource specifies the health source resources and the health destination resource to which the aggregated health result from the health source resources is delivered. + */ + export interface Schema$CompositeHealthCheck { + /** + * [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; + /** + * 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 CompositeHealthCheck. An up-to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck. + */ + fingerprint?: string | null; + /** + * URL to the destination resource. Must be set. Must be a ForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment for INTERNAL_MANAGED is not supported). Can be mutated. + */ + healthDestination?: string | null; + /** + * URLs to the HealthSource resources whose results are AND'ed. I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as the CompositeHealthCheck. Can be mutated. + */ + healthSources?: string[] | null; + /** + * [Output Only] A unique identifier for this resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#compositeHealthCheck for composite health checks. + */ + kind?: string | null; + /** + * 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 composite health check resides. This field applies only to the regional resource. 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; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL with id for the resource. + */ + selfLinkWithId?: string | null; + } + /** + * Contains a list of CompositeHealthChecksScopedList. + */ + export interface Schema$CompositeHealthCheckAggregatedList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of CompositeHealthChecksScopedList resources. + */ + items?: {[key: string]: Schema$CompositeHealthChecksScopedList} | null; + /** + * 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. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$CompositeHealthCheckList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of CompositeHealthCheck resources. + */ + items?: Schema$CompositeHealthCheck[]; + /** + * [Output Only] Type of the resource. Always compute#compositeHealthCheck for composite health checks. + */ + 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$CompositeHealthChecksScopedList { + /** + * A list of CompositeHealthChecks contained in this scope. + */ + resources?: Schema$CompositeHealthCheck[]; + /** + * Informational warning which replaces the list of composite health checks when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * A set of Confidential Instance options. */ @@ -3162,11 +3355,22 @@ export namespace compute_alpha { * Defines the type of technology used by the confidential instance. */ confidentialInstanceType?: string | null; + /** + * Defines a set of Confidential Paravisor (SVSM) options. + */ + confidentialParavisorConfig?: Schema$ConfidentialParavisorConfig; /** * Defines whether the instance should have confidential compute enabled. */ enableConfidentialCompute?: boolean | null; } + /** + * A set of Confidential Paravisor (SVSM) options. + */ + export interface Schema$ConfidentialParavisorConfig { + confidentialTpmType?: string | null; + sevSnpIrqMode?: string | null; + } /** * Message containing connection draining configuration. */ @@ -3765,7 +3969,7 @@ export namespace compute_alpha { } export interface Schema$DiskPairReplicationState { /** - * [Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. + * [Output Only] The status of disk creation. - ASYNC_REPLICATION_STATE_INITIALIZING: The device is doing the initial replication after starting the replication. - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The primary disk is healthily replicating to the secondary device i.e. last_replication_time is within RPO. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: The replication is lagging above the SLO limit due to the disk's change rate being above the supported limit. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: The replication is lagging, and the RPO is not being met due to some internal issue. - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The replication is completely stuck due to some internal error. - ASYNC_REPLICATION_STATE_STOPPING: The replication is under the process of being stopped. This is a transient state. - ASYNC_REPLICATION_STATE_STOPPED: The replication between the disk-pairs have stopped. - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_CG_HIGH_CHURN: The replication is lagging above the SLO limit for the disk in the consistency group due to disk's change rate being above the supported limit. */ dataReplicationState?: string | null; replicationDiskPair?: Schema$ReplicationDiskPair; @@ -3823,6 +4027,10 @@ export namespace compute_alpha { locations?: { [key: string]: Schema$DiskSettingsAccessLocationAccessLocationPreference; } | null; + /** + * Policy of which location is allowed to access snapshot. + */ + policy?: string | null; } /** * A structure for specifying an allowed target region to create snapshot. @@ -5624,6 +5832,94 @@ export namespace compute_alpha { */ type?: string | null; } + /** + * Represents a health aggregation policy. A health aggregation policy resource defines a policy to aggregate health. For more information, see Health checks overview. + */ + export interface Schema$HealthAggregationPolicy { + /** + * [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; + /** + * 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 HealthAggregationPolicy. An up-to-date fingerprint must be provided in order to patch the HealthAggregationPolicy; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthAggregationPolicy. + */ + fingerprint?: string | null; + /** + * Can only be set if the policyType field is BACKEND_SERVICE_POLICY. Specifies the threshold (as a percentage) of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to 60. Must be in range [0, 100]. Not applicable if the policyType field is DNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and minHealthyThreshold must be satisfied in order for HEALTHY to be the aggregated result. "Endpoints" refers to network endpoints within a Network Endpoint Group or instances within an Instance Group. + */ + healthyPercentThreshold?: number | 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#healthAggregationPolicy for health aggregation policies. + */ + kind?: string | null; + /** + * Can only be set if the policyType field is BACKEND_SERVICE_POLICY. Specifies the minimum number of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to 1. Must be positive. Not applicable if the policyType field is DNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and healthyPercentThreshold must be satisfied in order for HEALTHY to be the aggregated result. "Endpoints" refers to network endpoints within a Network Endpoint Group or instances within an Instance Group. + */ + minHealthyThreshold?: number | null; + /** + * 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; + /** + * Specifies the type of the healthAggregationPolicy. The only allowed value for global resources is DNS_PUBLIC_IP_POLICY. The only allowed value for regional resources is BACKEND_SERVICE_POLICY. Must be specified when the healthAggregationPolicy is created, and cannot be mutated. + */ + policyType?: string | null; + /** + * [Output Only] URL of the region where the health aggregation policy resides. This field applies only to the regional resource. 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; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL with id for the resource. + */ + selfLinkWithId?: string | null; + } + export interface Schema$HealthAggregationPolicyList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthAggregationPolicy resources. + */ + items?: Schema$HealthAggregationPolicy[]; + /** + * [Output Only] Type of the resource. Always compute#healthAggregationPolicy for health aggregation policies. + */ + 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; + } /** * Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](/compute/docs/reference/rest/alpha/regionHealthChecks) * [Global](/compute/docs/reference/rest/alpha/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). **Load balancing** Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide. **Autohealing in MIGs** The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview. */ @@ -5941,6 +6237,146 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status. + */ + export interface Schema$HealthSource { + /** + * [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; + /** + * 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 HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource. + */ + fingerprint?: string | null; + /** + * URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated. + */ + healthAggregationPolicy?: string | null; + /** + * [Output Only] A unique identifier for this resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#healthSource for health sources. + */ + kind?: string | null; + /** + * 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 health source resides. This field applies only to the regional resource. 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; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL with id for the resource. + */ + selfLinkWithId?: string | null; + /** + * URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated. + */ + sources?: string[] | null; + /** + * Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated. + */ + sourceType?: string | null; + } + /** + * Contains a list of HealthSourcesScopedList. + */ + export interface Schema$HealthSourceAggregatedList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthSourcesScopedList resources. + */ + items?: {[key: string]: Schema$HealthSourcesScopedList} | null; + /** + * 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. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$HealthSourceList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthSource resources. + */ + items?: Schema$HealthSource[]; + /** + * [Output Only] Type of the resource. Always compute#healthSource for health sources. + */ + 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$HealthSourcesScopedList { + /** + * A list of HealthSources contained in this scope. + */ + resources?: Schema$HealthSource[]; + /** + * Informational warning which replaces the list of health sources when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$HealthStatus { /** * Metadata defined as annotations for network endpoint. @@ -7620,7 +8056,7 @@ export namespace compute_alpha { */ metadataBasedReadinessSignal?: Schema$InstanceGroupManagerInstanceLifecyclePolicyMetadataBasedReadinessSignal; /** - * The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see about repairing VMs in a MIG. + * The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see About repairing VMs in a MIG. */ onFailedHealthCheck?: string | null; } @@ -8629,6 +9065,10 @@ export namespace compute_alpha { * The action hint to report the host as faulty. */ actionHint?: string | null; + /** + * The disruption schedule for the VM. Default to IMMEDIATE. + */ + disruptionSchedule?: string | null; faultReasons?: Schema$InstancesReportHostAsFaultyRequestFaultReason[]; } export interface Schema$InstancesReportHostAsFaultyRequestFaultReason { @@ -9699,6 +10139,140 @@ export namespace compute_alpha { */ zone?: string | null; } + export interface Schema$InterconnectAttachmentGroupsCreateMembers { + /** + * Parameters for the specific Attachments to create. + */ + attachments?: Schema$InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput[]; + /** + * How to behave when configured.availabilitySLA.effectiveSLA would not equal intent.availabilitySLA after this call. + */ + intentMismatchBehavior?: string | null; + /** + * Default parameters for the Attachments to create in this call. + */ + templateAttachment?: Schema$InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput; + } + /** + * LINT.IfChange Parameters used to create an InterconnectAttachment. This is similar to InterconnectAttachment, but the region field used here is not output only and all other output only fields are excluded. + */ + export interface Schema$InterconnectAttachmentGroupsCreateMembersInterconnectAttachmentInput { + /** + * Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. + */ + adminEnabled?: boolean | null; + /** + * Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s + */ + bandwidth?: string | null; + /** + * Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31. + */ + candidateCloudRouterIpAddress?: string | null; + /** + * Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126. + */ + candidateCloudRouterIpv6Address?: string | null; + /** + * Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment. + */ + candidateCustomerRouterIpAddress?: string | null; + /** + * Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment. + */ + candidateCustomerRouterIpv6Address?: string | null; + /** + * This field is not available. + */ + candidateIpv6Subnets?: string[] | null; + /** + * Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. + */ + candidateSubnets?: string[] | null; + /** + * This field is not available. + */ + cloudRouterIpv6InterfaceId?: string | null; + /** + * This field is not available. + */ + customerRouterIpv6InterfaceId?: string | null; + /** + * An optional description of this resource. + */ + description?: string | null; + /** + * Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. + */ + edgeAvailabilityDomain?: string | null; + /** + * Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - alpha - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. + */ + encryption?: string | null; + /** + * URL of the underlying Interconnect object that this attachment's traffic will traverse through. + */ + interconnect?: string | null; + /** + * A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool. + */ + ipsecInternalAddresses?: string[] | null; + /** + * L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance. + */ + l2Forwarding?: Schema$InterconnectAttachmentL2Forwarding; + /** + * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. + */ + mtu?: number | null; + /** + * Whether or not to permit multicast traffic for this attachment. Multicast packets will be dropped if this is not enabled. + */ + multicastEnabled?: boolean | null; + /** + * 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 for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" + */ + pairingKey?: string | null; + /** + * Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. + */ + partnerAsn?: string | null; + /** + * Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. + */ + partnerMetadata?: Schema$InterconnectAttachmentPartnerMetadata; + /** + * The region that the Attachment is in. + */ + region?: string | null; + /** + * URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. + */ + router?: string | null; + /** + * The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. + */ + stackType?: string | null; + /** + * Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. + */ + subnetLength?: number | null; + /** + * The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. + */ + type?: string | null; + /** + * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time. + */ + vlanTag8021q?: number | null; + } + export interface Schema$InterconnectAttachmentGroupsCreateMembersRequest { + request?: Schema$InterconnectAttachmentGroupsCreateMembers; + } /** * Response for the InterconnectAttachmentGroupsGetOperationalStatusResponse. */ @@ -9739,10 +10313,38 @@ export namespace compute_alpha { } | null; } export interface Schema$InterconnectAttachmentGroupsOperationalStatus { + attachmentStatuses?: Schema$InterconnectAttachmentGroupsOperationalStatusAttachmentStatus[]; + configured?: Schema$InterconnectAttachmentGroupConfigured; /** * Summarizes the status of the group. */ groupStatus?: string | null; + intent?: Schema$InterconnectAttachmentGroupIntent; + /** + * The operational state of the group, including only active Attachments. + */ + operational?: Schema$InterconnectAttachmentGroupConfigured; + } + /** + * The status of one Attachment in the group. List order is arbitrary. + */ + export interface Schema$InterconnectAttachmentGroupsOperationalStatusAttachmentStatus { + /** + * Whether this Attachment is enabled. This becomes false when the customer drains their Attachment. + */ + adminEnabled?: boolean | null; + /** + * The URL of the Attachment being described. + */ + attachment?: string | null; + /** + * Whether this Attachment is participating in the redundant configuration. This will be ACTIVE if and only if the status below is CONNECTION_UP. Any INACTIVE Attachments are excluded from the analysis that generates operational.availabilitySLA. + */ + isActive?: string | null; + /** + * Whether this Attachment is active, and if so, whether BGP is up. This is based on the statuses available in the Pantheon UI here: http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto + */ + status?: string | null; } /** * L2 Interconnect Attachment related configuration. @@ -10145,6 +10747,69 @@ export namespace compute_alpha { */ zone?: string | null; } + export interface Schema$InterconnectGroupsCreateMembers { + /** + * How to behave when configured.topologyCapability.supportedSLA would not equal intent.topologyCapability after this call. + */ + intentMismatchBehavior?: string | null; + interconnects?: Schema$InterconnectGroupsCreateMembersInterconnectInput[]; + /** + * Parameters for the Interconnects to create. + */ + templateInterconnect?: Schema$InterconnectGroupsCreateMembersInterconnectInput; + } + /** + * LINT.IfChange + */ + export interface Schema$InterconnectGroupsCreateMembersInterconnectInput { + /** + * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + */ + adminEnabled?: boolean | null; + /** + * Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. + */ + customerName?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * A zone-free location to use for all Interconnects created in this call, like "iad-1234". + */ + facility?: string | null; + /** + * Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. + */ + interconnectType?: string | null; + /** + * Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. + */ + linkType?: string | null; + /** + * 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; + /** + * Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. + */ + nocContactEmail?: string | null; + /** + * Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. + */ + remoteLocation?: string | null; + /** + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + */ + requestedFeatures?: string[] | null; + /** + * Target number of physical links in the link bundle, as requested by the customer. + */ + requestedLinkCount?: number | null; + } + export interface Schema$InterconnectGroupsCreateMembersRequest { + request?: Schema$InterconnectGroupsCreateMembers; + } /** * Response for the InterconnectGroupsGetOperationalStatusResponse. */ @@ -10293,7 +10958,7 @@ export namespace compute_alpha { */ creationTimestamp?: string | null; /** - * [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Interconnect metros. + * [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed. */ crossSiteInterconnectInfos?: Schema$InterconnectLocationCrossSiteInterconnectInfo[]; /** @@ -10346,11 +11011,11 @@ export namespace compute_alpha { supportsPzs?: boolean | null; } /** - * Information about any potential WireGroups between an Interconnect at a specific InterconnectLocation, and an Interconnect in another metro. + * Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location. */ export interface Schema$InterconnectLocationCrossSiteInterconnectInfo { /** - * Metropolitan area designator + * The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations. */ city?: string | null; /** @@ -10985,15 +11650,15 @@ export namespace compute_alpha { */ export interface Schema$LicenseResourceCommitment { /** - * The number of licenses purchased. + * The number of licenses you plan to purchase. */ amount?: string | null; /** - * Specifies the core range of the instance for which this license applies. + * The number of cores per license. */ coresPerLicense?: string | null; /** - * Any applicable license URI. + * The applicable license URI. */ license?: string | null; } @@ -11170,6 +11835,10 @@ export namespace compute_alpha { * 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; + /** + * Input only. [Input Only] Additional parameters that are passed in the request, but are not persisted in the resource. + */ + params?: Schema$MachineImageParams; /** * Output only. Reserved for future use. */ @@ -11248,6 +11917,19 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Machine Image parameters + */ + export interface Schema$MachineImageParams { + /** + * Input only. [Input Only] Specifies the list of disk device names that must be excluded from the new machine image. + */ + excludedDisks?: string[] | null; + /** + * Input only. [Input Only] Specifies the list of disk device names that must be included with the new machine image. + */ + includedDisks?: string[] | null; + } /** * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. */ @@ -11669,6 +12351,83 @@ export namespace compute_alpha { selfLinkWithId?: string | null; status?: Schema$MultiMigStatus; } + /** + * Represents a Multi-MIG member resource. + */ + export interface Schema$MultiMigMember { + /** + * [Output Only] Creation timestamp of this multi-MIG member in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. + */ + description?: string | null; + /** + * [Output only] The unique identifier for this resource type. The server generates this identifier. + */ + id?: string | null; + /** + * Type of the resource. Always compute#multiMigMember for a list of multi-MIG members. + */ + kind?: string | null; + /** + * [Output Only] The name of this multi-MIG member generated by Google Compute Engine. + */ + name?: string | null; + /** + * [Output Only] The URL of the region where the multi-MIG resides. + */ + region?: 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; + /** + * [Output Only] The status of this multi-MIG member + */ + status?: Schema$MultiMigMemberStatus; + } + export interface Schema$MultiMigMemberList { + /** + * Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of multi-MIG member resources. + */ + items?: Schema$MultiMigMember[]; + /** + * Type of the resource. Always compute#multiMigMember for a list of multi-MIG members. + */ + kind?: string | null; + /** + * 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; + /** + * Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$MultiMigMemberStatus { + /** + * [Output Only] URL of member instance group manager + */ + instanceGroupManager?: string | null; + } /** * Resource policies message for a multi-MIG. Specifies the workload policy configuration of the multi-MIG. */ @@ -12171,10 +12930,6 @@ export namespace compute_alpha { * Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. */ port?: number | null; - /** - * The name of the zone where the instance hosting the network endpoint is located (valid only for regional GCE_VM_IP_PORT NEGs). It should comply with RFC1035. The zone must belong to the region of the Network Endpoint Group. - */ - zone?: string | null; } /** * Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. @@ -12637,7 +13392,7 @@ export namespace compute_alpha { */ subnetwork?: string | null; /** - * VLAN tag of a dynamic network interface, must be in range from 2 to 4094 inclusively. + * VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively. */ vlan?: number | null; } @@ -12790,10 +13545,6 @@ export namespace compute_alpha { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string | null; - /** - * [Output Only] Zone to which the network is restricted. - */ - zone?: string | null; } export interface Schema$NetworkProfileLocation { name?: string | null; @@ -15390,7 +16141,7 @@ export namespace compute_alpha { } export interface Schema$RegionCommitmentsUpdateReservationsRequest { /** - * A list of two reservations to transfer GPUs and local SSD between. + * A list of two reservations to transfer GPUs and Local SSD disks between. */ reservations?: Schema$Reservation[]; } @@ -15978,6 +16729,10 @@ export namespace compute_alpha { * 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; + /** + * [Output only] Indicates the reservation mode of the reservation. + */ + reservationMode?: string | null; /** * Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. */ @@ -16243,19 +16998,19 @@ export namespace compute_alpha { } | null; } /** - * Commitment for a particular resource (a Commitment is composed of one or more of these). + * Commitment for a particular hardware resource (a commitment is composed of one or more of these). */ export interface Schema$ResourceCommitment { /** - * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. + * Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. */ acceleratorType?: string | null; /** - * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. + * The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. */ amount?: string | null; /** - * Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + * The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. */ type?: string | null; } @@ -16591,6 +17346,10 @@ export namespace compute_alpha { * Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. */ labels?: {[key: string]: string} | null; + /** + * Region where the snapshot is scoped to. + */ + region?: string | null; /** * Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional). */ @@ -16642,6 +17401,8 @@ export namespace compute_alpha { * Represents the workload policy. */ export interface Schema$ResourcePolicyWorkloadPolicy { + acceleratorTopology?: string | null; + maxTopologyDistance?: string | null; type?: string | null; } /** @@ -16652,6 +17413,10 @@ export namespace compute_alpha { * [Output Only] Accelerators status show results of GPU scans. These scans are specialized diagnostic tests designed to uncover latent manufacturing defects or other issues that could potentially lead to data corruption or impede the customer's ability to efficiently execute GPU workloads. */ acceleratorStatus?: Schema$ResourceStatusAcceleratorStatus[]; + /** + * [Output Only] Effective metadata is a field that consolidates project, zonal instance settings, and instance-level predefined metadata keys to provide the overridden value for those metadata keys at the instance level. + */ + effectiveInstanceMetadata?: Schema$ResourceStatusEffectiveInstanceMetadata; /** * [Output Only] Contains last termination details why the instance was terminated. */ @@ -16715,6 +17480,19 @@ export namespace compute_alpha { name?: string | null; version?: string | null; } + /** + * Effective values of predefined metadata keys for an instance. + */ + export interface Schema$ResourceStatusEffectiveInstanceMetadata { + /** + * Effective enable-oslogin value at Instance level. + */ + enableOsloginMetadataValue?: boolean | null; + /** + * Effective VM DNS setting at Instance level. + */ + vmDnsSettingMetadataValue?: string | null; + } export interface Schema$ResourceStatusLastInstanceTerminationDetails { /** * Reason for termination @@ -17193,11 +17971,11 @@ export namespace compute_alpha { */ enableIpv6?: boolean | null; /** - * List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + * List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. */ exportPolicies?: string[] | null; /** - * List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + * List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. */ importPolicies?: string[] | null; /** @@ -17287,7 +18065,7 @@ export namespace compute_alpha { } export interface Schema$RouterInterface { /** - * IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + * IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. */ ipRange?: string | null; /** @@ -17681,6 +18459,10 @@ export namespace compute_alpha { bestRoutesForRouter?: Schema$Route[]; bgpPeerStatus?: Schema$RouterStatusBgpPeerStatus[]; natStatus?: Schema$RouterStatusNatStatus[]; + /** + * URI of the ncc_gateway to which this router associated. + */ + nccGateway?: string | null; /** * URI of the network to which this router belongs. */ @@ -19442,7 +20224,7 @@ export namespace compute_alpha { */ sourceInstantSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + * [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. */ sourceInstantSnapshotId?: string | null; /** @@ -19567,6 +20349,10 @@ export namespace compute_alpha { key: string ]: Schema$SnapshotSettingsAccessLocationAccessLocationPreference; } | null; + /** + * Policy of which location is allowed to access snapshot. + */ + policy?: string | null; } /** * A structure for specifying an allowed target region. @@ -20704,7 +21490,7 @@ export namespace compute_alpha { */ privateIpv6GoogleAccess?: string | null; /** - * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. */ purpose?: string | null; /** @@ -21235,7 +22021,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string | null; /** - * Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. + * Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED or INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy attached to regional forwardingRules with the loadBalancingScheme set to EXTERNAL_MANAGED or INTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, INTERNAL_MANAGED, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. */ serverTlsPolicy?: string | null; /** @@ -22494,7 +23280,7 @@ export namespace compute_alpha { */ network?: string | null; /** - * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. */ purpose?: string | null; /** @@ -22902,6 +23688,10 @@ export namespace compute_alpha { * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. */ export interface Schema$VpnTunnel { + /** + * User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol. + */ + cipherSuite?: Schema$VpnTunnelCipherSuite; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -23033,6 +23823,10 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$VpnTunnelCipherSuite { + phase1?: Schema$VpnTunnelPhase1Algorithms; + phase2?: Schema$VpnTunnelPhase2Algorithms; + } /** * Contains a list of VpnTunnel resources. */ @@ -23066,6 +23860,17 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$VpnTunnelPhase1Algorithms { + dh?: string[] | null; + encryption?: string[] | null; + integrity?: string[] | null; + prf?: string[] | null; + } + export interface Schema$VpnTunnelPhase2Algorithms { + encryption?: string[] | null; + integrity?: string[] | null; + pfs?: string[] | null; + } export interface Schema$VpnTunnelsScopedList { /** * A list of VPN tunnels contained in this scope. @@ -23234,7 +24039,7 @@ export namespace compute_alpha { */ interconnect?: string | null; /** - * To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. - Port mode pseudowires must configure a value of `-1` for both endpoints. + * To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. */ vlanTags?: number[] | null; } @@ -23342,7 +24147,7 @@ export namespace compute_alpha { */ bandwidthMetered?: string | null; /** - * The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. Must be a multiple of 10. + * The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. */ bandwidthUnmetered?: string | null; /** @@ -29914,6 +30719,94 @@ export namespace compute_alpha { } } + /** + * Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkSetLabels( + params: Params$Resource$Disks$Bulksetlabels, + options: StreamMethodOptions + ): GaxiosPromise; + bulkSetLabels( + params?: Params$Resource$Disks$Bulksetlabels, + options?: MethodOptions + ): GaxiosPromise; + bulkSetLabels( + params: Params$Resource$Disks$Bulksetlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkSetLabels( + params: Params$Resource$Disks$Bulksetlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkSetLabels( + params: Params$Resource$Disks$Bulksetlabels, + callback: BodyResponseCallback + ): void; + bulkSetLabels(callback: BodyResponseCallback): void; + bulkSetLabels( + paramsOrCallback?: + | Params$Resource$Disks$Bulksetlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Bulksetlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Bulksetlabels; + 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}/disks/bulkSetLabels' + ).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); + } + } + /** * Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project. * @@ -31506,6 +32399,30 @@ export namespace compute_alpha { */ requestBody?: Schema$BulkInsertDiskResource; } + export interface Params$Resource$Disks$Bulksetlabels + 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 or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkZoneSetLabelsRequest; + } export interface Params$Resource$Disks$Createsnapshot extends StandardParameters { /** @@ -59867,6 +60784,95 @@ export namespace compute_alpha { this.context = context; } + /** + * Create Interconnect Attachments with redundancy by creating them in a specified interconnect attachment 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. + */ + createMembers( + params: Params$Resource$Interconnectattachmentgroups$Createmembers, + options: StreamMethodOptions + ): GaxiosPromise; + createMembers( + params?: Params$Resource$Interconnectattachmentgroups$Createmembers, + options?: MethodOptions + ): GaxiosPromise; + createMembers( + params: Params$Resource$Interconnectattachmentgroups$Createmembers, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createMembers( + params: Params$Resource$Interconnectattachmentgroups$Createmembers, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createMembers( + params: Params$Resource$Interconnectattachmentgroups$Createmembers, + callback: BodyResponseCallback + ): void; + createMembers(callback: BodyResponseCallback): void; + createMembers( + paramsOrCallback?: + | Params$Resource$Interconnectattachmentgroups$Createmembers + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectattachmentgroups$Createmembers; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Interconnectattachmentgroups$Createmembers; + 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/interconnectAttachmentGroups/{interconnectAttachmentGroup}/createMembers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'interconnectAttachmentGroup'], + pathParams: ['interconnectAttachmentGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes the specified InterconnectAttachmentGroup in the given scope * @@ -60696,6 +61702,22 @@ export namespace compute_alpha { } } + export interface Params$Resource$Interconnectattachmentgroups$Createmembers + extends StandardParameters { + /** + * Name of the group resource to create members for. + */ + interconnectAttachmentGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectAttachmentGroupsCreateMembersRequest; + } export interface Params$Resource$Interconnectattachmentgroups$Delete extends StandardParameters { /** @@ -62002,6 +63024,94 @@ export namespace compute_alpha { this.context = context; } + /** + * Create Interconnects with redundancy by creating them in a specified interconnect 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. + */ + createMembers( + params: Params$Resource$Interconnectgroups$Createmembers, + options: StreamMethodOptions + ): GaxiosPromise; + createMembers( + params?: Params$Resource$Interconnectgroups$Createmembers, + options?: MethodOptions + ): GaxiosPromise; + createMembers( + params: Params$Resource$Interconnectgroups$Createmembers, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createMembers( + params: Params$Resource$Interconnectgroups$Createmembers, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createMembers( + params: Params$Resource$Interconnectgroups$Createmembers, + callback: BodyResponseCallback + ): void; + createMembers(callback: BodyResponseCallback): void; + createMembers( + paramsOrCallback?: + | Params$Resource$Interconnectgroups$Createmembers + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnectgroups$Createmembers; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnectgroups$Createmembers; + 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/interconnectGroups/{interconnectGroup}/createMembers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'interconnectGroup'], + pathParams: ['interconnectGroup', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes the specified InterconnectGroup in the given scope * @@ -62823,6 +63933,22 @@ export namespace compute_alpha { } } + export interface Params$Resource$Interconnectgroups$Createmembers + extends StandardParameters { + /** + * Name of the group resource to create members for. + */ + interconnectGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InterconnectGroupsCreateMembersRequest; + } export interface Params$Resource$Interconnectgroups$Delete extends StandardParameters { /** @@ -77116,7 +78242,7 @@ export namespace compute_alpha { } /** - * Inserts an association for the specified security policy. + * Inserts an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -77293,7 +78419,7 @@ export namespace compute_alpha { } /** - * Copies rules to the specified security policy. + * Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -77381,7 +78507,7 @@ export namespace compute_alpha { } /** - * Deletes the specified policy. + * Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -77469,7 +78595,7 @@ export namespace compute_alpha { } /** - * List all of the ordered rules present in a single specified policy. + * List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -77557,7 +78683,7 @@ export namespace compute_alpha { } /** - * Gets an association with the specified name. + * Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -77653,7 +78779,7 @@ export namespace compute_alpha { } /** - * Gets a rule at the specified priority. + * Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -77744,7 +78870,7 @@ export namespace compute_alpha { } /** - * Creates a new policy in the specified project using the data included in the request. + * Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -77831,7 +78957,7 @@ export namespace compute_alpha { } /** - * List all the policies that have been configured for the specified project. + * List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -77921,7 +79047,7 @@ export namespace compute_alpha { } /** - * Lists associations of a specified target, i.e., organization or folder. + * Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -78117,7 +79243,7 @@ export namespace compute_alpha { } /** - * Moves the specified security policy. + * Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -78205,7 +79331,7 @@ export namespace compute_alpha { } /** - * Patches the specified policy with the data included in the request. + * Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -78293,7 +79419,7 @@ export namespace compute_alpha { } /** - * Patches a rule at the specified priority. + * Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -78381,7 +79507,7 @@ export namespace compute_alpha { } /** - * Removes an association for the specified security policy. + * Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -85744,7 +86870,7 @@ export namespace compute_alpha { } /** - * Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew. + * Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -85832,7 +86958,7 @@ export namespace compute_alpha { } /** - * Transfers GPUs or local SSDs between reservations within commitments. + * Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -86082,7 +87208,7 @@ export namespace compute_alpha { export interface Params$Resource$Regioncommitments$Update extends StandardParameters { /** - * Name of the commitment for which auto renew is being updated. + * Name of the commitment that you want to update. */ commitment?: string; /** @@ -86114,7 +87240,7 @@ export namespace compute_alpha { export interface Params$Resource$Regioncommitments$Updatereservations extends StandardParameters { /** - * Name of the commitment for which the reservation is being updated. + * Name of the commitment for which the reservations are being updated. */ commitment?: string; /** @@ -86136,152 +87262,72 @@ export namespace compute_alpha { requestBody?: Schema$RegionCommitmentsUpdateReservationsRequest; } - export class Resource$Regiondisks { + export class Resource$Regioncompositehealthchecks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project. 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. */ - addResourcePolicies( - params: Params$Resource$Regiondisks$Addresourcepolicies, + aggregatedList( + params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, options: StreamMethodOptions ): GaxiosPromise; - addResourcePolicies( - params?: Params$Resource$Regiondisks$Addresourcepolicies, + aggregatedList( + params?: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, options?: MethodOptions - ): GaxiosPromise; - addResourcePolicies( - params: Params$Resource$Regiondisks$Addresourcepolicies, + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Regiondisks$Addresourcepolicies, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addResourcePolicies( - params: Params$Resource$Regiondisks$Addresourcepolicies, - callback: BodyResponseCallback - ): void; - addResourcePolicies(callback: BodyResponseCallback): void; - addResourcePolicies( - paramsOrCallback?: - | Params$Resource$Regiondisks$Addresourcepolicies - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: + aggregatedList( + params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, + options: | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Addresourcepolicies; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Addresourcepolicies; - 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}/disks/{disk}/addResourcePolicies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Bulk create a set of disks. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - bulkInsert( - params: Params$Resource$Regiondisks$Bulkinsert, - options: StreamMethodOptions - ): GaxiosPromise; - bulkInsert( - params?: Params$Resource$Regiondisks$Bulkinsert, - options?: MethodOptions - ): GaxiosPromise; - bulkInsert( - params: Params$Resource$Regiondisks$Bulkinsert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Regiondisks$Bulkinsert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regioncompositehealthchecks$Aggregatedlist, + callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Regiondisks$Bulkinsert, - callback: BodyResponseCallback + aggregatedList( + callback: BodyResponseCallback ): void; - bulkInsert(callback: BodyResponseCallback): void; - bulkInsert( + aggregatedList( paramsOrCallback?: - | Params$Resource$Regiondisks$Bulkinsert - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Bulkinsert; + {}) as Params$Resource$Regioncompositehealthchecks$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Bulkinsert; + params = + {} as Params$Resource$Regioncompositehealthchecks$Aggregatedlist; options = {}; } @@ -86296,118 +87342,32 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/bulkInsert' + '/compute/alpha/projects/{project}/aggregated/compositeHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - - /** - * Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk 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. - */ - createSnapshot( - params: Params$Resource$Regiondisks$Createsnapshot, - options: StreamMethodOptions - ): GaxiosPromise; - createSnapshot( - params?: Params$Resource$Regiondisks$Createsnapshot, - options?: MethodOptions - ): GaxiosPromise; - createSnapshot( - params: Params$Resource$Regiondisks$Createsnapshot, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - createSnapshot( - params: Params$Resource$Regiondisks$Createsnapshot, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - createSnapshot( - params: Params$Resource$Regiondisks$Createsnapshot, - callback: BodyResponseCallback - ): void; - createSnapshot(callback: BodyResponseCallback): void; - createSnapshot( - paramsOrCallback?: - | Params$Resource$Regiondisks$Createsnapshot - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Createsnapshot; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Createsnapshot; - 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}/disks/{disk}/createSnapshot' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + return createAPIRequest( + parameters ); - } else { - return createAPIRequest(parameters); } } /** - * Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * Deletes the specified CompositeHealthCheck in the given region * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -86415,31 +87375,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Regiondisks$Delete, + params: Params$Resource$Regioncompositehealthchecks$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Regiondisks$Delete, + params?: Params$Resource$Regioncompositehealthchecks$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Regiondisks$Delete, + params: Params$Resource$Regioncompositehealthchecks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regiondisks$Delete, + params: Params$Resource$Regioncompositehealthchecks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regiondisks$Delete, + params: Params$Resource$Regioncompositehealthchecks$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Regiondisks$Delete + | Params$Resource$Regioncompositehealthchecks$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -86452,12 +87412,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Delete; + {}) as Params$Resource$Regioncompositehealthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Delete; + params = {} as Params$Resource$Regioncompositehealthchecks$Delete; options = {}; } @@ -86472,7 +87432,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -86480,8 +87440,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'compositeHealthCheck'], + pathParams: ['compositeHealthCheck', 'project', 'region'], context: this.context, }; if (callback) { @@ -86495,7 +87455,7 @@ export namespace compute_alpha { } /** - * Returns a specified regional persistent disk. + * Returns the specified CompositeHealthCheck resource in the given region. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -86503,143 +87463,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Regiondisks$Get, + params: Params$Resource$Regioncompositehealthchecks$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Regiondisks$Get, + params?: Params$Resource$Regioncompositehealthchecks$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Regiondisks$Get, + params: Params$Resource$Regioncompositehealthchecks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regiondisks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regiondisks$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Regiondisks$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$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}/disks/{disk}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the status of current async replication for a given device. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getAsyncReplicationStatus( - params: Params$Resource$Regiondisks$Getasyncreplicationstatus, - options: StreamMethodOptions - ): GaxiosPromise; - getAsyncReplicationStatus( - params?: Params$Resource$Regiondisks$Getasyncreplicationstatus, - options?: MethodOptions - ): GaxiosPromise; - getAsyncReplicationStatus( - params: Params$Resource$Regiondisks$Getasyncreplicationstatus, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAsyncReplicationStatus( - params: Params$Resource$Regiondisks$Getasyncreplicationstatus, + params: Params$Resource$Regioncompositehealthchecks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAsyncReplicationStatus( - params: Params$Resource$Regiondisks$Getasyncreplicationstatus, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getAsyncReplicationStatus( - callback: BodyResponseCallback + get( + params: Params$Resource$Regioncompositehealthchecks$Get, + callback: BodyResponseCallback ): void; - getAsyncReplicationStatus( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regiondisks$Getasyncreplicationstatus - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Getasyncreplicationstatus; + {}) as Params$Resource$Regioncompositehealthchecks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Getasyncreplicationstatus; + params = {} as Params$Resource$Regioncompositehealthchecks$Get; options = {}; } @@ -86654,7 +87525,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/getAsyncReplicationStatus' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -86662,112 +87533,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'compositeHealthCheck'], + pathParams: ['compositeHealthCheck', 'project', 'region'], 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. 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$Regiondisks$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Regiondisks$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Regiondisks$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Regiondisks$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Regiondisks$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Regiondisks$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$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}/regions/{region}/disks/{resource}/getIamPolicy' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Creates a persistent regional disk in the specified project using the data included in the request. + * Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -86775,31 +87556,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regiondisks$Insert, + params: Params$Resource$Regioncompositehealthchecks$Insert, options: StreamMethodOptions ): GaxiosPromise; insert( - params?: Params$Resource$Regiondisks$Insert, + params?: Params$Resource$Regioncompositehealthchecks$Insert, options?: MethodOptions ): GaxiosPromise; insert( - params: Params$Resource$Regiondisks$Insert, + params: Params$Resource$Regioncompositehealthchecks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regiondisks$Insert, + params: Params$Resource$Regioncompositehealthchecks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regiondisks$Insert, + params: Params$Resource$Regioncompositehealthchecks$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regiondisks$Insert + | Params$Resource$Regioncompositehealthchecks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -86812,12 +87593,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Insert; + {}) as Params$Resource$Regioncompositehealthchecks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Insert; + params = {} as Params$Resource$Regioncompositehealthchecks$Insert; options = {}; } @@ -86832,7 +87613,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -86855,7 +87636,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of persistent disks contained within the specified region. + * Lists the CompositeHealthChecks for a project in the given region. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -86863,48 +87644,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regiondisks$List, + params: Params$Resource$Regioncompositehealthchecks$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Regiondisks$List, + params?: Params$Resource$Regioncompositehealthchecks$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Regiondisks$List, + params: Params$Resource$Regioncompositehealthchecks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regiondisks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regioncompositehealthchecks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regiondisks$List, - callback: BodyResponseCallback + params: Params$Resource$Regioncompositehealthchecks$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regiondisks$List - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$List; + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioncompositehealthchecks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$List; + params = {} as Params$Resource$Regioncompositehealthchecks$List; options = {}; } @@ -86919,7 +87706,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -86932,51 +87719,49 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Removes resource policies from a regional disk. + * Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeResourcePolicies( - params: Params$Resource$Regiondisks$Removeresourcepolicies, + patch( + params: Params$Resource$Regioncompositehealthchecks$Patch, options: StreamMethodOptions ): GaxiosPromise; - removeResourcePolicies( - params?: Params$Resource$Regiondisks$Removeresourcepolicies, + patch( + params?: Params$Resource$Regioncompositehealthchecks$Patch, options?: MethodOptions ): GaxiosPromise; - removeResourcePolicies( - params: Params$Resource$Regiondisks$Removeresourcepolicies, + patch( + params: Params$Resource$Regioncompositehealthchecks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeResourcePolicies( - params: Params$Resource$Regiondisks$Removeresourcepolicies, + patch( + params: Params$Resource$Regioncompositehealthchecks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeResourcePolicies( - params: Params$Resource$Regiondisks$Removeresourcepolicies, - callback: BodyResponseCallback - ): void; - removeResourcePolicies( + patch( + params: Params$Resource$Regioncompositehealthchecks$Patch, callback: BodyResponseCallback ): void; - removeResourcePolicies( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regiondisks$Removeresourcepolicies + | Params$Resource$Regioncompositehealthchecks$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -86989,12 +87774,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Removeresourcepolicies; + {}) as Params$Resource$Regioncompositehealthchecks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Removeresourcepolicies; + params = {} as Params$Resource$Regioncompositehealthchecks$Patch; options = {}; } @@ -87009,16 +87794,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'compositeHealthCheck'], + pathParams: ['compositeHealthCheck', 'project', 'region'], context: this.context, }; if (callback) { @@ -87032,57 +87817,65 @@ export namespace compute_alpha { } /** - * Resizes the specified regional persistent disk. + * Returns permissions that a caller has on the specified 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. */ - resize( - params: Params$Resource$Regiondisks$Resize, + testIamPermissions( + params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - resize( - params?: Params$Resource$Regiondisks$Resize, + testIamPermissions( + params?: Params$Resource$Regioncompositehealthchecks$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - resize( - params: Params$Resource$Regiondisks$Resize, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regiondisks$Resize, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regiondisks$Resize, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Regioncompositehealthchecks$Testiampermissions, + callback: BodyResponseCallback ): void; - resize(callback: BodyResponseCallback): void; - resize( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Regiondisks$Resize - | BodyResponseCallback + | Params$Resource$Regioncompositehealthchecks$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Resize; + {}) as Params$Resource$Regioncompositehealthchecks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Resize; + params = + {} as Params$Resource$Regioncompositehealthchecks$Testiampermissions; options = {}; } @@ -87097,7 +87890,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/resize' + '/compute/alpha/projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -87105,72 +87898,244 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regioncompositehealthchecks$Aggregatedlist + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. + * 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; + /** + * Name of the project scoping 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$Regioncompositehealthchecks$Delete + extends StandardParameters { + /** + * Name of the CompositeHealthCheck resource to delete. + */ + compositeHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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$Regioncompositehealthchecks$Get + extends StandardParameters { + /** + * Name of the CompositeHealthCheck resource to return. + */ + compositeHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioncompositehealthchecks$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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$CompositeHealthCheck; + } + export interface Params$Resource$Regioncompositehealthchecks$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 scoping 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 interface Params$Resource$Regioncompositehealthchecks$Patch + extends StandardParameters { + /** + * Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + compositeHealthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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$CompositeHealthCheck; + } + export interface Params$Resource$Regioncompositehealthchecks$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regiondisks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot 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. */ - setIamPolicy( - params: Params$Resource$Regiondisks$Setiampolicy, + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Regiondisks$Setiampolicy, + addResourcePolicies( + params?: Params$Resource$Regiondisks$Addresourcepolicies, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Regiondisks$Setiampolicy, + ): GaxiosPromise; + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regiondisks$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Regiondisks$Setiampolicy, - callback: BodyResponseCallback + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( paramsOrCallback?: - | Params$Resource$Regiondisks$Setiampolicy - | BodyResponseCallback + | Params$Resource$Regiondisks$Addresourcepolicies + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Setiampolicy; + {}) as Params$Resource$Regiondisks$Addresourcepolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Setiampolicy; + params = {} as Params$Resource$Regiondisks$Addresourcepolicies; options = {}; } @@ -87185,7 +88150,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/setIamPolicy' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -87193,54 +88158,54 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the labels on the target regional disk. + * Bulk create a set of disks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setLabels( - params: Params$Resource$Regiondisks$Setlabels, + bulkInsert( + params: Params$Resource$Regiondisks$Bulkinsert, options: StreamMethodOptions ): GaxiosPromise; - setLabels( - params?: Params$Resource$Regiondisks$Setlabels, + bulkInsert( + params?: Params$Resource$Regiondisks$Bulkinsert, options?: MethodOptions ): GaxiosPromise; - setLabels( - params: Params$Resource$Regiondisks$Setlabels, + bulkInsert( + params: Params$Resource$Regiondisks$Bulkinsert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Regiondisks$Setlabels, + bulkInsert( + params: Params$Resource$Regiondisks$Bulkinsert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setLabels( - params: Params$Resource$Regiondisks$Setlabels, + bulkInsert( + params: Params$Resource$Regiondisks$Bulkinsert, callback: BodyResponseCallback ): void; - setLabels(callback: BodyResponseCallback): void; - setLabels( + bulkInsert(callback: BodyResponseCallback): void; + bulkInsert( paramsOrCallback?: - | Params$Resource$Regiondisks$Setlabels + | Params$Resource$Regiondisks$Bulkinsert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87253,12 +88218,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Setlabels; + {}) as Params$Resource$Regiondisks$Bulkinsert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Setlabels; + params = {} as Params$Resource$Regiondisks$Bulkinsert; options = {}; } @@ -87273,7 +88238,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/setLabels' + '/compute/alpha/projects/{project}/regions/{region}/disks/bulkInsert' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -87281,8 +88246,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -87296,41 +88261,39 @@ export namespace compute_alpha { } /** - * Starts asynchronous replication. Must be invoked on the primary disk. + * Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk 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. */ - startAsyncReplication( - params: Params$Resource$Regiondisks$Startasyncreplication, + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, options: StreamMethodOptions ): GaxiosPromise; - startAsyncReplication( - params?: Params$Resource$Regiondisks$Startasyncreplication, + createSnapshot( + params?: Params$Resource$Regiondisks$Createsnapshot, options?: MethodOptions ): GaxiosPromise; - startAsyncReplication( - params: Params$Resource$Regiondisks$Startasyncreplication, + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startAsyncReplication( - params: Params$Resource$Regiondisks$Startasyncreplication, + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startAsyncReplication( - params: Params$Resource$Regiondisks$Startasyncreplication, - callback: BodyResponseCallback - ): void; - startAsyncReplication( + createSnapshot( + params: Params$Resource$Regiondisks$Createsnapshot, callback: BodyResponseCallback ): void; - startAsyncReplication( + createSnapshot(callback: BodyResponseCallback): void; + createSnapshot( paramsOrCallback?: - | Params$Resource$Regiondisks$Startasyncreplication + | Params$Resource$Regiondisks$Createsnapshot | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87343,12 +88306,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Startasyncreplication; + {}) as Params$Resource$Regiondisks$Createsnapshot; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Startasyncreplication; + params = {} as Params$Resource$Regiondisks$Createsnapshot; options = {}; } @@ -87363,7 +88326,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/createSnapshot' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -87386,41 +88349,39 @@ export namespace compute_alpha { } /** - * Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk. + * Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stopAsyncReplication( - params: Params$Resource$Regiondisks$Stopasyncreplication, + delete( + params: Params$Resource$Regiondisks$Delete, options: StreamMethodOptions ): GaxiosPromise; - stopAsyncReplication( - params?: Params$Resource$Regiondisks$Stopasyncreplication, + delete( + params?: Params$Resource$Regiondisks$Delete, options?: MethodOptions ): GaxiosPromise; - stopAsyncReplication( - params: Params$Resource$Regiondisks$Stopasyncreplication, + delete( + params: Params$Resource$Regiondisks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopAsyncReplication( - params: Params$Resource$Regiondisks$Stopasyncreplication, + delete( + params: Params$Resource$Regiondisks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopAsyncReplication( - params: Params$Resource$Regiondisks$Stopasyncreplication, - callback: BodyResponseCallback - ): void; - stopAsyncReplication( + delete( + params: Params$Resource$Regiondisks$Delete, callback: BodyResponseCallback ): void; - stopAsyncReplication( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regiondisks$Stopasyncreplication + | Params$Resource$Regiondisks$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87433,12 +88394,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Stopasyncreplication; + {}) as Params$Resource$Regiondisks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Stopasyncreplication; + params = {} as Params$Resource$Regiondisks$Delete; options = {}; } @@ -87453,9 +88414,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options @@ -87476,59 +88437,56 @@ export namespace compute_alpha { } /** - * Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope. + * Returns a specified regional persistent disk. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stopGroupAsyncReplication( - params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + get( + params: Params$Resource$Regiondisks$Get, options: StreamMethodOptions ): GaxiosPromise; - stopGroupAsyncReplication( - params?: Params$Resource$Regiondisks$Stopgroupasyncreplication, + get( + params?: Params$Resource$Regiondisks$Get, options?: MethodOptions - ): GaxiosPromise; - stopGroupAsyncReplication( - params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + ): GaxiosPromise; + get( + params: Params$Resource$Regiondisks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stopGroupAsyncReplication( - params: Params$Resource$Regiondisks$Stopgroupasyncreplication, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - stopGroupAsyncReplication( - params: Params$Resource$Regiondisks$Stopgroupasyncreplication, - callback: BodyResponseCallback + get( + params: Params$Resource$Regiondisks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - stopGroupAsyncReplication( - callback: BodyResponseCallback + get( + params: Params$Resource$Regiondisks$Get, + callback: BodyResponseCallback ): void; - stopGroupAsyncReplication( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regiondisks$Stopgroupasyncreplication - | BodyResponseCallback + | Params$Resource$Regiondisks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Stopgroupasyncreplication; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Stopgroupasyncreplication; + params = {} as Params$Resource$Regiondisks$Get; options = {}; } @@ -87543,87 +88501,87 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/stopGroupAsyncReplication' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], 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. + * Gets the status of current async replication for a given device. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Regiondisks$Testiampermissions, + getAsyncReplicationStatus( + params: Params$Resource$Regiondisks$Getasyncreplicationstatus, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Regiondisks$Testiampermissions, + getAsyncReplicationStatus( + params?: Params$Resource$Regiondisks$Getasyncreplicationstatus, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Regiondisks$Testiampermissions, + ): GaxiosPromise; + getAsyncReplicationStatus( + params: Params$Resource$Regiondisks$Getasyncreplicationstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regiondisks$Testiampermissions, + getAsyncReplicationStatus( + params: Params$Resource$Regiondisks$Getasyncreplicationstatus, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Regiondisks$Testiampermissions, - callback: BodyResponseCallback + getAsyncReplicationStatus( + params: Params$Resource$Regiondisks$Getasyncreplicationstatus, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + getAsyncReplicationStatus( + callback: BodyResponseCallback ): void; - testIamPermissions( + getAsyncReplicationStatus( paramsOrCallback?: - | Params$Resource$Regiondisks$Testiampermissions - | BodyResponseCallback + | Params$Resource$Regiondisks$Getasyncreplicationstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Testiampermissions; + {}) as Params$Resource$Regiondisks$Getasyncreplicationstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Testiampermissions; + params = {} as Params$Resource$Regiondisks$Getasyncreplicationstatus; options = {}; } @@ -87638,9 +88596,99 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/getAsyncReplicationStatus' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + 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$Regiondisks$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Regiondisks$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regiondisks$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Regiondisks$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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}/regions/{region}/disks/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -87651,49 +88699,49 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license. + * Creates a persistent regional disk in the specified project using the data included in the 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. */ - update( - params: Params$Resource$Regiondisks$Update, + insert( + params: Params$Resource$Regiondisks$Insert, options: StreamMethodOptions ): GaxiosPromise; - update( - params?: Params$Resource$Regiondisks$Update, + insert( + params?: Params$Resource$Regiondisks$Insert, options?: MethodOptions ): GaxiosPromise; - update( - params: Params$Resource$Regiondisks$Update, + insert( + params: Params$Resource$Regiondisks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regiondisks$Update, + insert( + params: Params$Resource$Regiondisks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regiondisks$Update, + insert( + params: Params$Resource$Regiondisks$Insert, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regiondisks$Update + | Params$Resource$Regiondisks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87706,12 +88754,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Update; + {}) as Params$Resource$Regiondisks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Update; + params = {} as Params$Resource$Regiondisks$Insert; options = {}; } @@ -87726,16 +88774,16 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}' + '/compute/alpha/projects/{project}/regions/{region}/disks' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['project', 'region', 'disk'], - pathParams: ['disk', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -87749,41 +88797,128 @@ export namespace compute_alpha { } /** - * Wait for replication to catch up on the secondary disk. + * Retrieves the list of persistent disks 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. */ - waitForReplicationCatchUp( - params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + list( + params: Params$Resource$Regiondisks$List, options: StreamMethodOptions ): GaxiosPromise; - waitForReplicationCatchUp( - params?: Params$Resource$Regiondisks$Waitforreplicationcatchup, + list( + params?: Params$Resource$Regiondisks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regiondisks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiondisks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiondisks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regiondisks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regiondisks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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}/disks' + ).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); + } + } + + /** + * Removes resource policies from a regional disk. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, + options: StreamMethodOptions + ): GaxiosPromise; + removeResourcePolicies( + params?: Params$Resource$Regiondisks$Removeresourcepolicies, options?: MethodOptions ): GaxiosPromise; - waitForReplicationCatchUp( - params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - waitForReplicationCatchUp( - params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - waitForReplicationCatchUp( - params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, callback: BodyResponseCallback ): void; - waitForReplicationCatchUp( + removeResourcePolicies( callback: BodyResponseCallback ): void; - waitForReplicationCatchUp( + removeResourcePolicies( paramsOrCallback?: - | Params$Resource$Regiondisks$Waitforreplicationcatchup + | Params$Resource$Regiondisks$Removeresourcepolicies | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87796,12 +88931,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisks$Waitforreplicationcatchup; + {}) as Params$Resource$Regiondisks$Removeresourcepolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisks$Waitforreplicationcatchup; + params = {} as Params$Resource$Regiondisks$Removeresourcepolicies; options = {}; } @@ -87816,7 +88951,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/waitForReplicationCatchUp' + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -87837,92 +88972,2259 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - export interface Params$Resource$Regiondisks$Addresourcepolicies - extends StandardParameters { /** - * The disk name for this request. - */ - disk?: 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). + * Resizes the specified regional persistent disk. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - requestId?: string; + resize( + params: Params$Resource$Regiondisks$Resize, + options: StreamMethodOptions + ): GaxiosPromise; + resize( + params?: Params$Resource$Regiondisks$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Regiondisks$Resize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Regiondisks$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Regiondisks$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Regiondisks$Resize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Resize; + 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}/disks/{disk}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata - */ - requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; - } - export interface Params$Resource$Regiondisks$Bulkinsert - extends StandardParameters { - /** - * 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). + * Sets the access control policy on the specified resource. Replaces any existing 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. */ - requestId?: string; + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Regiondisks$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regiondisks$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Regiondisks$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Setiampolicy; + 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}/disks/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata + * Sets the labels on the target regional disk. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setLabels( + params: Params$Resource$Regiondisks$Setlabels, + options: StreamMethodOptions + ): GaxiosPromise; + setLabels( + params?: Params$Resource$Regiondisks$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Regiondisks$Setlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Regiondisks$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Regiondisks$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Regiondisks$Setlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Setlabels; + 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}/disks/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Starts asynchronous replication. Must be invoked on the primary disk. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + startAsyncReplication( + params: Params$Resource$Regiondisks$Startasyncreplication, + options: StreamMethodOptions + ): GaxiosPromise; + startAsyncReplication( + params?: Params$Resource$Regiondisks$Startasyncreplication, + options?: MethodOptions + ): GaxiosPromise; + startAsyncReplication( + params: Params$Resource$Regiondisks$Startasyncreplication, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startAsyncReplication( + params: Params$Resource$Regiondisks$Startasyncreplication, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startAsyncReplication( + params: Params$Resource$Regiondisks$Startasyncreplication, + callback: BodyResponseCallback + ): void; + startAsyncReplication( + callback: BodyResponseCallback + ): void; + startAsyncReplication( + paramsOrCallback?: + | Params$Resource$Regiondisks$Startasyncreplication + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Startasyncreplication; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Startasyncreplication; + 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}/disks/{disk}/startAsyncReplication' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + stopAsyncReplication( + params: Params$Resource$Regiondisks$Stopasyncreplication, + options: StreamMethodOptions + ): GaxiosPromise; + stopAsyncReplication( + params?: Params$Resource$Regiondisks$Stopasyncreplication, + options?: MethodOptions + ): GaxiosPromise; + stopAsyncReplication( + params: Params$Resource$Regiondisks$Stopasyncreplication, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopAsyncReplication( + params: Params$Resource$Regiondisks$Stopasyncreplication, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopAsyncReplication( + params: Params$Resource$Regiondisks$Stopasyncreplication, + callback: BodyResponseCallback + ): void; + stopAsyncReplication( + callback: BodyResponseCallback + ): void; + stopAsyncReplication( + paramsOrCallback?: + | Params$Resource$Regiondisks$Stopasyncreplication + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Stopasyncreplication; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Stopasyncreplication; + 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}/disks/{disk}/stopAsyncReplication' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary 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. + */ + stopGroupAsyncReplication( + params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + options: StreamMethodOptions + ): GaxiosPromise; + stopGroupAsyncReplication( + params?: Params$Resource$Regiondisks$Stopgroupasyncreplication, + options?: MethodOptions + ): GaxiosPromise; + stopGroupAsyncReplication( + params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopGroupAsyncReplication( + params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopGroupAsyncReplication( + params: Params$Resource$Regiondisks$Stopgroupasyncreplication, + callback: BodyResponseCallback + ): void; + stopGroupAsyncReplication( + callback: BodyResponseCallback + ): void; + stopGroupAsyncReplication( + paramsOrCallback?: + | Params$Resource$Regiondisks$Stopgroupasyncreplication + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Stopgroupasyncreplication; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Stopgroupasyncreplication; + 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}/disks/stopGroupAsyncReplication' + ).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); + } + } + + /** + * Returns permissions that a caller has on the specified 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$Regiondisks$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Regiondisks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regiondisks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regiondisks$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Testiampermissions; + 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}/disks/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regiondisks$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Regiondisks$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regiondisks$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regiondisks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regiondisks$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regiondisks$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$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/alpha/projects/{project}/regions/{region}/disks/{disk}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Wait for replication to catch up on the secondary disk. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + waitForReplicationCatchUp( + params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + options: StreamMethodOptions + ): GaxiosPromise; + waitForReplicationCatchUp( + params?: Params$Resource$Regiondisks$Waitforreplicationcatchup, + options?: MethodOptions + ): GaxiosPromise; + waitForReplicationCatchUp( + params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + waitForReplicationCatchUp( + params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + waitForReplicationCatchUp( + params: Params$Resource$Regiondisks$Waitforreplicationcatchup, + callback: BodyResponseCallback + ): void; + waitForReplicationCatchUp( + callback: BodyResponseCallback + ): void; + waitForReplicationCatchUp( + paramsOrCallback?: + | Params$Resource$Regiondisks$Waitforreplicationcatchup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisks$Waitforreplicationcatchup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Waitforreplicationcatchup; + 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}/disks/{disk}/waitForReplicationCatchUp' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regiondisks$Addresourcepolicies + extends StandardParameters { + /** + * The disk name for this request. + */ + disk?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; + } + export interface Params$Resource$Regiondisks$Bulkinsert + extends StandardParameters { + /** + * 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; + + /** + * Request body metadata */ requestBody?: Schema$BulkInsertDiskResource; } - export interface Params$Resource$Regiondisks$Createsnapshot + export interface Params$Resource$Regiondisks$Createsnapshot + extends StandardParameters { + /** + * Name of the regional persistent disk to snapshot. + */ + disk?: string; + /** + * [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. + */ + guestFlush?: boolean; + /** + * 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$Snapshot; + } + export interface Params$Resource$Regiondisks$Delete + extends StandardParameters { + /** + * Name of the regional persistent disk to delete. + */ + disk?: 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$Regiondisks$Get extends StandardParameters { + /** + * Name of the regional persistent disk to return. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisks$Getasyncreplicationstatus + extends StandardParameters { + /** + * Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisks$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regiondisks$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; + /** + * Source image to restore onto a disk. This field is optional. + */ + sourceImage?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Disk; + } + export interface Params$Resource$Regiondisks$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 interface Params$Resource$Regiondisks$Removeresourcepolicies + extends StandardParameters { + /** + * The disk name for this request. + */ + disk?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; + } + export interface Params$Resource$Regiondisks$Resize + extends StandardParameters { + /** + * Name of the regional persistent disk. + */ + disk?: string; + /** + * The 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$RegionDisksResizeRequest; + } + export interface Params$Resource$Regiondisks$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regiondisks$Setlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * 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; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Regiondisks$Startasyncreplication + extends StandardParameters { + /** + * The name of the persistent disk. + */ + disk?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksStartAsyncReplicationRequest; + } + export interface Params$Resource$Regiondisks$Stopasyncreplication + extends StandardParameters { + /** + * The name of the persistent disk. + */ + disk?: 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$Regiondisks$Stopgroupasyncreplication + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group. + */ + 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$DisksStopGroupAsyncReplicationResource; + } + export interface Params$Resource$Regiondisks$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regiondisks$Update + extends StandardParameters { + /** + * The disk name for this request. + */ + disk?: string; + /** + * + */ + paths?: 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; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Disk; + } + export interface Params$Resource$Regiondisks$Waitforreplicationcatchup + extends StandardParameters { + /** + * The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. + */ + disk?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionWaitForReplicationCatchUpRequest; + } + + export class Resource$Regiondisksettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get Regional Disk Settings. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regiondisksettings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regiondisksettings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiondisksettings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiondisksettings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiondisksettings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiondisksettings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisksettings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisksettings$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}/diskSettings' + ).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); + } + } + + /** + * Patch Regional Disk Settings + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regiondisksettings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Regiondisksettings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regiondisksettings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regiondisksettings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regiondisksettings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regiondisksettings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisksettings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisksettings$Patch; + 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}/diskSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + 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$Regiondisksettings$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisksettings$Patch + 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; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DiskSettings; + } + + export class Resource$Regiondisktypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the specified regional disk 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. + */ + get( + params: Params$Resource$Regiondisktypes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regiondisktypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiondisktypes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiondisktypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiondisktypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiondisktypes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisktypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisktypes$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}/diskTypes/{diskType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'diskType'], + pathParams: ['diskType', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of regional disk types available to 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$Regiondisktypes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regiondisktypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regiondisktypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiondisktypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regiondisktypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regiondisktypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisktypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisktypes$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}/diskTypes' + ).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$Regiondisktypes$Get extends StandardParameters { /** - * Name of the regional persistent disk to snapshot. + * Name of the disk type to return. */ - disk?: string; + diskType?: string; /** - * [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. + * Project ID for this request. */ - guestFlush?: boolean; + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisktypes$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. + * 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). + * 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. */ - requestId?: string; + returnPartialSuccess?: boolean; + } + + export class Resource$Regionhealthaggregationpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified HealthAggregationPolicy in the given 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. + */ + delete( + params: Params$Resource$Regionhealthaggregationpolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Regionhealthaggregationpolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionhealthaggregationpolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionhealthaggregationpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionhealthaggregationpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionhealthaggregationpolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthaggregationpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthaggregationpolicies$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}/healthAggregationPolicies/{healthAggregationPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthAggregationPolicy'], + pathParams: ['healthAggregationPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified HealthAggregationPolicy resource in the given 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$Regionhealthaggregationpolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regionhealthaggregationpolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionhealthaggregationpolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthaggregationpolicies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthaggregationpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionhealthaggregationpolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthaggregationpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthaggregationpolicies$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}/healthAggregationPolicies/{healthAggregationPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthAggregationPolicy'], + pathParams: ['healthAggregationPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Create a HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the 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. + */ + insert( + params: Params$Resource$Regionhealthaggregationpolicies$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regionhealthaggregationpolicies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionhealthaggregationpolicies$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthaggregationpolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthaggregationpolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionhealthaggregationpolicies$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthaggregationpolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthaggregationpolicies$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}/healthAggregationPolicies' + ).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); + } + } + + /** + * Lists the HealthAggregationPolicies for a project in the given 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$Regionhealthaggregationpolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regionhealthaggregationpolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionhealthaggregationpolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionhealthaggregationpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionhealthaggregationpolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Regionhealthaggregationpolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthaggregationpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthaggregationpolicies$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}/healthAggregationPolicies' + ).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); + } + } + + /** + * Updates the specified regional HealthAggregationPolicy resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionhealthaggregationpolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Regionhealthaggregationpolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionhealthaggregationpolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionhealthaggregationpolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionhealthaggregationpolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionhealthaggregationpolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthaggregationpolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthaggregationpolicies$Patch; + 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}/healthAggregationPolicies/{healthAggregationPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthAggregationPolicy'], + pathParams: ['healthAggregationPolicy', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata + * Returns permissions that a caller has on the specified 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. */ - requestBody?: Schema$Snapshot; + testIamPermissions( + params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionhealthaggregationpolicies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionhealthaggregationpolicies$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthaggregationpolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionhealthaggregationpolicies$Testiampermissions; + 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}/healthAggregationPolicies/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Regiondisks$Delete + + export interface Params$Resource$Regionhealthaggregationpolicies$Delete extends StandardParameters { /** - * Name of the regional persistent disk to delete. + * Name of the HealthAggregationPolicy resource to delete. */ - disk?: string; + healthAggregationPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** @@ -87930,79 +91232,43 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regiondisks$Get extends StandardParameters { - /** - * Name of the regional persistent disk to return. - */ - disk?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regiondisks$Getasyncreplicationstatus - extends StandardParameters { - /** - * Name of the Disk resource whose Async replication details are requested. Name should conform to RFC1035 or be an unsigned long integer. - */ - disk?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the zone for this request. - */ - region?: string; - } - export interface Params$Resource$Regiondisks$Getiampolicy + export interface Params$Resource$Regionhealthaggregationpolicies$Get extends StandardParameters { /** - * Requested IAM Policy version. + * Name of the HealthAggregationPolicy resource to return. */ - optionsRequestedPolicyVersion?: number; + healthAggregationPolicy?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region scoping this request. */ region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; } - export interface Params$Resource$Regiondisks$Insert + export interface Params$Resource$Regionhealthaggregationpolicies$Insert extends StandardParameters { /** * Project ID for this request. */ project?: string; /** - * Name of the region for this request. + * Name of the region scoping 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; - /** - * Source image to restore onto a disk. This field is optional. - */ - sourceImage?: string; /** * Request body metadata */ - requestBody?: Schema$Disk; + requestBody?: Schema$HealthAggregationPolicy; } - export interface Params$Resource$Regiondisks$List extends StandardParameters { + export interface Params$Resource$Regionhealthaggregationpolicies$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. */ @@ -88024,7 +91290,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** @@ -88032,42 +91298,18 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regiondisks$Removeresourcepolicies + export interface Params$Resource$Regionhealthaggregationpolicies$Patch extends StandardParameters { /** - * The disk name for this request. + * Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035. */ - disk?: string; + healthAggregationPolicy?: 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; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; - } - export interface Params$Resource$Regiondisks$Resize - extends StandardParameters { - /** - * Name of the regional persistent disk. - */ - disk?: string; - /** - * The project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** @@ -88078,9 +91320,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$RegionDisksResizeRequest; + requestBody?: Schema$HealthAggregationPolicy; } - export interface Params$Resource$Regiondisks$Setiampolicy + export interface Params$Resource$Regionhealthaggregationpolicies$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -88098,230 +91340,331 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$RegionSetPolicyRequest; + requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regiondisks$Setlabels - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * 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; - /** - * Name or id of the resource for this request. - */ - resource?: string; - /** - * Request body metadata - */ - requestBody?: Schema$RegionSetLabelsRequest; - } - export interface Params$Resource$Regiondisks$Startasyncreplication - extends StandardParameters { - /** - * The name of the persistent disk. - */ - disk?: 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 class Resource$Regionhealthchecks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Request body metadata - */ - requestBody?: Schema$RegionDisksStartAsyncReplicationRequest; - } - export interface Params$Resource$Regiondisks$Stopasyncreplication - extends StandardParameters { - /** - * The name of the persistent disk. - */ - disk?: 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$Regiondisks$Stopgroupasyncreplication - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group. - */ - 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). + * Deletes the specified HealthCheck 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. */ - requestId?: string; + delete( + params: Params$Resource$Regionhealthchecks$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Regionhealthchecks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionhealthchecks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionhealthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionhealthchecks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$DisksStopGroupAsyncReplicationResource; - } - export interface Params$Resource$Regiondisks$Testiampermissions - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - /** - * Name or id of the resource for this request. - */ - resource?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } - export interface Params$Resource$Regiondisks$Update - extends StandardParameters { - /** - * The disk name for this request. - */ - disk?: string; - /** + * Returns the specified HealthCheck 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. */ - paths?: 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; - /** - * update_mask indicates fields to be updated as part of this request. - */ - updateMask?: string; + get( + params: Params$Resource$Regionhealthchecks$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regionhealthchecks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionhealthchecks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthchecks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$Disk; - } - export interface Params$Resource$Regiondisks$Waitforreplicationcatchup - extends StandardParameters { - /** - * The name of the persistent disk. Name should conform to RFC1035 or be an unsigned long integer. - */ - disk?: 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; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata + * Creates a HealthCheck resource in the specified project using the data included in the 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. */ - requestBody?: Schema$RegionWaitForReplicationCatchUpRequest; - } + insert( + params: Params$Resource$Regionhealthchecks$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regionhealthchecks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionhealthchecks$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthchecks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthchecks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Regiondisksettings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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}/healthChecks' + ).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); + } } /** - * Get Regional Disk Settings. + * Retrieves the list of HealthCheck resources available to 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. */ - get( - params: Params$Resource$Regiondisksettings$Get, + list( + params: Params$Resource$Regionhealthchecks$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Regiondisksettings$Get, + list( + params?: Params$Resource$Regionhealthchecks$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Regiondisksettings$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Regionhealthchecks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regiondisksettings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionhealthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regiondisksettings$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Regionhealthchecks$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regiondisksettings$Get - | BodyResponseCallback + | Params$Resource$Regionhealthchecks$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$Regiondisksettings$Get; + {}) as Params$Resource$Regionhealthchecks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisksettings$Get; + params = {} as Params$Resource$Regionhealthchecks$List; options = {}; } @@ -88336,7 +91679,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/diskSettings' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -88349,17 +91692,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Patch Regional Disk Settings + * Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -88367,31 +91710,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Regiondisksettings$Patch, + params: Params$Resource$Regionhealthchecks$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Regiondisksettings$Patch, + params?: Params$Resource$Regionhealthchecks$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Regiondisksettings$Patch, + params: Params$Resource$Regionhealthchecks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Regiondisksettings$Patch, + params: Params$Resource$Regionhealthchecks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Regiondisksettings$Patch, + params: Params$Resource$Regionhealthchecks$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Regiondisksettings$Patch + | Params$Resource$Regionhealthchecks$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88404,12 +91747,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisksettings$Patch; + {}) as Params$Resource$Regionhealthchecks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisksettings$Patch; + params = {} as Params$Resource$Regionhealthchecks$Patch; options = {}; } @@ -88424,7 +91767,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/diskSettings' + '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -88432,8 +91775,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { @@ -88445,193 +91788,410 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } - } - export interface Params$Resource$Regiondisksettings$Get - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regiondisksettings$Patch - 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; /** - * update_mask indicates fields to be updated as part of this request. + * Returns permissions that a caller has on the specified 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. */ - updateMask?: string; + testIamPermissions( + params: Params$Resource$Regionhealthchecks$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Regionhealthchecks$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionhealthchecks$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionhealthchecks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionhealthchecks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$DiskSettings; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$Testiampermissions; + options = {}; + } - export class Resource$Regiondisktypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + 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}/healthChecks/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Returns the specified regional disk type. + * Updates a HealthCheck resource in the specified project using the data included in the 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$Regiondisktypes$Get, + update( + params: Params$Resource$Regionhealthchecks$Update, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Regiondisktypes$Get, + update( + params?: Params$Resource$Regionhealthchecks$Update, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Regiondisktypes$Get, + ): GaxiosPromise; + update( + params: Params$Resource$Regionhealthchecks$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regiondisktypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + update( + params: Params$Resource$Regionhealthchecks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regiondisktypes$Get, - callback: BodyResponseCallback + update( + params: Params$Resource$Regionhealthchecks$Update, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Regiondisktypes$Get - | BodyResponseCallback + | Params$Resource$Regionhealthchecks$Update + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisktypes$Get; + {}) as Params$Resource$Regionhealthchecks$Update; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisktypes$Get; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$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/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionhealthchecks$Delete + extends StandardParameters { + /** + * Name of the HealthCheck resource to delete. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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$Regionhealthchecks$Get + extends StandardParameters { + /** + * Name of the HealthCheck resource to return. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthchecks$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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$HealthCheck; + } + export interface Params$Resource$Regionhealthchecks$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 scoping 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 interface Params$Resource$Regionhealthchecks$Patch + extends StandardParameters { + /** + * Name of the HealthCheck resource to patch. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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$HealthCheck; + } + export interface Params$Resource$Regionhealthchecks$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regionhealthchecks$Update + extends StandardParameters { + /** + * Name of the HealthCheck resource to update. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheck; + } - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/diskTypes/{diskType}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'diskType'], - pathParams: ['diskType', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Regionhealthcheckservices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Retrieves a list of regional disk types available to the specified project. + * Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project. 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. */ - list( - params: Params$Resource$Regiondisktypes$List, + aggregatedList( + params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Regiondisktypes$List, + aggregatedList( + params?: Params$Resource$Regionhealthcheckservices$Aggregatedlist, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regiondisktypes$List, + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regiondisktypes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regiondisktypes$List, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Regiondisktypes$List - | BodyResponseCallback + | Params$Resource$Regionhealthcheckservices$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regiondisktypes$List; + {}) as Params$Resource$Regionhealthcheckservices$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiondisktypes$List; + params = {} as Params$Resource$Regionhealthcheckservices$Aggregatedlist; options = {}; } @@ -88646,7 +92206,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/diskTypes' + '/compute/alpha/projects/{project}/aggregated/healthCheckServices' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -88654,76 +92214,24 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Regiondisktypes$Get - extends StandardParameters { - /** - * Name of the disk type to return. - */ - diskType?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regiondisktypes$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$Regionhealthchecks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes the specified HealthCheck resource. + * Deletes the specified regional HealthCheckService. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -88731,31 +92239,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Regionhealthchecks$Delete, + params: Params$Resource$Regionhealthcheckservices$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Regionhealthchecks$Delete, + params?: Params$Resource$Regionhealthcheckservices$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Regionhealthchecks$Delete, + params: Params$Resource$Regionhealthcheckservices$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthchecks$Delete, + params: Params$Resource$Regionhealthcheckservices$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthchecks$Delete, + params: Params$Resource$Regionhealthcheckservices$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Delete + | Params$Resource$Regionhealthcheckservices$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88768,12 +92276,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Delete; + {}) as Params$Resource$Regionhealthcheckservices$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Delete; + params = {} as Params$Resource$Regionhealthcheckservices$Delete; options = {}; } @@ -88788,7 +92296,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -88796,8 +92304,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheck'], - pathParams: ['healthCheck', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], context: this.context, }; if (callback) { @@ -88811,7 +92319,7 @@ export namespace compute_alpha { } /** - * Returns the specified HealthCheck resource. + * Returns the specified regional HealthCheckService resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -88819,49 +92327,52 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Regionhealthchecks$Get, + params: Params$Resource$Regionhealthcheckservices$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Regionhealthchecks$Get, + params?: Params$Resource$Regionhealthcheckservices$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Regionhealthchecks$Get, + params: Params$Resource$Regionhealthcheckservices$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regionhealthchecks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthcheckservices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regionhealthchecks$Get, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthcheckservices$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Get - | BodyResponseCallback + | Params$Resource$Regionhealthcheckservices$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$Regionhealthchecks$Get; + {}) as Params$Resource$Regionhealthcheckservices$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Get; + params = {} as Params$Resource$Regionhealthcheckservices$Get; options = {}; } @@ -88876,7 +92387,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -88884,22 +92395,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheck'], - pathParams: ['healthCheck', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a HealthCheck resource in the specified project using the data included in the request. + * Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -88907,31 +92418,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regionhealthchecks$Insert, + params: Params$Resource$Regionhealthcheckservices$Insert, options: StreamMethodOptions ): GaxiosPromise; insert( - params?: Params$Resource$Regionhealthchecks$Insert, + params?: Params$Resource$Regionhealthcheckservices$Insert, options?: MethodOptions ): GaxiosPromise; insert( - params: Params$Resource$Regionhealthchecks$Insert, + params: Params$Resource$Regionhealthcheckservices$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionhealthchecks$Insert, + params: Params$Resource$Regionhealthcheckservices$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionhealthchecks$Insert, + params: Params$Resource$Regionhealthcheckservices$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Insert + | Params$Resource$Regionhealthcheckservices$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88944,12 +92455,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Insert; + {}) as Params$Resource$Regionhealthcheckservices$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Insert; + params = {} as Params$Resource$Regionhealthcheckservices$Insert; options = {}; } @@ -88964,7 +92475,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -88987,7 +92498,7 @@ export namespace compute_alpha { } /** - * Retrieves the list of HealthCheck resources available to the specified project. + * Lists all the HealthCheckService resources that have been configured for the specified project in the given region. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -88995,49 +92506,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regionhealthchecks$List, + params: Params$Resource$Regionhealthcheckservices$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Regionhealthchecks$List, + params?: Params$Resource$Regionhealthcheckservices$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Regionhealthchecks$List, + params: Params$Resource$Regionhealthcheckservices$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionhealthchecks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthcheckservices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionhealthchecks$List, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthcheckservices$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$List - | BodyResponseCallback + | Params$Resource$Regionhealthcheckservices$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$Regionhealthchecks$List; + {}) as Params$Resource$Regionhealthcheckservices$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$List; + params = {} as Params$Resource$Regionhealthcheckservices$List; options = {}; } @@ -89052,7 +92568,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -89065,17 +92581,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -89083,31 +92599,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Regionhealthchecks$Patch, + params: Params$Resource$Regionhealthcheckservices$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Regionhealthchecks$Patch, + params?: Params$Resource$Regionhealthcheckservices$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Regionhealthchecks$Patch, + params: Params$Resource$Regionhealthcheckservices$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Regionhealthchecks$Patch, + params: Params$Resource$Regionhealthcheckservices$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Regionhealthchecks$Patch, + params: Params$Resource$Regionhealthcheckservices$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Patch + | Params$Resource$Regionhealthcheckservices$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -89120,12 +92636,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Patch; + {}) as Params$Resource$Regionhealthcheckservices$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Patch; + params = {} as Params$Resource$Regionhealthcheckservices$Patch; options = {}; } @@ -89140,7 +92656,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -89148,8 +92664,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheck'], - pathParams: ['healthCheck', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], context: this.context, }; if (callback) { @@ -89171,27 +92687,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Regionhealthchecks$Testiampermissions, + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Regionhealthchecks$Testiampermissions, + params?: Params$Resource$Regionhealthcheckservices$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Regionhealthchecks$Testiampermissions, + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regionhealthchecks$Testiampermissions, + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regionhealthchecks$Testiampermissions, + params: Params$Resource$Regionhealthcheckservices$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -89199,7 +92715,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Testiampermissions + | Params$Resource$Regionhealthcheckservices$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -89215,12 +92731,13 @@ export namespace compute_alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Testiampermissions; + {}) as Params$Resource$Regionhealthcheckservices$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$Testiampermissions; + params = + {} as Params$Resource$Regionhealthcheckservices$Testiampermissions; options = {}; } @@ -89235,7 +92752,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -89256,102 +92773,49 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regionhealthcheckservices$Aggregatedlist + extends StandardParameters { /** - * Updates a HealthCheck resource in the specified project using the data included in the 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. + * 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. */ - update( - params: Params$Resource$Regionhealthchecks$Update, - options: StreamMethodOptions - ): GaxiosPromise; - update( - params?: Params$Resource$Regionhealthchecks$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Regionhealthchecks$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Regionhealthchecks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Regionhealthchecks$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Regionhealthchecks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthchecks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthchecks$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/alpha/projects/{project}/regions/{region}/healthChecks/{healthCheck}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'healthCheck'], - pathParams: ['healthCheck', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } + 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; + /** + * Name of the project scoping 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$Regionhealthchecks$Delete + export interface Params$Resource$Regionhealthcheckservices$Delete extends StandardParameters { /** - * Name of the HealthCheck resource to delete. + * Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. */ - healthCheck?: string; + healthCheckService?: string; /** * Project ID for this request. */ @@ -89365,12 +92829,12 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionhealthchecks$Get + export interface Params$Resource$Regionhealthcheckservices$Get extends StandardParameters { /** - * Name of the HealthCheck resource to return. + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. */ - healthCheck?: string; + healthCheckService?: string; /** * Project ID for this request. */ @@ -89380,7 +92844,7 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionhealthchecks$Insert + export interface Params$Resource$Regionhealthcheckservices$Insert extends StandardParameters { /** * Project ID for this request. @@ -89398,9 +92862,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HealthCheck; + requestBody?: Schema$HealthCheckService; } - export interface Params$Resource$Regionhealthchecks$List + export interface Params$Resource$Regionhealthcheckservices$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. @@ -89431,12 +92895,12 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regionhealthchecks$Patch + export interface Params$Resource$Regionhealthcheckservices$Patch extends StandardParameters { /** - * Name of the HealthCheck resource to patch. + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. */ - healthCheck?: string; + healthCheckService?: string; /** * Project ID for this request. */ @@ -89453,9 +92917,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HealthCheck; + requestBody?: Schema$HealthCheckService; } - export interface Params$Resource$Regionhealthchecks$Testiampermissions + export interface Params$Resource$Regionhealthcheckservices$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -89475,39 +92939,15 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionhealthchecks$Update - extends StandardParameters { - /** - * Name of the HealthCheck resource to update. - */ - healthCheck?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping 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$HealthCheck; - } - export class Resource$Regionhealthcheckservices { + export class Resource$Regionhealthsources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Retrieves the list of all HealthSource resources (all regional) available to the specified project. 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`. @@ -89515,56 +92955,56 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ aggregatedList( - params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, + params: Params$Resource$Regionhealthsources$Aggregatedlist, options: StreamMethodOptions ): GaxiosPromise; aggregatedList( - params?: Params$Resource$Regionhealthcheckservices$Aggregatedlist, + params?: Params$Resource$Regionhealthsources$Aggregatedlist, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; aggregatedList( - params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, + params: Params$Resource$Regionhealthsources$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, + params: Params$Resource$Regionhealthsources$Aggregatedlist, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Regionhealthcheckservices$Aggregatedlist, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$Aggregatedlist, + callback: BodyResponseCallback ): void; aggregatedList( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; aggregatedList( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Regionhealthsources$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Aggregatedlist; + {}) as Params$Resource$Regionhealthsources$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Aggregatedlist; + params = {} as Params$Resource$Regionhealthsources$Aggregatedlist; options = {}; } @@ -89579,7 +93019,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/aggregated/healthCheckServices' + '/compute/alpha/projects/{project}/aggregated/healthSources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -89592,19 +93032,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes the specified regional HealthCheckService. + * Deletes the specified HealthSource in the given region * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -89612,31 +93050,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Regionhealthcheckservices$Delete, + params: Params$Resource$Regionhealthsources$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Regionhealthcheckservices$Delete, + params?: Params$Resource$Regionhealthsources$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Regionhealthcheckservices$Delete, + params: Params$Resource$Regionhealthsources$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthcheckservices$Delete, + params: Params$Resource$Regionhealthsources$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionhealthcheckservices$Delete, + params: Params$Resource$Regionhealthsources$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Delete + | Params$Resource$Regionhealthsources$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -89649,12 +93087,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Delete; + {}) as Params$Resource$Regionhealthsources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Delete; + params = {} as Params$Resource$Regionhealthsources$Delete; options = {}; } @@ -89669,7 +93107,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -89677,8 +93115,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheckService'], - pathParams: ['healthCheckService', 'project', 'region'], + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], context: this.context, }; if (callback) { @@ -89692,7 +93130,7 @@ export namespace compute_alpha { } /** - * Returns the specified regional HealthCheckService resource. + * Returns the specified HealthSource resource in the given region. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -89700,52 +93138,49 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Regionhealthcheckservices$Get, + params: Params$Resource$Regionhealthsources$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Regionhealthcheckservices$Get, + params?: Params$Resource$Regionhealthsources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Regionhealthcheckservices$Get, + params: Params$Resource$Regionhealthsources$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regionhealthcheckservices$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regionhealthcheckservices$Get, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Get - | BodyResponseCallback + | Params$Resource$Regionhealthsources$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$Regionhealthcheckservices$Get; + {}) as Params$Resource$Regionhealthsources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Get; + params = {} as Params$Resource$Regionhealthsources$Get; options = {}; } @@ -89760,7 +93195,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -89768,22 +93203,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheckService'], - pathParams: ['healthCheckService', 'project', 'region'], + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. + * Create a HealthSource in the specified project in the given region using the parameters that are included in the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -89791,31 +93226,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Regionhealthcheckservices$Insert, + params: Params$Resource$Regionhealthsources$Insert, options: StreamMethodOptions ): GaxiosPromise; insert( - params?: Params$Resource$Regionhealthcheckservices$Insert, + params?: Params$Resource$Regionhealthsources$Insert, options?: MethodOptions ): GaxiosPromise; insert( - params: Params$Resource$Regionhealthcheckservices$Insert, + params: Params$Resource$Regionhealthsources$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionhealthcheckservices$Insert, + params: Params$Resource$Regionhealthsources$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Regionhealthcheckservices$Insert, + params: Params$Resource$Regionhealthsources$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Insert + | Params$Resource$Regionhealthsources$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -89828,12 +93263,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Insert; + {}) as Params$Resource$Regionhealthsources$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Insert; + params = {} as Params$Resource$Regionhealthsources$Insert; options = {}; } @@ -89848,7 +93283,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' + '/compute/alpha/projects/{project}/regions/{region}/healthSources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -89871,7 +93306,7 @@ export namespace compute_alpha { } /** - * Lists all the HealthCheckService resources that have been configured for the specified project in the given region. + * Lists the HealthSources for a project in the given region. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -89879,54 +93314,49 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Regionhealthcheckservices$List, + params: Params$Resource$Regionhealthsources$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Regionhealthcheckservices$List, + params?: Params$Resource$Regionhealthsources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Regionhealthcheckservices$List, + params: Params$Resource$Regionhealthsources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionhealthcheckservices$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Regionhealthcheckservices$List, - callback: BodyResponseCallback + params: Params$Resource$Regionhealthsources$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$List - | BodyResponseCallback + | Params$Resource$Regionhealthsources$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$Regionhealthcheckservices$List; + {}) as Params$Resource$Regionhealthsources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$List; + params = {} as Params$Resource$Regionhealthsources$List; options = {}; } @@ -89941,7 +93371,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices' + '/compute/alpha/projects/{project}/regions/{region}/healthSources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -89954,17 +93384,17 @@ export namespace compute_alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -89972,31 +93402,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Regionhealthcheckservices$Patch, + params: Params$Resource$Regionhealthsources$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Regionhealthcheckservices$Patch, + params?: Params$Resource$Regionhealthsources$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Regionhealthcheckservices$Patch, + params: Params$Resource$Regionhealthsources$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Regionhealthcheckservices$Patch, + params: Params$Resource$Regionhealthsources$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Regionhealthcheckservices$Patch, + params: Params$Resource$Regionhealthsources$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Patch + | Params$Resource$Regionhealthsources$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -90009,12 +93439,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Patch; + {}) as Params$Resource$Regionhealthsources$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionhealthcheckservices$Patch; + params = {} as Params$Resource$Regionhealthsources$Patch; options = {}; } @@ -90029,7 +93459,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + '/compute/alpha/projects/{project}/regions/{region}/healthSources/{healthSource}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -90037,8 +93467,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'region', 'healthCheckService'], - pathParams: ['healthCheckService', 'project', 'region'], + requiredParams: ['project', 'region', 'healthSource'], + pathParams: ['healthSource', 'project', 'region'], context: this.context, }; if (callback) { @@ -90060,27 +93490,27 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + params: Params$Resource$Regionhealthsources$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Regionhealthcheckservices$Testiampermissions, + params?: Params$Resource$Regionhealthsources$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + params: Params$Resource$Regionhealthsources$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + params: Params$Resource$Regionhealthsources$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Regionhealthcheckservices$Testiampermissions, + params: Params$Resource$Regionhealthsources$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -90088,7 +93518,7 @@ export namespace compute_alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Regionhealthcheckservices$Testiampermissions + | Params$Resource$Regionhealthsources$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -90104,13 +93534,12 @@ export namespace compute_alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionhealthcheckservices$Testiampermissions; + {}) as Params$Resource$Regionhealthsources$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Regionhealthcheckservices$Testiampermissions; + params = {} as Params$Resource$Regionhealthsources$Testiampermissions; options = {}; } @@ -90125,7 +93554,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions' + '/compute/alpha/projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -90148,7 +93577,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionhealthcheckservices$Aggregatedlist + export interface Params$Resource$Regionhealthsources$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. @@ -90183,12 +93612,12 @@ export namespace compute_alpha { */ serviceProjectNumber?: string; } - export interface Params$Resource$Regionhealthcheckservices$Delete + export interface Params$Resource$Regionhealthsources$Delete extends StandardParameters { /** - * Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. + * Name of the HealthSource resource to delete. */ - healthCheckService?: string; + healthSource?: string; /** * Project ID for this request. */ @@ -90202,12 +93631,12 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionhealthcheckservices$Get + export interface Params$Resource$Regionhealthsources$Get extends StandardParameters { /** - * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + * Name of the HealthSource resource to return. */ - healthCheckService?: string; + healthSource?: string; /** * Project ID for this request. */ @@ -90217,7 +93646,7 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionhealthcheckservices$Insert + export interface Params$Resource$Regionhealthsources$Insert extends StandardParameters { /** * Project ID for this request. @@ -90235,9 +93664,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HealthCheckService; + requestBody?: Schema$HealthSource; } - export interface Params$Resource$Regionhealthcheckservices$List + export interface Params$Resource$Regionhealthsources$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. @@ -90268,12 +93697,12 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Regionhealthcheckservices$Patch + export interface Params$Resource$Regionhealthsources$Patch extends StandardParameters { /** - * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + * Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. */ - healthCheckService?: string; + healthSource?: string; /** * Project ID for this request. */ @@ -90290,9 +93719,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$HealthCheckService; + requestBody?: Schema$HealthSource; } - export interface Params$Resource$Regionhealthcheckservices$Testiampermissions + export interface Params$Resource$Regionhealthsources$Testiampermissions extends StandardParameters { /** * Project ID for this request. @@ -96912,6 +100341,247 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Regionmultimigmembers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves information about the specified multi-MIG member. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionmultimigmembers$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regionmultimigmembers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionmultimigmembers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionmultimigmembers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionmultimigmembers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionmultimigmembers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionmultimigmembers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionmultimigmembers$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}/multiMigMembers/{multiMigMember}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'multiMig', 'multiMigMember'], + pathParams: ['multiMig', 'multiMigMember', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of members of a specific multi-MIG. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionmultimigmembers$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regionmultimigmembers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionmultimigmembers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionmultimigmembers$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionmultimigmembers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionmultimigmembers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionmultimigmembers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionmultimigmembers$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/{multiMig}/multiMigMembers' + ).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); + } + } + } + + export interface Params$Resource$Regionmultimigmembers$Get + extends StandardParameters { + /** + * The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. + */ + multiMig?: string; + /** + * The name of the multi-MIG member. Name should conform to RFC1035 or be a resource ID. + */ + multiMigMember?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. Region name should conform to RFC1035. + */ + region?: string; + } + export interface Params$Resource$Regionmultimigmembers$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; + /** + * The name of the multi-MIG. Name should conform to RFC1035 or be a resource ID. + */ + multiMig?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + 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 name should conform to RFC1035. + */ + 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$Regionmultimigs { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 931b9b538b7..bffcae5d465 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -118,10 +118,13 @@ export namespace compute_beta { context: APIRequestContext; acceleratorTypes: Resource$Acceleratortypes; addresses: Resource$Addresses; + advice: Resource$Advice; autoscalers: Resource$Autoscalers; backendBuckets: Resource$Backendbuckets; backendServices: Resource$Backendservices; + crossSiteNetworks: Resource$Crosssitenetworks; disks: Resource$Disks; + diskSettings: Resource$Disksettings; diskTypes: Resource$Disktypes; externalVpnGateways: Resource$Externalvpngateways; firewallPolicies: Resource$Firewallpolicies; @@ -172,6 +175,7 @@ export namespace compute_beta { regionBackendServices: Resource$Regionbackendservices; regionCommitments: Resource$Regioncommitments; regionDisks: Resource$Regiondisks; + regionDiskSettings: Resource$Regiondisksettings; regionDiskTypes: Resource$Regiondisktypes; regionHealthChecks: Resource$Regionhealthchecks; regionHealthCheckServices: Resource$Regionhealthcheckservices; @@ -188,6 +192,8 @@ export namespace compute_beta { regionOperations: Resource$Regionoperations; regions: Resource$Regions; regionSecurityPolicies: Resource$Regionsecuritypolicies; + regionSnapshots: Resource$Regionsnapshots; + regionSnapshotSettings: Resource$Regionsnapshotsettings; regionSslCertificates: Resource$Regionsslcertificates; regionSslPolicies: Resource$Regionsslpolicies; regionTargetHttpProxies: Resource$Regiontargethttpproxies; @@ -220,6 +226,7 @@ export namespace compute_beta { urlMaps: Resource$Urlmaps; vpnGateways: Resource$Vpngateways; vpnTunnels: Resource$Vpntunnels; + wireGroups: Resource$Wiregroups; zoneOperations: Resource$Zoneoperations; zones: Resource$Zones; @@ -231,10 +238,13 @@ export namespace compute_beta { this.acceleratorTypes = new Resource$Acceleratortypes(this.context); this.addresses = new Resource$Addresses(this.context); + this.advice = new Resource$Advice(this.context); this.autoscalers = new Resource$Autoscalers(this.context); this.backendBuckets = new Resource$Backendbuckets(this.context); this.backendServices = new Resource$Backendservices(this.context); + this.crossSiteNetworks = new Resource$Crosssitenetworks(this.context); this.disks = new Resource$Disks(this.context); + this.diskSettings = new Resource$Disksettings(this.context); this.diskTypes = new Resource$Disktypes(this.context); this.externalVpnGateways = new Resource$Externalvpngateways(this.context); this.firewallPolicies = new Resource$Firewallpolicies(this.context); @@ -310,6 +320,7 @@ export namespace compute_beta { ); this.regionCommitments = new Resource$Regioncommitments(this.context); this.regionDisks = new Resource$Regiondisks(this.context); + this.regionDiskSettings = new Resource$Regiondisksettings(this.context); this.regionDiskTypes = new Resource$Regiondisktypes(this.context); this.regionHealthChecks = new Resource$Regionhealthchecks(this.context); this.regionHealthCheckServices = new Resource$Regionhealthcheckservices( @@ -341,6 +352,10 @@ export namespace compute_beta { this.regionSecurityPolicies = new Resource$Regionsecuritypolicies( this.context ); + this.regionSnapshots = new Resource$Regionsnapshots(this.context); + this.regionSnapshotSettings = new Resource$Regionsnapshotsettings( + this.context + ); this.regionSslCertificates = new Resource$Regionsslcertificates( this.context ); @@ -381,6 +396,7 @@ export namespace compute_beta { this.urlMaps = new Resource$Urlmaps(this.context); this.vpnGateways = new Resource$Vpngateways(this.context); this.vpnTunnels = new Resource$Vpntunnels(this.context); + this.wireGroups = new Resource$Wiregroups(this.context); this.zoneOperations = new Resource$Zoneoperations(this.context); this.zones = new Resource$Zones(this.context); } @@ -1680,6 +1696,36 @@ export namespace compute_beta { 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. @@ -1699,7 +1745,7 @@ export namespace compute_beta { */ maxUtilization?: number | null; /** - * Name of a custom utilization signal. The name must be 1-24 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 of a custom utilization signal. 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; } @@ -1753,6 +1799,10 @@ export namespace compute_beta { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * Dynamic forwarding configuration. This field is used to configure the backend service with dynamic forwarding feature which together with Service Extension allows customized and complex routing logic. + */ + dynamicForwarding?: Schema$BackendServiceDynamicForwarding; /** * [Output Only] The resource URL for the edge security policy associated with this backend service. */ @@ -1829,6 +1879,10 @@ export namespace compute_beta { * The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. */ network?: string | null; + /** + * Configures traffic steering properties of internal passthrough Network Load Balancers. + */ + networkPassThroughLbTrafficPolicy?: Schema$BackendServiceNetworkPassThroughLbTrafficPolicy; /** * Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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. */ @@ -2033,10 +2087,28 @@ export namespace compute_beta { */ dryRun?: boolean | null; /** - * Name of a custom utilization signal. The name must be 1-24 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 of a custom utilization signal. 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; } + /** + * Defines a dynamic forwarding configuration for the backend service. + */ + export interface Schema$BackendServiceDynamicForwarding { + /** + * IP:PORT based dynamic forwarding configuration. + */ + ipPortSelection?: Schema$BackendServiceDynamicForwardingIpPortSelection; + } + /** + * Defines a IP:PORT based dynamic forwarding configuration for the backend service. Some ranges are restricted: Restricted ranges. + */ + export interface Schema$BackendServiceDynamicForwardingIpPortSelection { + /** + * A boolean flag enabling IP:PORT based dynamic forwarding. + */ + enabled?: boolean | null; + } /** * 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). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). */ @@ -2222,6 +2294,22 @@ export namespace compute_beta { */ sampleRate?: number | null; } + export interface Schema$BackendServiceNetworkPassThroughLbTrafficPolicy { + /** + * When configured, new connections are load balanced across healthy backend endpoints in the local zone. + */ + zonalAffinity?: Schema$BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity; + } + export interface Schema$BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity { + /** + * This field indicates whether zonal affinity is enabled or not. The possible values are: - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity is disabled. The load balancer distributes new connections to all healthy backend endpoints across all zones. - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is enabled. The load balancer distributes new connections to all healthy backend endpoints in the local zone only. If there are no healthy backend endpoints in the local zone, the load balancer distributes new connections to all backend endpoints in the local zone. - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is enabled. The load balancer distributes new connections to all healthy backend endpoints in the local zone only. If there aren't enough healthy backend endpoints in the local zone, the load balancer distributes new connections to all healthy backend endpoints across all zones. + */ + spillover?: string | null; + /** + * The value of the field must be in [0, 1]. When the ratio of the count of healthy backend endpoints in a zone to the count of backend endpoints in that same zone is equal to or above this threshold, the load balancer distributes new connections to all healthy endpoints in the local zone only. When the ratio of the count of healthy backend endpoints in a zone to the count of backend endpoints in that same zone is below this threshold, the load balancer distributes all new connections to all healthy endpoints across all zones. + */ + spilloverRatio?: number | null; + } export interface Schema$BackendServiceReference { backendService?: string | null; } @@ -2559,6 +2647,10 @@ export namespace compute_beta { partitionCount?: number | null; } export interface Schema$CacheInvalidationRule { + /** + * [Preview] A list of cache tags used to identify cached objects. - Cache tags are specified when the response is first cached, by setting the `Cache-Tag` response header at the origin. - Multiple cache tags in the same invalidation request are treated as Boolean `OR` - for example, `tag1 OR tag2 OR tag3`. - If other fields are also specified, these are treated as Boolean `AND` with any tags. Up to 10 tags can be specified in a single invalidation request. + */ + cacheTags?: string[] | null; /** * If set, this invalidation rule will only apply to requests with a Host header matching host. */ @@ -2598,6 +2690,35 @@ export namespace compute_beta { */ queryStringWhitelist?: string[] | null; } + /** + * A request to recommend the best way to consume the specified resources in the future. + */ + export interface Schema$CalendarModeAdviceRequest { + /** + * Specification of resources to create in the future. The key of the map is an arbitrary string specified by the caller. Value of the map is a specification of required resources and their constraints. Currently only one value is allowed in this map. + */ + futureResourcesSpecs?: {[key: string]: Schema$FutureResourcesSpec} | null; + } + /** + * A response containing the recommended way of creating the specified resources in the future. It contains (will contain) multiple recommendations that can be analyzed by the customer and the best one can be picked. + */ + export interface Schema$CalendarModeAdviceResponse { + /** + * Recommendations where, how and when to create the requested resources in order to maximize their obtainability and minimize cost. + */ + recommendations?: Schema$CalendarModeRecommendation[]; + } + /** + * A single recommendation to create requested resources. Contains detailed recommendations for every future resources specification specified in CalendarModeAdviceRequest. + */ + export interface Schema$CalendarModeRecommendation { + /** + * Recommendations for every future resource specification passed in CalendarModeAdviceRequest. Keys of the map correspond to keys specified in the request. + */ + recommendationsPerSpec?: { + [key: string]: Schema$FutureResourcesRecommendation; + } | null; + } /** * Settings controlling the volume of requests, connections and retries to this backend service. */ @@ -2628,15 +2749,15 @@ export namespace compute_beta { maxRetries?: number | null; } /** - * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. + * Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts */ export interface Schema$Commitment { /** - * Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. + * Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. */ autoRenew?: boolean | null; /** - * The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + * The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. */ category?: string | null; /** @@ -2644,20 +2765,17 @@ export namespace compute_beta { */ 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. + * [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment'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. + * An optional description of the commitment. You can provide this property when you create the resource. */ description?: string | null; /** * [Output Only] Commitment end time in RFC3339 text format. */ endTimestamp?: string | null; - /** - * Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation - */ existingReservations?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. @@ -2672,27 +2790,27 @@ export namespace compute_beta { */ licenseResource?: Schema$LicenseResourceCommitment; /** - * List of source commitments to be merged into a new commitment. + * The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. */ mergeSourceCommitments?: string[] | null; /** - * 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 of the commitment. You must specify a name when you purchase the commitment. 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; /** - * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + * The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). */ plan?: string | null; /** - * [Output Only] URL of the region where this commitment may be used. + * [Output Only] URL of the region where the commitment and committed resources are located. */ region?: string | null; /** - * List of create-on-create reservations for this commitment. + * The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. */ reservations?: Schema$Reservation[]; /** - * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. + * The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. */ resources?: Schema$ResourceCommitment[]; /** @@ -2704,7 +2822,7 @@ export namespace compute_beta { */ selfLink?: string | null; /** - * Source commitment to be split into a new commitment. + * The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. */ splitSourceCommitment?: string | null; /** @@ -2712,7 +2830,7 @@ export namespace compute_beta { */ startTimestamp?: string | null; /** - * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. */ status?: string | null; /** @@ -2720,7 +2838,7 @@ export namespace compute_beta { */ statusMessage?: string | null; /** - * The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + * The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. */ type?: string | null; } @@ -2802,7 +2920,7 @@ export namespace compute_beta { } export interface Schema$CommitmentsScopedList { /** - * [Output Only] A list of commitments contained in this scope. + * [Output Only] The list of commitments contained in this scope. */ commitments?: Schema$Commitment[]; /** @@ -2907,6 +3025,77 @@ export namespace compute_beta { */ maxAge?: number | null; } + /** + * A resource that represents a cross-site network. You can use cross-site networks to connect your on-premises networks to each other through Interconnect connections. + */ + export interface Schema$CrossSiteNetwork { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of the cross-site network. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks. + */ + kind?: string | null; + /** + * 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] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + } + /** + * Response to the list request that contains a list of cross-site networks. + */ + export interface Schema$CrossSiteNetworkList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of CrossSiteNetwork resources. + */ + items?: Schema$CrossSiteNetwork[]; + /** + * [Output Only] Type of the resource. Always compute#crossSiteNetwork for cross-site networks. + */ + 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$CustomerEncryptionKey { /** * The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 @@ -3375,6 +3564,21 @@ export namespace compute_beta { */ resourcePolicies?: string[] | null; } + export interface Schema$DiskSettings { + /** + * Policy of which locations are allowed to create regional snapshots. + */ + accessLocation?: Schema$DiskSettingsAccessLocation; + } + export interface Schema$DiskSettingsAccessLocation { + locations?: { + [key: string]: Schema$DiskSettingsAccessLocationAccessLocationPreference; + } | null; + policy?: string | null; + } + export interface Schema$DiskSettingsAccessLocationAccessLocationPreference { + region?: string | null; + } export interface Schema$DisksRemoveResourcePoliciesRequest { /** * Resource policies to be removed from this disk. @@ -4219,6 +4423,17 @@ export namespace compute_beta { */ percent?: number | null; } + /** + * A flexible specification of a time range that has 3 points of flexibility: (1) a flexible start time, (2) a flexible end time, (3) a flexible duration. It is possible to specify a contradictory time range that cannot be matched by any Interval. This causes a validation error. + */ + export interface Schema$FlexibleTimeRange { + endTimeNotEarlierThan?: string | null; + endTimeNotLaterThan?: string | null; + maxDuration?: string | null; + minDuration?: string | null; + startTimeNotEarlierThan?: string | null; + startTimeNotLaterThan?: string | null; + } /** * Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/globalForwardingRules) * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding. */ @@ -4475,6 +4690,10 @@ export namespace compute_beta { } | null; } export interface Schema$FutureReservation { + /** + * Aggregate reservation details for the future reservation. + */ + aggregateReservation?: Schema$AllocationAggregateReservation; /** * 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. */ @@ -4523,6 +4742,10 @@ export namespace compute_beta { * Planning state before being submitted for evaluation */ planningStatus?: string | null; + /** + * The reservation mode which determines reservation-termination behavior and expected pricing. + */ + reservationMode?: string | null; /** * Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. */ @@ -4786,6 +5009,130 @@ export namespace compute_beta { */ startTime?: string | null; } + /** + * Recommendation for single resources specification, to be created in the future. + */ + export interface Schema$FutureResourcesRecommendation { + endTime?: string | null; + /** + * The advised location for resource usage. When a zone, in format 'zones/'. If not set, it means that no location is recommended - see other_locations for details. + */ + location?: string | null; + /** + * List of locations in the request scope that were not recommended. Keys of the map are zones, in format 'zones/'. The values are status information indicating the recommendation status. + */ + otherLocations?: { + [key: string]: Schema$FutureResourcesRecommendationOtherLocation; + } | null; + /** + * Unique id of the recommendation, a UUID string generated by the API. + */ + recommendationId?: string | null; + /** + * Type of recommendation. Currently only FUTURE_RESERVATION is supported. + */ + recommendationType?: string | null; + startTime?: string | null; + } + /** + * Information about recommendation status for locations that were allowed but not used by the response. + */ + export interface Schema$FutureResourcesRecommendationOtherLocation { + /** + * Details (human readable) describing the situation. For example, if status is CONDITION_NOT_MET, then details contain information about the parameters of the time window that did not meet the required conditions. + */ + details?: string | null; + /** + * Status of recommendation in this location. + */ + status?: string | null; + } + /** + * Specification of resources to be created at some time in the future within an optionally specified set of locations, and within the specified time range. + */ + export interface Schema$FutureResourcesSpec { + /** + * Indicates if the reservation allocation strategy is static (DENSE) or dynamic (STANDARD). Defaults to DENSE. + */ + deploymentType?: string | null; + /** + * Optional location policy allowing to exclude some zone(s) in which the resources must not be created. + */ + locationPolicy?: Schema$FutureResourcesSpecLocationPolicy; + /** + * Specification of the reserved resources. + */ + targetResources?: Schema$FutureResourcesSpecTargetResources; + /** + * Specification of a time range in which the resources may be created. The time range specifies start of resource use and planned end of resource use. + */ + timeRangeSpec?: Schema$FlexibleTimeRange; + } + export interface Schema$FutureResourcesSpecAggregateResources { + /** + * Size of the request, in accelerator (chip) count. + */ + acceleratorCount?: string | null; + /** + * The VM family that all instances scheduled against this reservation must belong to. Use for TPU reservations. + */ + vmFamily?: string | null; + /** + * Workload type. Use for TPU reservations. + */ + workloadType?: string | null; + } + export interface Schema$FutureResourcesSpecLocalSsdPartition { + /** + * Disk interface. Defaults to SCSI. + */ + diskInterface?: string | null; + /** + * The size of the disk in GB. + */ + diskSizeGb?: string | null; + } + /** + * Specification of locations to create resources in. + */ + export interface Schema$FutureResourcesSpecLocationPolicy { + /** + * Preferences for specified locations. Keys of the map are locations - zones, in format of 'zones/'. Values are preferences for the zones. If a zone is not specified in this map, it is ALLOWed. + */ + locations?: { + [key: string]: Schema$FutureResourcesSpecLocationPolicyLocation; + } | null; + } + /** + * Preference for a single specified location. + */ + export interface Schema$FutureResourcesSpecLocationPolicyLocation { + /** + * Preference for this location. + */ + preference?: string | null; + } + export interface Schema$FutureResourcesSpecSpecificSKUResources { + /** + * Size of the request, in instance count. + */ + instanceCount?: string | null; + /** + * Local SSD partitions. You do not have to include SSD partitions that are built in the machine type. + */ + localSsdPartitions?: Schema$FutureResourcesSpecLocalSsdPartition[]; + /** + * The machine type to use for instances that will use the reservation. This field only accepts machine type names. e.g. n2-standard-4 and does not accept machine type full or partial url. e.g. projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4. Use for GPU reservations. + */ + machineType?: string | null; + } + /** + * Specification of reserved resources. + */ + export interface Schema$FutureResourcesSpecTargetResources { + aggregateResources?: Schema$FutureResourcesSpecAggregateResources; + specificSkuResources?: Schema$FutureResourcesSpecSpecificSKUResources; + } export interface Schema$GlobalAddressesMoveRequest { /** * An optional destination address description if intended to be different from the source. @@ -6784,6 +7131,10 @@ export namespace compute_beta { * A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. */ forceUpdateOnRepair?: string | null; + /** + * The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see About repairing VMs in a MIG. + */ + onFailedHealthCheck?: string | null; } /** * [Output Only] A list of managed instance groups. @@ -7699,6 +8050,17 @@ export namespace compute_beta { */ resourcePolicies?: string[] | null; } + export interface Schema$InstancesReportHostAsFaultyRequest { + /** + * The disruption schedule for the VM. Default to IMMEDIATE. + */ + disruptionSchedule?: string | null; + faultReasons?: Schema$InstancesReportHostAsFaultyRequestFaultReason[]; + } + export interface Schema$InstancesReportHostAsFaultyRequestFaultReason { + behavior?: string | null; + description?: string | null; + } export interface Schema$InstancesResumeRequest { /** * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. @@ -8236,6 +8598,10 @@ export namespace compute_beta { * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ state?: string | null; + /** + * [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty. + */ + wireGroups?: string[] | null; } /** * Configuration information for application awareness on this Cloud Interconnect. @@ -8749,6 +9115,10 @@ export namespace compute_beta { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; + /** + * [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed. + */ + crossSiteInterconnectInfos?: Schema$InterconnectLocationCrossSiteInterconnectInfo[]; /** * [Output Only] An optional description of the resource. */ @@ -8794,6 +9164,15 @@ export namespace compute_beta { */ supportsPzs?: boolean | null; } + /** + * Information about Cross-Site Interconnect wires which may be created between the containing location and another remote location. + */ + export interface Schema$InterconnectLocationCrossSiteInterconnectInfo { + /** + * The remote location for Cross-Site Interconnect wires. This specifies an InterconnectLocation city (metropolitan area designator), which itself may match multiple InterconnectLocations. + */ + city?: string | null; + } /** * Response to the list request, and contains a list of interconnect locations. */ @@ -9196,15 +9575,15 @@ export namespace compute_beta { */ export interface Schema$LicenseResourceCommitment { /** - * The number of licenses purchased. + * The number of licenses you plan to purchase. */ amount?: string | null; /** - * Specifies the core range of the instance for which this license applies. + * The number of cores per license. */ coresPerLicense?: string | null; /** - * Any applicable license URI. + * The applicable license URI. */ license?: string | null; } @@ -10654,6 +11033,10 @@ export namespace compute_beta { * The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. */ nicType?: string | null; + /** + * Name of the parent network interface of a dynamic network interface. + */ + parentNicName?: string | null; /** * 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. */ @@ -10666,6 +11049,10 @@ export namespace compute_beta { * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ subnetwork?: string | null; + /** + * VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively. + */ + vlan?: number | null; } /** * Contains a list of networks. @@ -10796,10 +11183,6 @@ export namespace compute_beta { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string | null; - /** - * [Output Only] Zone to which the network is restricted. - */ - zone?: string | null; } export interface Schema$NetworkProfileLocation { name?: string | null; @@ -11522,6 +11905,10 @@ export namespace compute_beta { * [Output Only] Local SSD available to the node type, defined in GB. */ localSsdGb?: number | null; + /** + * [Output Only] Maximum number of VMs that can be created for this node type. + */ + maxVms?: number | null; /** * [Output Only] The amount of physical memory available to the node type, defined in MB. */ @@ -12991,7 +13378,7 @@ export namespace compute_beta { } export interface Schema$RegionCommitmentsUpdateReservationsRequest { /** - * A list of two reservations to transfer GPUs and local SSD between. + * A list of two reservations to transfer GPUs and Local SSD disks between. */ reservations?: Schema$Reservation[]; } @@ -13552,6 +13939,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; + /** + * [Output only] Indicates the reservation mode of the reservation. + */ + reservationMode?: string | null; /** * Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. */ @@ -13776,6 +14167,18 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$ReservationsBlocksPerformMaintenanceRequest { + /** + * Specifies if all, running or unused hosts are in scope for this request. + */ + maintenanceScope?: string | null; + } + export interface Schema$ReservationsPerformMaintenanceRequest { + /** + * Specifies if all, running or unused hosts are in scope for this request. + */ + maintenanceScope?: string | null; + } export interface Schema$ReservationsResizeRequest { /** * Number of allocated resources can be resized with minimum = 1 and maximum = 1000. @@ -13797,19 +14200,19 @@ export namespace compute_beta { } | null; } /** - * Commitment for a particular resource (a Commitment is composed of one or more of these). + * Commitment for a particular hardware resource (a commitment is composed of one or more of these). */ export interface Schema$ResourceCommitment { /** - * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. + * Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. */ acceleratorType?: string | null; /** - * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. + * The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. */ amount?: string | null; /** - * Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + * The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. */ type?: string | null; } @@ -13956,6 +14359,10 @@ export namespace compute_beta { * Specifies network collocation */ collocation?: string | null; + /** + * Specifies the shape of the GPU slice, in slice based GPU families eg. A4X. + */ + gpuTopology?: string | null; /** * Specifies the number of max logical switches. */ @@ -14160,6 +14567,8 @@ export namespace compute_beta { * Represents the workload policy. */ export interface Schema$ResourcePolicyWorkloadPolicy { + acceleratorTopology?: string | null; + maxTopologyDistance?: string | null; type?: string | null; } /** @@ -14599,11 +15008,11 @@ export namespace compute_beta { */ enableIpv6?: boolean | null; /** - * List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + * List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. */ exportPolicies?: string[] | null; /** - * List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + * List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. */ importPolicies?: string[] | null; /** @@ -14681,7 +15090,7 @@ export namespace compute_beta { } export interface Schema$RouterInterface { /** - * IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + * IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. */ ipRange?: string | null; /** @@ -16581,6 +16990,10 @@ export namespace compute_beta { * 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 snapshot resides. Only applicable for regional snapshots. + */ + region?: string | null; /** * Output only. Reserved for future use. */ @@ -16626,7 +17039,7 @@ export namespace compute_beta { */ sourceInstantSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + * [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. */ sourceInstantSnapshotId?: string | null; /** @@ -16658,6 +17071,41 @@ export namespace compute_beta { */ userLicenses?: string[] | null; } + export interface Schema$SnapshotAggregatedList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of SnapshotsScopedList resources. + */ + items?: {[key: string]: Schema$SnapshotsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#snapshotAggregatedList for aggregated lists of snapshots. + */ + 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; + } /** * Contains a list of Snapshot resources. */ @@ -16692,11 +17140,38 @@ export namespace compute_beta { } | null; } export interface Schema$SnapshotSettings { + /** + * (Regional snapshots use only)Policy of which location is allowed to access snapshot. + */ + accessLocation?: Schema$SnapshotSettingsAccessLocation; /** * Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out. */ storageLocation?: Schema$SnapshotSettingsStorageLocationSettings; } + export interface Schema$SnapshotSettingsAccessLocation { + /** + * List of regions that can restore a regional snapshot from the current region + */ + locations?: { + [ + key: string + ]: Schema$SnapshotSettingsAccessLocationAccessLocationPreference; + } | null; + /** + * Policy of which location is allowed to access snapshot. + */ + policy?: string | null; + } + /** + * A structure for specifying an allowed target region. + */ + export interface Schema$SnapshotSettingsAccessLocationAccessLocationPreference { + /** + * Accessible region name + */ + region?: string | null; + } export interface Schema$SnapshotSettingsStorageLocationSettings { /** * When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are Cloud Storage bucket locations. Only one location can be specified. @@ -16720,6 +17195,20 @@ export namespace compute_beta { */ name?: string | null; } + export interface Schema$SnapshotsScopedList { + /** + * [Output Only] A list of snapshots contained in this scope. + */ + snapshots?: Schema$Snapshot[]; + /** + * [Output Only] Informational warning which replaces the list of snapshots when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$SourceDiskEncryptionKey { /** * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. @@ -17738,7 +18227,7 @@ export namespace compute_beta { */ privateIpv6GoogleAccess?: string | null; /** - * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. */ purpose?: string | null; /** @@ -18239,7 +18728,7 @@ export namespace compute_beta { */ selfLink?: string | null; /** - * Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. + * Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED or INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy attached to regional forwardingRules with the loadBalancingScheme set to EXTERNAL_MANAGED or INTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, INTERNAL_MANAGED, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. */ serverTlsPolicy?: string | null; /** @@ -19385,7 +19874,7 @@ export namespace compute_beta { */ network?: string | null; /** - * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. */ purpose?: string | null; /** @@ -20004,6 +20493,194 @@ export namespace compute_beta { */ weight?: number | null; } + /** + * A pseudowire that connects two Interconnect connections. + */ + export interface Schema$Wire { + /** + * [Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true. + */ + adminEnabled?: boolean | null; + /** + * Wire endpoints are specific Interconnect connections. + */ + endpoints?: Schema$WireEndpoint[]; + /** + * [Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: - ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects. - CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects. + */ + label?: string | null; + /** + * [Output Only] Properties of the wire. + */ + wireProperties?: Schema$WireProperties; + } + /** + * Wire endpoints are specific Interconnect connections. + */ + export interface Schema$WireEndpoint { + interconnect?: string | null; + vlanTag?: number | null; + } + /** + * A resource that represents a group of redundant wires. + */ + export interface Schema$WireGroup { + /** + * Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of `adminEnabled` to false, a given wire is enabled. Defaults to true. + */ + adminEnabled?: boolean | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of the wire group. + */ + description?: string | null; + /** + * A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object. + */ + endpoints?: {[key: string]: Schema$WireGroupEndpoint} | null; + /** + * [Output Only] The unique identifier for the resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#wireGroups for wire groups. + */ + kind?: string | null; + /** + * 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] Server-defined URL for the resource. + */ + selfLink?: string | null; + selfLinkWithId?: string | null; + /** + * Topology details for the wire group configuration. + */ + topology?: Schema$WireGroupTopology; + /** + * Properties of the wire group. + */ + wireGroupProperties?: Schema$WireGroupProperties; + /** + * Properties for all wires in the wire group. + */ + wireProperties?: Schema$WireProperties; + /** + * The single/redundant wire(s) managed by the wire group. + */ + wires?: Schema$Wire[]; + } + /** + * A logical endpoint for the wire group. An endpoint represents a metro that contains redundant Interconnect connections. A wire group is created between two endpoints. + */ + export interface Schema$WireGroupEndpoint { + /** + * A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Interconnect object. + */ + interconnects?: { + [key: string]: Schema$WireGroupEndpointInterconnect; + } | null; + } + /** + * The redundant Interconnect connections for this endpoint. + */ + export interface Schema$WireGroupEndpointInterconnect { + /** + * An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs: global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME - https://compute.googleapis.com/compute/projects/PROJECT_ID /global/interconnects/NAME + */ + interconnect?: string | null; + /** + * To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from `2` to `4093`. You can autoallocate a tag by entering `0`. To configure the wire group for port mode, enter `-1`. Review the following guidelines: - A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups. - Both endpoints of a wire must use the same VLAN tag value. - Single wire and redundant type wire groups must have only one VLAN tag. - Port mode pseudowires must have a single VLAN tag with a value of `-1` for both endpoints. - Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire. + */ + vlanTags?: number[] | null; + } + /** + * Response for the list request. + */ + export interface Schema$WireGroupList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of wire group resources. + */ + items?: Schema$WireGroup[]; + /** + * [Output Only] Type of the resource. Always compute#wireGroups for wire groups. + */ + 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; + } + /** + * The properties of a wire group. These properties determine how a group of redundant wires are created and managed. + */ + export interface Schema$WireGroupProperties { + /** + * The type of the wire group, one of the following: - WIRE: a single pseudowire over two Interconnect connections with no redundancy. - REDUNDANT: two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros. - BOX_AND_CROSS: four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros. + */ + type?: string | null; + } + /** + * Topology details for the wire group. + */ + export interface Schema$WireGroupTopology { + /** + * Topology details for all endpoints in the wire group. + */ + endpoints?: Schema$WireGroupTopologyEndpoint[]; + } + /** + * Topology details for a single wire group endpoint. + */ + export interface Schema$WireGroupTopologyEndpoint { + /** + * The InterconnectLocation.city (metropolitan area designator) that all interconnects are located in. + */ + city?: string | null; + /** + * Endpoint label from the wire group. + */ + label?: string | null; + } + /** + * The properties of a wire. + */ + export interface Schema$WireProperties { + /** + * The unmetered bandwidth in Gigabits per second, using decimal units. `10` is 10 Gbps, `100` is 100 Gbps. + */ + bandwidthUnmetered?: string | null; + /** + * Response when a fault is detected in a pseudowire: - NONE: default. - DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires. + */ + faultResponse?: string | null; + } export interface Schema$XpnHostList { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -21422,6 +22099,125 @@ export namespace compute_beta { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Advice { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits. The method recommends creating future reservations for the requested 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. + */ + calendarMode( + params: Params$Resource$Advice$Calendarmode, + options: StreamMethodOptions + ): GaxiosPromise; + calendarMode( + params?: Params$Resource$Advice$Calendarmode, + options?: MethodOptions + ): GaxiosPromise; + calendarMode( + params: Params$Resource$Advice$Calendarmode, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calendarMode( + params: Params$Resource$Advice$Calendarmode, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calendarMode( + params: Params$Resource$Advice$Calendarmode, + callback: BodyResponseCallback + ): void; + calendarMode( + callback: BodyResponseCallback + ): void; + calendarMode( + paramsOrCallback?: + | Params$Resource$Advice$Calendarmode + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advice$Calendarmode; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advice$Calendarmode; + 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}/regions/{region}/advice/calendarMode' + ).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); + } + } + } + + export interface Params$Resource$Advice$Calendarmode + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CalendarModeAdviceRequest; + } + export class Resource$Autoscalers { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -22955,6 +23751,101 @@ export namespace compute_beta { } } + /** + * 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/beta/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. * @@ -23528,6 +24419,33 @@ export namespace compute_beta { */ 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 { /** @@ -25494,46 +26412,46 @@ export namespace compute_beta { requestBody?: Schema$BackendService; } - export class Resource$Disks { + export class Resource$Crosssitenetworks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * Deletes the specified cross-site network in the given 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. */ - addResourcePolicies( - params: Params$Resource$Disks$Addresourcepolicies, + delete( + params: Params$Resource$Crosssitenetworks$Delete, options: StreamMethodOptions ): GaxiosPromise; - addResourcePolicies( - params?: Params$Resource$Disks$Addresourcepolicies, + delete( + params?: Params$Resource$Crosssitenetworks$Delete, options?: MethodOptions ): GaxiosPromise; - addResourcePolicies( - params: Params$Resource$Disks$Addresourcepolicies, + delete( + params: Params$Resource$Crosssitenetworks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Disks$Addresourcepolicies, + delete( + params: Params$Resource$Crosssitenetworks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addResourcePolicies( - params: Params$Resource$Disks$Addresourcepolicies, + delete( + params: Params$Resource$Crosssitenetworks$Delete, callback: BodyResponseCallback ): void; - addResourcePolicies(callback: BodyResponseCallback): void; - addResourcePolicies( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Disks$Addresourcepolicies + | Params$Resource$Crosssitenetworks$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25546,12 +26464,12 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Disks$Addresourcepolicies; + {}) as Params$Resource$Crosssitenetworks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Disks$Addresourcepolicies; + params = {} as Params$Resource$Crosssitenetworks$Delete; options = {}; } @@ -25566,16 +26484,16 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies' + '/compute/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'disk'], - pathParams: ['disk', 'project', 'zone'], + requiredParams: ['project', 'crossSiteNetwork'], + pathParams: ['crossSiteNetwork', 'project'], context: this.context, }; if (callback) { @@ -25589,62 +26507,57 @@ export namespace compute_beta { } /** - * Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * Returns the specified cross-site network in the given 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. */ - aggregatedList( - params: Params$Resource$Disks$Aggregatedlist, + get( + params: Params$Resource$Crosssitenetworks$Get, options: StreamMethodOptions ): GaxiosPromise; - aggregatedList( - params?: Params$Resource$Disks$Aggregatedlist, + get( + params?: Params$Resource$Crosssitenetworks$Get, options?: MethodOptions - ): GaxiosPromise; - aggregatedList( - params: Params$Resource$Disks$Aggregatedlist, + ): GaxiosPromise; + get( + params: Params$Resource$Crosssitenetworks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - aggregatedList( - params: Params$Resource$Disks$Aggregatedlist, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Disks$Aggregatedlist, - callback: BodyResponseCallback + get( + params: Params$Resource$Crosssitenetworks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - aggregatedList( - callback: BodyResponseCallback + get( + params: Params$Resource$Crosssitenetworks$Get, + callback: BodyResponseCallback ): void; - aggregatedList( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Disks$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Crosssitenetworks$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$Disks$Aggregatedlist; + {}) as Params$Resource$Crosssitenetworks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Disks$Aggregatedlist; + params = {} as Params$Resource$Crosssitenetworks$Get; options = {}; } @@ -25658,7 +26571,8 @@ export namespace compute_beta { options: Object.assign( { url: ( - rootUrl + '/compute/beta/projects/{project}/aggregated/disks' + rootUrl + + '/compute/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -25666,54 +26580,54 @@ export namespace compute_beta { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'crossSiteNetwork'], + pathParams: ['crossSiteNetwork', 'project'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Bulk create a set of disks. + * Creates a cross-site network in the specified project in the given scope using the parameters that are included in the 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. */ - bulkInsert( - params: Params$Resource$Disks$Bulkinsert, + insert( + params: Params$Resource$Crosssitenetworks$Insert, options: StreamMethodOptions ): GaxiosPromise; - bulkInsert( - params?: Params$Resource$Disks$Bulkinsert, + insert( + params?: Params$Resource$Crosssitenetworks$Insert, options?: MethodOptions ): GaxiosPromise; - bulkInsert( - params: Params$Resource$Disks$Bulkinsert, + insert( + params: Params$Resource$Crosssitenetworks$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Disks$Bulkinsert, + insert( + params: Params$Resource$Crosssitenetworks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkInsert( - params: Params$Resource$Disks$Bulkinsert, + insert( + params: Params$Resource$Crosssitenetworks$Insert, callback: BodyResponseCallback ): void; - bulkInsert(callback: BodyResponseCallback): void; - bulkInsert( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Disks$Bulkinsert + | Params$Resource$Crosssitenetworks$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25725,12 +26639,13 @@ export namespace compute_beta { | BodyResponseCallback | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Disks$Bulkinsert; + let params = (paramsOrCallback || + {}) as Params$Resource$Crosssitenetworks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Disks$Bulkinsert; + params = {} as Params$Resource$Crosssitenetworks$Insert; options = {}; } @@ -25745,7 +26660,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/disks/bulkInsert' + '/compute/beta/projects/{project}/global/crossSiteNetworks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -25753,8 +26668,8 @@ export namespace compute_beta { options ), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { @@ -25768,39 +26683,132 @@ export namespace compute_beta { } /** - * Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project. + * Lists the cross-site networks for a project in the given 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. */ - createSnapshot( - params: Params$Resource$Disks$Createsnapshot, + list( + params: Params$Resource$Crosssitenetworks$List, options: StreamMethodOptions ): GaxiosPromise; - createSnapshot( - params?: Params$Resource$Disks$Createsnapshot, + list( + params?: Params$Resource$Crosssitenetworks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Crosssitenetworks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Crosssitenetworks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Crosssitenetworks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Crosssitenetworks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Crosssitenetworks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Crosssitenetworks$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/beta/projects/{project}/global/crossSiteNetworks' + ).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 cross-site network with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Crosssitenetworks$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Crosssitenetworks$Patch, options?: MethodOptions ): GaxiosPromise; - createSnapshot( - params: Params$Resource$Disks$Createsnapshot, + patch( + params: Params$Resource$Crosssitenetworks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createSnapshot( - params: Params$Resource$Disks$Createsnapshot, + patch( + params: Params$Resource$Crosssitenetworks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createSnapshot( - params: Params$Resource$Disks$Createsnapshot, + patch( + params: Params$Resource$Crosssitenetworks$Patch, callback: BodyResponseCallback ): void; - createSnapshot(callback: BodyResponseCallback): void; - createSnapshot( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Disks$Createsnapshot + | Params$Resource$Crosssitenetworks$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25813,12 +26821,12 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Disks$Createsnapshot; + {}) as Params$Resource$Crosssitenetworks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Disks$Createsnapshot; + params = {} as Params$Resource$Crosssitenetworks$Patch; options = {}; } @@ -25833,16 +26841,16 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/disks/{disk}/createSnapshot' + '/compute/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'zone', 'disk'], - pathParams: ['disk', 'project', 'zone'], + requiredParams: ['project', 'crossSiteNetwork'], + pathParams: ['crossSiteNetwork', 'project'], context: this.context, }; if (callback) { @@ -25854,41 +26862,150 @@ export namespace compute_beta { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Crosssitenetworks$Delete + extends StandardParameters { /** - * Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * Name of the cross-site network to delete. + */ + crossSiteNetwork?: 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). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + } + export interface Params$Resource$Crosssitenetworks$Get + extends StandardParameters { + /** + * Name of the cross-site network to return. + */ + crossSiteNetwork?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Crosssitenetworks$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). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + /** + * [Input Only] Validate the new configuration, but don't create it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$CrossSiteNetwork; + } + export interface Params$Resource$Crosssitenetworks$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; + } + export interface Params$Resource$Crosssitenetworks$Patch + extends StandardParameters { + /** + * Name of the cross-site network to update. + */ + crossSiteNetwork?: 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). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + /** + * [Input Only] Validate the new configuration, but don't update it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$CrossSiteNetwork; + } + + export class Resource$Disks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot 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. */ - delete( - params: Params$Resource$Disks$Delete, + addResourcePolicies( + params: Params$Resource$Disks$Addresourcepolicies, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Disks$Delete, + addResourcePolicies( + params?: Params$Resource$Disks$Addresourcepolicies, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Disks$Delete, + addResourcePolicies( + params: Params$Resource$Disks$Addresourcepolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Disks$Delete, + addResourcePolicies( + params: Params$Resource$Disks$Addresourcepolicies, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Disks$Delete, + addResourcePolicies( + params: Params$Resource$Disks$Addresourcepolicies, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( paramsOrCallback?: - | Params$Resource$Disks$Delete + | Params$Resource$Disks$Addresourcepolicies | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25900,12 +27017,13 @@ export namespace compute_beta { | BodyResponseCallback | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Disks$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Addresourcepolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Disks$Delete; + params = {} as Params$Resource$Disks$Addresourcepolicies; options = {}; } @@ -25920,9 +27038,363 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/disks/{disk}' + '/compute/beta/projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves an aggregated list of persistent disks. 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$Disks$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Disks$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Disks$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Disks$Aggregatedlist, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Disks$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Disks$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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/beta/projects/{project}/aggregated/disks' + ).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); + } + } + + /** + * Bulk create a set of disks. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkInsert( + params: Params$Resource$Disks$Bulkinsert, + options: StreamMethodOptions + ): GaxiosPromise; + bulkInsert( + params?: Params$Resource$Disks$Bulkinsert, + options?: MethodOptions + ): GaxiosPromise; + bulkInsert( + params: Params$Resource$Disks$Bulkinsert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkInsert( + params: Params$Resource$Disks$Bulkinsert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkInsert( + params: Params$Resource$Disks$Bulkinsert, + callback: BodyResponseCallback + ): void; + bulkInsert(callback: BodyResponseCallback): void; + bulkInsert( + paramsOrCallback?: + | Params$Resource$Disks$Bulkinsert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disks$Bulkinsert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Bulkinsert; + 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}/zones/{zone}/disks/bulkInsert' + ).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); + } + } + + /** + * Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk 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. + */ + createSnapshot( + params: Params$Resource$Disks$Createsnapshot, + options: StreamMethodOptions + ): GaxiosPromise; + createSnapshot( + params?: Params$Resource$Disks$Createsnapshot, + options?: MethodOptions + ): GaxiosPromise; + createSnapshot( + params: Params$Resource$Disks$Createsnapshot, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSnapshot( + params: Params$Resource$Disks$Createsnapshot, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSnapshot( + params: Params$Resource$Disks$Createsnapshot, + callback: BodyResponseCallback + ): void; + createSnapshot(callback: BodyResponseCallback): void; + createSnapshot( + paramsOrCallback?: + | Params$Resource$Disks$Createsnapshot + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Createsnapshot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Createsnapshot; + 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}/zones/{zone}/disks/{disk}/createSnapshot' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Disks$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Disks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Disks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Disks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Disks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Disks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$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/beta/projects/{project}/zones/{zone}/disks/{disk}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -27509,6 +28981,223 @@ export namespace compute_beta { requestBody?: Schema$Disk; } + export class Resource$Disksettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get Zonal Disk Settings. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Disksettings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Disksettings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Disksettings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Disksettings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Disksettings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Disksettings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Disksettings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disksettings$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/beta/projects/{project}/zones/{zone}/diskSettings' + ).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); + } + } + + /** + * Patch Zonal Disk Settings + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Disksettings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Disksettings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Disksettings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Disksettings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Disksettings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Disksettings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disksettings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disksettings$Patch; + 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}/zones/{zone}/diskSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + 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$Disksettings$Get extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Disksettings$Patch + 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; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DiskSettings; + } + export class Resource$Disktypes { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -46002,6 +47691,94 @@ export namespace compute_beta { } } + /** + * Adds one dynamic network interface to an active 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. + */ + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, + options: StreamMethodOptions + ): GaxiosPromise; + addNetworkInterface( + params?: Params$Resource$Instances$Addnetworkinterface, + options?: MethodOptions + ): GaxiosPromise; + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addNetworkInterface( + params: Params$Resource$Instances$Addnetworkinterface, + callback: BodyResponseCallback + ): void; + addNetworkInterface(callback: BodyResponseCallback): void; + addNetworkInterface( + paramsOrCallback?: + | Params$Resource$Instances$Addnetworkinterface + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Addnetworkinterface; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Addnetworkinterface; + 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}/zones/{zone}/instances/{instance}/addNetworkInterface' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. * @@ -46541,6 +48318,96 @@ export namespace compute_beta { } } + /** + * Deletes one dynamic network interface from an active instance. InstancesDeleteNetworkInterfaceRequest indicates: - instance from which to delete, using project+zone+resource_id fields; - dynamic network interface to be deleted, using network_interface_name field; + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, + options: StreamMethodOptions + ): GaxiosPromise; + deleteNetworkInterface( + params?: Params$Resource$Instances$Deletenetworkinterface, + options?: MethodOptions + ): GaxiosPromise; + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteNetworkInterface( + params: Params$Resource$Instances$Deletenetworkinterface, + callback: BodyResponseCallback + ): void; + deleteNetworkInterface( + callback: BodyResponseCallback + ): void; + deleteNetworkInterface( + paramsOrCallback?: + | Params$Resource$Instances$Deletenetworkinterface + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Deletenetworkinterface; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Deletenetworkinterface; + 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}/zones/{zone}/instances/{instance}/deleteNetworkInterface' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterfaceName'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Detaches a disk from an instance. * @@ -47984,6 +49851,94 @@ export namespace compute_beta { } } + /** + * Mark the host as faulty and try to restart the instance on a new host. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: StreamMethodOptions + ): GaxiosPromise; + reportHostAsFaulty( + params?: Params$Resource$Instances$Reporthostasfaulty, + options?: MethodOptions + ): GaxiosPromise; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty(callback: BodyResponseCallback): void; + reportHostAsFaulty( + paramsOrCallback?: + | Params$Resource$Instances$Reporthostasfaulty + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Reporthostasfaulty; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Reporthostasfaulty; + 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}/zones/{zone}/instances/{instance}/reportHostAsFaulty' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance. * @@ -50676,6 +52631,30 @@ export namespace compute_beta { */ requestBody?: Schema$AccessConfig; } + export interface Params$Resource$Instances$Addnetworkinterface + extends StandardParameters { + /** + * The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + */ + instance?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkInterface; + } export interface Params$Resource$Instances$Addresourcepolicies extends StandardParameters { /** @@ -50832,6 +52811,29 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Instances$Deletenetworkinterface + extends StandardParameters { + /** + * The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer. + */ + instance?: string; + /** + * The name of the dynamic network interface to be deleted from the instance. + */ + networkInterfaceName?: 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$Instances$Detachdisk extends StandardParameters { /** @@ -51184,6 +53186,30 @@ export namespace compute_beta { */ requestBody?: Schema$InstancesRemoveResourcePoliciesRequest; } + export interface Params$Resource$Instances$Reporthostasfaulty + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesReportHostAsFaultyRequest; + } export interface Params$Resource$Instances$Reset extends StandardParameters { /** * Name of the instance scoping this request. @@ -67975,7 +70001,7 @@ export namespace compute_beta { } /** - * Inserts an association for the specified security policy. + * Inserts an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68152,7 +70178,7 @@ export namespace compute_beta { } /** - * Copies rules to the specified security policy. + * Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68240,7 +70266,7 @@ export namespace compute_beta { } /** - * Deletes the specified policy. + * Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68328,7 +70354,7 @@ export namespace compute_beta { } /** - * List all of the ordered rules present in a single specified policy. + * List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68416,7 +70442,7 @@ export namespace compute_beta { } /** - * Gets an association with the specified name. + * Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68512,7 +70538,7 @@ export namespace compute_beta { } /** - * Gets a rule at the specified priority. + * Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68603,7 +70629,7 @@ export namespace compute_beta { } /** - * Creates a new policy in the specified project using the data included in the request. + * Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68690,7 +70716,7 @@ export namespace compute_beta { } /** - * List all the policies that have been configured for the specified project. + * List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68780,7 +70806,7 @@ export namespace compute_beta { } /** - * Lists associations of a specified target, i.e., organization or folder. + * Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68976,7 +71002,7 @@ export namespace compute_beta { } /** - * Moves the specified security policy. + * Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -69064,7 +71090,7 @@ export namespace compute_beta { } /** - * Patches the specified policy with the data included in the request. + * Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -69152,7 +71178,7 @@ export namespace compute_beta { } /** - * Patches a rule at the specified priority. + * Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -69240,7 +71266,7 @@ export namespace compute_beta { } /** - * Removes an association for the specified security policy. + * Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -76317,7 +78343,7 @@ export namespace compute_beta { } /** - * Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew. + * Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -76405,7 +78431,7 @@ export namespace compute_beta { } /** - * Transfers GPUs or local SSDs between reservations within commitments. + * Transfers GPUs or Local SSD disks between reservations that are attached to the same commitment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -76617,7 +78643,7 @@ export namespace compute_beta { export interface Params$Resource$Regioncommitments$Update extends StandardParameters { /** - * Name of the commitment for which auto renew is being updated. + * Name of the commitment that you want to update. */ commitment?: string; /** @@ -76649,7 +78675,7 @@ export namespace compute_beta { export interface Params$Resource$Regioncommitments$Updatereservations extends StandardParameters { /** - * Name of the commitment for which the reservation is being updated. + * Name of the commitment for which the reservations are being updated. */ commitment?: string; /** @@ -78569,6 +80595,225 @@ export namespace compute_beta { requestBody?: Schema$Disk; } + export class Resource$Regiondisksettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get Regional Disk Settings. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regiondisksettings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regiondisksettings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regiondisksettings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiondisksettings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regiondisksettings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regiondisksettings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisksettings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisksettings$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/beta/projects/{project}/regions/{region}/diskSettings' + ).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); + } + } + + /** + * Patch Regional Disk Settings + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regiondisksettings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Regiondisksettings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regiondisksettings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regiondisksettings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regiondisksettings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regiondisksettings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiondisksettings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisksettings$Patch; + 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}/regions/{region}/diskSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + 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$Regiondisksettings$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regiondisksettings$Patch + 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; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DiskSettings; + } + export class Resource$Regiondisktypes { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -91606,6 +93851,1112 @@ export namespace compute_beta { requestBody?: Schema$RegionSetLabelsRequest; } + export class Resource$Regionsnapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionsnapshots$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Regionsnapshots$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionsnapshots$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionsnapshots$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionsnapshots$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$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/beta/projects/{project}/regions/{region}/snapshots/{snapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'snapshot'], + pathParams: ['project', 'region', 'snapshot'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified Snapshot 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$Regionsnapshots$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regionsnapshots$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionsnapshots$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionsnapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionsnapshots$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$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/beta/projects/{project}/regions/{region}/snapshots/{snapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'snapshot'], + pathParams: ['project', 'region', 'snapshot'], + 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$Regionsnapshots$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Regionsnapshots$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Regionsnapshots$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regionsnapshots$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regionsnapshots$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$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/beta/projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a snapshot in the specified region using the data included in the 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. + */ + insert( + params: Params$Resource$Regionsnapshots$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regionsnapshots$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionsnapshots$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionsnapshots$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionsnapshots$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$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/beta/projects/{project}/regions/{region}/snapshots' + ).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 Snapshot 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$Regionsnapshots$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regionsnapshots$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionsnapshots$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionsnapshots$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionsnapshots$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$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/beta/projects/{project}/regions/{region}/snapshots' + ).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); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing 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. + */ + setIamPolicy( + params: Params$Resource$Regionsnapshots$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Regionsnapshots$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Regionsnapshots$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regionsnapshots$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regionsnapshots$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$Setiampolicy; + 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}/regions/{region}/snapshots/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setLabels( + params: Params$Resource$Regionsnapshots$Setlabels, + options: StreamMethodOptions + ): GaxiosPromise; + setLabels( + params?: Params$Resource$Regionsnapshots$Setlabels, + options?: MethodOptions + ): GaxiosPromise; + setLabels( + params: Params$Resource$Regionsnapshots$Setlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Regionsnapshots$Setlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setLabels( + params: Params$Resource$Regionsnapshots$Setlabels, + callback: BodyResponseCallback + ): void; + setLabels(callback: BodyResponseCallback): void; + setLabels( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$Setlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$Setlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$Setlabels; + 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}/regions/{region}/snapshots/{resource}/setLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', '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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionsnapshots$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Regionsnapshots$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionsnapshots$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionsnapshots$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionsnapshots$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionsnapshots$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshots$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshots$Testiampermissions; + 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}/regions/{region}/snapshots/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionsnapshots$Delete + extends StandardParameters { + /** + * 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; + /** + * Name of the snapshot resource to delete. + */ + snapshot?: string; + } + export interface Params$Resource$Regionsnapshots$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Snapshot resource to return. + */ + snapshot?: string; + } + export interface Params$Resource$Regionsnapshots$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regionsnapshots$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$Snapshot; + } + export interface Params$Resource$Regionsnapshots$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 interface Params$Resource$Regionsnapshots$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regionsnapshots$Setlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * 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; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetLabelsRequest; + } + export interface Params$Resource$Regionsnapshots$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionsnapshotsettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get region snapshot settings. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionsnapshotsettings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regionsnapshotsettings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionsnapshotsettings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionsnapshotsettings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionsnapshotsettings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionsnapshotsettings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshotsettings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshotsettings$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/beta/projects/{project}/regions/{region}/snapshotSettings' + ).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); + } + } + + /** + * Patch region snapshot settings. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionsnapshotsettings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Regionsnapshotsettings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionsnapshotsettings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionsnapshotsettings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionsnapshotsettings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionsnapshotsettings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsnapshotsettings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsnapshotsettings$Patch; + 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}/regions/{region}/snapshotSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + 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$Regionsnapshotsettings$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regionsnapshotsettings$Patch + 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; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SnapshotSettings; + } + export class Resource$Regionsslcertificates { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -96239,222 +99590,368 @@ export namespace compute_beta { */ project?: string; /** - * Region for this request. + * 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$Reservationblocks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves information about the specified reservation block. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reservationblocks$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Reservationblocks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Reservationblocks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reservationblocks$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reservationblocks$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Reservationblocks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationblocks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationblocks$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/beta/projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation', 'reservationBlock'], + pathParams: ['project', 'reservation', 'reservationBlock', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Retrieves a list of reservation blocks under a single 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. + */ + list( + params: Params$Resource$Reservationblocks$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Reservationblocks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Reservationblocks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reservationblocks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reservationblocks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Reservationblocks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationblocks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationblocks$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/beta/projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation'], + pathParams: ['project', 'reservation', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Allows customers to perform maintenance on a reservation block + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + performMaintenance( + params: Params$Resource$Reservationblocks$Performmaintenance, + options: StreamMethodOptions + ): GaxiosPromise; + performMaintenance( + params?: Params$Resource$Reservationblocks$Performmaintenance, + options?: MethodOptions + ): GaxiosPromise; + performMaintenance( + params: Params$Resource$Reservationblocks$Performmaintenance, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Reservationblocks$Performmaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Reservationblocks$Performmaintenance, + callback: BodyResponseCallback + ): void; + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( + paramsOrCallback?: + | Params$Resource$Reservationblocks$Performmaintenance + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationblocks$Performmaintenance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationblocks$Performmaintenance; + 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}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation', 'reservationBlock'], + pathParams: ['project', 'reservation', 'reservationBlock', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reservationblocks$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the reservation. Name should conform to RFC1035 or be a resource ID. + */ + reservation?: string; + /** + * The name of the reservation block. Name should conform to RFC1035 or be a resource ID. + */ + reservationBlock?: string; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Reservationblocks$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 reservation. Name should conform to RFC1035 or be a resource ID. */ - region?: string; + reservation?: 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$Reservationblocks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Retrieves information about the specified reservation block. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Reservationblocks$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Reservationblocks$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Reservationblocks$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reservationblocks$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reservationblocks$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Reservationblocks$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Reservationblocks$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reservationblocks$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/beta/projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'reservation', 'reservationBlock'], - pathParams: ['project', 'reservation', 'reservationBlock', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** - * Retrieves a list of reservation blocks under a single 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. + * Name of the zone for this request. Zone name should conform to RFC1035. */ - list( - params: Params$Resource$Reservationblocks$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Reservationblocks$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Reservationblocks$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reservationblocks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reservationblocks$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Reservationblocks$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Reservationblocks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reservationblocks$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/beta/projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'reservation'], - pathParams: ['project', 'reservation', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } + zone?: string; } - - export interface Params$Resource$Reservationblocks$Get + export interface Params$Resource$Reservationblocks$Performmaintenance 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; /** * The name of the reservation. Name should conform to RFC1035 or be a resource ID. */ @@ -96467,41 +99964,11 @@ export namespace compute_beta { * Name of the zone for this request. Zone name should conform to RFC1035. */ zone?: string; - } - export interface Params$Resource$Reservationblocks$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 reservation. Name should conform to RFC1035 or be a resource ID. - */ - reservation?: 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. Zone name should conform to RFC1035. + * Request body metadata */ - zone?: string; + requestBody?: Schema$ReservationsBlocksPerformMaintenanceRequest; } export class Resource$Reservations { @@ -97044,6 +100511,94 @@ export namespace compute_beta { } } + /** + * Perform maintenance on an extended 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. + */ + performMaintenance( + params: Params$Resource$Reservations$Performmaintenance, + options: StreamMethodOptions + ): GaxiosPromise; + performMaintenance( + params?: Params$Resource$Reservations$Performmaintenance, + options?: MethodOptions + ): GaxiosPromise; + performMaintenance( + params: Params$Resource$Reservations$Performmaintenance, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Reservations$Performmaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Reservations$Performmaintenance, + callback: BodyResponseCallback + ): void; + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( + paramsOrCallback?: + | Params$Resource$Reservations$Performmaintenance + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Performmaintenance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$Performmaintenance; + 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}/zones/{zone}/reservations/{reservation}/performMaintenance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation'], + pathParams: ['project', 'reservation', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. * @@ -97542,6 +101097,30 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Reservations$Performmaintenance + 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; + /** + * The name of the reservation. Name should conform to RFC1035 or be a resource ID. + */ + reservation?: string; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReservationsPerformMaintenanceRequest; + } export interface Params$Resource$Reservations$Resize extends StandardParameters { /** @@ -103780,6 +107359,100 @@ export namespace compute_beta { this.context = context; } + /** + * Retrieves an aggregated list of all of the snapshots in your project across all regions and global scope. 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$Snapshots$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Snapshots$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Snapshots$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Snapshots$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Snapshots$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Snapshots$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Snapshots$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$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/beta/projects/{project}/aggregated/snapshots' + ).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 Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. * @@ -104486,6 +108159,41 @@ export namespace compute_beta { } } + export interface Params$Resource$Snapshots$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$Snapshots$Delete extends StandardParameters { /** * Project ID for this request. @@ -120011,6 +123719,569 @@ export namespace compute_beta { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Wiregroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified wire group in the given 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. + */ + delete( + params: Params$Resource$Wiregroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Wiregroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Wiregroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Wiregroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Wiregroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Wiregroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Wiregroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Wiregroups$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/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'crossSiteNetwork', 'wireGroup'], + pathParams: ['crossSiteNetwork', 'project', 'wireGroup'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the specified wire group resource in the given 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$Wiregroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Wiregroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Wiregroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Wiregroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Wiregroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Wiregroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Wiregroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Wiregroups$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/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'crossSiteNetwork', 'wireGroup'], + pathParams: ['crossSiteNetwork', 'project', 'wireGroup'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a wire group in the specified project in the given scope using the parameters that are included in the 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. + */ + insert( + params: Params$Resource$Wiregroups$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Wiregroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Wiregroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Wiregroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Wiregroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Wiregroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Wiregroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Wiregroups$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/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'crossSiteNetwork'], + pathParams: ['crossSiteNetwork', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the wire groups for a project in the given 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. + */ + list( + params: Params$Resource$Wiregroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Wiregroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Wiregroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Wiregroups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Wiregroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Wiregroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Wiregroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Wiregroups$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/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'crossSiteNetwork'], + pathParams: ['crossSiteNetwork', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the specified wire group resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Wiregroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Wiregroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Wiregroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Wiregroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Wiregroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Wiregroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Wiregroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Wiregroups$Patch; + 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/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'crossSiteNetwork', 'wireGroup'], + pathParams: ['crossSiteNetwork', 'project', 'wireGroup'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Wiregroups$Delete + extends StandardParameters { + /** + * + */ + crossSiteNetwork?: 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). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + /** + * Name of the wire group resource to delete. + */ + wireGroup?: string; + } + export interface Params$Resource$Wiregroups$Get extends StandardParameters { + /** + * + */ + crossSiteNetwork?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the wire group resource to return. + */ + wireGroup?: string; + } + export interface Params$Resource$Wiregroups$Insert + extends StandardParameters { + /** + * + */ + crossSiteNetwork?: 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). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + /** + * [Input Only] Validate the new configuration, but don't create it. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$WireGroup; + } + export interface Params$Resource$Wiregroups$List extends StandardParameters { + /** + * + */ + crossSiteNetwork?: string; + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based 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$Wiregroups$Patch extends StandardParameters { + /** + * + */ + crossSiteNetwork?: 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). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + /** + * [Input Only] Validate the new configuration, but don't update it. + */ + validateOnly?: boolean; + /** + * Name of the WireGroups resource to patch. + */ + wireGroup?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WireGroup; + } + export class Resource$Zoneoperations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index f56dcdc82cd..1c1bcadc281 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -799,6 +799,12 @@ export namespace compute_v1 { */ acceleratorType?: string | null; } + export interface Schema$AllocationReservationSharingPolicy { + /** + * Sharing config for all Google Cloud services. + */ + serviceShareType?: string | null; + } /** * [Output Only] Contains output only fields. */ @@ -816,6 +822,10 @@ export namespace compute_v1 { * 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 { /** @@ -1377,6 +1387,10 @@ export namespace compute_v1 { * 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. + */ + customMetrics?: Schema$BackendCustomMetric[]; /** * An optional description of this resource. Provide this property when you create the resource. */ @@ -1606,6 +1620,23 @@ export namespace compute_v1 { */ reference?: string | null; } + /** + * Custom Metrics are used for CUSTOM_METRICS balancing_mode. + */ + 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 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/v1/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services. */ @@ -1640,6 +1671,10 @@ export namespace compute_v1 { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; + /** + * List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. + */ + customMetrics?: Schema$BackendServiceCustomMetric[]; /** * Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). */ @@ -1911,6 +1946,19 @@ export namespace compute_v1 { */ trackingMode?: string | null; } + /** + * Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. + */ + export interface Schema$BackendServiceCustomMetric { + /** + * If true, the metric data is not used for load balancing. + */ + dryRun?: boolean | null; + /** + * Name of a custom utilization signal. 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; + } /** * 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). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). */ @@ -2248,6 +2296,51 @@ export namespace compute_v1 { */ numTx?: number | null; } + export interface Schema$BgpRoute { + /** + * [Output only] AS-PATH for the route + */ + asPaths?: Schema$BgpRouteAsPath[]; + /** + * [Output only] BGP communities in human-readable A:B format. + */ + communities?: string[] | null; + /** + * [Output only] Destination IP range for the route, in human-readable CIDR format + */ + destination?: Schema$BgpRouteNetworkLayerReachabilityInformation; + /** + * [Output only] BGP multi-exit discriminator + */ + med?: number | null; + /** + * [Output only] BGP origin (EGP, IGP or INCOMPLETE) + */ + origin?: string | null; + } + export interface Schema$BgpRouteAsPath { + /** + * [Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered. + */ + asns?: number[] | null; + /** + * [Output only] Type of AS-PATH segment (SEQUENCE or SET) + */ + type?: string | null; + } + /** + * Network Layer Reachability Information (NLRI) for a route. + */ + export interface Schema$BgpRouteNetworkLayerReachabilityInformation { + /** + * If the BGP session supports multiple paths (RFC 7911), the path identifier for this route. + */ + pathId?: number | null; + /** + * Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16. + */ + prefix?: string | null; + } /** * Associates `members`, or principals, with a `role`. */ @@ -2410,15 +2503,15 @@ export namespace compute_v1 { maxRetries?: number | null; } /** - * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. + * Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts */ export interface Schema$Commitment { /** - * Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. + * Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027. */ autoRenew?: boolean | null; /** - * The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + * The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to. */ category?: string | null; /** @@ -2426,20 +2519,17 @@ export namespace compute_v1 { */ 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. + * [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment'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. + * An optional description of the commitment. You can provide this property when you create the resource. */ description?: string | null; /** * [Output Only] Commitment end time in RFC3339 text format. */ endTimestamp?: string | null; - /** - * Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation - */ existingReservations?: string[] | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. @@ -2454,27 +2544,27 @@ export namespace compute_v1 { */ licenseResource?: Schema$LicenseResourceCommitment; /** - * List of source commitments to be merged into a new commitment. + * The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments. */ mergeSourceCommitments?: string[] | null; /** - * 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 of the commitment. You must specify a name when you purchase the commitment. 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; /** - * The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). + * The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). */ plan?: string | null; /** - * [Output Only] URL of the region where this commitment may be used. + * [Output Only] URL of the region where the commitment and committed resources are located. */ region?: string | null; /** - * List of create-on-create reservations for this commitment. + * The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead. */ reservations?: Schema$Reservation[]; /** - * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. + * The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type. */ resources?: Schema$ResourceCommitment[]; /** @@ -2486,7 +2576,7 @@ export namespace compute_v1 { */ selfLink?: string | null; /** - * Source commitment to be split into a new commitment. + * The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments. */ splitSourceCommitment?: string | null; /** @@ -2494,7 +2584,7 @@ export namespace compute_v1 { */ startTimestamp?: string | null; /** - * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. + * [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. */ status?: string | null; /** @@ -2502,7 +2592,7 @@ export namespace compute_v1 { */ statusMessage?: string | null; /** - * The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. + * The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series. */ type?: string | null; } @@ -2584,7 +2674,7 @@ export namespace compute_v1 { } export interface Schema$CommitmentsScopedList { /** - * [Output Only] A list of commitments contained in this scope. + * [Output Only] The list of commitments contained in this scope. */ commitments?: Schema$Commitment[]; /** @@ -3721,6 +3811,10 @@ export namespace compute_v1 { * 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. */ @@ -5892,6 +5986,10 @@ export namespace compute_v1 { * [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. */ @@ -6238,6 +6336,12 @@ export namespace compute_v1 { }>; } | 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]. @@ -6889,6 +6993,10 @@ export namespace compute_v1 { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output Only] The packet mirroring rules that apply to the instance. + */ + packetMirroringRules?: Schema$FirewallPolicyRule[]; /** * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. */ @@ -6912,6 +7020,17 @@ export namespace compute_v1 { */ resourcePolicies?: string[] | null; } + export interface Schema$InstancesReportHostAsFaultyRequest { + /** + * The disruption schedule for the VM. Default to IMMEDIATE. + */ + disruptionSchedule?: string | null; + faultReasons?: Schema$InstancesReportHostAsFaultyRequestFaultReason[]; + } + export interface Schema$InstancesReportHostAsFaultyRequestFaultReason { + behavior?: string | null; + description?: string | null; + } export interface Schema$InstancesScopedList { /** * [Output Only] A list of instances contained in this scope. @@ -8353,15 +8472,15 @@ export namespace compute_v1 { */ export interface Schema$LicenseResourceCommitment { /** - * The number of licenses purchased. + * The number of licenses you plan to purchase. */ amount?: string | null; /** - * Specifies the core range of the instance for which this license applies. + * The number of cores per license. */ coresPerLicense?: string | null; /** - * Any applicable license URI. + * The applicable license URI. */ license?: string | null; } @@ -9801,10 +9920,6 @@ export namespace compute_v1 { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string | null; - /** - * [Output Only] Zone to which the network is restricted. - */ - zone?: string | null; } export interface Schema$NetworkProfileLocation { name?: string | null; @@ -10004,6 +10119,10 @@ export namespace compute_v1 { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output Only] The packet mirroring rules that apply to the network. + */ + packetMirroringRules?: Schema$FirewallPolicyRule[]; /** * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. */ @@ -10506,6 +10625,10 @@ export namespace compute_v1 { * [Output Only] Local SSD available to the node type, defined in GB. */ localSsdGb?: number | null; + /** + * [Output Only] Maximum number of VMs that can be created for this node type. + */ + maxVms?: number | null; /** * [Output Only] The amount of physical memory available to the node type, defined in MB. */ @@ -12339,6 +12462,14 @@ export namespace compute_v1 { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output only] The packet mirroring rules that apply to the network. + */ + packetMirroringRules?: Schema$FirewallPolicyRule[]; + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + */ + priority?: number | null; /** * [Output only] The rules that apply to the network. */ @@ -12425,6 +12556,10 @@ export namespace compute_v1 { * 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. */ @@ -12567,19 +12702,19 @@ export namespace compute_v1 { } | null; } /** - * Commitment for a particular resource (a Commitment is composed of one or more of these). + * Commitment for a particular hardware resource (a commitment is composed of one or more of these). */ export interface Schema$ResourceCommitment { /** - * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. + * Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR. */ acceleratorType?: string | null; /** - * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. + * The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. */ amount?: string | null; /** - * Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + * The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type. */ type?: string | null; } @@ -12921,9 +13056,34 @@ export namespace compute_v1 { * [Output Only] The precise location of your instance within the zone's data center, including the block, sub-block, and host. The field is formatted as follows: blockId/subBlockId/hostId. */ physicalHost?: string | null; + /** + * [Output Only] A series of fields containing the global name of the Compute Engine cluster, as well as the ID of the block, sub-block, and host on which the running instance is located. + */ + physicalHostTopology?: Schema$ResourceStatusPhysicalHostTopology; scheduling?: Schema$ResourceStatusScheduling; upcomingMaintenance?: Schema$UpcomingMaintenance; } + /** + * Represents the physical host topology of the host on which the VM is running. + */ + export interface Schema$ResourceStatusPhysicalHostTopology { + /** + * [Output Only] The ID of the block in which the running instance is located. Instances within the same block experience low network latency. + */ + block?: string | null; + /** + * [Output Only] The global name of the Compute Engine cluster where the running instance is located. + */ + cluster?: string | null; + /** + * [Output Only] The ID of the host on which the running instance is located. Instances on the same host experience the lowest possible network latency. + */ + host?: string | null; + /** + * [Output Only] The ID of the sub-block in which the running instance is located. Instances in the same sub-block experience lower network latency than instances in the same block. + */ + subblock?: string | null; + } 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. @@ -13082,6 +13242,39 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$RoutePolicy { + /** + * An optional description of route policy. + */ + description?: string | null; + /** + * A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy. + */ + fingerprint?: string | null; + /** + * Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035. + */ + name?: string | null; + /** + * List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later. + */ + terms?: Schema$RoutePolicyPolicyTerm[]; + type?: string | null; + } + export interface Schema$RoutePolicyPolicyTerm { + /** + * CEL expressions to evaluate to modify a route when this term matches. + */ + actions?: Schema$Expr[]; + /** + * CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes. + */ + match?: Schema$Expr; + /** + * The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list. + */ + priority?: number | null; + } /** * Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview. */ @@ -13261,11 +13454,11 @@ export namespace compute_v1 { */ enableIpv6?: boolean | null; /** - * List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + * List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. */ exportPolicies?: string[] | null; /** - * List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies. + * List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. */ importPolicies?: string[] | null; /** @@ -13343,7 +13536,7 @@ export namespace compute_v1 { } export interface Schema$RouterInterface { /** - * IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. + * IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. */ ipRange?: string | null; /** @@ -13570,6 +13763,79 @@ export namespace compute_v1 { */ sourceIpRangesToNat?: string[] | null; } + export interface Schema$RoutersGetRoutePolicyResponse { + resource?: Schema$RoutePolicy; + } + export interface Schema$RoutersListBgpRoutes { + etag?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes. + */ + 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] A list of bgp routes. + */ + result?: Schema$BgpRoute[]; + /** + * [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$RoutersListRoutePolicies { + etag?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#routersListRoutePolicies for lists of route policies. + */ + 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] A list of route policies. + */ + result?: Schema$RoutePolicy[]; + /** + * [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$RoutersPreviewResponse { /** * Preview of given router. @@ -13878,6 +14144,10 @@ export namespace compute_v1 { * 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. + */ + hostErrorTimeoutSeconds?: number | null; /** * Specifies the termination action for the instance. */ @@ -14977,7 +15247,7 @@ export namespace compute_v1 { */ sourceInstantSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** - * [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. + * [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. */ sourceInstantSnapshotId?: string | null; /** @@ -16030,6 +16300,10 @@ export namespace compute_v1 { * The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. */ ipCidrRange?: string | null; + /** + * Reference to the source of IP, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack subnetwork with external access using BYOIP: - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/sub-pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/ sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name + */ + ipCollection?: string | null; /** * The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. */ @@ -16038,6 +16312,10 @@ export namespace compute_v1 { * [Output Only] This field is for internal use. */ ipv6CidrRange?: string | null; + /** + * [Output Only] Possible endpoints of this subnetwork. It can be one of the following: - VM_ONLY: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb. - VM_AND_FR: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly. + */ + ipv6GceEndpoint?: string | null; /** * [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. */ @@ -16063,7 +16341,7 @@ export namespace compute_v1 { */ privateIpv6GoogleAccess?: string | null; /** - * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. */ purpose?: string | null; /** @@ -16536,7 +16814,7 @@ export namespace compute_v1 { */ selfLink?: string | null; /** - * Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. + * Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED or INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy attached to regional forwardingRules with the loadBalancingScheme set to EXTERNAL_MANAGED or INTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, INTERNAL_MANAGED, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. */ serverTlsPolicy?: string | null; /** @@ -17682,7 +17960,7 @@ export namespace compute_v1 { */ network?: string | null; /** - * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + * The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. */ purpose?: string | null; /** @@ -43066,6 +43344,94 @@ export namespace compute_v1 { } } + /** + * Mark the host as faulty and try to restart the instance on a new host. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: StreamMethodOptions + ): GaxiosPromise; + reportHostAsFaulty( + params?: Params$Resource$Instances$Reporthostasfaulty, + options?: MethodOptions + ): GaxiosPromise; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty(callback: BodyResponseCallback): void; + reportHostAsFaulty( + paramsOrCallback?: + | Params$Resource$Instances$Reporthostasfaulty + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Reporthostasfaulty; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Reporthostasfaulty; + 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}/instances/{instance}/reportHostAsFaulty' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance. * @@ -46016,6 +46382,30 @@ export namespace compute_v1 { */ requestBody?: Schema$InstancesRemoveResourcePoliciesRequest; } + export interface Params$Resource$Instances$Reporthostasfaulty + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesReportHostAsFaultyRequest; + } export interface Params$Resource$Instances$Reset extends StandardParameters { /** * Name of the instance scoping this request. @@ -55779,6 +56169,97 @@ export namespace compute_v1 { } } + /** + * 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$Networkfirewallpolicies$Addpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + addPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkfirewallpolicies$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/v1/projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule' + ).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); + } + } + /** * Inserts a rule into a firewall policy. * @@ -56411,6 +56892,100 @@ export namespace compute_v1 { } } + /** + * 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/v1/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. * @@ -56768,39 +57343,41 @@ export namespace compute_v1 { } /** - * 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$Networkfirewallpolicies$Patchrule, + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, options: StreamMethodOptions ): GaxiosPromise; - patchRule( - params?: Params$Resource$Networkfirewallpolicies$Patchrule, + patchPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, options?: MethodOptions ): GaxiosPromise; - patchRule( - params: Params$Resource$Networkfirewallpolicies$Patchrule, + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Networkfirewallpolicies$Patchrule, + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Networkfirewallpolicies$Patchrule, + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, callback: BodyResponseCallback ): void; - patchRule(callback: BodyResponseCallback): void; - patchRule( + patchPacketMirroringRule( + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Patchrule + | Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56813,12 +57390,13 @@ export namespace compute_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Patchrule; + {}) as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Patchrule; + params = + {} as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; options = {}; } @@ -56833,7 +57411,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule' + '/compute/v1/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -56856,39 +57434,39 @@ export namespace compute_v1 { } /** - * Removes an association for the specified firewall policy. + * 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. */ - removeAssociation( - params: Params$Resource$Networkfirewallpolicies$Removeassociation, + patchRule( + params: Params$Resource$Networkfirewallpolicies$Patchrule, options: StreamMethodOptions ): GaxiosPromise; - removeAssociation( - params?: Params$Resource$Networkfirewallpolicies$Removeassociation, + patchRule( + params?: Params$Resource$Networkfirewallpolicies$Patchrule, options?: MethodOptions ): GaxiosPromise; - removeAssociation( - params: Params$Resource$Networkfirewallpolicies$Removeassociation, + patchRule( + params: Params$Resource$Networkfirewallpolicies$Patchrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Networkfirewallpolicies$Removeassociation, + patchRule( + params: Params$Resource$Networkfirewallpolicies$Patchrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeAssociation( - params: Params$Resource$Networkfirewallpolicies$Removeassociation, + patchRule( + params: Params$Resource$Networkfirewallpolicies$Patchrule, callback: BodyResponseCallback ): void; - removeAssociation(callback: BodyResponseCallback): void; - removeAssociation( + patchRule(callback: BodyResponseCallback): void; + patchRule( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Removeassociation + | Params$Resource$Networkfirewallpolicies$Patchrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56901,13 +57479,12 @@ export namespace compute_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Removeassociation; + {}) as Params$Resource$Networkfirewallpolicies$Patchrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Networkfirewallpolicies$Removeassociation; + params = {} as Params$Resource$Networkfirewallpolicies$Patchrule; options = {}; } @@ -56922,7 +57499,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation' + '/compute/v1/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -56945,39 +57522,39 @@ export namespace compute_v1 { } /** - * Deletes a rule of the specified priority. + * Removes an association for 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. */ - removeRule( - params: Params$Resource$Networkfirewallpolicies$Removerule, + removeAssociation( + params: Params$Resource$Networkfirewallpolicies$Removeassociation, options: StreamMethodOptions ): GaxiosPromise; - removeRule( - params?: Params$Resource$Networkfirewallpolicies$Removerule, + removeAssociation( + params?: Params$Resource$Networkfirewallpolicies$Removeassociation, options?: MethodOptions ): GaxiosPromise; - removeRule( - params: Params$Resource$Networkfirewallpolicies$Removerule, + removeAssociation( + params: Params$Resource$Networkfirewallpolicies$Removeassociation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Networkfirewallpolicies$Removerule, + removeAssociation( + params: Params$Resource$Networkfirewallpolicies$Removeassociation, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeRule( - params: Params$Resource$Networkfirewallpolicies$Removerule, + removeAssociation( + params: Params$Resource$Networkfirewallpolicies$Removeassociation, callback: BodyResponseCallback ): void; - removeRule(callback: BodyResponseCallback): void; - removeRule( + removeAssociation(callback: BodyResponseCallback): void; + removeAssociation( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Removerule + | Params$Resource$Networkfirewallpolicies$Removeassociation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56990,12 +57567,13 @@ export namespace compute_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Removerule; + {}) as Params$Resource$Networkfirewallpolicies$Removeassociation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Removerule; + params = + {} as Params$Resource$Networkfirewallpolicies$Removeassociation; options = {}; } @@ -57010,7 +57588,186 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule' + '/compute/v1/projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation' + ).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 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/v1/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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeRule( + params: Params$Resource$Networkfirewallpolicies$Removerule, + options: StreamMethodOptions + ): GaxiosPromise; + removeRule( + params?: Params$Resource$Networkfirewallpolicies$Removerule, + options?: MethodOptions + ): GaxiosPromise; + removeRule( + params: Params$Resource$Networkfirewallpolicies$Removerule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Networkfirewallpolicies$Removerule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Networkfirewallpolicies$Removerule, + callback: BodyResponseCallback + ): void; + removeRule(callback: BodyResponseCallback): void; + removeRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Removerule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Removerule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkfirewallpolicies$Removerule; + 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}/global/firewallPolicies/{firewallPolicy}/removeRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -57241,6 +57998,34 @@ export namespace compute_v1 { */ 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 { /** @@ -57379,6 +58164,21 @@ export namespace compute_v1 { */ 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 { /** @@ -57457,6 +58257,30 @@ export namespace compute_v1 { */ 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 { /** @@ -57500,6 +58324,25 @@ export namespace compute_v1 { */ 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 { /** @@ -68271,7 +69114,7 @@ export namespace compute_v1 { } /** - * Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew. + * Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -68463,7 +69306,7 @@ export namespace compute_v1 { export interface Params$Resource$Regioncommitments$Update extends StandardParameters { /** - * Name of the commitment for which auto renew is being updated. + * Name of the commitment that you want to update. */ commitment?: string; /** @@ -87613,6 +88456,94 @@ export namespace compute_v1 { } } + /** + * Deletes Route 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. + */ + deleteRoutePolicy( + params: Params$Resource$Routers$Deleteroutepolicy, + options: StreamMethodOptions + ): GaxiosPromise; + deleteRoutePolicy( + params?: Params$Resource$Routers$Deleteroutepolicy, + options?: MethodOptions + ): GaxiosPromise; + deleteRoutePolicy( + params: Params$Resource$Routers$Deleteroutepolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteRoutePolicy( + params: Params$Resource$Routers$Deleteroutepolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteRoutePolicy( + params: Params$Resource$Routers$Deleteroutepolicy, + callback: BodyResponseCallback + ): void; + deleteRoutePolicy(callback: BodyResponseCallback): void; + deleteRoutePolicy( + paramsOrCallback?: + | Params$Resource$Routers$Deleteroutepolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Deleteroutepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Deleteroutepolicy; + 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}/regions/{region}/routers/{router}/deleteRoutePolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns the specified Router resource. * @@ -87888,6 +88819,103 @@ export namespace compute_v1 { } } + /** + * Returns specified Route 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. + */ + getRoutePolicy( + params: Params$Resource$Routers$Getroutepolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getRoutePolicy( + params?: Params$Resource$Routers$Getroutepolicy, + options?: MethodOptions + ): GaxiosPromise; + getRoutePolicy( + params: Params$Resource$Routers$Getroutepolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRoutePolicy( + params: Params$Resource$Routers$Getroutepolicy, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRoutePolicy( + params: Params$Resource$Routers$Getroutepolicy, + callback: BodyResponseCallback + ): void; + getRoutePolicy( + callback: BodyResponseCallback + ): void; + getRoutePolicy( + paramsOrCallback?: + | Params$Resource$Routers$Getroutepolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Getroutepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Getroutepolicy; + 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}/regions/{region}/routers/{router}/getRoutePolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Retrieves runtime information of the specified router. * @@ -88157,6 +89185,196 @@ export namespace compute_v1 { } } + /** + * Retrieves a list of router bgp routes available to 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. + */ + listBgpRoutes( + params: Params$Resource$Routers$Listbgproutes, + options: StreamMethodOptions + ): GaxiosPromise; + listBgpRoutes( + params?: Params$Resource$Routers$Listbgproutes, + options?: MethodOptions + ): GaxiosPromise; + listBgpRoutes( + params: Params$Resource$Routers$Listbgproutes, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listBgpRoutes( + params: Params$Resource$Routers$Listbgproutes, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listBgpRoutes( + params: Params$Resource$Routers$Listbgproutes, + callback: BodyResponseCallback + ): void; + listBgpRoutes( + callback: BodyResponseCallback + ): void; + listBgpRoutes( + paramsOrCallback?: + | Params$Resource$Routers$Listbgproutes + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Listbgproutes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Listbgproutes; + 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}/regions/{region}/routers/{router}/listBgpRoutes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of router route policy subresources available to 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. + */ + listRoutePolicies( + params: Params$Resource$Routers$Listroutepolicies, + options: StreamMethodOptions + ): GaxiosPromise; + listRoutePolicies( + params?: Params$Resource$Routers$Listroutepolicies, + options?: MethodOptions + ): GaxiosPromise; + listRoutePolicies( + params: Params$Resource$Routers$Listroutepolicies, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listRoutePolicies( + params: Params$Resource$Routers$Listroutepolicies, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listRoutePolicies( + params: Params$Resource$Routers$Listroutepolicies, + callback: BodyResponseCallback + ): void; + listRoutePolicies( + callback: BodyResponseCallback + ): void; + listRoutePolicies( + paramsOrCallback?: + | Params$Resource$Routers$Listroutepolicies + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Listroutepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Listroutepolicies; + 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}/regions/{region}/routers/{router}/listRoutePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @@ -88244,6 +89462,94 @@ export namespace compute_v1 { } } + /** + * Patches Route 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. + */ + patchRoutePolicy( + params: Params$Resource$Routers$Patchroutepolicy, + options: StreamMethodOptions + ): GaxiosPromise; + patchRoutePolicy( + params?: Params$Resource$Routers$Patchroutepolicy, + options?: MethodOptions + ): GaxiosPromise; + patchRoutePolicy( + params: Params$Resource$Routers$Patchroutepolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRoutePolicy( + params: Params$Resource$Routers$Patchroutepolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRoutePolicy( + params: Params$Resource$Routers$Patchroutepolicy, + callback: BodyResponseCallback + ): void; + patchRoutePolicy(callback: BodyResponseCallback): void; + patchRoutePolicy( + paramsOrCallback?: + | Params$Resource$Routers$Patchroutepolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Patchroutepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Patchroutepolicy; + 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}/regions/{region}/routers/{router}/patchRoutePolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. * @@ -88424,6 +89730,94 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * Updates or creates new Route 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. + */ + updateRoutePolicy( + params: Params$Resource$Routers$Updateroutepolicy, + options: StreamMethodOptions + ): GaxiosPromise; + updateRoutePolicy( + params?: Params$Resource$Routers$Updateroutepolicy, + options?: MethodOptions + ): GaxiosPromise; + updateRoutePolicy( + params: Params$Resource$Routers$Updateroutepolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateRoutePolicy( + params: Params$Resource$Routers$Updateroutepolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateRoutePolicy( + params: Params$Resource$Routers$Updateroutepolicy, + callback: BodyResponseCallback + ): void; + updateRoutePolicy(callback: BodyResponseCallback): void; + updateRoutePolicy( + paramsOrCallback?: + | Params$Resource$Routers$Updateroutepolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Updateroutepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Updateroutepolicy; + 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}/regions/{region}/routers/{router}/updateRoutePolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Routers$Aggregatedlist @@ -88479,6 +89873,29 @@ export namespace compute_v1 { */ router?: string; } + export interface Params$Resource$Routers$Deleteroutepolicy + extends StandardParameters { + /** + * The Policy name for this request. Name must conform to RFC1035 + */ + policy?: 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; + /** + * Name of the Router resource where Route Policy is defined. + */ + router?: string; + } export interface Params$Resource$Routers$Get extends StandardParameters { /** * Project ID for this request. @@ -88551,6 +89968,25 @@ export namespace compute_v1 { */ router?: string; } + export interface Params$Resource$Routers$Getroutepolicy + extends StandardParameters { + /** + * The Policy name for this request. Name must conform to RFC1035 + */ + policy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Router resource to query for the route policy. The name should conform to RFC1035. + */ + router?: string; + } export interface Params$Resource$Routers$Getrouterstatus extends StandardParameters { /** @@ -88615,6 +90051,96 @@ export namespace compute_v1 { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Routers$Listbgproutes + extends StandardParameters { + /** + * (Required) limit results to this address family (either IPv4 or IPv6) + */ + addressFamily?: string; + /** + * Limit results to destinations that are subnets of this CIDR range + */ + destinationPrefix?: string; + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based 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; + /** + * (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035. + */ + peer?: string; + /** + * When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes. + */ + policyApplied?: boolean; + /** + * 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; + /** + * Name or id of the resource for this request. Name should conform to RFC1035. + */ + router?: string; + /** + * (Required) limit results to this type of route (either LEARNED or ADVERTISED) + */ + routeType?: string; + } + export interface Params$Resource$Routers$Listroutepolicies + 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; + /** + * Name or id of the resource for this request. Name should conform to RFC1035. + */ + router?: string; + } export interface Params$Resource$Routers$Patch extends StandardParameters { /** * Project ID for this request. @@ -88638,6 +90164,30 @@ export namespace compute_v1 { */ requestBody?: Schema$Router; } + export interface Params$Resource$Routers$Patchroutepolicy + 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; + /** + * Name of the Router resource where Route Policy is defined. + */ + router?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RoutePolicy; + } export interface Params$Resource$Routers$Preview extends StandardParameters { /** * Project ID for this request. @@ -88680,6 +90230,30 @@ export namespace compute_v1 { */ requestBody?: Schema$Router; } + export interface Params$Resource$Routers$Updateroutepolicy + 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; + /** + * Name of the Router resource where Route Policy is defined. + */ + router?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RoutePolicy; + } export class Resource$Routes { context: APIRequestContext; From c88138fdc37056a2ce21898e92dfdb89a793e80c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:42 +0000 Subject: [PATCH 033/144] fix(config): update the API #### config:v1 The following keys were changed: - schemas.Preview.properties.annotations.description --- discovery/config-v1.json | 4 ++-- src/apis/config/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/config-v1.json b/discovery/config-v1.json index 0829228204d..c195547b742 100644 --- a/discovery/config-v1.json +++ b/discovery/config-v1.json @@ -1187,7 +1187,7 @@ } } }, - "revision": "20250108", + "revision": "20250219", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -2000,7 +2000,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Arbitrary key-value metadata storage e.g. to help client tools identifiy preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.", + "description": "Optional. Arbitrary key-value metadata storage e.g. to help client tools identify preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.", "type": "object" }, "artifactsGcsBucket": { diff --git a/src/apis/config/v1.ts b/src/apis/config/v1.ts index b3506a818e3..da9e9a40932 100644 --- a/src/apis/config/v1.ts +++ b/src/apis/config/v1.ts @@ -650,7 +650,7 @@ export namespace config_v1 { */ export interface Schema$Preview { /** - * Optional. Arbitrary key-value metadata storage e.g. to help client tools identifiy preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. + * Optional. Arbitrary key-value metadata storage e.g. to help client tools identify preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. */ annotations?: {[key: string]: string} | null; /** From a66d8595d86ca3e1b418271d1e79494b2e0cb60d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:42 +0000 Subject: [PATCH 034/144] feat(connectors): update the API #### connectors:v1 The following keys were added: - schemas.Connection.properties.trafficShapingConfigs.description - schemas.Connection.properties.trafficShapingConfigs.items.$ref - schemas.Connection.properties.trafficShapingConfigs.type - schemas.EnrichmentConfig.description - schemas.EnrichmentConfig.id - schemas.EnrichmentConfig.properties.appendAcl.description - schemas.EnrichmentConfig.properties.appendAcl.type - schemas.EnrichmentConfig.type - schemas.EventSubscriptionDestination.properties.pubsub.$ref - schemas.EventSubscriptionDestination.properties.pubsub.description - schemas.EventingConfig.properties.enrichmentConfig.$ref - schemas.EventingConfig.properties.enrichmentConfig.description - schemas.JsonSchema.properties.additionalDetails.additionalProperties.description - schemas.JsonSchema.properties.additionalDetails.additionalProperties.type - schemas.JsonSchema.properties.additionalDetails.description - schemas.JsonSchema.properties.additionalDetails.type - schemas.PartnerMetadata.properties.hasDynamicSpecUri.description - schemas.PartnerMetadata.properties.hasDynamicSpecUri.readOnly - schemas.PartnerMetadata.properties.hasDynamicSpecUri.type - schemas.PartnerMetadata.properties.localSpecPath.description - schemas.PartnerMetadata.properties.localSpecPath.readOnly - schemas.PartnerMetadata.properties.localSpecPath.type - schemas.PubSub.description - schemas.PubSub.id - schemas.PubSub.properties.attributes.additionalProperties.type - schemas.PubSub.properties.attributes.description - schemas.PubSub.properties.attributes.type - schemas.PubSub.properties.configVariables.description - schemas.PubSub.properties.configVariables.items.$ref - schemas.PubSub.properties.configVariables.type - schemas.PubSub.properties.projectId.description - schemas.PubSub.properties.projectId.type - schemas.PubSub.properties.topicId.description - schemas.PubSub.properties.topicId.type - schemas.PubSub.type - schemas.TrafficShapingConfig.description - schemas.TrafficShapingConfig.id - schemas.TrafficShapingConfig.properties.duration.description - schemas.TrafficShapingConfig.properties.duration.format - schemas.TrafficShapingConfig.properties.duration.type - schemas.TrafficShapingConfig.properties.quotaLimit.description - schemas.TrafficShapingConfig.properties.quotaLimit.format - schemas.TrafficShapingConfig.properties.quotaLimit.type - schemas.TrafficShapingConfig.type The following keys were changed: - resources.projects.resources.locations.resources.providers.resources.connectors.resources.versions.methods.fetchAuthSchema.parameters.view.enum - resources.projects.resources.locations.resources.providers.resources.connectors.resources.versions.methods.fetchAuthSchema.parameters.view.enumDescriptions - schemas.ConnectorVersionInfraConfig.description - schemas.RoleGrant.properties.principal.description - schemas.Source.properties.fieldId.description #### connectors:v2 The following keys were added: - resources.projects.resources.locations.resources.connections.resources.entityTypes.methods.get.parameters.view.description - resources.projects.resources.locations.resources.connections.resources.entityTypes.methods.get.parameters.view.enum - resources.projects.resources.locations.resources.connections.resources.entityTypes.methods.get.parameters.view.enumDescriptions - resources.projects.resources.locations.resources.connections.resources.entityTypes.methods.get.parameters.view.location - resources.projects.resources.locations.resources.connections.resources.entityTypes.methods.get.parameters.view.type --- discovery/connectors-v1.json | 104 +++++++++++++++++++++++++++++++++-- discovery/connectors-v2.json | 17 +++++- src/apis/connectors/v1.ts | 73 +++++++++++++++++++++++- src/apis/connectors/v2.ts | 4 ++ 4 files changed, 188 insertions(+), 10 deletions(-) diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index 72f3ea51cef..c5d58a06311 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -2370,12 +2370,14 @@ "enum": [ "AUTH_SCHEMA_VIEW_UNSPECIFIED", "BASIC", - "JSON_SCHEMA" + "JSON_SCHEMA", + "EUA_SCHEMA" ], "enumDescriptions": [ "Default value.", "Basic view of the AuthSchema.", - "JSON schema view of the AuthSchema." + "JSON schema view of the AuthSchema.", + "EUA Schema view of the AuthSchema." ], "location": "query", "type": "string" @@ -2558,7 +2560,7 @@ } } }, - "revision": "20250101", + "revision": "20250304", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -3286,6 +3288,13 @@ "readOnly": true, "type": "string" }, + "trafficShapingConfigs": { + "description": "Optional. Traffic shaping configuration for the connection.", + "items": { + "$ref": "TrafficShapingConfig" + }, + "type": "array" + }, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", @@ -3784,7 +3793,7 @@ "type": "object" }, "ConnectorVersionInfraConfig": { - "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", + "description": "This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version", "id": "ConnectorVersionInfraConfig", "properties": { "connectionRatelimitWindowSeconds": { @@ -4434,6 +4443,17 @@ }, "type": "object" }, + "EnrichmentConfig": { + "description": "Data enrichment configuration.", + "id": "EnrichmentConfig", + "properties": { + "appendAcl": { + "description": "Optional. Append ACL to the event.", + "type": "boolean" + } + }, + "type": "object" + }, "EnumOption": { "description": "EnumOption definition", "id": "EnumOption", @@ -4511,6 +4531,10 @@ "$ref": "EndPoint", "description": "OPTION 1: Hit an endpoint when we receive an event." }, + "pubsub": { + "$ref": "PubSub", + "description": "OPTION 3: Write the event to Pub/Sub topic." + }, "serviceAccount": { "description": "Service account needed for runtime plane to trigger IP workflow.", "type": "string" @@ -4635,6 +4659,10 @@ "$ref": "DeadLetterConfig", "description": "Optional. Dead letter configuration for eventing of a connection." }, + "enrichmentConfig": { + "$ref": "EnrichmentConfig", + "description": "Optional. Data enrichment configuration." + }, "enrichmentEnabled": { "description": "Optional. Enrichment Enabled.", "type": "boolean" @@ -5548,6 +5576,14 @@ "description": "JsonSchema representation of schema metadata", "id": "JsonSchema", "properties": { + "additionalDetails": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema", + "type": "object" + }, "default": { "description": "The default value of the field or object described by this schema.", "type": "any" @@ -6713,10 +6749,20 @@ "description": "Required. Public URL for the demo video.", "type": "string" }, + "hasDynamicSpecUri": { + "description": "Output only. Has dynamic open api spec uri.", + "readOnly": true, + "type": "boolean" + }, "integrationTemplates": { "description": "Required. Integration example templates for the custom connector.", "type": "string" }, + "localSpecPath": { + "description": "Output only. Local spec path. Required if has_dynamic_spec_uri is true.", + "readOnly": true, + "type": "string" + }, "marketplaceProduct": { "description": "Optional. Marketplace product name.", "type": "string" @@ -6900,6 +6946,35 @@ }, "type": "object" }, + "PubSub": { + "description": "Pub/Sub message includes details of the Destination Pub/Sub topic.", + "id": "PubSub", + "properties": { + "attributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Pub/Sub message attributes to be added to the Pub/Sub message.", + "type": "object" + }, + "configVariables": { + "description": "Optional. Configuration for configuring the trigger", + "items": { + "$ref": "ConfigVariable" + }, + "type": "array" + }, + "projectId": { + "description": "Required. The project id which has the Pub/Sub topic.", + "type": "string" + }, + "topicId": { + "description": "Required. The topic id of the Pub/Sub topic.", + "type": "string" + } + }, + "type": "object" + }, "PublishCustomConnectorVersionRequest": { "description": "Request message for ConnectorsService.PublishCustomConnectorVersion", "id": "PublishCustomConnectorVersionRequest", @@ -7238,7 +7313,7 @@ "type": "string" }, "principal": { - "description": "Optional. Prinicipal/Identity for whom the role need to assigned.", + "description": "Optional. Principal/Identity for whom the role need to assigned.", "enum": [ "PRINCIPAL_UNSPECIFIED", "CONNECTOR_SA" @@ -7650,7 +7725,7 @@ "id": "Source", "properties": { "fieldId": { - "description": "Field identifier. For example config vaiable name.", + "description": "Field identifier. For example config variable name.", "type": "string" }, "sourceType": { @@ -7962,6 +8037,23 @@ }, "type": "object" }, + "TrafficShapingConfig": { + "description": "* TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.", + "id": "TrafficShapingConfig", + "properties": { + "duration": { + "description": "Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.", + "format": "google-duration", + "type": "string" + }, + "quotaLimit": { + "description": "Required. Maximum number of api calls allowed.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "UpdatePolicy": { "description": "Maintenance policy applicable to instance updates.", "id": "UpdatePolicy", diff --git a/discovery/connectors-v2.json b/discovery/connectors-v2.json index dbdc7540aaa..e1dd1dbadad 100644 --- a/discovery/connectors-v2.json +++ b/discovery/connectors-v2.json @@ -368,6 +368,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Specifies view for entity type schema.", + "enum": [ + "ENTITY_TYPE_SCHEMA_VIEW_UNSPECIFIED", + "ENTITY_TYPE_SCHEMA_VIEW_BASIC", + "ENTITY_TYPE_SCHEMA_VIEW_ENRICHED" + ], + "enumDescriptions": [ + "VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.", + "Return basic entity type schema.", + "Return enriched entity types schema." + ], + "location": "query", + "type": "string" } }, "path": "v2/{+name}", @@ -660,7 +675,7 @@ } } }, - "revision": "20241015", + "revision": "20250304", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index fe097a4bfda..ad5ba98229b 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -593,6 +593,10 @@ export namespace connectors_v1 { * Output only. The name of the Service Directory service with TLS. */ tlsServiceDirectory?: string | null; + /** + * Optional. Traffic shaping configuration for the connection. + */ + trafficShapingConfigs?: Schema$TrafficShapingConfig[]; /** * Output only. Updated time. */ @@ -893,7 +897,7 @@ export namespace connectors_v1 { updateTime?: string | null; } /** - * This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version + * This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version */ export interface Schema$ConnectorVersionInfraConfig { /** @@ -1288,6 +1292,15 @@ export namespace connectors_v1 { */ updateTime?: string | null; } + /** + * Data enrichment configuration. + */ + export interface Schema$EnrichmentConfig { + /** + * Optional. Append ACL to the event. + */ + appendAcl?: boolean | null; + } /** * EnumOption definition */ @@ -1317,6 +1330,10 @@ export namespace connectors_v1 { * Optional. Dead letter configuration for eventing of a connection. */ deadLetterConfig?: Schema$DeadLetterConfig; + /** + * Optional. Data enrichment configuration. + */ + enrichmentConfig?: Schema$EnrichmentConfig; /** * Optional. Enrichment Enabled. */ @@ -1523,6 +1540,10 @@ export namespace connectors_v1 { * OPTION 1: Hit an endpoint when we receive an event. */ endpoint?: Schema$EndPoint; + /** + * OPTION 3: Write the event to Pub/Sub topic. + */ + pubsub?: Schema$PubSub; /** * Service account needed for runtime plane to trigger IP workflow. */ @@ -1864,6 +1885,10 @@ export namespace connectors_v1 { * JsonSchema representation of schema metadata */ export interface Schema$JsonSchema { + /** + * Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema + */ + additionalDetails?: {[key: string]: any} | null; /** * The default value of the field or object described by this schema. */ @@ -2620,10 +2645,18 @@ export namespace connectors_v1 { * Required. Public URL for the demo video. */ demoUri?: string | null; + /** + * Output only. Has dynamic open api spec uri. + */ + hasDynamicSpecUri?: boolean | null; /** * Required. Integration example templates for the custom connector. */ integrationTemplates?: string | null; + /** + * Output only. Local spec path. Required if has_dynamic_spec_uri is true. + */ + localSpecPath?: string | null; /** * Optional. Marketplace product name. */ @@ -2783,6 +2816,27 @@ export namespace connectors_v1 { */ publishTime?: string | null; } + /** + * Pub/Sub message includes details of the Destination Pub/Sub topic. + */ + export interface Schema$PubSub { + /** + * Optional. Pub/Sub message attributes to be added to the Pub/Sub message. + */ + attributes?: {[key: string]: string} | null; + /** + * Optional. Configuration for configuring the trigger + */ + configVariables?: Schema$ConfigVariable[]; + /** + * Required. The project id which has the Pub/Sub topic. + */ + projectId?: string | null; + /** + * Required. The topic id of the Pub/Sub topic. + */ + topicId?: string | null; + } /** * Request message for ConnectorsService.RefreshConnectionSchemaMetadata. */ @@ -2893,7 +2947,7 @@ export namespace connectors_v1 { */ helperTextTemplate?: string | null; /** - * Optional. Prinicipal/Identity for whom the role need to assigned. + * Optional. Principal/Identity for whom the role need to assigned. */ principal?: string | null; /** @@ -3154,7 +3208,7 @@ export namespace connectors_v1 { */ export interface Schema$Source { /** - * Field identifier. For example config vaiable name. + * Field identifier. For example config variable name. */ fieldId?: string | null; /** @@ -3344,6 +3398,19 @@ export namespace connectors_v1 { */ seconds?: number | null; } + /** + * * TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 \} \} - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 \} \} - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 \} and so on. + */ + export interface Schema$TrafficShapingConfig { + /** + * Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds. + */ + duration?: string | null; + /** + * Required. Maximum number of api calls allowed. + */ + quotaLimit?: string | null; + } /** * Maintenance policy applicable to instance updates. */ diff --git a/src/apis/connectors/v2.ts b/src/apis/connectors/v2.ts index 6f0b8df792b..fa2dcf0f8b8 100644 --- a/src/apis/connectors/v2.ts +++ b/src/apis/connectors/v2.ts @@ -1985,6 +1985,10 @@ export namespace connectors_v2 { * Required. Resource name of the Entity Type. Format: projects/{project\}/locations/{location\}/connections/{connection\}/entityTypes/{entityType\} */ name?: string; + /** + * Specifies view for entity type schema. + */ + view?: string; } export interface Params$Resource$Projects$Locations$Connections$Entitytypes$List extends StandardParameters { From 3529bbf7d0512b6cfb50601f6cc59dca73a5f50d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:42 +0000 Subject: [PATCH 035/144] fix(contactcenteraiplatform): update the API #### contactcenteraiplatform:v1alpha1 The following keys were changed: - schemas.ContactCenter.description - schemas.InstanceConfig.properties.instanceSize.enum - schemas.InstanceConfig.properties.instanceSize.enumDescriptions - schemas.Quota.properties.contactCenterInstanceSize.enum - schemas.Quota.properties.contactCenterInstanceSize.enumDescriptions --- discovery/contactcenteraiplatform-v1alpha1.json | 8 ++------ src/apis/contactcenteraiplatform/v1alpha1.ts | 2 +- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/discovery/contactcenteraiplatform-v1alpha1.json b/discovery/contactcenteraiplatform-v1alpha1.json index 14da7cf56d3..77bf3c362b7 100644 --- a/discovery/contactcenteraiplatform-v1alpha1.json +++ b/discovery/contactcenteraiplatform-v1alpha1.json @@ -512,7 +512,7 @@ } } }, - "revision": "20241205", + "revision": "20250205", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -555,7 +555,7 @@ "type": "object" }, "ContactCenter": { - "description": "Message describing ContactCenter object Next ID: 24", + "description": "Message describing ContactCenter object", "id": "ContactCenter", "properties": { "adminUser": { @@ -786,7 +786,6 @@ "STANDARD_XLARGE", "STANDARD_2XLARGE", "STANDARD_3XLARGE", - "DEV_XSMALL", "MULTIREGION_SMALL", "MULTIREGION_MEDIUM", "MULTIREGION_LARGE", @@ -806,7 +805,6 @@ "Instance Size STANDARD_XLARGE.", "Instance Size STANDARD_2XLARGE.", "Instance Size STANDARD_3XLARGE.", - "Instance Size DEV_EXTRA_SMALL.", "Instance Size MULTIREGION_SMALL", "Instance Size MULTIREGION_MEDIUM", "Instance Size MULTIREGION_LARGE", @@ -1078,7 +1076,6 @@ "STANDARD_XLARGE", "STANDARD_2XLARGE", "STANDARD_3XLARGE", - "DEV_XSMALL", "MULTIREGION_SMALL", "MULTIREGION_MEDIUM", "MULTIREGION_LARGE", @@ -1098,7 +1095,6 @@ "Instance Size STANDARD_XLARGE.", "Instance Size STANDARD_2XLARGE.", "Instance Size STANDARD_3XLARGE.", - "Instance Size DEV_EXTRA_SMALL.", "Instance Size MULTIREGION_SMALL", "Instance Size MULTIREGION_MEDIUM", "Instance Size MULTIREGION_LARGE", diff --git a/src/apis/contactcenteraiplatform/v1alpha1.ts b/src/apis/contactcenteraiplatform/v1alpha1.ts index f900125b6d3..c7167f86e01 100644 --- a/src/apis/contactcenteraiplatform/v1alpha1.ts +++ b/src/apis/contactcenteraiplatform/v1alpha1.ts @@ -155,7 +155,7 @@ export namespace contactcenteraiplatform_v1alpha1 { serviceAttachmentNames?: string[] | null; } /** - * Message describing ContactCenter object Next ID: 24 + * Message describing ContactCenter object */ export interface Schema$ContactCenter { /** From 4c8aa1bcc8dc65d049b3f073c57a55cbb18b1774 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:42 +0000 Subject: [PATCH 036/144] feat(contactcenterinsights): update the API #### contactcenterinsights:v1 The following keys were added: - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.description - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.flatPath - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.httpMethod - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.id - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.parameterOrder - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.parameters.parent.description - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.parameters.parent.location - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.parameters.parent.pattern - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.parameters.parent.required - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.parameters.parent.type - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.path - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.request.$ref - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.response.$ref - resources.projects.resources.locations.methods.bulkDeleteFeedbackLabels.scopes - schemas.GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig.properties.generator.description - schemas.GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig.properties.generator.type - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.description - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.id - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.properties.partialErrors.description - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.properties.partialErrors.items.$ref - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.properties.partialErrors.type - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.properties.request.$ref - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.properties.request.description - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.properties.request.readOnly - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata.type - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest.description - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest.id - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest.properties.filter.description - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest.properties.filter.type - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest.properties.parent.description - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest.properties.parent.type - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest.type - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse.description - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse.id - schemas.GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse.type - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata.properties.completedExportCount.description - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata.properties.completedExportCount.format - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata.properties.completedExportCount.type - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata.properties.failedExportCount.description - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata.properties.failedExportCount.format - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata.properties.failedExportCount.type - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest.properties.exportSchemaVersion.description - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest.properties.exportSchemaVersion.enum - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest.properties.exportSchemaVersion.enumDescriptions - schemas.GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest.properties.exportSchemaVersion.type - schemas.GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig.properties.generator.description - schemas.GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig.properties.generator.type - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.description - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.id - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.properties.partialErrors.description - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.properties.partialErrors.items.$ref - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.properties.partialErrors.type - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.properties.request.$ref - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.properties.request.description - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.properties.request.readOnly - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata.type - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest.description - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest.id - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest.properties.filter.description - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest.properties.filter.type - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest.properties.parent.description - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest.properties.parent.type - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest.type - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse.description - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse.id - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse.type - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata.properties.completedExportCount.description - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata.properties.completedExportCount.format - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata.properties.completedExportCount.type - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata.properties.failedExportCount.description - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata.properties.failedExportCount.format - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata.properties.failedExportCount.type - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest.properties.exportSchemaVersion.description - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest.properties.exportSchemaVersion.enum - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest.properties.exportSchemaVersion.enumDescriptions - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest.properties.exportSchemaVersion.type The following keys were changed: - resources.projects.resources.locations.methods.bulkDownloadFeedbackLabels.description - resources.projects.resources.locations.methods.bulkUploadFeedbackLabels.description - schemas.GoogleCloudContactcenterinsightsV1Conversation.properties.metadataJson.description - schemas.GoogleCloudContactcenterinsightsV1Dimension.properties.dimensionKey.enum - schemas.GoogleCloudContactcenterinsightsV1Dimension.properties.dimensionKey.enumDescriptions - schemas.GoogleCloudContactcenterinsightsV1FeedbackLabel.description - schemas.GoogleCloudContactcenterinsightsV1FeedbackLabel.properties.label.description - schemas.GoogleCloudContactcenterinsightsV1FeedbackLabel.properties.labeledResource.description - schemas.GoogleCloudContactcenterinsightsV1FeedbackLabel.properties.qaAnswerLabel.description - schemas.GoogleCloudContactcenterinsightsV1IssueAssignment.properties.displayName.description - schemas.GoogleCloudContactcenterinsightsV1SentimentData.properties.magnitude.description - schemas.GoogleCloudContactcenterinsightsV1alpha1Conversation.properties.metadataJson.description - schemas.GoogleCloudContactcenterinsightsV1alpha1Dimension.properties.dimensionKey.enum - schemas.GoogleCloudContactcenterinsightsV1alpha1Dimension.properties.dimensionKey.enumDescriptions - schemas.GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel.description - schemas.GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel.properties.label.description - schemas.GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel.properties.labeledResource.description - schemas.GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel.properties.qaAnswerLabel.description - schemas.GoogleCloudContactcenterinsightsV1alpha1IssueAssignment.properties.displayName.description - schemas.GoogleCloudContactcenterinsightsV1alpha1SentimentData.properties.magnitude.description --- discovery/contactcenterinsights-v1.json | 238 +++++++++++++++++++++--- src/apis/contactcenterinsights/v1.ts | 233 +++++++++++++++++++++-- 2 files changed, 434 insertions(+), 37 deletions(-) diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 41688e4d8d9..23d26670260 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -109,8 +109,36 @@ "resources": { "locations": { "methods": { + "bulkDeleteFeedbackLabels": { + "description": "Delete feedback labels in bulk using a filter.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkDeleteFeedbackLabels", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.bulkDeleteFeedbackLabels", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:bulkDeleteFeedbackLabels", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "bulkDownloadFeedbackLabels": { - "description": "Download feedback labels in bulk.", + "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels", @@ -138,7 +166,7 @@ ] }, "bulkUploadFeedbackLabels": { - "description": "Upload feedback labels in bulk.", + "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.bulkUploadFeedbackLabels", @@ -2609,7 +2637,7 @@ } } }, - "revision": "20250106", + "revision": "20250311", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -2876,6 +2904,10 @@ "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, + "generator": { + "description": "The resource name of the existing created generator. Format: projects//locations//generators/", + "type": "string" + }, "summarizationModel": { "description": "Default summarization model to be used.", "enum": [ @@ -3102,6 +3134,46 @@ "properties": {}, "type": "object" }, + "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata": { + "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", + "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata", + "properties": { + "partialErrors": { + "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", + "description": "Output only. The original request for delete.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest": { + "description": "Request for the BulkDeleteFeedbackLabels endpoint.", + "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest", + "properties": { + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse": { + "description": "Response for the BulkDeleteFeedbackLabels endpoint.", + "id": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata": { "description": "Metadata for the BulkDownloadFeedbackLabel endpoint.", "id": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata", @@ -3535,7 +3607,7 @@ "type": "string" }, "metadataJson": { - "description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.", + "description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.", "type": "string" }, "name": { @@ -4156,20 +4228,24 @@ "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", + "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", - "CONVERSATION_PROFILE_ID" + "CONVERSATION_PROFILE_ID", + "MEDIUM" ], "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", + "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", - "The dimension is keyed by the conversation profile ID." + "The dimension is keyed by the conversation profile ID.", + "The dimension is keyed by the conversation medium." ], "type": "string" }, @@ -4391,6 +4467,11 @@ "description": "Metadata for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata", "properties": { + "completedExportCount": { + "description": "The number of conversations that were exported successfully.", + "format": "int32", + "type": "integer" + }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -4403,6 +4484,11 @@ "readOnly": true, "type": "string" }, + "failedExportCount": { + "description": "The number of conversations that failed to be exported.", + "format": "int32", + "type": "integer" + }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "items": { @@ -4425,6 +4511,32 @@ "$ref": "GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination", "description": "Specified if sink is a BigQuery table." }, + "exportSchemaVersion": { + "description": "Optional. Version of the export schema.", + "enum": [ + "EXPORT_SCHEMA_VERSION_UNSPECIFIED", + "EXPORT_V1", + "EXPORT_V2", + "EXPORT_V3", + "EXPORT_V4", + "EXPORT_V5", + "EXPORT_V6", + "EXPORT_V7", + "EXPORT_VERSION_LATEST_AVAILABLE" + ], + "enumDescriptions": [ + "Unspecified. Defaults to EXPORT_V3.", + "Export schema version 1.", + "Export schema version 2.", + "Export schema version 3.", + "Export schema version 4.", + "Export schema version 5.", + "Export schema version 6.", + "Export schema version 7.", + "Export schema version latest available." + ], + "type": "string" + }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" @@ -4568,7 +4680,7 @@ "type": "object" }, "GoogleCloudContactcenterinsightsV1FeedbackLabel": { - "description": "Represents a conversation, resource, and label provided by the user.", + "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling.", "id": "GoogleCloudContactcenterinsightsV1FeedbackLabel", "properties": { "createTime": { @@ -4578,11 +4690,11 @@ "type": "string" }, "label": { - "description": "String label.", + "description": "String label used for Topic Modeling.", "type": "string" }, "labeledResource": { - "description": "Resource name of the resource to be labeled.", + "description": "Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model}", "type": "string" }, "name": { @@ -4591,7 +4703,7 @@ }, "qaAnswerLabel": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", - "description": "QaAnswer label." + "description": "QaAnswer label used for Quality AI example conversations." }, "updateTime": { "description": "Output only. Update time of the label.", @@ -4997,7 +5109,7 @@ "id": "GoogleCloudContactcenterinsightsV1IssueAssignment", "properties": { "displayName": { - "description": "Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.", + "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "issue": { @@ -6348,7 +6460,7 @@ "id": "GoogleCloudContactcenterinsightsV1SentimentData", "properties": { "magnitude": { - "description": "A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.", + "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "format": "float", "type": "number" }, @@ -6876,6 +6988,10 @@ "description": "Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}", "type": "string" }, + "generator": { + "description": "The resource name of the existing created generator. Format: projects//locations//generators/", + "type": "string" + }, "summarizationModel": { "description": "Default summarization model to be used.", "enum": [ @@ -7102,6 +7218,46 @@ "properties": {}, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata": { + "description": "Metadata for the BulkDeleteFeedbackLabels endpoint.", + "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata", + "properties": { + "partialErrors": { + "description": "Partial errors during deletion operation that might cause the operation output to be incomplete.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", + "description": "Output only. The original request for delete.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest": { + "description": "Request for the BulkDeleteFeedbackLabels endpoint.", + "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest", + "properties": { + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse": { + "description": "Response for the BulkDeleteFeedbackLabels endpoint.", + "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation": { "description": "A piece of metadata that applies to a window of a call.", "id": "GoogleCloudContactcenterinsightsV1alpha1CallAnnotation", @@ -7231,7 +7387,7 @@ "type": "string" }, "metadataJson": { - "description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.", + "description": "Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.", "type": "string" }, "name": { @@ -7846,20 +8002,24 @@ "enum": [ "DIMENSION_KEY_UNSPECIFIED", "ISSUE", + "ISSUE_NAME", "AGENT", "AGENT_TEAM", "QA_QUESTION_ID", "QA_QUESTION_ANSWER_VALUE", - "CONVERSATION_PROFILE_ID" + "CONVERSATION_PROFILE_ID", + "MEDIUM" ], "enumDescriptions": [ "The key of the dimension is unspecified.", "The dimension is keyed by issues.", + "The dimension is keyed by issue names.", "The dimension is keyed by agents.", "The dimension is keyed by agent teams.", "The dimension is keyed by QaQuestionIds. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing stats for the same question across different scorecard revisions.", "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", - "The dimension is keyed by the conversation profile ID." + "The dimension is keyed by the conversation profile ID.", + "The dimension is keyed by the conversation medium." ], "type": "string" }, @@ -8070,6 +8230,11 @@ "description": "Metadata for an export insights operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata", "properties": { + "completedExportCount": { + "description": "The number of conversations that were exported successfully.", + "format": "int32", + "type": "integer" + }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -8082,6 +8247,11 @@ "readOnly": true, "type": "string" }, + "failedExportCount": { + "description": "The number of conversations that failed to be exported.", + "format": "int32", + "type": "integer" + }, "partialErrors": { "description": "Partial errors during export operation that might cause the operation output to be incomplete.", "items": { @@ -8104,6 +8274,32 @@ "$ref": "GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination", "description": "Specified if sink is a BigQuery table." }, + "exportSchemaVersion": { + "description": "Optional. Version of the export schema.", + "enum": [ + "EXPORT_SCHEMA_VERSION_UNSPECIFIED", + "EXPORT_V1", + "EXPORT_V2", + "EXPORT_V3", + "EXPORT_V4", + "EXPORT_V5", + "EXPORT_V6", + "EXPORT_V7", + "EXPORT_VERSION_LATEST_AVAILABLE" + ], + "enumDescriptions": [ + "Unspecified. Defaults to EXPORT_V3.", + "Export schema version 1.", + "Export schema version 2.", + "Export schema version 3.", + "Export schema version 4.", + "Export schema version 5.", + "Export schema version 6.", + "Export schema version 7.", + "Export schema version latest available." + ], + "type": "string" + }, "filter": { "description": "A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.", "type": "string" @@ -8247,7 +8443,7 @@ "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel": { - "description": "Represents a conversation, resource, and label provided by the user.", + "description": "Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling.", "id": "GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel", "properties": { "createTime": { @@ -8257,11 +8453,11 @@ "type": "string" }, "label": { - "description": "String label.", + "description": "String label used for Topic Modeling.", "type": "string" }, "labeledResource": { - "description": "Resource name of the resource to be labeled.", + "description": "Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question} - issueModels/{issue_model}", "type": "string" }, "name": { @@ -8270,7 +8466,7 @@ }, "qaAnswerLabel": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", - "description": "QaAnswer label." + "description": "QaAnswer label used for Quality AI example conversations." }, "updateTime": { "description": "Output only. Update time of the label.", @@ -8676,7 +8872,7 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1IssueAssignment", "properties": { "displayName": { - "description": "Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then.", + "description": "Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then.", "type": "string" }, "issue": { @@ -9439,7 +9635,7 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", "properties": { "magnitude": { - "description": "A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score.", + "description": "A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score.", "format": "float", "type": "number" }, diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index c95dfe3a731..b9589bd9f1a 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -303,6 +303,10 @@ export namespace contactcenterinsights_v1 { * Resource name of the Dialogflow conversation profile. Format: projects/{project\}/locations/{location\}/conversationProfiles/{conversation_profile\} */ conversationProfile?: string | null; + /** + * The resource name of the existing created generator. Format: projects//locations//generators/ + */ + generator?: string | null; /** * Default summarization model to be used. */ @@ -467,6 +471,36 @@ export namespace contactcenterinsights_v1 { * The response for a bulk delete conversations operation. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse {} + /** + * Metadata for the BulkDeleteFeedbackLabels endpoint. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata { + /** + * Partial errors during deletion operation that might cause the operation output to be incomplete. + */ + partialErrors?: Schema$GoogleRpcStatus[]; + /** + * Output only. The original request for delete. + */ + request?: Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest; + } + /** + * Request for the BulkDeleteFeedbackLabels endpoint. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest { + /** + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + */ + filter?: string | null; + /** + * Required. The parent resource for new feedback labels. + */ + parent?: string | null; + } + /** + * Response for the BulkDeleteFeedbackLabels endpoint. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse {} /** * A piece of metadata that applies to a window of a call. */ @@ -573,7 +607,7 @@ export namespace contactcenterinsights_v1 { */ medium?: string | null; /** - * Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + * Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. */ metadataJson?: string | null; /** @@ -1181,6 +1215,10 @@ export namespace contactcenterinsights_v1 { * Metadata for an export insights operation. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata { + /** + * The number of conversations that were exported successfully. + */ + completedExportCount?: number | null; /** * Output only. The time the operation was created. */ @@ -1189,6 +1227,10 @@ export namespace contactcenterinsights_v1 { * Output only. The time the operation finished running. */ endTime?: string | null; + /** + * The number of conversations that failed to be exported. + */ + failedExportCount?: number | null; /** * Partial errors during export operation that might cause the operation output to be incomplete. */ @@ -1206,6 +1248,10 @@ export namespace contactcenterinsights_v1 { * Specified if sink is a BigQuery table. */ bigQueryDestination?: Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination; + /** + * Optional. Version of the export schema. + */ + exportSchemaVersion?: string | null; /** * A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties. */ @@ -1317,7 +1363,7 @@ export namespace contactcenterinsights_v1 { source?: string | null; } /** - * Represents a conversation, resource, and label provided by the user. + * Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel { /** @@ -1325,11 +1371,11 @@ export namespace contactcenterinsights_v1 { */ createTime?: string | null; /** - * String label. + * String label used for Topic Modeling. */ label?: string | null; /** - * Resource name of the resource to be labeled. + * Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard\}/revisions/{revision\}/qaQuestions/{question\} - issueModels/{issue_model\} */ labeledResource?: string | null; /** @@ -1337,7 +1383,7 @@ export namespace contactcenterinsights_v1 { */ name?: string | null; /** - * QaAnswer label. + * QaAnswer label used for Quality AI example conversations. */ qaAnswerLabel?: Schema$GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue; /** @@ -1638,7 +1684,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IssueAssignment { /** - * Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + * Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. */ displayName?: string | null; /** @@ -2200,7 +2246,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SentimentData { /** - * A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + * A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. */ magnitude?: number | null; /** @@ -2557,6 +2603,10 @@ export namespace contactcenterinsights_v1 { * Resource name of the Dialogflow conversation profile. Format: projects/{project\}/locations/{location\}/conversationProfiles/{conversation_profile\} */ conversationProfile?: string | null; + /** + * The resource name of the existing created generator. Format: projects//locations//generators/ + */ + generator?: string | null; /** * Default summarization model to be used. */ @@ -2721,6 +2771,36 @@ export namespace contactcenterinsights_v1 { * The response for a bulk delete conversations operation. */ export interface Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse {} + /** + * Metadata for the BulkDeleteFeedbackLabels endpoint. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata { + /** + * Partial errors during deletion operation that might cause the operation output to be incomplete. + */ + partialErrors?: Schema$GoogleRpcStatus[]; + /** + * Output only. The original request for delete. + */ + request?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest; + } + /** + * Request for the BulkDeleteFeedbackLabels endpoint. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest { + /** + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + */ + filter?: string | null; + /** + * Required. The parent resource for new feedback labels. + */ + parent?: string | null; + } + /** + * Response for the BulkDeleteFeedbackLabels endpoint. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse {} /** * Metadata for the BulkDownloadFeedbackLabel endpoint. */ @@ -3035,7 +3115,7 @@ export namespace contactcenterinsights_v1 { */ medium?: string | null; /** - * Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats. + * Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. */ metadataJson?: string | null; /** @@ -3656,6 +3736,10 @@ export namespace contactcenterinsights_v1 { * Metadata for an export insights operation. */ export interface Schema$GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata { + /** + * The number of conversations that were exported successfully. + */ + completedExportCount?: number | null; /** * Output only. The time the operation was created. */ @@ -3664,6 +3748,10 @@ export namespace contactcenterinsights_v1 { * Output only. The time the operation finished running. */ endTime?: string | null; + /** + * The number of conversations that failed to be exported. + */ + failedExportCount?: number | null; /** * Partial errors during export operation that might cause the operation output to be incomplete. */ @@ -3681,6 +3769,10 @@ export namespace contactcenterinsights_v1 { * Specified if sink is a BigQuery table. */ bigQueryDestination?: Schema$GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination; + /** + * Optional. Version of the export schema. + */ + exportSchemaVersion?: string | null; /** * A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties. */ @@ -3792,7 +3884,7 @@ export namespace contactcenterinsights_v1 { source?: string | null; } /** - * Represents a conversation, resource, and label provided by the user. + * Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. */ export interface Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel { /** @@ -3800,11 +3892,11 @@ export namespace contactcenterinsights_v1 { */ createTime?: string | null; /** - * String label. + * String label used for Topic Modeling. */ label?: string | null; /** - * Resource name of the resource to be labeled. + * Resource name of the resource to be labeled. Supported resources: - qaScorecards/{scorecard\}/revisions/{revision\}/qaQuestions/{question\} - issueModels/{issue_model\} */ labeledResource?: string | null; /** @@ -3812,7 +3904,7 @@ export namespace contactcenterinsights_v1 { */ name?: string | null; /** - * QaAnswer label. + * QaAnswer label used for Quality AI example conversations. */ qaAnswerLabel?: Schema$GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue; /** @@ -4113,7 +4205,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1IssueAssignment { /** - * Immutable. Display name of the assigned issue. This field is set at time of analyis and immutable since then. + * Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. */ displayName?: string | null; /** @@ -5060,7 +5152,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1SentimentData { /** - * A non-negative number from 0 to infinity which represents the abolute magnitude of sentiment regardless of score. + * A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. */ magnitude?: number | null; /** @@ -5429,7 +5521,104 @@ export namespace contactcenterinsights_v1 { } /** - * Download feedback labels in bulk. + * Delete feedback labels in bulk using a filter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels, + options: StreamMethodOptions + ): GaxiosPromise; + bulkDeleteFeedbackLabels( + params?: Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels, + options?: MethodOptions + ): GaxiosPromise; + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels, + callback: BodyResponseCallback + ): void; + bulkDeleteFeedbackLabels( + callback: BodyResponseCallback + ): void; + bulkDeleteFeedbackLabels( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:bulkDeleteFeedbackLabels').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); + } + } + + /** + * Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5526,7 +5715,7 @@ export namespace contactcenterinsights_v1 { } /** - * Upload feedback labels in bulk. + * Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6102,6 +6291,18 @@ export namespace contactcenterinsights_v1 { } } + export interface Params$Resource$Projects$Locations$Bulkdeletefeedbacklabels + extends StandardParameters { + /** + * Required. The parent resource for new feedback labels. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest; + } export interface Params$Resource$Projects$Locations$Bulkdownloadfeedbacklabels extends StandardParameters { /** From e7308846ebfe56a4bb4d3f99e17a7218f23fe3a5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:42 +0000 Subject: [PATCH 037/144] feat(container)!: update the API BREAKING CHANGE: This release has breaking changes. #### container:v1beta1 The following keys were added: - schemas.AutopilotConfig.description - schemas.AutopilotConfig.id - schemas.AutopilotConfig.properties.enabled.description - schemas.AutopilotConfig.properties.enabled.type - schemas.AutopilotConfig.type - schemas.Cluster.properties.enableTpu.deprecated - schemas.Cluster.properties.tpuConfig.deprecated - schemas.Cluster.properties.tpuIpv4CidrBlock.deprecated - schemas.ClusterUpdate.properties.desiredTpuConfig.deprecated - schemas.IPAllocationPolicy.properties.tpuIpv4CidrBlock.deprecated - schemas.NodeKubeletConfig.properties.allowedUnsafeSysctls.description - schemas.NodeKubeletConfig.properties.allowedUnsafeSysctls.items.type - schemas.NodeKubeletConfig.properties.allowedUnsafeSysctls.type - schemas.NodeKubeletConfig.properties.containerLogMaxFiles.description - schemas.NodeKubeletConfig.properties.containerLogMaxFiles.format - schemas.NodeKubeletConfig.properties.containerLogMaxFiles.type - schemas.NodeKubeletConfig.properties.containerLogMaxSize.description - schemas.NodeKubeletConfig.properties.containerLogMaxSize.type - schemas.NodeKubeletConfig.properties.imageGcHighThresholdPercent.description - schemas.NodeKubeletConfig.properties.imageGcHighThresholdPercent.format - schemas.NodeKubeletConfig.properties.imageGcHighThresholdPercent.type - schemas.NodeKubeletConfig.properties.imageGcLowThresholdPercent.description - schemas.NodeKubeletConfig.properties.imageGcLowThresholdPercent.format - schemas.NodeKubeletConfig.properties.imageGcLowThresholdPercent.type - schemas.NodeKubeletConfig.properties.imageMaximumGcAge.description - schemas.NodeKubeletConfig.properties.imageMaximumGcAge.type - schemas.NodeKubeletConfig.properties.imageMinimumGcAge.description - schemas.NodeKubeletConfig.properties.imageMinimumGcAge.type - schemas.NodePool.properties.autopilotConfig.$ref - schemas.NodePool.properties.autopilotConfig.description - schemas.TpuConfig.deprecated - schemas.WorkloadPolicyConfig.properties.autopilotCompatibilityAuditingEnabled.description - schemas.WorkloadPolicyConfig.properties.autopilotCompatibilityAuditingEnabled.type The following keys were changed: - schemas.AutopilotCompatibilityIssue.properties.documentationUrl.description - schemas.CertificateAuthorityDomainConfig.properties.fqdns.description - schemas.Cluster.properties.enableTpu.description - schemas.Cluster.properties.tpuConfig.description - schemas.Cluster.properties.tpuIpv4CidrBlock.description - schemas.ClusterUpdate.properties.desiredTpuConfig.description - schemas.Filter.properties.eventType.items.enum - schemas.Filter.properties.eventType.items.enumDescriptions - schemas.GetJSONWebKeysResponse.description - schemas.LinuxNodeConfig.properties.sysctls.description - schemas.LoggingComponentConfig.properties.enableComponents.items.enum - schemas.LoggingComponentConfig.properties.enableComponents.items.enumDescriptions - schemas.MasterAuthorizedNetworksConfig.properties.gcpPublicCidrsAccessEnabled.description - schemas.MonitoringComponentConfig.properties.enableComponents.items.enum - schemas.MonitoringComponentConfig.properties.enableComponents.items.enumDeprecated - schemas.MonitoringComponentConfig.properties.enableComponents.items.enumDescriptions - schemas.NetworkConfig.properties.network.description - schemas.NodeConfig.properties.localSsdEncryptionMode.description - schemas.StatusCondition.properties.code.enum - schemas.StatusCondition.properties.code.enumDescriptions - schemas.TpuConfig.description - schemas.UpgradeInfoEvent.properties.eventType.enum - schemas.UpgradeInfoEvent.properties.eventType.enumDescriptions #### container:v1 The following keys were deleted: - schemas.Cluster.properties.location.description The following keys were added: - schemas.AutoMonitoringConfig.description - schemas.AutoMonitoringConfig.id - schemas.AutoMonitoringConfig.properties.scope.description - schemas.AutoMonitoringConfig.properties.scope.enum - schemas.AutoMonitoringConfig.properties.scope.enumDescriptions - schemas.AutoMonitoringConfig.properties.scope.type - schemas.AutoMonitoringConfig.type - schemas.AutopilotConfig.description - schemas.AutopilotConfig.id - schemas.AutopilotConfig.properties.enabled.description - schemas.AutopilotConfig.properties.enabled.type - schemas.AutopilotConfig.type - schemas.Cluster.properties.enableTpu.deprecated - schemas.Cluster.properties.tpuIpv4CidrBlock.deprecated - schemas.IPAllocationPolicy.properties.tpuIpv4CidrBlock.deprecated - schemas.ManagedPrometheusConfig.properties.autoMonitoringConfig.$ref - schemas.ManagedPrometheusConfig.properties.autoMonitoringConfig.description - schemas.NodeKubeletConfig.properties.allowedUnsafeSysctls.description - schemas.NodeKubeletConfig.properties.allowedUnsafeSysctls.items.type - schemas.NodeKubeletConfig.properties.allowedUnsafeSysctls.type - schemas.NodeKubeletConfig.properties.containerLogMaxFiles.description - schemas.NodeKubeletConfig.properties.containerLogMaxFiles.format - schemas.NodeKubeletConfig.properties.containerLogMaxFiles.type - schemas.NodeKubeletConfig.properties.containerLogMaxSize.description - schemas.NodeKubeletConfig.properties.containerLogMaxSize.type - schemas.NodeKubeletConfig.properties.imageGcHighThresholdPercent.description - schemas.NodeKubeletConfig.properties.imageGcHighThresholdPercent.format - schemas.NodeKubeletConfig.properties.imageGcHighThresholdPercent.type - schemas.NodeKubeletConfig.properties.imageGcLowThresholdPercent.description - schemas.NodeKubeletConfig.properties.imageGcLowThresholdPercent.format - schemas.NodeKubeletConfig.properties.imageGcLowThresholdPercent.type - schemas.NodeKubeletConfig.properties.imageMaximumGcAge.description - schemas.NodeKubeletConfig.properties.imageMaximumGcAge.type - schemas.NodeKubeletConfig.properties.imageMinimumGcAge.description - schemas.NodeKubeletConfig.properties.imageMinimumGcAge.type - schemas.NodePool.properties.autopilotConfig.$ref - schemas.NodePool.properties.autopilotConfig.description - schemas.WorkloadPolicyConfig.properties.autopilotCompatibilityAuditingEnabled.description - schemas.WorkloadPolicyConfig.properties.autopilotCompatibilityAuditingEnabled.type The following keys were changed: - schemas.AutopilotCompatibilityIssue.properties.documentationUrl.description - schemas.CertificateAuthorityDomainConfig.properties.fqdns.description - schemas.Cluster.properties.enableTpu.description - schemas.Cluster.properties.tpuIpv4CidrBlock.description - schemas.Filter.properties.eventType.items.enum - schemas.Filter.properties.eventType.items.enumDescriptions - schemas.GetJSONWebKeysResponse.description - schemas.IPAllocationPolicy.properties.tpuIpv4CidrBlock.description - schemas.LinuxNodeConfig.properties.sysctls.description - schemas.LoggingComponentConfig.properties.enableComponents.items.enum - schemas.LoggingComponentConfig.properties.enableComponents.items.enumDescriptions - schemas.MasterAuthorizedNetworksConfig.properties.gcpPublicCidrsAccessEnabled.description - schemas.MonitoringComponentConfig.properties.enableComponents.items.enum - schemas.MonitoringComponentConfig.properties.enableComponents.items.enumDescriptions - schemas.NetworkConfig.properties.network.description - schemas.NodeConfig.properties.localSsdEncryptionMode.description - schemas.StatusCondition.properties.code.enum - schemas.StatusCondition.properties.code.enumDescriptions - schemas.UpgradeInfoEvent.properties.eventType.enum - schemas.UpgradeInfoEvent.properties.eventType.enumDescriptions --- discovery/container-v1.json | 134 ++++++++++++++++++++++++++----- discovery/container-v1beta1.json | 116 ++++++++++++++++++++------ src/apis/container/v1.ts | 81 ++++++++++++++++--- src/apis/container/v1beta1.ts | 69 +++++++++++++--- 4 files changed, 330 insertions(+), 70 deletions(-) diff --git a/discovery/container-v1.json b/discovery/container-v1.json index 8ea9fd7fe4a..551f2eb718b 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20241228", + "revision": "20250225", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2757,6 +2757,27 @@ }, "type": "object" }, + "AutoMonitoringConfig": { + "description": "AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring.", + "id": "AutoMonitoringConfig", + "properties": { + "scope": { + "description": "Scope for GKE Workload Auto-Monitoring.", + "enum": [ + "SCOPE_UNSPECIFIED", + "ALL", + "NONE" + ], + "enumDescriptions": [ + "Not set.", + "Auto-Monitoring is enabled for all supported applications.", + "Disable Auto-Monitoring." + ], + "type": "string" + } + }, + "type": "object" + }, "AutoUpgradeOptions": { "description": "AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.", "id": "AutoUpgradeOptions", @@ -2802,7 +2823,7 @@ "type": "string" }, "documentationUrl": { - "description": "A URL to a public documnetation, which addresses resolving this issue.", + "description": "A URL to a public documentation, which addresses resolving this issue.", "type": "string" }, "incompatibilityType": { @@ -2836,6 +2857,17 @@ }, "type": "object" }, + "AutopilotConfig": { + "description": "AutopilotConfig contains configuration of autopilot feature for this nodepool.", + "id": "AutopilotConfig", + "properties": { + "enabled": { + "description": "Denotes that nodes belonging to this node pool are Autopilot nodes.", + "type": "boolean" + } + }, + "type": "object" + }, "AutoprovisioningNodePoolDefaults": { "description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.", "id": "AutoprovisioningNodePoolDefaults", @@ -3045,7 +3077,7 @@ "id": "CertificateAuthorityDomainConfig", "properties": { "fqdns": { - "description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", + "description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", "items": { "type": "string" }, @@ -3222,7 +3254,8 @@ "type": "boolean" }, "enableTpu": { - "description": "Enable the ability to use Cloud TPUs in this cluster.", + "deprecated": true, + "description": "Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.", "type": "boolean" }, "endpoint": { @@ -3288,7 +3321,6 @@ "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.", "readOnly": true, "type": "string" }, @@ -3471,7 +3503,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`).", + "deprecated": true, + "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`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.", "readOnly": true, "type": "string" }, @@ -4333,13 +4366,15 @@ "EVENT_TYPE_UNSPECIFIED", "UPGRADE_AVAILABLE_EVENT", "UPGRADE_EVENT", - "SECURITY_BULLETIN_EVENT" + "SECURITY_BULLETIN_EVENT", + "UPGRADE_INFO_EVENT" ], "enumDescriptions": [ "Not set, will be ignored.", "Corresponds with UpgradeAvailableEvent.", "Corresponds with UpgradeEvent.", - "Corresponds with SecurityBulletinEvent." + "Corresponds with SecurityBulletinEvent.", + "Corresponds with UpgradeInfoEvent." ], "type": "string" }, @@ -4503,7 +4538,7 @@ "type": "object" }, "GetJSONWebKeysResponse": { - "description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517", + "description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517", "id": "GetJSONWebKeysResponse", "properties": { "cacheHeader": { @@ -4756,7 +4791,8 @@ "type": "string" }, "tpuIpv4CidrBlock": { - "description": "The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.", + "deprecated": true, + "description": "The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.", "type": "string" }, "useIpAliases": { @@ -4934,7 +4970,7 @@ "additionalProperties": { "type": "string" }, - "description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse kernel.shmmni kernel.shmmax kernel.shmall", + "description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall vm.max_map_count", "type": "object" } }, @@ -5041,7 +5077,8 @@ "SCHEDULER", "CONTROLLER_MANAGER", "KCP_SSHD", - "KCP_CONNECTION" + "KCP_CONNECTION", + "KCP_HPA" ], "enumDescriptions": [ "Default value. This shouldn't be used.", @@ -5051,7 +5088,8 @@ "kube-scheduler", "kube-controller-manager", "kcp-sshd", - "kcp connection logs" + "kcp connection logs", + "horizontal pod autoscaler decision logs" ], "type": "string" }, @@ -5154,6 +5192,10 @@ "description": "ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.", "id": "ManagedPrometheusConfig", "properties": { + "autoMonitoringConfig": { + "$ref": "AutoMonitoringConfig", + "description": "GKE Workload Auto-Monitoring Configuration." + }, "enabled": { "description": "Enable Managed Collection.", "type": "boolean" @@ -5213,7 +5255,7 @@ "type": "boolean" }, "gcpPublicCidrsAccessEnabled": { - "description": "Whether master is accessbile via Google Compute Engine Public IP addresses.", + "description": "Whether master is accessible via Google Compute Engine Public IP addresses.", "type": "boolean" }, "privateEndpointEnforcementEnabled": { @@ -5292,7 +5334,8 @@ "STATEFULSET", "CADVISOR", "KUBELET", - "DCGM" + "DCGM", + "JOBSET" ], "enumDescriptions": [ "Default value. This shouldn't be used.", @@ -5308,7 +5351,8 @@ "Statefulset", "CADVISOR", "KUBELET", - "NVIDIA Data Center GPU Manager (DCGM)" + "NVIDIA Data Center GPU Manager (DCGM)", + "JobSet" ], "type": "string" }, @@ -5409,7 +5453,7 @@ "type": "string" }, "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", + "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" }, @@ -5644,7 +5688,7 @@ "type": "integer" }, "localSsdEncryptionMode": { - "description": "Specifies which method should be used for encrypting the Local SSDs attahced to the node.", + "description": "Specifies which method should be used for encrypting the Local SSDs attached to the node.", "enum": [ "LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", "STANDARD_ENCRYPTION", @@ -5801,6 +5845,22 @@ "description": "Node kubelet configs.", "id": "NodeKubeletConfig", "properties": { + "allowedUnsafeSysctls": { + "description": "Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "containerLogMaxFiles": { + "description": "Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified.", + "format": "int32", + "type": "integer" + }, + "containerLogMaxSize": { + "description": "Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified.", + "type": "string" + }, "cpuCfsQuota": { "description": "Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.", "type": "boolean" @@ -5813,6 +5873,24 @@ "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", "type": "string" }, + "imageGcHighThresholdPercent": { + "description": "Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent. The default value is 85 if unspecified.", + "format": "int32", + "type": "integer" + }, + "imageGcLowThresholdPercent": { + "description": "Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent. The default value is 80 if unspecified.", + "format": "int32", + "type": "integer" + }, + "imageMaximumGcAge": { + "description": "Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300s\", \"1.5h\", and \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration greater than image_minimum_gc_age or \"0s\". The default value is \"0s\" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long.", + "type": "string" + }, + "imageMinimumGcAge": { + "description": "Optional. Defines the minimum age for an unused image before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300s\", \"1.5h\", and \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration less than or equal to 2 minutes. The default value is \"2m0s\" if unspecified.", + "type": "string" + }, "insecureKubeletReadonlyPortEnabled": { "description": "Enable or disable Kubelet read only port.", "type": "boolean" @@ -5913,6 +5991,10 @@ "description": "NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.", "id": "NodePool", "properties": { + "autopilotConfig": { + "$ref": "AutopilotConfig", + "description": "Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api" + }, "autoscaling": { "$ref": "NodePoolAutoscaling", "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present." @@ -7674,7 +7756,8 @@ "GCE_QUOTA_EXCEEDED", "SET_BY_OPERATOR", "CLOUD_KMS_KEY_ERROR", - "CA_EXPIRING" + "CA_EXPIRING", + "NODE_SERVICE_ACCOUNT_MISSING_PERMISSIONS" ], "enumDescriptions": [ "UNKNOWN indicates a generic condition.", @@ -7683,7 +7766,8 @@ "Google Compute Engine quota was exceeded.", "Cluster state was manually changed by an SRE due to a system logic error.", "Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption.", - "Cluster CA is expiring soon." + "Cluster CA is expiring soon.", + "Node service account is missing permissions." ], "type": "string" }, @@ -8036,11 +8120,13 @@ "description": "The type of the event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", - "END_OF_SUPPORT" + "END_OF_SUPPORT", + "COS_MILESTONE_VERSION_UPDATE" ], "enumDescriptions": [ "EVENT_TYPE_UNSPECIFIED indicates the event type is unspecified.", - "END_OF_SUPPORT indicates GKE version reaches end of support, check standard_support_end_time and extended_support_end_time for more details." + "END_OF_SUPPORT indicates GKE version reaches end of support, check standard_support_end_time and extended_support_end_time for more details.", + "COS_MILESTONE_VERSION_UPDATE indicates that the COS node image will update COS milestone version for new patch versions starting with the one in the description." ], "type": "string" }, @@ -8332,6 +8418,10 @@ "allowNetAdmin": { "description": "If true, workloads can use NET_ADMIN capability.", "type": "boolean" + }, + "autopilotCompatibilityAuditingEnabled": { + "description": "If true, enables the GCW Auditor that audits workloads on standard clusters.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index c85eaa4821c..f4ed36dd397 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2685,7 +2685,7 @@ } } }, - "revision": "20241228", + "revision": "20250225", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2989,7 +2989,7 @@ "type": "string" }, "documentationUrl": { - "description": "A URL to a public documnetation, which addresses resolving this issue.", + "description": "A URL to a public documentation, which addresses resolving this issue.", "type": "string" }, "incompatibilityType": { @@ -3023,6 +3023,17 @@ }, "type": "object" }, + "AutopilotConfig": { + "description": "AutopilotConfig contains configuration of autopilot feature for this nodepool.", + "id": "AutopilotConfig", + "properties": { + "enabled": { + "description": "Denotes that nodes belonging to this node pool are Autopilot nodes.", + "type": "boolean" + } + }, + "type": "object" + }, "AutopilotConversionStatus": { "description": "AutopilotConversionStatus represents conversion status.", "id": "AutopilotConversionStatus", @@ -3291,7 +3302,7 @@ "id": "CertificateAuthorityDomainConfig", "properties": { "fqdns": { - "description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", + "description": "List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000", "items": { "type": "string" }, @@ -3472,7 +3483,8 @@ "type": "boolean" }, "enableTpu": { - "description": "Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.", + "deprecated": true, + "description": "Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.", "type": "boolean" }, "endpoint": { @@ -3749,10 +3761,12 @@ }, "tpuConfig": { "$ref": "TpuConfig", - "description": "Configuration for Cloud TPU support;" + "deprecated": true, + "description": "Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25." }, "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`).", + "deprecated": true, + "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`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.", "readOnly": true, "type": "string" }, @@ -4189,7 +4203,8 @@ }, "desiredTpuConfig": { "$ref": "TpuConfig", - "description": "The desired Cloud TPU configuration." + "deprecated": true, + "description": "The desired Cloud TPU configuration. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25." }, "desiredVerticalPodAutoscaling": { "$ref": "VerticalPodAutoscaling", @@ -4795,13 +4810,15 @@ "EVENT_TYPE_UNSPECIFIED", "UPGRADE_AVAILABLE_EVENT", "UPGRADE_EVENT", - "SECURITY_BULLETIN_EVENT" + "SECURITY_BULLETIN_EVENT", + "UPGRADE_INFO_EVENT" ], "enumDescriptions": [ "Not set, will be ignored.", "Corresponds with UpgradeAvailableEvent.", "Corresponds with UpgradeEvent.", - "Corresponds with SecurityBulletinEvent." + "Corresponds with SecurityBulletinEvent.", + "Corresponds with UpgradeInfoEvent." ], "type": "string" }, @@ -4965,7 +4982,7 @@ "type": "object" }, "GetJSONWebKeysResponse": { - "description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517", + "description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517", "id": "GetJSONWebKeysResponse", "properties": { "cacheHeader": { @@ -5247,6 +5264,7 @@ "type": "string" }, "tpuIpv4CidrBlock": { + "deprecated": true, "description": "The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.", "type": "string" }, @@ -5462,7 +5480,7 @@ "additionalProperties": { "type": "string" }, - "description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse kernel.shmmni kernel.shmmax kernel.shmall", + "description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall vm.max_map_count", "type": "object" } }, @@ -5616,7 +5634,8 @@ "SCHEDULER", "CONTROLLER_MANAGER", "KCP_SSHD", - "KCP_CONNECTION" + "KCP_CONNECTION", + "KCP_HPA" ], "enumDescriptions": [ "Default value. This shouldn't be used.", @@ -5626,7 +5645,8 @@ "kube-scheduler", "kube-controller-manager", "kcp-sshd", - "kcp connection logs" + "kcp connection logs", + "horizontal pod autoscaler decision logs" ], "type": "string" }, @@ -5798,7 +5818,7 @@ "type": "boolean" }, "gcpPublicCidrsAccessEnabled": { - "description": "Whether master is accessbile via Google Compute Engine Public IP addresses.", + "description": "Whether master is accessible via Google Compute Engine Public IP addresses.", "type": "boolean" }, "privateEndpointEnforcementEnabled": { @@ -5878,7 +5898,8 @@ "STATEFULSET", "CADVISOR", "KUBELET", - "DCGM" + "DCGM", + "JOBSET" ], "enumDeprecated": [ false, @@ -5895,6 +5916,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5912,7 +5934,8 @@ "Statefulset", "CADVISOR", "KUBELET", - "NVIDIA Data Center GPU Manager (DCGM)" + "NVIDIA Data Center GPU Manager (DCGM)", + "JobSet" ], "type": "string" }, @@ -6013,7 +6036,7 @@ "type": "string" }, "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", + "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" }, @@ -6268,7 +6291,7 @@ "type": "integer" }, "localSsdEncryptionMode": { - "description": "Specifies which method should be used for encrypting the Local SSDs attahced to the node.", + "description": "Specifies which method should be used for encrypting the Local SSDs attached to the node.", "enum": [ "LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", "STANDARD_ENCRYPTION", @@ -6429,6 +6452,22 @@ "description": "Node kubelet configs.", "id": "NodeKubeletConfig", "properties": { + "allowedUnsafeSysctls": { + "description": "Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "containerLogMaxFiles": { + "description": "Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified.", + "format": "int32", + "type": "integer" + }, + "containerLogMaxSize": { + "description": "Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified.", + "type": "string" + }, "cpuCfsQuota": { "description": "Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.", "type": "boolean" @@ -6441,6 +6480,24 @@ "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", "type": "string" }, + "imageGcHighThresholdPercent": { + "description": "Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent. The default value is 85 if unspecified.", + "format": "int32", + "type": "integer" + }, + "imageGcLowThresholdPercent": { + "description": "Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent. The default value is 80 if unspecified.", + "format": "int32", + "type": "integer" + }, + "imageMaximumGcAge": { + "description": "Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300s\", \"1.5h\", and \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration greater than image_minimum_gc_age or \"0s\". The default value is \"0s\" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long.", + "type": "string" + }, + "imageMinimumGcAge": { + "description": "Optional. Defines the minimum age for an unused image before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300s\", \"1.5h\", and \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration less than or equal to 2 minutes. The default value is \"2m0s\" if unspecified.", + "type": "string" + }, "insecureKubeletReadonlyPortEnabled": { "description": "Enable or disable Kubelet read only port.", "type": "boolean" @@ -6541,6 +6598,10 @@ "description": "NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.", "id": "NodePool", "properties": { + "autopilotConfig": { + "$ref": "AutopilotConfig", + "description": "Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api" + }, "autoscaling": { "$ref": "NodePoolAutoscaling", "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present." @@ -8482,7 +8543,8 @@ "GCE_QUOTA_EXCEEDED", "SET_BY_OPERATOR", "CLOUD_KMS_KEY_ERROR", - "CA_EXPIRING" + "CA_EXPIRING", + "NODE_SERVICE_ACCOUNT_MISSING_PERMISSIONS" ], "enumDescriptions": [ "UNKNOWN indicates a generic condition.", @@ -8491,7 +8553,8 @@ "Google Compute Engine quota was exceeded.", "Cluster state was manually changed by an SRE due to a system logic error.", "Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption.", - "Cluster CA is expiring soon. More codes TBA" + "Cluster CA is expiring soon.", + "Node service account is missing permissions." ], "type": "string" }, @@ -8524,7 +8587,8 @@ "type": "object" }, "TpuConfig": { - "description": "Configuration for Cloud TPU.", + "deprecated": true, + "description": "Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.", "id": "TpuConfig", "properties": { "enabled": { @@ -8911,11 +8975,13 @@ "description": "The type of the event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", - "END_OF_SUPPORT" + "END_OF_SUPPORT", + "COS_MILESTONE_VERSION_UPDATE" ], "enumDescriptions": [ "EVENT_TYPE_UNSPECIFIED indicates the event type is unspecified.", - "END_OF_SUPPORT indicates GKE version reaches end of support, check standard_support_end_time and extended_support_end_time for more details." + "END_OF_SUPPORT indicates GKE version reaches end of support, check standard_support_end_time and extended_support_end_time for more details.", + "COS_MILESTONE_VERSION_UPDATE indicates that the COS node image will update COS milestone version for new patch versions starting with the one in the description." ], "type": "string" }, @@ -9320,6 +9386,10 @@ "allowNetAdmin": { "description": "If true, workloads can use NET_ADMIN capability.", "type": "boolean" + }, + "autopilotCompatibilityAuditingEnabled": { + "description": "If true, enables the GCW Auditor that audits workloads on standard clusters.", + "type": "boolean" } }, "type": "object" diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 71190452056..323e5b05e50 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -300,6 +300,15 @@ export namespace container_v1 { */ securityGroup?: string | null; } + /** + * AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. + */ + export interface Schema$AutoMonitoringConfig { + /** + * Scope for GKE Workload Auto-Monitoring. + */ + scope?: string | null; + } /** * Autopilot is the configuration for Autopilot settings on the cluster. */ @@ -326,7 +335,7 @@ export namespace container_v1 { */ description?: string | null; /** - * A URL to a public documnetation, which addresses resolving this issue. + * A URL to a public documentation, which addresses resolving this issue. */ documentationUrl?: string | null; /** @@ -342,6 +351,15 @@ export namespace container_v1 { */ subjects?: string[] | null; } + /** + * AutopilotConfig contains configuration of autopilot feature for this nodepool. + */ + export interface Schema$AutopilotConfig { + /** + * Denotes that nodes belonging to this node pool are Autopilot nodes. + */ + enabled?: boolean | null; + } /** * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. */ @@ -503,7 +521,7 @@ export namespace container_v1 { */ export interface Schema$CertificateAuthorityDomainConfig { /** - * List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + * List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 */ fqdns?: string[] | null; /** @@ -644,7 +662,7 @@ export namespace container_v1 { */ enableKubernetesAlpha?: boolean | null; /** - * Enable the ability to use Cloud TPUs in this cluster. + * Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ enableTpu?: boolean | null; /** @@ -699,9 +717,6 @@ export namespace container_v1 { * Configuration for the legacy ABAC authorization mode. */ 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. - */ location?: string | null; /** * The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. @@ -844,7 +859,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`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ tpuIpv4CidrBlock?: string | null; /** @@ -1533,7 +1548,7 @@ export namespace container_v1 { enabled?: boolean | null; } /** - * GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 + * GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517 */ export interface Schema$GetJSONWebKeysResponse { /** @@ -1761,7 +1776,7 @@ export namespace container_v1 { */ subnetworkName?: string | null; /** - * The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. + * The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ tpuIpv4CidrBlock?: string | null; /** @@ -1887,7 +1902,7 @@ export namespace container_v1 { */ hugepages?: Schema$HugepagesConfig; /** - * The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse kernel.shmmni kernel.shmmax kernel.shmall + * The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall vm.max_map_count */ sysctls?: {[key: string]: string} | null; } @@ -2018,6 +2033,10 @@ export namespace container_v1 { * ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. */ export interface Schema$ManagedPrometheusConfig { + /** + * GKE Workload Auto-Monitoring Configuration. + */ + autoMonitoringConfig?: Schema$AutoMonitoringConfig; /** * Enable Managed Collection. */ @@ -2065,7 +2084,7 @@ export namespace container_v1 { */ enabled?: boolean | null; /** - * Whether master is accessbile via Google Compute Engine Public IP addresses. + * Whether master is accessible via Google Compute Engine Public IP addresses. */ gcpPublicCidrsAccessEnabled?: boolean | null; /** @@ -2191,7 +2210,7 @@ export namespace container_v1 { */ inTransitEncryptionConfig?: string | null; /** - * 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 + * 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 */ network?: string | null; /** @@ -2349,7 +2368,7 @@ export namespace container_v1 { */ localSsdCount?: number | null; /** - * Specifies which method should be used for encrypting the Local SSDs attahced to the node. + * Specifies which method should be used for encrypting the Local SSDs attached to the node. */ localSsdEncryptionMode?: string | null; /** @@ -2470,6 +2489,18 @@ export namespace container_v1 { * Node kubelet configs. */ export interface Schema$NodeKubeletConfig { + /** + * Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. + */ + allowedUnsafeSysctls?: string[] | null; + /** + * Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. + */ + containerLogMaxFiles?: number | null; + /** + * Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. + */ + containerLogMaxSize?: string | null; /** * Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. */ @@ -2482,6 +2513,22 @@ export namespace container_v1 { * Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. */ cpuManagerPolicy?: string | null; + /** + * Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent. The default value is 85 if unspecified. + */ + imageGcHighThresholdPercent?: number | null; + /** + * Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent. The default value is 80 if unspecified. + */ + imageGcLowThresholdPercent?: number | null; + /** + * Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration greater than image_minimum_gc_age or "0s". The default value is "0s" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long. + */ + imageMaximumGcAge?: string | null; + /** + * Optional. Defines the minimum age for an unused image before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration less than or equal to 2 minutes. The default value is "2m0s" if unspecified. + */ + imageMinimumGcAge?: string | null; /** * Enable or disable Kubelet read only port. */ @@ -2562,6 +2609,10 @@ export namespace container_v1 { * NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. */ export interface Schema$NodePool { + /** + * Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + */ + autopilotConfig?: Schema$AutopilotConfig; /** * Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. */ @@ -4228,6 +4279,10 @@ export namespace container_v1 { * If true, workloads can use NET_ADMIN capability. */ allowNetAdmin?: boolean | null; + /** + * If true, enables the GCW Auditor that audits workloads on standard clusters. + */ + autopilotCompatibilityAuditingEnabled?: boolean | null; } export class Resource$Projects { diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index b189f8b24ad..5f67986c065 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -351,7 +351,7 @@ export namespace container_v1beta1 { */ description?: string | null; /** - * A URL to a public documnetation, which addresses resolving this issue. + * A URL to a public documentation, which addresses resolving this issue. */ documentationUrl?: string | null; /** @@ -367,6 +367,15 @@ export namespace container_v1beta1 { */ subjects?: string[] | null; } + /** + * AutopilotConfig contains configuration of autopilot feature for this nodepool. + */ + export interface Schema$AutopilotConfig { + /** + * Denotes that nodes belonging to this node pool are Autopilot nodes. + */ + enabled?: boolean | null; + } /** * AutopilotConversionStatus represents conversion status. */ @@ -562,7 +571,7 @@ export namespace container_v1beta1 { */ export interface Schema$CertificateAuthorityDomainConfig { /** - * List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 + * List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 */ fqdns?: string[] | null; /** @@ -707,7 +716,7 @@ export namespace container_v1beta1 { */ enableKubernetesAlpha?: boolean | null; /** - * Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. + * Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ enableTpu?: boolean | null; /** @@ -931,11 +940,11 @@ export namespace container_v1beta1 { */ subnetwork?: string | null; /** - * Configuration for Cloud TPU support; + * Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ 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`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ tpuIpv4CidrBlock?: string | null; /** @@ -1275,7 +1284,7 @@ export namespace container_v1beta1 { */ desiredStackType?: string | null; /** - * The desired Cloud TPU configuration. + * The desired Cloud TPU configuration. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ desiredTpuConfig?: Schema$TpuConfig; /** @@ -1740,7 +1749,7 @@ export namespace container_v1beta1 { enabled?: boolean | null; } /** - * GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 + * GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517 */ export interface Schema$GetJSONWebKeysResponse { /** @@ -2133,7 +2142,7 @@ export namespace container_v1beta1 { */ hugepages?: Schema$HugepagesConfig; /** - * The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse kernel.shmmni kernel.shmmax kernel.shmall + * The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall vm.max_map_count */ sysctls?: {[key: string]: string} | null; } @@ -2349,7 +2358,7 @@ export namespace container_v1beta1 { */ enabled?: boolean | null; /** - * Whether master is accessbile via Google Compute Engine Public IP addresses. + * Whether master is accessible via Google Compute Engine Public IP addresses. */ gcpPublicCidrsAccessEnabled?: boolean | null; /** @@ -2475,7 +2484,7 @@ export namespace container_v1beta1 { */ inTransitEncryptionConfig?: string | null; /** - * 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 + * 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 */ network?: string | null; /** @@ -2645,7 +2654,7 @@ export namespace container_v1beta1 { */ localSsdCount?: number | null; /** - * Specifies which method should be used for encrypting the Local SSDs attahced to the node. + * Specifies which method should be used for encrypting the Local SSDs attached to the node. */ localSsdEncryptionMode?: string | null; /** @@ -2770,6 +2779,18 @@ export namespace container_v1beta1 { * Node kubelet configs. */ export interface Schema$NodeKubeletConfig { + /** + * Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. + */ + allowedUnsafeSysctls?: string[] | null; + /** + * Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. + */ + containerLogMaxFiles?: number | null; + /** + * Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. + */ + containerLogMaxSize?: string | null; /** * Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified. */ @@ -2782,6 +2803,22 @@ export namespace container_v1beta1 { * Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified. */ cpuManagerPolicy?: string | null; + /** + * Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent. The default value is 85 if unspecified. + */ + imageGcHighThresholdPercent?: number | null; + /** + * Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent. The default value is 80 if unspecified. + */ + imageGcLowThresholdPercent?: number | null; + /** + * Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration greater than image_minimum_gc_age or "0s". The default value is "0s" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long. + */ + imageMaximumGcAge?: string | null; + /** + * Optional. Defines the minimum age for an unused image before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration less than or equal to 2 minutes. The default value is "2m0s" if unspecified. + */ + imageMinimumGcAge?: string | null; /** * Enable or disable Kubelet read only port. */ @@ -2862,6 +2899,10 @@ export namespace container_v1beta1 { * NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. */ export interface Schema$NodePool { + /** + * Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler to implement go/gke-managed-nodes-ccc-api + */ + autopilotConfig?: Schema$AutopilotConfig; /** * Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. */ @@ -4179,7 +4220,7 @@ export namespace container_v1beta1 { startTime?: string | null; } /** - * Configuration for Cloud TPU. + * Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ export interface Schema$TpuConfig { /** @@ -4741,6 +4782,10 @@ export namespace container_v1beta1 { * If true, workloads can use NET_ADMIN capability. */ allowNetAdmin?: boolean | null; + /** + * If true, enables the GCW Auditor that audits workloads on standard clusters. + */ + autopilotCompatibilityAuditingEnabled?: boolean | null; } export class Resource$Projects { From 72a12199ad4314e8736065ea53dec69f52e9f3cd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:42 +0000 Subject: [PATCH 038/144] feat(containeranalysis): update the API #### containeranalysis:v1alpha1 The following keys were added: - schemas.BaseImage.description - schemas.BaseImage.id - schemas.BaseImage.properties.layerCount.description - schemas.BaseImage.properties.layerCount.format - schemas.BaseImage.properties.layerCount.type - schemas.BaseImage.properties.name.description - schemas.BaseImage.properties.name.type - schemas.BaseImage.properties.repository.description - schemas.BaseImage.properties.repository.type - schemas.BaseImage.type - schemas.BuildStep.properties.results.items.$ref - schemas.BuildStep.properties.results.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.modulePath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.modulePath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.moduleVersion.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.moduleVersion.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryLocation.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryLocation.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryName.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryName.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryProjectId.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryProjectId.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.sourcePath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.sourcePath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.enableStructuredLogging.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.enableStructuredLogging.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.empty.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.empty.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.format - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.destPath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.destPath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.recurseSubmodules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.recurseSubmodules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.repository.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.repository.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.revision.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.revision.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.developerConnect.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.developerConnect.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.url.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.url.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.fileHashes.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.fileHashes.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.readOnly - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.uri.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.uri.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.type - schemas.FileLocation.properties.layerDetails.$ref - schemas.FileLocation.properties.layerDetails.description - schemas.LayerDetails.description - schemas.LayerDetails.id - schemas.LayerDetails.properties.baseImages.description - schemas.LayerDetails.properties.baseImages.items.$ref - schemas.LayerDetails.properties.baseImages.type - schemas.LayerDetails.properties.command.description - schemas.LayerDetails.properties.command.type - schemas.LayerDetails.properties.diffId.description - schemas.LayerDetails.properties.diffId.type - schemas.LayerDetails.properties.index.description - schemas.LayerDetails.properties.index.format - schemas.LayerDetails.properties.index.type - schemas.LayerDetails.type - schemas.StepResult.description - schemas.StepResult.id - schemas.StepResult.properties.attestationContentName.type - schemas.StepResult.properties.attestationType.type - schemas.StepResult.properties.name.type - schemas.StepResult.type The following keys were changed: - endpoints - schemas.BuildStep.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enumDescriptions - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Hash.properties.type.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Hash.properties.type.enumDescriptions #### containeranalysis:v1beta1 The following keys were added: - schemas.BuildStep.properties.results.items.$ref - schemas.BuildStep.properties.results.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.modulePath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.modulePath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.moduleVersion.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.moduleVersion.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryLocation.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryLocation.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryName.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryName.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryProjectId.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryProjectId.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.sourcePath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.sourcePath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.enableStructuredLogging.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.enableStructuredLogging.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.empty.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.empty.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.format - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.destPath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.destPath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.recurseSubmodules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.recurseSubmodules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.repository.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.repository.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.revision.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.revision.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.developerConnect.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.developerConnect.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.url.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.url.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.fileHashes.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.fileHashes.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.readOnly - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.uri.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.uri.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.type - schemas.StepResult.description - schemas.StepResult.id - schemas.StepResult.properties.attestationContentName.type - schemas.StepResult.properties.attestationType.type - schemas.StepResult.properties.name.type - schemas.StepResult.type The following keys were changed: - endpoints - schemas.BuildStep.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enumDescriptions - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Hash.properties.type.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Hash.properties.type.enumDescriptions #### containeranalysis:v1 The following keys were added: - schemas.BaseImage.description - schemas.BaseImage.id - schemas.BaseImage.properties.layerCount.description - schemas.BaseImage.properties.layerCount.format - schemas.BaseImage.properties.layerCount.type - schemas.BaseImage.properties.name.description - schemas.BaseImage.properties.name.type - schemas.BaseImage.properties.repository.description - schemas.BaseImage.properties.repository.type - schemas.BaseImage.type - schemas.BuildStep.properties.results.items.$ref - schemas.BuildStep.properties.results.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts.properties.goModules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.modulePath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.modulePath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.moduleVersion.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.moduleVersion.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryLocation.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryLocation.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryName.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryName.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryProjectId.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.repositoryProjectId.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.sourcePath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.properties.sourcePath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Build.properties.dependencies.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.enableStructuredLogging.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.enableStructuredLogging.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.empty.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.empty.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.format - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.depth.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.destPath.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.destPath.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.recurseSubmodules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.recurseSubmodules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.repository.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.repository.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.revision.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.properties.revision.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.developerConnect.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.developerConnect.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.url.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.properties.url.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.items.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.goModules.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.id - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.fileHashes.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.fileHashes.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.$ref - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.pushTiming.readOnly - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.uri.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.properties.uri.type - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule.type - schemas.GrafeasV1FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1FileLocation.properties.layerDetails.description - schemas.LayerDetails.description - schemas.LayerDetails.id - schemas.LayerDetails.properties.baseImages.description - schemas.LayerDetails.properties.baseImages.items.$ref - schemas.LayerDetails.properties.baseImages.type - schemas.LayerDetails.properties.command.description - schemas.LayerDetails.properties.command.type - schemas.LayerDetails.properties.diffId.description - schemas.LayerDetails.properties.diffId.type - schemas.LayerDetails.properties.index.description - schemas.LayerDetails.properties.index.format - schemas.LayerDetails.properties.index.type - schemas.LayerDetails.type - schemas.StepResult.description - schemas.StepResult.id - schemas.StepResult.properties.attestationContentName.type - schemas.StepResult.properties.attestationType.type - schemas.StepResult.properties.name.type - schemas.StepResult.type The following keys were changed: - endpoints - schemas.BuildStep.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.properties.sourceProvenanceHash.items.enumDescriptions - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Hash.properties.type.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Hash.properties.type.enumDescriptions - schemas.ExportSBOMRequest.properties.cloudStorageLocation.description --- discovery/containeranalysis-v1.json | 241 +++++++++++++++++++++- discovery/containeranalysis-v1alpha1.json | 239 ++++++++++++++++++++- discovery/containeranalysis-v1beta1.json | 188 ++++++++++++++++- src/apis/containeranalysis/v1.ts | 172 ++++++++++++++- src/apis/containeranalysis/v1alpha1.ts | 170 ++++++++++++++- src/apis/containeranalysis/v1beta1.ts | 128 +++++++++++- 6 files changed, 1127 insertions(+), 11 deletions(-) diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index c35c7fe34e3..4937a8e06c9 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -200,6 +200,26 @@ "description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.us-west4.rep.googleapis.com/", "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.europe-west10.rep.googleapis.com/", + "location": "europe-west10" } ], "fullyEncodeReservedExpansion": true, @@ -1655,7 +1675,7 @@ } } }, - "revision": "20240924", + "revision": "20250307", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -1824,6 +1844,26 @@ }, "type": "object" }, + "BaseImage": { + "description": "BaseImage describes a base image of a container image.", + "id": "BaseImage", + "properties": { + "layerCount": { + "description": "The number of layers that the base image is composed of.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "The name of the base image.", + "type": "string" + }, + "repository": { + "description": "The repository name in which the base image is from.", + "type": "string" + } + }, + "type": "object" + }, "BatchCreateNotesRequest": { "description": "Request to create notes in batch.", "id": "BatchCreateNotesRequest", @@ -2058,7 +2098,7 @@ "type": "object" }, "BuildStep": { - "description": "A step in the build pipeline. Next ID: 21", + "description": "A step in the build pipeline. Next ID: 22", "id": "BuildStep", "properties": { "allowExitCodes": { @@ -2116,6 +2156,12 @@ "$ref": "TimeSpan", "description": "Output only. Stores timing information for pulling this build step's builder image only." }, + "results": { + "items": { + "$ref": "StepResult" + }, + "type": "array" + }, "script": { "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.", "type": "string" @@ -2758,6 +2804,13 @@ "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts", "properties": { + "goModules": { + "description": "Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule" + }, + "type": "array" + }, "images": { "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", "items": { @@ -2816,6 +2869,37 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule": { + "description": "Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule", + "properties": { + "modulePath": { + "description": "Optional. The Go module's \"module path\". e.g. example.com/foo/v2", + "type": "string" + }, + "moduleVersion": { + "description": "Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5", + "type": "string" + }, + "repositoryLocation": { + "description": "Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location.", + "type": "string" + }, + "repositoryName": { + "description": "Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo", + "type": "string" + }, + "repositoryProjectId": { + "description": "Optional. Project ID of the Artifact Registry repository. Defaults to the build project.", + "type": "string" + }, + "sourcePath": { + "description": "Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact": { "description": "A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact", @@ -2904,6 +2988,13 @@ "readOnly": true, "type": "string" }, + "dependencies": { + "description": "Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency" + }, + "type": "array" + }, "failureInfo": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo", "description": "Output only. Contains information about the build when status=FAILURE.", @@ -3169,6 +3260,10 @@ "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.", "type": "boolean" }, + "enableStructuredLogging": { + "description": "Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.", + "type": "boolean" + }, "env": { "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { @@ -3250,6 +3345,10 @@ "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, + "pubsubTopic": { + "description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", + "type": "string" + }, "requestedVerifyOption": { "description": "Requested verifiability options.", "enum": [ @@ -3276,12 +3375,14 @@ "NONE", "SHA256", "MD5", + "GO_MODULE_H1", "SHA512" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", + "Dirhash of a Go module's source code which is then hex-encoded.", "Use a sha512 hash." ], "type": "string" @@ -3520,6 +3621,64 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency": { + "description": "A dependency that the Cloud Build worker will fetch before executing user steps.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency", + "properties": { + "empty": { + "description": "If set to true disable all dependency fetching (ignoring the default source as well).", + "type": "boolean" + }, + "gitSource": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency", + "description": "Represents a git repository as a build dependency." + } + }, + "type": "object" + }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency": { + "description": "Represents a git repository as a build dependency.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency", + "properties": { + "depth": { + "description": "Optional. How much history should be fetched for the build (default 1, -1 for all history).", + "format": "int64", + "type": "string" + }, + "destPath": { + "description": "Required. Where should the files be placed on the worker.", + "type": "string" + }, + "recurseSubmodules": { + "description": "Optional. True if submodules should be fetched too (default false).", + "type": "boolean" + }, + "repository": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository", + "description": "Required. The kind of repo (url or dev connect)." + }, + "revision": { + "description": "Required. The revision that we will fetch the repo at.", + "type": "string" + } + }, + "type": "object" + }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository": { + "description": "A repository for a git source.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository", + "properties": { + "developerConnect": { + "description": "The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", + "type": "string" + }, + "url": { + "description": "Location of the Git repository.", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig": { "description": "This config defines the location of a source through Developer Connect.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig", @@ -3604,12 +3763,14 @@ "NONE", "SHA256", "MD5", + "GO_MODULE_H1", "SHA512" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", + "Dirhash of a Go module's source code which is then hex-encoded.", "Use a sha512 hash." ], "type": "string" @@ -3710,6 +3871,13 @@ }, "type": "array" }, + "goModules": { + "description": "Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule" + }, + "type": "array" + }, "images": { "description": "Container images that were built as a part of the build.", "items": { @@ -3940,6 +4108,26 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule": { + "description": "A Go module artifact uploaded to Artifact Registry using the GoModule directive.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule", + "properties": { + "fileHashes": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the Go Module Artifact." + }, + "pushTiming": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded artifact.", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact": { "description": "A Maven artifact uploaded using the MavenArtifact directive.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact", @@ -4399,7 +4587,7 @@ "properties": { "cloudStorageLocation": { "$ref": "CloudStorageLocation", - "description": "Empty placeholder to denote that this is a Google Cloud Storage export request." + "description": "Optional. Empty placeholder to denote that this is a Google Cloud Storage export request." } }, "type": "object" @@ -4600,6 +4788,10 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" + }, + "layerDetails": { + "$ref": "LayerDetails", + "description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package)." } }, "type": "object" @@ -4944,6 +5136,33 @@ }, "type": "object" }, + "LayerDetails": { + "description": "Details about the layer a package was found in.", + "id": "LayerDetails", + "properties": { + "baseImages": { + "description": "The base images the layer is found within.", + "items": { + "$ref": "BaseImage" + }, + "type": "array" + }, + "command": { + "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", + "type": "string" + }, + "diffId": { + "description": "The diff ID (typically a sha256 hash) of the layer in the container image.", + "type": "string" + }, + "index": { + "description": "The index of the layer in the container image.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "License": { "description": "License information.", "id": "License", @@ -6169,6 +6388,22 @@ }, "type": "object" }, + "StepResult": { + "description": "StepResult is the declaration of a result for a build step.", + "id": "StepResult", + "properties": { + "attestationContentName": { + "type": "string" + }, + "attestationType": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, "Subject": { "id": "Subject", "properties": { diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index 75fcea869cf..cf4b352c715 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -200,6 +200,26 @@ "description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.us-west4.rep.googleapis.com/", "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.europe-west10.rep.googleapis.com/", + "location": "europe-west10" } ], "fullyEncodeReservedExpansion": true, @@ -1420,7 +1440,7 @@ } } }, - "revision": "20241025", + "revision": "20250307", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -1561,6 +1581,26 @@ }, "type": "object" }, + "BaseImage": { + "description": "BaseImage describes a base image of a container image.", + "id": "BaseImage", + "properties": { + "layerCount": { + "description": "The number of layers that the base image is composed of.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "The name of the base image.", + "type": "string" + }, + "repository": { + "description": "The repository name in which the base image is from.", + "type": "string" + } + }, + "type": "object" + }, "Basis": { "description": "Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url.", "id": "Basis", @@ -1776,7 +1816,7 @@ "type": "object" }, "BuildStep": { - "description": "A step in the build pipeline. Next ID: 21", + "description": "A step in the build pipeline. Next ID: 22", "id": "BuildStep", "properties": { "allowExitCodes": { @@ -1834,6 +1874,12 @@ "$ref": "TimeSpan", "description": "Output only. Stores timing information for pulling this build step's builder image only." }, + "results": { + "items": { + "$ref": "StepResult" + }, + "type": "array" + }, "script": { "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.", "type": "string" @@ -2329,6 +2375,13 @@ "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts", "properties": { + "goModules": { + "description": "Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule" + }, + "type": "array" + }, "images": { "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", "items": { @@ -2387,6 +2440,37 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule": { + "description": "Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule", + "properties": { + "modulePath": { + "description": "Optional. The Go module's \"module path\". e.g. example.com/foo/v2", + "type": "string" + }, + "moduleVersion": { + "description": "Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5", + "type": "string" + }, + "repositoryLocation": { + "description": "Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location.", + "type": "string" + }, + "repositoryName": { + "description": "Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo", + "type": "string" + }, + "repositoryProjectId": { + "description": "Optional. Project ID of the Artifact Registry repository. Defaults to the build project.", + "type": "string" + }, + "sourcePath": { + "description": "Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact": { "description": "A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact", @@ -2475,6 +2559,13 @@ "readOnly": true, "type": "string" }, + "dependencies": { + "description": "Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency" + }, + "type": "array" + }, "failureInfo": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo", "description": "Output only. Contains information about the build when status=FAILURE.", @@ -2740,6 +2831,10 @@ "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.", "type": "boolean" }, + "enableStructuredLogging": { + "description": "Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.", + "type": "boolean" + }, "env": { "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { @@ -2821,6 +2916,10 @@ "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, + "pubsubTopic": { + "description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", + "type": "string" + }, "requestedVerifyOption": { "description": "Requested verifiability options.", "enum": [ @@ -2847,12 +2946,14 @@ "NONE", "SHA256", "MD5", + "GO_MODULE_H1", "SHA512" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", + "Dirhash of a Go module's source code which is then hex-encoded.", "Use a sha512 hash." ], "type": "string" @@ -3091,6 +3192,64 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency": { + "description": "A dependency that the Cloud Build worker will fetch before executing user steps.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency", + "properties": { + "empty": { + "description": "If set to true disable all dependency fetching (ignoring the default source as well).", + "type": "boolean" + }, + "gitSource": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency", + "description": "Represents a git repository as a build dependency." + } + }, + "type": "object" + }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency": { + "description": "Represents a git repository as a build dependency.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency", + "properties": { + "depth": { + "description": "Optional. How much history should be fetched for the build (default 1, -1 for all history).", + "format": "int64", + "type": "string" + }, + "destPath": { + "description": "Required. Where should the files be placed on the worker.", + "type": "string" + }, + "recurseSubmodules": { + "description": "Optional. True if submodules should be fetched too (default false).", + "type": "boolean" + }, + "repository": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository", + "description": "Required. The kind of repo (url or dev connect)." + }, + "revision": { + "description": "Required. The revision that we will fetch the repo at.", + "type": "string" + } + }, + "type": "object" + }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository": { + "description": "A repository for a git source.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository", + "properties": { + "developerConnect": { + "description": "The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", + "type": "string" + }, + "url": { + "description": "Location of the Git repository.", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig": { "description": "This config defines the location of a source through Developer Connect.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig", @@ -3175,12 +3334,14 @@ "NONE", "SHA256", "MD5", + "GO_MODULE_H1", "SHA512" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", + "Dirhash of a Go module's source code which is then hex-encoded.", "Use a sha512 hash." ], "type": "string" @@ -3281,6 +3442,13 @@ }, "type": "array" }, + "goModules": { + "description": "Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule" + }, + "type": "array" + }, "images": { "description": "Container images that were built as a part of the build.", "items": { @@ -3511,6 +3679,26 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule": { + "description": "A Go module artifact uploaded to Artifact Registry using the GoModule directive.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule", + "properties": { + "fileHashes": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the Go Module Artifact." + }, + "pushTiming": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded artifact.", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact": { "description": "A Maven artifact uploaded using the MavenArtifact directive.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact", @@ -4164,6 +4352,10 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" + }, + "layerDetails": { + "$ref": "LayerDetails", + "description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package)." } }, "type": "object" @@ -4876,6 +5068,33 @@ }, "type": "object" }, + "LayerDetails": { + "description": "Details about the layer a package was found in.", + "id": "LayerDetails", + "properties": { + "baseImages": { + "description": "The base images the layer is found within.", + "items": { + "$ref": "BaseImage" + }, + "type": "array" + }, + "command": { + "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", + "type": "string" + }, + "diffId": { + "description": "The diff ID (sha256 hash) of the layer in the container image.", + "type": "string" + }, + "index": { + "description": "The index of the layer in the container image.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "License": { "description": "License information.", "id": "License", @@ -6562,6 +6781,22 @@ }, "type": "object" }, + "StepResult": { + "description": "StepResult is the declaration of a result for a build step.", + "id": "StepResult", + "properties": { + "attestationContentName": { + "type": "string" + }, + "attestationType": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, "StorageSource": { "description": "StorageSource describes the location of the source in an archive file in Google Cloud Storage.", "id": "StorageSource", diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index be15eefcf30..b134c561257 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -200,6 +200,26 @@ "description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.us-west4.rep.googleapis.com/", "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://containeranalysis.europe-west10.rep.googleapis.com/", + "location": "europe-west10" } ], "fullyEncodeReservedExpansion": true, @@ -1711,7 +1731,7 @@ } } }, - "revision": "20240924", + "revision": "20250307", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2151,7 +2171,7 @@ "type": "object" }, "BuildStep": { - "description": "A step in the build pipeline. Next ID: 21", + "description": "A step in the build pipeline. Next ID: 22", "id": "BuildStep", "properties": { "allowExitCodes": { @@ -2209,6 +2229,12 @@ "$ref": "TimeSpan", "description": "Output only. Stores timing information for pulling this build step's builder image only." }, + "results": { + "items": { + "$ref": "StepResult" + }, + "type": "array" + }, "script": { "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.", "type": "string" @@ -2714,6 +2740,13 @@ "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts", "properties": { + "goModules": { + "description": "Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule" + }, + "type": "array" + }, "images": { "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", "items": { @@ -2772,6 +2805,37 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule": { + "description": "Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule", + "properties": { + "modulePath": { + "description": "Optional. The Go module's \"module path\". e.g. example.com/foo/v2", + "type": "string" + }, + "moduleVersion": { + "description": "Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5", + "type": "string" + }, + "repositoryLocation": { + "description": "Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location.", + "type": "string" + }, + "repositoryName": { + "description": "Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo", + "type": "string" + }, + "repositoryProjectId": { + "description": "Optional. Project ID of the Artifact Registry repository. Defaults to the build project.", + "type": "string" + }, + "sourcePath": { + "description": "Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact": { "description": "A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact", @@ -2860,6 +2924,13 @@ "readOnly": true, "type": "string" }, + "dependencies": { + "description": "Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency" + }, + "type": "array" + }, "failureInfo": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo", "description": "Output only. Contains information about the build when status=FAILURE.", @@ -3125,6 +3196,10 @@ "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.", "type": "boolean" }, + "enableStructuredLogging": { + "description": "Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.", + "type": "boolean" + }, "env": { "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { @@ -3206,6 +3281,10 @@ "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, + "pubsubTopic": { + "description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", + "type": "string" + }, "requestedVerifyOption": { "description": "Requested verifiability options.", "enum": [ @@ -3232,12 +3311,14 @@ "NONE", "SHA256", "MD5", + "GO_MODULE_H1", "SHA512" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", + "Dirhash of a Go module's source code which is then hex-encoded.", "Use a sha512 hash." ], "type": "string" @@ -3476,6 +3557,64 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency": { + "description": "A dependency that the Cloud Build worker will fetch before executing user steps.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency", + "properties": { + "empty": { + "description": "If set to true disable all dependency fetching (ignoring the default source as well).", + "type": "boolean" + }, + "gitSource": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency", + "description": "Represents a git repository as a build dependency." + } + }, + "type": "object" + }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency": { + "description": "Represents a git repository as a build dependency.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency", + "properties": { + "depth": { + "description": "Optional. How much history should be fetched for the build (default 1, -1 for all history).", + "format": "int64", + "type": "string" + }, + "destPath": { + "description": "Required. Where should the files be placed on the worker.", + "type": "string" + }, + "recurseSubmodules": { + "description": "Optional. True if submodules should be fetched too (default false).", + "type": "boolean" + }, + "repository": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository", + "description": "Required. The kind of repo (url or dev connect)." + }, + "revision": { + "description": "Required. The revision that we will fetch the repo at.", + "type": "string" + } + }, + "type": "object" + }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository": { + "description": "A repository for a git source.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository", + "properties": { + "developerConnect": { + "description": "The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", + "type": "string" + }, + "url": { + "description": "Location of the Git repository.", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig": { "description": "This config defines the location of a source through Developer Connect.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig", @@ -3560,12 +3699,14 @@ "NONE", "SHA256", "MD5", + "GO_MODULE_H1", "SHA512" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", + "Dirhash of a Go module's source code which is then hex-encoded.", "Use a sha512 hash." ], "type": "string" @@ -3666,6 +3807,13 @@ }, "type": "array" }, + "goModules": { + "description": "Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.", + "items": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule" + }, + "type": "array" + }, "images": { "description": "Container images that were built as a part of the build.", "items": { @@ -3896,6 +4044,26 @@ }, "type": "object" }, + "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule": { + "description": "A Go module artifact uploaded to Artifact Registry using the GoModule directive.", + "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule", + "properties": { + "fileHashes": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes", + "description": "Hash types and values of the Go Module Artifact." + }, + "pushTiming": { + "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", + "description": "Output only. Stores timing information for pushing the specified artifact.", + "readOnly": true + }, + "uri": { + "description": "URI of the uploaded artifact.", + "type": "string" + } + }, + "type": "object" + }, "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact": { "description": "A Maven artifact uploaded using the MavenArtifact directive.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact", @@ -6667,6 +6835,22 @@ }, "type": "object" }, + "StepResult": { + "description": "StepResult is the declaration of a result for a build step.", + "id": "StepResult", + "properties": { + "attestationContentName": { + "type": "string" + }, + "attestationType": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, "Subject": { "description": "Set of software artifacts that the attestation applies to. Each element represents a single software artifact.", "id": "Subject", diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index fec27a0a744..a7854efb554 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -227,6 +227,23 @@ export namespace containeranalysis_v1 { */ signatures?: Schema$Signature[]; } + /** + * BaseImage describes a base image of a container image. + */ + export interface Schema$BaseImage { + /** + * The number of layers that the base image is composed of. + */ + layerCount?: number | null; + /** + * The name of the base image. + */ + name?: string | null; + /** + * The repository name in which the base image is from. + */ + repository?: string | null; + } /** * Request to create notes in batch. */ @@ -386,7 +403,7 @@ export namespace containeranalysis_v1 { triggerId?: string | null; } /** - * A step in the build pipeline. Next ID: 21 + * A step in the build pipeline. Next ID: 22 */ export interface Schema$BuildStep { /** @@ -433,6 +450,7 @@ export namespace containeranalysis_v1 { * Output only. Stores timing information for pulling this build step's builder image only. */ pullTiming?: Schema$TimeSpan; + results?: Schema$StepResult[]; /** * A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. */ @@ -643,6 +661,10 @@ export namespace containeranalysis_v1 { * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts { + /** + * Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + */ + goModules?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule[]; /** * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ @@ -681,6 +703,35 @@ export namespace containeranalysis_v1 { */ timing?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan; } + /** + * Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule { + /** + * Optional. The Go module's "module path". e.g. example.com/foo/v2 + */ + modulePath?: string | null; + /** + * Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + */ + moduleVersion?: string | null; + /** + * Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + */ + repositoryLocation?: string | null; + /** + * Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + */ + repositoryName?: string | null; + /** + * Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + */ + repositoryProjectId?: string | null; + /** + * Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + */ + sourcePath?: string | null; + } /** * A Maven artifact to upload to Artifact Registry upon successful completion of all build steps. */ @@ -756,6 +807,10 @@ export namespace containeranalysis_v1 { * Output only. Time at which the request to create the build was received. */ createTime?: string | null; + /** + * Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. + */ + dependencies?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency[]; /** * Output only. Contains information about the build when status=FAILURE. */ @@ -909,6 +964,10 @@ export namespace containeranalysis_v1 { * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. */ dynamicSubstitutions?: boolean | null; + /** + * Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. + */ + enableStructuredLogging?: boolean | null; /** * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ @@ -929,6 +988,10 @@ export namespace containeranalysis_v1 { * Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. */ pool?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption; + /** + * Optional. Option to specify the Pub/Sub topic to receive build status updates. + */ + pubsubTopic?: string | null; /** * Requested verifiability options. */ @@ -1087,6 +1150,57 @@ export namespace containeranalysis_v1 { */ revision?: string | null; } + /** + * A dependency that the Cloud Build worker will fetch before executing user steps. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency { + /** + * If set to true disable all dependency fetching (ignoring the default source as well). + */ + empty?: boolean | null; + /** + * Represents a git repository as a build dependency. + */ + gitSource?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency; + } + /** + * Represents a git repository as a build dependency. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency { + /** + * Optional. How much history should be fetched for the build (default 1, -1 for all history). + */ + depth?: string | null; + /** + * Required. Where should the files be placed on the worker. + */ + destPath?: string | null; + /** + * Optional. True if submodules should be fetched too (default false). + */ + recurseSubmodules?: boolean | null; + /** + * Required. The kind of repo (url or dev connect). + */ + repository?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository; + /** + * Required. The revision that we will fetch the repo at. + */ + revision?: string | null; + } + /** + * A repository for a git source. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository { + /** + * The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/x/locations/x/connections/x/gitRepositoryLink/x` + */ + developerConnect?: string | null; + /** + * Location of the Git repository. + */ + url?: string | null; + } /** * This config defines the location of a source through Developer Connect. */ @@ -1231,6 +1345,10 @@ export namespace containeranalysis_v1 { * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. */ buildStepOutputs?: string[] | null; + /** + * Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + */ + goModules?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule[]; /** * Container images that were built as a part of the build. */ @@ -1404,6 +1522,23 @@ export namespace containeranalysis_v1 { */ startTime?: string | null; } + /** + * A Go module artifact uploaded to Artifact Registry using the GoModule directive. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule { + /** + * Hash types and values of the Go Module Artifact. + */ + fileHashes?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded artifact. + */ + uri?: string | null; + } /** * A Maven artifact uploaded using the MavenArtifact directive. */ @@ -1751,7 +1886,7 @@ export namespace containeranalysis_v1 { */ export interface Schema$ExportSBOMRequest { /** - * Empty placeholder to denote that this is a Google Cloud Storage export request. + * Optional. Empty placeholder to denote that this is a Google Cloud Storage export request. */ cloudStorageLocation?: Schema$CloudStorageLocation; } @@ -1905,6 +2040,10 @@ export namespace containeranalysis_v1 { * For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. */ filePath?: string | null; + /** + * Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package). + */ + layerDetails?: Schema$LayerDetails; } /** * Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance. @@ -2105,6 +2244,27 @@ export namespace containeranalysis_v1 { */ directive?: string | null; } + /** + * Details about the layer a package was found in. + */ + export interface Schema$LayerDetails { + /** + * The base images the layer is found within. + */ + baseImages?: Schema$BaseImage[]; + /** + * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + */ + command?: string | null; + /** + * The diff ID (typically a sha256 hash) of the layer in the container image. + */ + diffId?: string | null; + /** + * The index of the layer in the container image. + */ + index?: number | null; + } /** * License information. */ @@ -2937,6 +3097,14 @@ export namespace containeranalysis_v1 { */ message?: string | null; } + /** + * StepResult is the declaration of a result for a build step. + */ + export interface Schema$StepResult { + attestationContentName?: string | null; + attestationType?: string | null; + name?: string | null; + } export interface Schema$Subject { /** * `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 35b902ae016..797025a20a1 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -218,6 +218,23 @@ export namespace containeranalysis_v1alpha1 { */ humanReadableName?: string | null; } + /** + * BaseImage describes a base image of a container image. + */ + export interface Schema$BaseImage { + /** + * The number of layers that the base image is composed of. + */ + layerCount?: number | null; + /** + * The name of the base image. + */ + name?: string | null; + /** + * The repository name in which the base image is from. + */ + repository?: string | null; + } /** * Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. */ @@ -366,7 +383,7 @@ export namespace containeranalysis_v1alpha1 { signature?: string | null; } /** - * A step in the build pipeline. Next ID: 21 + * A step in the build pipeline. Next ID: 22 */ export interface Schema$BuildStep { /** @@ -413,6 +430,7 @@ export namespace containeranalysis_v1alpha1 { * Output only. Stores timing information for pulling this build step's builder image only. */ pullTiming?: Schema$TimeSpan; + results?: Schema$StepResult[]; /** * A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. */ @@ -623,6 +641,10 @@ export namespace containeranalysis_v1alpha1 { * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts { + /** + * Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + */ + goModules?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule[]; /** * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ @@ -661,6 +683,35 @@ export namespace containeranalysis_v1alpha1 { */ timing?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan; } + /** + * Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule { + /** + * Optional. The Go module's "module path". e.g. example.com/foo/v2 + */ + modulePath?: string | null; + /** + * Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + */ + moduleVersion?: string | null; + /** + * Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + */ + repositoryLocation?: string | null; + /** + * Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + */ + repositoryName?: string | null; + /** + * Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + */ + repositoryProjectId?: string | null; + /** + * Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + */ + sourcePath?: string | null; + } /** * A Maven artifact to upload to Artifact Registry upon successful completion of all build steps. */ @@ -736,6 +787,10 @@ export namespace containeranalysis_v1alpha1 { * Output only. Time at which the request to create the build was received. */ createTime?: string | null; + /** + * Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. + */ + dependencies?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency[]; /** * Output only. Contains information about the build when status=FAILURE. */ @@ -889,6 +944,10 @@ export namespace containeranalysis_v1alpha1 { * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. */ dynamicSubstitutions?: boolean | null; + /** + * Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. + */ + enableStructuredLogging?: boolean | null; /** * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ @@ -909,6 +968,10 @@ export namespace containeranalysis_v1alpha1 { * Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. */ pool?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption; + /** + * Optional. Option to specify the Pub/Sub topic to receive build status updates. + */ + pubsubTopic?: string | null; /** * Requested verifiability options. */ @@ -1067,6 +1130,57 @@ export namespace containeranalysis_v1alpha1 { */ revision?: string | null; } + /** + * A dependency that the Cloud Build worker will fetch before executing user steps. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency { + /** + * If set to true disable all dependency fetching (ignoring the default source as well). + */ + empty?: boolean | null; + /** + * Represents a git repository as a build dependency. + */ + gitSource?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency; + } + /** + * Represents a git repository as a build dependency. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency { + /** + * Optional. How much history should be fetched for the build (default 1, -1 for all history). + */ + depth?: string | null; + /** + * Required. Where should the files be placed on the worker. + */ + destPath?: string | null; + /** + * Optional. True if submodules should be fetched too (default false). + */ + recurseSubmodules?: boolean | null; + /** + * Required. The kind of repo (url or dev connect). + */ + repository?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository; + /** + * Required. The revision that we will fetch the repo at. + */ + revision?: string | null; + } + /** + * A repository for a git source. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository { + /** + * The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/x/locations/x/connections/x/gitRepositoryLink/x` + */ + developerConnect?: string | null; + /** + * Location of the Git repository. + */ + url?: string | null; + } /** * This config defines the location of a source through Developer Connect. */ @@ -1211,6 +1325,10 @@ export namespace containeranalysis_v1alpha1 { * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. */ buildStepOutputs?: string[] | null; + /** + * Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + */ + goModules?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule[]; /** * Container images that were built as a part of the build. */ @@ -1384,6 +1502,23 @@ export namespace containeranalysis_v1alpha1 { */ startTime?: string | null; } + /** + * A Go module artifact uploaded to Artifact Registry using the GoModule directive. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule { + /** + * Hash types and values of the Go Module Artifact. + */ + fileHashes?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded artifact. + */ + uri?: string | null; + } /** * A Maven artifact uploaded using the MavenArtifact directive. */ @@ -1895,6 +2030,10 @@ export namespace containeranalysis_v1alpha1 { * For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. */ filePath?: string | null; + /** + * Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package). + */ + layerDetails?: Schema$LayerDetails; } /** * FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ @@ -2354,6 +2493,27 @@ export namespace containeranalysis_v1alpha1 { */ directive?: string | null; } + /** + * Details about the layer a package was found in. + */ + export interface Schema$LayerDetails { + /** + * The base images the layer is found within. + */ + baseImages?: Schema$BaseImage[]; + /** + * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + */ + command?: string | null; + /** + * The diff ID (sha256 hash) of the layer in the container image. + */ + diffId?: string | null; + /** + * The index of the layer in the container image. + */ + index?: number | null; + } /** * License information. */ @@ -3432,6 +3592,14 @@ export namespace containeranalysis_v1alpha1 { */ message?: string | null; } + /** + * StepResult is the declaration of a result for a build step. + */ + export interface Schema$StepResult { + attestationContentName?: string | null; + attestationType?: string | null; + name?: string | null; + } /** * StorageSource describes the location of the source in an archive file in Google Cloud Storage. */ diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index cd41ff29888..61b29e75101 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -401,7 +401,7 @@ export namespace containeranalysis_v1beta1 { signature?: string | null; } /** - * A step in the build pipeline. Next ID: 21 + * A step in the build pipeline. Next ID: 22 */ export interface Schema$BuildStep { /** @@ -448,6 +448,7 @@ export namespace containeranalysis_v1beta1 { * Output only. Stores timing information for pulling this build step's builder image only. */ pullTiming?: Schema$TimeSpan; + results?: Schema$StepResult[]; /** * A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. */ @@ -567,6 +568,10 @@ export namespace containeranalysis_v1beta1 { * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts { + /** + * Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + */ + goModules?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule[]; /** * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. */ @@ -605,6 +610,35 @@ export namespace containeranalysis_v1beta1 { */ timing?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan; } + /** + * Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule { + /** + * Optional. The Go module's "module path". e.g. example.com/foo/v2 + */ + modulePath?: string | null; + /** + * Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + */ + moduleVersion?: string | null; + /** + * Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + */ + repositoryLocation?: string | null; + /** + * Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + */ + repositoryName?: string | null; + /** + * Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + */ + repositoryProjectId?: string | null; + /** + * Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + */ + sourcePath?: string | null; + } /** * A Maven artifact to upload to Artifact Registry upon successful completion of all build steps. */ @@ -680,6 +714,10 @@ export namespace containeranalysis_v1beta1 { * Output only. Time at which the request to create the build was received. */ createTime?: string | null; + /** + * Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. + */ + dependencies?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency[]; /** * Output only. Contains information about the build when status=FAILURE. */ @@ -833,6 +871,10 @@ export namespace containeranalysis_v1beta1 { * Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. */ dynamicSubstitutions?: boolean | null; + /** + * Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. + */ + enableStructuredLogging?: boolean | null; /** * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */ @@ -853,6 +895,10 @@ export namespace containeranalysis_v1beta1 { * Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. */ pool?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption; + /** + * Optional. Option to specify the Pub/Sub topic to receive build status updates. + */ + pubsubTopic?: string | null; /** * Requested verifiability options. */ @@ -1011,6 +1057,57 @@ export namespace containeranalysis_v1beta1 { */ revision?: string | null; } + /** + * A dependency that the Cloud Build worker will fetch before executing user steps. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency { + /** + * If set to true disable all dependency fetching (ignoring the default source as well). + */ + empty?: boolean | null; + /** + * Represents a git repository as a build dependency. + */ + gitSource?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency; + } + /** + * Represents a git repository as a build dependency. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency { + /** + * Optional. How much history should be fetched for the build (default 1, -1 for all history). + */ + depth?: string | null; + /** + * Required. Where should the files be placed on the worker. + */ + destPath?: string | null; + /** + * Optional. True if submodules should be fetched too (default false). + */ + recurseSubmodules?: boolean | null; + /** + * Required. The kind of repo (url or dev connect). + */ + repository?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository; + /** + * Required. The revision that we will fetch the repo at. + */ + revision?: string | null; + } + /** + * A repository for a git source. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository { + /** + * The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/x/locations/x/connections/x/gitRepositoryLink/x` + */ + developerConnect?: string | null; + /** + * Location of the Git repository. + */ + url?: string | null; + } /** * This config defines the location of a source through Developer Connect. */ @@ -1155,6 +1252,10 @@ export namespace containeranalysis_v1beta1 { * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. */ buildStepOutputs?: string[] | null; + /** + * Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + */ + goModules?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule[]; /** * Container images that were built as a part of the build. */ @@ -1328,6 +1429,23 @@ export namespace containeranalysis_v1beta1 { */ startTime?: string | null; } + /** + * A Go module artifact uploaded to Artifact Registry using the GoModule directive. + */ + export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule { + /** + * Hash types and values of the Go Module Artifact. + */ + fileHashes?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes; + /** + * Output only. Stores timing information for pushing the specified artifact. + */ + pushTiming?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan; + /** + * URI of the uploaded artifact. + */ + uri?: string | null; + } /** * A Maven artifact uploaded using the MavenArtifact directive. */ @@ -3119,6 +3237,14 @@ export namespace containeranalysis_v1beta1 { */ message?: string | null; } + /** + * StepResult is the declaration of a result for a build step. + */ + export interface Schema$StepResult { + attestationContentName?: string | null; + attestationType?: string | null; + name?: string | null; + } /** * Set of software artifacts that the attestation applies to. Each element represents a single software artifact. */ From 1654902e7a11628e827f9e08f397d4955b843a07 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 039/144] feat(content): update the API #### content:v2.1 The following keys were added: - schemas.AccountIssue.properties.prerenderedOutOfCourtDisputeSettlement.description - schemas.AccountIssue.properties.prerenderedOutOfCourtDisputeSettlement.type - schemas.ProductIssue.properties.prerenderedOutOfCourtDisputeSettlement.description - schemas.ProductIssue.properties.prerenderedOutOfCourtDisputeSettlement.type - schemas.RenderAccountIssuesResponse.properties.alternateDisputeResolution.deprecated - schemas.RenderProductIssuesResponse.properties.alternateDisputeResolution.deprecated The following keys were changed: - schemas.RenderAccountIssuesResponse.properties.alternateDisputeResolution.description - schemas.RenderProductIssuesResponse.properties.alternateDisputeResolution.description - schemas.ReturnPolicyOnlineReturnReasonCategoryInfo.properties.returnLabelSource.description --- discovery/content-v2.1.json | 18 ++++++++++++++---- src/apis/content/v2.1.ts | 14 +++++++++++--- 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json index bd537119887..7abc3f12626 100644 --- a/discovery/content-v2.1.json +++ b/discovery/content-v2.1.json @@ -4570,7 +4570,7 @@ } } }, - "revision": "20250115", + "revision": "20250301", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -4944,6 +4944,10 @@ "description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", "type": "string" }, + "prerenderedOutOfCourtDisputeSettlement": { + "description": "Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.", + "type": "string" + }, "title": { "description": "Title of the issue.", "type": "string" @@ -10758,6 +10762,10 @@ "description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `list-intro` - marks the paragraph that contains an intro for a list. This paragraph will be always followed by a list. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", "type": "string" }, + "prerenderedOutOfCourtDisputeSettlement": { + "description": "Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.", + "type": "string" + }, "title": { "description": "Title of the issue.", "type": "string" @@ -12492,7 +12500,8 @@ "properties": { "alternateDisputeResolution": { "$ref": "AlternateDisputeResolution", - "description": "The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). If the ADR is present, it MUST be available to the merchant on the page that shows the list with their account issues." + "deprecated": true, + "description": "Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead." }, "issues": { "description": "List of account issues for a given account. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.", @@ -12543,7 +12552,8 @@ "properties": { "alternateDisputeResolution": { "$ref": "AlternateDisputeResolution", - "description": "The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). If present, the link should be shown on the same page as the list of issues." + "deprecated": true, + "description": "Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead." }, "issues": { "description": "List of issues for a given product. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.", @@ -12945,7 +12955,7 @@ "id": "ReturnPolicyOnlineReturnReasonCategoryInfo", "properties": { "returnLabelSource": { - "description": "The corresponding return label source.", + "description": "The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.", "enum": [ "RETURN_LABEL_SOURCE_UNSPECIFIED", "DOWNLOAD_AND_PRINT", diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index a329ff287dc..5314c0bd638 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -474,6 +474,10 @@ export namespace content_v2_1 { * Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. */ prerenderedContent?: string | null; + /** + * Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. + */ + prerenderedOutOfCourtDisputeSettlement?: string | null; /** * Title of the issue. */ @@ -4773,6 +4777,10 @@ export namespace content_v2_1 { * Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `list-intro` - marks the paragraph that contains an intro for a list. This paragraph will be always followed by a list. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. */ prerenderedContent?: string | null; + /** + * Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. + */ + prerenderedOutOfCourtDisputeSettlement?: string | null; /** * Title of the issue. */ @@ -5960,7 +5968,7 @@ export namespace content_v2_1 { */ export interface Schema$RenderAccountIssuesResponse { /** - * The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). If the ADR is present, it MUST be available to the merchant on the page that shows the list with their account issues. + * Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead. */ alternateDisputeResolution?: Schema$AlternateDisputeResolution; /** @@ -5986,7 +5994,7 @@ export namespace content_v2_1 { */ export interface Schema$RenderProductIssuesResponse { /** - * The Alternate Dispute Resolution (ADR) contains a link to a page where merchant can bring their appeal to an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501). If present, the link should be shown on the same page as the list of issues. + * Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead. */ alternateDisputeResolution?: Schema$AlternateDisputeResolution; /** @@ -6410,7 +6418,7 @@ export namespace content_v2_1 { */ export interface Schema$ReturnPolicyOnlineReturnReasonCategoryInfo { /** - * The corresponding return label source. + * The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories. */ returnLabelSource?: string | null; /** From 030a2673dfb97759a7b83a9c7abadddbde5192f9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 040/144] fix(css): update the API #### css:v1 The following keys were changed: - resources.accounts.resources.cssProductInputs.methods.delete.parameters.name.description - resources.accounts.resources.cssProductInputs.methods.patch.parameters.name.description - schemas.Account.properties.parent.description - schemas.CssProductInput.properties.name.description --- discovery/css-v1.json | 10 +++++----- src/apis/css/v1.ts | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/css-v1.json b/discovery/css-v1.json index 543e439b36f..51289d93dd8 100644 --- a/discovery/css-v1.json +++ b/discovery/css-v1.json @@ -226,7 +226,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}", + "description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123", "location": "path", "pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$", "required": true, @@ -292,7 +292,7 @@ ], "parameters": { "name": { - "description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`", + "description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123", "location": "path", "pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$", "required": true, @@ -507,7 +507,7 @@ } } }, - "revision": "20250106", + "revision": "20250219", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -576,7 +576,7 @@ "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.", + "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. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy.\"", "type": "string" } }, @@ -960,7 +960,7 @@ "type": "string" }, "name": { - "description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`", + "description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123", "type": "string" }, "rawProvidedId": { diff --git a/src/apis/css/v1.ts b/src/apis/css/v1.ts index ac9545778dc..9e299ac4b8b 100644 --- a/src/apis/css/v1.ts +++ b/src/apis/css/v1.ts @@ -157,7 +157,7 @@ export namespace css_v1 { */ 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. + * 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. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy." */ parent?: string | null; } @@ -474,7 +474,7 @@ export namespace css_v1 { */ freshnessTime?: string | null; /** - * The name of the CSS Product input. Format: `accounts/{account\}/cssProductInputs/{css_product_input\}` + * The name of the CSS Product input. Format: `accounts/{account\}/cssProductInputs/{css_product_input\}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 */ name?: string | null; /** @@ -1329,7 +1329,7 @@ export namespace css_v1 { 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\} + * Required. The name of the CSS product input resource to delete. Format: accounts/{account\}/cssProductInputs/{css_product_input\}, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 */ name?: string; /** @@ -1356,7 +1356,7 @@ export namespace css_v1 { export interface Params$Resource$Accounts$Cssproductinputs$Patch extends StandardParameters { /** - * The name of the CSS Product input. Format: `accounts/{account\}/cssProductInputs/{css_product_input\}` + * The name of the CSS Product input. Format: `accounts/{account\}/cssProductInputs/{css_product_input\}`, where the last section `css_product_input` consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123 */ name?: string; /** From dc1dcd7a3899d885f715ccbcaab3d197e6780cdc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 041/144] feat(datacatalog): update the API #### datacatalog:v1beta1 The following keys were added: - resources.catalog.deprecated - resources.catalog.methods.search.deprecated - resources.entries.deprecated - resources.entries.methods.lookup.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.create.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.delete.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.get.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.getIamPolicy.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.list.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.patch.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.setIamPolicy.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.testIamPermissions.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.create.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.delete.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.get.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.getIamPolicy.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.list.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.patch.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.testIamPermissions.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.create.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.delete.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.list.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.patch.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.methods.create.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.methods.delete.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.methods.list.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.methods.patch.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.create.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.delete.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.get.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.getIamPolicy.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.patch.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.setIamPolicy.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.testIamPermissions.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.methods.create.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.methods.delete.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.methods.patch.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.methods.rename.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.resources.enumValues.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.resources.enumValues.methods.rename.deprecated The following keys were changed: - schemas.GoogleCloudDatacatalogV1DatabaseTableSpec.properties.databaseViewSpec.description - schemas.GoogleCloudDatacatalogV1FeatureOnlineStoreSpec.properties.storageType.description - schemas.GoogleCloudDatacatalogV1FeatureOnlineStoreSpec.properties.storageType.enumDescriptions #### datacatalog:v1 The following keys were added: - resources.catalog.deprecated - resources.catalog.methods.search.deprecated - resources.entries.deprecated - resources.entries.methods.lookup.deprecated - resources.organizations.resources.locations.deprecated - resources.organizations.resources.locations.methods.retrieveConfig.deprecated - resources.organizations.resources.locations.methods.retrieveEffectiveConfig.deprecated - resources.organizations.resources.locations.methods.setConfig.deprecated - resources.projects.resources.locations.methods.retrieveEffectiveConfig.deprecated - resources.projects.resources.locations.methods.setConfig.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.create.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.delete.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.get.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.getIamPolicy.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.list.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.patch.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.setIamPolicy.deprecated - resources.projects.resources.locations.resources.entryGroups.methods.testIamPermissions.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.create.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.delete.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.get.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.getIamPolicy.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.import.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.list.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.modifyEntryContacts.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.modifyEntryOverview.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.patch.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.star.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.testIamPermissions.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.unstar.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.create.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.delete.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.list.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.patch.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.entries.resources.tags.methods.reconcile.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.methods.create.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.methods.delete.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.methods.list.deprecated - resources.projects.resources.locations.resources.entryGroups.resources.tags.methods.patch.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.create.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.delete.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.get.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.getIamPolicy.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.patch.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.setIamPolicy.deprecated - resources.projects.resources.locations.resources.tagTemplates.methods.testIamPermissions.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.methods.create.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.methods.delete.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.methods.patch.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.methods.rename.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.resources.enumValues.deprecated - resources.projects.resources.locations.resources.tagTemplates.resources.fields.resources.enumValues.methods.rename.deprecated The following keys were changed: - schemas.GoogleCloudDatacatalogV1DatabaseTableSpec.properties.databaseViewSpec.description - schemas.GoogleCloudDatacatalogV1FeatureOnlineStoreSpec.properties.storageType.description - schemas.GoogleCloudDatacatalogV1FeatureOnlineStoreSpec.properties.storageType.enumDescriptions --- discovery/datacatalog-v1.json | 62 ++++++++++++++++++++++++++++-- discovery/datacatalog-v1beta1.json | 50 ++++++++++++++++++++++-- src/apis/datacatalog/v1.ts | 4 +- src/apis/datacatalog/v1beta1.ts | 4 +- 4 files changed, 108 insertions(+), 12 deletions(-) diff --git a/discovery/datacatalog-v1.json b/discovery/datacatalog-v1.json index 6ea680cbdc8..01cd0e673f6 100644 --- a/discovery/datacatalog-v1.json +++ b/discovery/datacatalog-v1.json @@ -106,8 +106,10 @@ "protocol": "rest", "resources": { "catalog": { + "deprecated": true, "methods": { "search": { + "deprecated": true, "description": "Searches Data Catalog for multiple resources like entries and tags that match a query. This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods. Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).", "flatPath": "v1/catalog:search", "httpMethod": "POST", @@ -128,8 +130,10 @@ } }, "entries": { + "deprecated": true, "methods": { "lookup": { + "deprecated": true, "description": "Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.", "flatPath": "v1/entries:lookup", "httpMethod": "GET", @@ -175,8 +179,10 @@ "organizations": { "resources": { "locations": { + "deprecated": true, "methods": { "retrieveConfig": { + "deprecated": true, "description": "Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:retrieveConfig", "httpMethod": "GET", @@ -202,6 +208,7 @@ ] }, "retrieveEffectiveConfig": { + "deprecated": true, "description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:retrieveEffectiveConfig", "httpMethod": "GET", @@ -227,6 +234,7 @@ ] }, "setConfig": { + "deprecated": true, "description": "Sets the configuration related to the migration to Dataplex for an organization or project.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:setConfig", "httpMethod": "POST", @@ -263,6 +271,7 @@ "locations": { "methods": { "retrieveEffectiveConfig": { + "deprecated": true, "description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveEffectiveConfig", "httpMethod": "GET", @@ -288,6 +297,7 @@ ] }, "setConfig": { + "deprecated": true, "description": "Sets the configuration related to the migration to Dataplex for an organization or project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setConfig", "httpMethod": "POST", @@ -320,6 +330,7 @@ "entryGroups": { "methods": { "create": { + "deprecated": true, "description": "Creates an entry group. An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources: * BigQuery entries (`@bigquery`) * Pub/Sub topics (`@pubsub`) * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups", "httpMethod": "POST", @@ -353,6 +364,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes an entry group. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "DELETE", @@ -383,6 +395,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets an entry group.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "GET", @@ -414,6 +427,7 @@ ] }, "getIamPolicy": { + "deprecated": true, "description": "Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy", "httpMethod": "POST", @@ -442,6 +456,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists entry groups.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups", "httpMethod": "GET", @@ -478,6 +493,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates an entry group. You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "PATCH", @@ -512,6 +528,7 @@ ] }, "setIamPolicy": { + "deprecated": true, "description": "Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy", "httpMethod": "POST", @@ -540,6 +557,7 @@ ] }, "testIamPermissions": { + "deprecated": true, "description": "Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions", "httpMethod": "POST", @@ -572,6 +590,7 @@ "entries": { "methods": { "create": { + "deprecated": true, "description": "Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", "httpMethod": "POST", @@ -605,6 +624,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "DELETE", @@ -630,6 +650,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets an entry.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "GET", @@ -655,6 +676,7 @@ ] }, "getIamPolicy": { + "deprecated": true, "description": "Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:getIamPolicy", "httpMethod": "POST", @@ -683,6 +705,7 @@ ] }, "import": { + "deprecated": true, "description": "Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. `ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of DumpItem type. `ImportEntries` returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries:import", "httpMethod": "POST", @@ -711,6 +734,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", "httpMethod": "GET", @@ -753,6 +777,7 @@ ] }, "modifyEntryContacts": { + "deprecated": true, "description": "Modifies contacts, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:modifyEntryContacts", "httpMethod": "POST", @@ -781,6 +806,7 @@ ] }, "modifyEntryOverview": { + "deprecated": true, "description": "Modifies entry overview, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:modifyEntryOverview", "httpMethod": "POST", @@ -809,6 +835,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "PATCH", @@ -843,6 +870,7 @@ ] }, "star": { + "deprecated": true, "description": "Marks an Entry as starred by the current user. Starring information is private to each user.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:star", "httpMethod": "POST", @@ -871,6 +899,7 @@ ] }, "testIamPermissions": { + "deprecated": true, "description": "Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:testIamPermissions", "httpMethod": "POST", @@ -899,6 +928,7 @@ ] }, "unstar": { + "deprecated": true, "description": "Marks an Entry as NOT starred by the current user. Starring information is private to each user.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:unstar", "httpMethod": "POST", @@ -929,8 +959,10 @@ }, "resources": { "tags": { + "deprecated": true, "methods": { "create": { + "deprecated": true, "description": "Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags", "httpMethod": "POST", @@ -959,6 +991,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a tag.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}", "httpMethod": "DELETE", @@ -984,6 +1017,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists tags assigned to an Entry. The columns in the response are lowercased.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags", "httpMethod": "GET", @@ -1020,6 +1054,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates an existing tag.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}", "httpMethod": "PATCH", @@ -1054,6 +1089,7 @@ ] }, "reconcile": { + "deprecated": true, "description": "`ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags:reconcile", "httpMethod": "POST", @@ -1086,8 +1122,10 @@ } }, "tags": { + "deprecated": true, "methods": { "create": { + "deprecated": true, "description": "Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags", "httpMethod": "POST", @@ -1116,6 +1154,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a tag.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}", "httpMethod": "DELETE", @@ -1141,6 +1180,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists tags assigned to an Entry. The columns in the response are lowercased.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags", "httpMethod": "GET", @@ -1177,6 +1217,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates an existing tag.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}", "httpMethod": "PATCH", @@ -1337,6 +1378,7 @@ "tagTemplates": { "methods": { "create": { + "deprecated": true, "description": "Creates a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates", "httpMethod": "POST", @@ -1370,6 +1412,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "httpMethod": "DELETE", @@ -1400,6 +1443,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets a tag template.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "httpMethod": "GET", @@ -1425,6 +1469,7 @@ ] }, "getIamPolicy": { + "deprecated": true, "description": "Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:getIamPolicy", "httpMethod": "POST", @@ -1453,6 +1498,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "httpMethod": "PATCH", @@ -1487,6 +1533,7 @@ ] }, "setIamPolicy": { + "deprecated": true, "description": "Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:setIamPolicy", "httpMethod": "POST", @@ -1515,6 +1562,7 @@ ] }, "testIamPermissions": { + "deprecated": true, "description": "Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:testIamPermissions", "httpMethod": "POST", @@ -1547,6 +1595,7 @@ "fields": { "methods": { "create": { + "deprecated": true, "description": "Creates a field in a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields", "httpMethod": "POST", @@ -1580,6 +1629,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a field in a tag template and all uses of this field from the tags based on this template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}", "httpMethod": "DELETE", @@ -1610,6 +1660,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a field in a tag template. You can't update the field type with this method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}", "httpMethod": "PATCH", @@ -1644,6 +1695,7 @@ ] }, "rename": { + "deprecated": true, "description": "Renames a field in a tag template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}:rename", "httpMethod": "POST", @@ -1674,8 +1726,10 @@ }, "resources": { "enumValues": { + "deprecated": true, "methods": { "rename": { + "deprecated": true, "description": "Renames an enum value in a tag template. Within a single enum field, enum values must be unique.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}/enumValues/{enumValuesId}:rename", "httpMethod": "POST", @@ -2285,7 +2339,7 @@ } } }, - "revision": "20241202", + "revision": "20250212", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2765,7 +2819,7 @@ "properties": { "databaseViewSpec": { "$ref": "GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec", - "description": "Spec what aplies to tables that are actually views. Not set for \"real\" tables." + "description": "Spec what applies to tables that are actually views. Not set for \"real\" tables." }, "dataplexTable": { "$ref": "GoogleCloudDatacatalogV1DataplexTableSpec", @@ -3203,7 +3257,7 @@ "id": "GoogleCloudDatacatalogV1FeatureOnlineStoreSpec", "properties": { "storageType": { - "description": "Output only. Type of underelaying storage for the FeatureOnlineStore.", + "description": "Output only. Type of underlying storage for the FeatureOnlineStore.", "enum": [ "STORAGE_TYPE_UNSPECIFIED", "BIGTABLE", @@ -3212,7 +3266,7 @@ "enumDescriptions": [ "Should not be used.", "Underlsying storgae is Bigtable.", - "Underlaying is optimized online server (Lightning)." + "Underlying is optimized online server (Lightning)." ], "readOnly": true, "type": "string" diff --git a/discovery/datacatalog-v1beta1.json b/discovery/datacatalog-v1beta1.json index a47b0c9af33..5fc8552dadf 100644 --- a/discovery/datacatalog-v1beta1.json +++ b/discovery/datacatalog-v1beta1.json @@ -106,8 +106,10 @@ "protocol": "rest", "resources": { "catalog": { + "deprecated": true, "methods": { "search": { + "deprecated": true, "description": "Searches Data Catalog for multiple resources like entries, tags that match a query. This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequently call `Get` methods. Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries. See [Data Catalog Search Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information.", "flatPath": "v1beta1/catalog:search", "httpMethod": "POST", @@ -128,8 +130,10 @@ } }, "entries": { + "deprecated": true, "methods": { "lookup": { + "deprecated": true, "description": "Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.", "flatPath": "v1beta1/entries:lookup", "httpMethod": "GET", @@ -164,6 +168,7 @@ "entryGroups": { "methods": { "create": { + "deprecated": true, "description": "A maximum of 10,000 entry groups may be created per organization across all locations. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups", "httpMethod": "POST", @@ -197,6 +202,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "DELETE", @@ -227,6 +233,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets an EntryGroup.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "GET", @@ -258,6 +265,7 @@ ] }, "getIamPolicy": { + "deprecated": true, "description": "Gets the access control policy for a 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. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy", "httpMethod": "POST", @@ -286,6 +294,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists entry groups.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups", "httpMethod": "GET", @@ -322,6 +331,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `entry_group.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "PATCH", @@ -356,6 +366,7 @@ ] }, "setIamPolicy": { + "deprecated": true, "description": "Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy", "httpMethod": "POST", @@ -384,6 +395,7 @@ ] }, "testIamPermissions": { + "deprecated": true, "description": "Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions", "httpMethod": "POST", @@ -416,6 +428,7 @@ "entries": { "methods": { "create": { + "deprecated": true, "description": "Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). A maximum of 100,000 entries may be created per entry group.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", "httpMethod": "POST", @@ -449,6 +462,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes an existing entry. Only entries created through CreateEntry method can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "DELETE", @@ -474,6 +488,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets an entry.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "GET", @@ -499,6 +514,7 @@ ] }, "getIamPolicy": { + "deprecated": true, "description": "Gets the access control policy for a 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. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:getIamPolicy", "httpMethod": "POST", @@ -527,6 +543,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists entries.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", "httpMethod": "GET", @@ -569,6 +586,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates an existing entry. Users should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "PATCH", @@ -603,6 +621,7 @@ ] }, "testIamPermissions": { + "deprecated": true, "description": "Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:testIamPermissions", "httpMethod": "POST", @@ -633,8 +652,10 @@ }, "resources": { "tags": { + "deprecated": true, "methods": { "create": { + "deprecated": true, "description": "Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags", "httpMethod": "POST", @@ -663,6 +684,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a tag.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}", "httpMethod": "DELETE", @@ -688,6 +710,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists tags assigned to an Entry. The columns in the response are lowercased.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags", "httpMethod": "GET", @@ -724,6 +747,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates an existing tag.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}", "httpMethod": "PATCH", @@ -762,8 +786,10 @@ } }, "tags": { + "deprecated": true, "methods": { "create": { + "deprecated": true, "description": "Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags", "httpMethod": "POST", @@ -792,6 +818,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a tag.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}", "httpMethod": "DELETE", @@ -817,6 +844,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists tags assigned to an Entry. The columns in the response are lowercased.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags", "httpMethod": "GET", @@ -853,6 +881,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates an existing tag.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}", "httpMethod": "PATCH", @@ -893,6 +922,7 @@ "tagTemplates": { "methods": { "create": { + "deprecated": true, "description": "Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates", "httpMethod": "POST", @@ -926,6 +956,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "httpMethod": "DELETE", @@ -956,6 +987,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets a tag template.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "httpMethod": "GET", @@ -981,6 +1013,7 @@ ] }, "getIamPolicy": { + "deprecated": true, "description": "Gets the access control policy for a 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. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:getIamPolicy", "httpMethod": "POST", @@ -1009,6 +1042,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "httpMethod": "PATCH", @@ -1043,6 +1077,7 @@ ] }, "setIamPolicy": { + "deprecated": true, "description": "Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:setIamPolicy", "httpMethod": "POST", @@ -1071,6 +1106,7 @@ ] }, "testIamPermissions": { + "deprecated": true, "description": "Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:testIamPermissions", "httpMethod": "POST", @@ -1103,6 +1139,7 @@ "fields": { "methods": { "create": { + "deprecated": true, "description": "Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields", "httpMethod": "POST", @@ -1136,6 +1173,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}", "httpMethod": "DELETE", @@ -1166,6 +1204,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}", "httpMethod": "PATCH", @@ -1200,6 +1239,7 @@ ] }, "rename": { + "deprecated": true, "description": "Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}:rename", "httpMethod": "POST", @@ -1230,8 +1270,10 @@ }, "resources": { "enumValues": { + "deprecated": true, "methods": { "rename": { + "deprecated": true, "description": "Renames an enum value in a tag template. The enum values have to be unique within one enum field. Thus, an enum value cannot be renamed with a name used in any other enum value within the same enum field.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}/enumValues/{enumValuesId}:rename", "httpMethod": "POST", @@ -1813,7 +1855,7 @@ } } }, - "revision": "20241021", + "revision": "20250212", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2282,7 +2324,7 @@ "properties": { "databaseViewSpec": { "$ref": "GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec", - "description": "Spec what aplies to tables that are actually views. Not set for \"real\" tables." + "description": "Spec what applies to tables that are actually views. Not set for \"real\" tables." }, "dataplexTable": { "$ref": "GoogleCloudDatacatalogV1DataplexTableSpec", @@ -2678,7 +2720,7 @@ "id": "GoogleCloudDatacatalogV1FeatureOnlineStoreSpec", "properties": { "storageType": { - "description": "Output only. Type of underelaying storage for the FeatureOnlineStore.", + "description": "Output only. Type of underlying storage for the FeatureOnlineStore.", "enum": [ "STORAGE_TYPE_UNSPECIFIED", "BIGTABLE", @@ -2687,7 +2729,7 @@ "enumDescriptions": [ "Should not be used.", "Underlsying storgae is Bigtable.", - "Underlaying is optimized online server (Lightning)." + "Underlying is optimized online server (Lightning)." ], "readOnly": true, "type": "string" diff --git a/src/apis/datacatalog/v1.ts b/src/apis/datacatalog/v1.ts index 6bf3a260934..cc50b660f00 100644 --- a/src/apis/datacatalog/v1.ts +++ b/src/apis/datacatalog/v1.ts @@ -435,7 +435,7 @@ export namespace datacatalog_v1 { */ export interface Schema$GoogleCloudDatacatalogV1DatabaseTableSpec { /** - * Spec what aplies to tables that are actually views. Not set for "real" tables. + * Spec what applies to tables that are actually views. Not set for "real" tables. */ databaseViewSpec?: Schema$GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec; /** @@ -753,7 +753,7 @@ export namespace datacatalog_v1 { */ export interface Schema$GoogleCloudDatacatalogV1FeatureOnlineStoreSpec { /** - * Output only. Type of underelaying storage for the FeatureOnlineStore. + * Output only. Type of underlying storage for the FeatureOnlineStore. */ storageType?: string | null; } diff --git a/src/apis/datacatalog/v1beta1.ts b/src/apis/datacatalog/v1beta1.ts index 25a813551ee..d236f54def2 100644 --- a/src/apis/datacatalog/v1beta1.ts +++ b/src/apis/datacatalog/v1beta1.ts @@ -1139,7 +1139,7 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$GoogleCloudDatacatalogV1DatabaseTableSpec { /** - * Spec what aplies to tables that are actually views. Not set for "real" tables. + * Spec what applies to tables that are actually views. Not set for "real" tables. */ databaseViewSpec?: Schema$GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec; /** @@ -1423,7 +1423,7 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$GoogleCloudDatacatalogV1FeatureOnlineStoreSpec { /** - * Output only. Type of underelaying storage for the FeatureOnlineStore. + * Output only. Type of underlying storage for the FeatureOnlineStore. */ storageType?: string | null; } From 6d084fb125821fff7bea0730fb7bf067fb475b48 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 042/144] feat(dataflow): update the API #### dataflow:v1b3 The following keys were added: - schemas.FlexTemplateRuntimeEnvironment.properties.additionalPipelineOptions.description - schemas.FlexTemplateRuntimeEnvironment.properties.additionalPipelineOptions.items.type - schemas.FlexTemplateRuntimeEnvironment.properties.additionalPipelineOptions.type - schemas.RuntimeEnvironment.properties.additionalPipelineOptions.description - schemas.RuntimeEnvironment.properties.additionalPipelineOptions.items.type - schemas.RuntimeEnvironment.properties.additionalPipelineOptions.type - schemas.TemplateMetadata.properties.yamlDefinition.description - schemas.TemplateMetadata.properties.yamlDefinition.type The following keys were changed: - schemas.MetricUpdate.description - schemas.SDKInfo.properties.language.enum - schemas.SDKInfo.properties.language.enumDescriptions --- discovery/dataflow-v1b3.json | 28 ++++++++++++++++++++++++---- src/apis/dataflow/v1b3.ts | 14 +++++++++++++- 2 files changed, 37 insertions(+), 5 deletions(-) diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index 724823ff946..d9611701d18 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -2208,7 +2208,7 @@ } } }, - "revision": "20250106", + "revision": "20250310", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3518,6 +3518,13 @@ }, "type": "array" }, + "additionalPipelineOptions": { + "description": "Optional. Additional pipeline option flags for the job.", + "items": { + "type": "string" + }, + "type": "array" + }, "additionalUserLabels": { "additionalProperties": { "type": "string" @@ -4753,7 +4760,7 @@ "type": "object" }, "MetricUpdate": { - "description": "Describes the state of a metric. Next ID: 14", + "description": "Describes the state of a metric.", "id": "MetricUpdate", "properties": { "cumulative": { @@ -5600,6 +5607,13 @@ }, "type": "array" }, + "additionalPipelineOptions": { + "description": "Optional. Additional pipeline option flags for the job.", + "items": { + "type": "string" + }, + "type": "array" + }, "additionalUserLabels": { "additionalProperties": { "type": "string" @@ -5747,13 +5761,15 @@ "UNKNOWN", "JAVA", "PYTHON", - "GO" + "GO", + "YAML" ], "enumDescriptions": [ "UNKNOWN Language.", "Java.", "Python.", - "Go." + "Go.", + "YAML." ], "type": "string" }, @@ -7241,6 +7257,10 @@ "supportsExactlyOnce": { "description": "Optional. Indicates if the streaming template supports exactly once mode.", "type": "boolean" + }, + "yamlDefinition": { + "description": "Optional. For future use.", + "type": "string" } }, "type": "object" diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index debdb7d31a8..f6e1d89f80d 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -1037,6 +1037,10 @@ export namespace dataflow_v1b3 { * Additional experiment flags for the job. */ additionalExperiments?: string[] | null; + /** + * Optional. Additional pipeline option flags for the job. + */ + additionalPipelineOptions?: string[] | null; /** * Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" \}. */ @@ -1899,7 +1903,7 @@ export namespace dataflow_v1b3 { origin?: string | null; } /** - * Describes the state of a metric. Next ID: 14 + * Describes the state of a metric. */ export interface Schema$MetricUpdate { /** @@ -2489,6 +2493,10 @@ export namespace dataflow_v1b3 { * Optional. Additional experiment flags for the job, specified with the `--experiments` option. */ additionalExperiments?: string[] | null; + /** + * Optional. Additional pipeline option flags for the job. + */ + additionalPipelineOptions?: string[] | null; /** * Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" \}. */ @@ -3669,6 +3677,10 @@ export namespace dataflow_v1b3 { * Optional. Indicates if the streaming template supports exactly once mode. */ supportsExactlyOnce?: boolean | null; + /** + * Optional. For future use. + */ + yamlDefinition?: string | null; } /** * Global topology of the streaming Dataflow job, including all computations and their sharded locations. From 48e902302f43f48dcac99720468d660b6e5b327e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 043/144] feat(dataform): update the API #### dataform:v1beta1 The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/bigquery.description - schemas.CancelWorkflowInvocationResponse.description - schemas.CancelWorkflowInvocationResponse.id - schemas.CancelWorkflowInvocationResponse.type - schemas.CodeCompilationConfig.properties.defaultNotebookRuntimeOptions.description - schemas.CommitWorkspaceChangesResponse.description - schemas.CommitWorkspaceChangesResponse.id - schemas.CommitWorkspaceChangesResponse.type - schemas.Notebook.description - schemas.NotebookRuntimeOptions.description - schemas.PullGitCommitsResponse.description - schemas.PullGitCommitsResponse.id - schemas.PullGitCommitsResponse.type - schemas.PushGitCommitsResponse.description - schemas.PushGitCommitsResponse.id - schemas.PushGitCommitsResponse.type - schemas.RemoveDirectoryResponse.description - schemas.RemoveDirectoryResponse.id - schemas.RemoveDirectoryResponse.type - schemas.RemoveFileResponse.description - schemas.RemoveFileResponse.id - schemas.RemoveFileResponse.type - schemas.ResetWorkspaceChangesResponse.description - schemas.ResetWorkspaceChangesResponse.id - schemas.ResetWorkspaceChangesResponse.type - schemas.ScheduledExecutionRecord.properties.executionTime.readOnly - schemas.ScheduledReleaseRecord.properties.releaseTime.readOnly - schemas.UncommittedFileChange.properties.state.readOnly The following keys were changed: - resources.projects.resources.locations.methods.get.scopes - resources.projects.resources.locations.methods.getConfig.scopes - resources.projects.resources.locations.methods.list.scopes - resources.projects.resources.locations.methods.updateConfig.scopes - resources.projects.resources.locations.resources.repositories.methods.commit.scopes - resources.projects.resources.locations.resources.repositories.methods.computeAccessTokenStatus.scopes - resources.projects.resources.locations.resources.repositories.methods.create.scopes - resources.projects.resources.locations.resources.repositories.methods.delete.parameters.force.description - resources.projects.resources.locations.resources.repositories.methods.delete.scopes - resources.projects.resources.locations.resources.repositories.methods.fetchHistory.scopes - resources.projects.resources.locations.resources.repositories.methods.fetchRemoteBranches.scopes - resources.projects.resources.locations.resources.repositories.methods.get.scopes - resources.projects.resources.locations.resources.repositories.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.repositories.methods.list.scopes - resources.projects.resources.locations.resources.repositories.methods.patch.scopes - resources.projects.resources.locations.resources.repositories.methods.queryDirectoryContents.scopes - resources.projects.resources.locations.resources.repositories.methods.readFile.scopes - resources.projects.resources.locations.resources.repositories.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.repositories.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.repositories.resources.compilationResults.methods.create.scopes - resources.projects.resources.locations.resources.repositories.resources.compilationResults.methods.get.scopes - resources.projects.resources.locations.resources.repositories.resources.compilationResults.methods.list.scopes - resources.projects.resources.locations.resources.repositories.resources.compilationResults.methods.query.scopes - resources.projects.resources.locations.resources.repositories.resources.releaseConfigs.methods.create.scopes - resources.projects.resources.locations.resources.repositories.resources.releaseConfigs.methods.delete.scopes - resources.projects.resources.locations.resources.repositories.resources.releaseConfigs.methods.get.scopes - resources.projects.resources.locations.resources.repositories.resources.releaseConfigs.methods.list.scopes - resources.projects.resources.locations.resources.repositories.resources.releaseConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowConfigs.methods.create.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowConfigs.methods.delete.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowConfigs.methods.get.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowConfigs.methods.list.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowInvocations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.repositories.resources.workflowInvocations.methods.cancel.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowInvocations.methods.create.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowInvocations.methods.delete.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowInvocations.methods.get.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowInvocations.methods.list.scopes - resources.projects.resources.locations.resources.repositories.resources.workflowInvocations.methods.query.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.commit.response.$ref - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.commit.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.create.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.delete.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.fetchFileDiff.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.fetchFileGitStatuses.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.fetchGitAheadBehind.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.get.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.installNpmPackages.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.list.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.makeDirectory.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.moveDirectory.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.moveFile.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.pull.response.$ref - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.pull.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.push.response.$ref - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.push.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.queryDirectoryContents.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.readFile.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.removeDirectory.response.$ref - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.removeDirectory.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.removeFile.response.$ref - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.removeFile.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.reset.response.$ref - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.reset.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.searchFiles.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.writeFile.scopes - schemas.CommitRepositoryChangesRequest.properties.fileOperations.description - schemas.DataEncryptionState.properties.kmsKeyVersionName.description - schemas.ScheduledExecutionRecord.properties.executionTime.description - schemas.ScheduledReleaseRecord.properties.releaseTime.description - schemas.Target.properties.database.description - schemas.Target.properties.name.description - schemas.Target.properties.schema.description - schemas.UncommittedFileChange.properties.state.description --- discovery/dataform-v1beta1.json | 149 ++++++++++++++++--- src/apis/dataform/v1beta1.ts | 256 +++++++++++++++++++++----------- 2 files changed, 301 insertions(+), 104 deletions(-) diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index a99c5f0f4a8..451c423e595 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/bigquery": { + "description": "View and manage your data in Google BigQuery and see the email address for your Google Account" + }, "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." } @@ -130,6 +133,7 @@ "$ref": "Location" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -155,6 +159,7 @@ "$ref": "Config" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -196,6 +201,7 @@ "$ref": "ListLocationsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -230,6 +236,7 @@ "$ref": "Config" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -262,6 +269,7 @@ "$ref": "CommitRepositoryChangesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -287,6 +295,7 @@ "$ref": "ComputeRepositoryAccessTokenStatusResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -320,6 +329,7 @@ "$ref": "Repository" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -333,7 +343,7 @@ ], "parameters": { "force": { - "description": "If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)", + "description": "Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)", "location": "query", "type": "boolean" }, @@ -350,6 +360,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -386,6 +397,7 @@ "$ref": "FetchRepositoryHistoryResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -411,6 +423,7 @@ "$ref": "FetchRemoteBranchesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -436,6 +449,7 @@ "$ref": "Repository" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -467,6 +481,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -513,6 +528,7 @@ "$ref": "ListRepositoriesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -547,6 +563,7 @@ "$ref": "Repository" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -593,6 +610,7 @@ "$ref": "QueryRepositoryDirectoryContentsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -628,6 +646,7 @@ "$ref": "ReadRepositoryFileResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -656,6 +675,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -684,6 +704,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -716,6 +737,7 @@ "$ref": "CompilationResult" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -741,6 +763,7 @@ "$ref": "CompilationResult" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -787,6 +810,7 @@ "$ref": "ListCompilationResultsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -828,6 +852,7 @@ "$ref": "QueryCompilationResultActionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -865,6 +890,7 @@ "$ref": "ReleaseConfig" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -890,6 +916,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -915,6 +942,7 @@ "$ref": "ReleaseConfig" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -951,6 +979,7 @@ "$ref": "ListReleaseConfigsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -985,6 +1014,7 @@ "$ref": "ReleaseConfig" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1022,6 +1052,7 @@ "$ref": "WorkflowConfig" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1047,6 +1078,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1072,6 +1104,7 @@ "$ref": "WorkflowConfig" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1108,6 +1141,7 @@ "$ref": "ListWorkflowConfigsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1142,6 +1176,7 @@ "$ref": "WorkflowConfig" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1171,9 +1206,10 @@ "$ref": "CancelWorkflowInvocationRequest" }, "response": { - "$ref": "Empty" + "$ref": "CancelWorkflowInvocationResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1202,6 +1238,7 @@ "$ref": "WorkflowInvocation" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1227,6 +1264,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1252,6 +1290,7 @@ "$ref": "WorkflowInvocation" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1298,6 +1337,7 @@ "$ref": "ListWorkflowInvocationsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1334,6 +1374,7 @@ "$ref": "QueryWorkflowInvocationActionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1363,9 +1404,10 @@ "$ref": "CommitWorkspaceChangesRequest" }, "response": { - "$ref": "Empty" + "$ref": "CommitWorkspaceChangesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1399,6 +1441,7 @@ "$ref": "Workspace" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1424,6 +1467,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1454,6 +1498,7 @@ "$ref": "FetchFileDiffResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1479,6 +1524,7 @@ "$ref": "FetchFileGitStatusesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1509,6 +1555,7 @@ "$ref": "FetchGitAheadBehindResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1534,6 +1581,7 @@ "$ref": "Workspace" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1565,6 +1613,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1593,6 +1642,7 @@ "$ref": "InstallNpmPackagesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1639,6 +1689,7 @@ "$ref": "ListWorkspacesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1667,6 +1718,7 @@ "$ref": "MakeDirectoryResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1695,6 +1747,7 @@ "$ref": "MoveDirectoryResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1723,6 +1776,7 @@ "$ref": "MoveFileResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1748,9 +1802,10 @@ "$ref": "PullGitCommitsRequest" }, "response": { - "$ref": "Empty" + "$ref": "PullGitCommitsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1776,9 +1831,10 @@ "$ref": "PushGitCommitsRequest" }, "response": { - "$ref": "Empty" + "$ref": "PushGitCommitsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1820,6 +1876,7 @@ "$ref": "QueryDirectoryContentsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1855,6 +1912,7 @@ "$ref": "ReadFileResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1880,9 +1938,10 @@ "$ref": "RemoveDirectoryRequest" }, "response": { - "$ref": "Empty" + "$ref": "RemoveDirectoryResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1908,9 +1967,10 @@ "$ref": "RemoveFileRequest" }, "response": { - "$ref": "Empty" + "$ref": "RemoveFileResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1936,9 +1996,10 @@ "$ref": "ResetWorkspaceChangesRequest" }, "response": { - "$ref": "Empty" + "$ref": "ResetWorkspaceChangesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1980,6 +2041,7 @@ "$ref": "SearchFilesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2008,6 +2070,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2036,6 +2099,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2064,6 +2128,7 @@ "$ref": "WriteFileResponse" }, "scopes": [ + "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2076,7 +2141,7 @@ } } }, - "revision": "20250119", + "revision": "20250306", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { @@ -2161,6 +2226,12 @@ "properties": {}, "type": "object" }, + "CancelWorkflowInvocationResponse": { + "description": "`CancelWorkflowInvocation` response message.", + "id": "CancelWorkflowInvocationResponse", + "properties": {}, + "type": "object" + }, "CodeCompilationConfig": { "description": "Configures various aspects of Dataform code compilation.", "id": "CodeCompilationConfig", @@ -2182,7 +2253,8 @@ "type": "string" }, "defaultNotebookRuntimeOptions": { - "$ref": "NotebookRuntimeOptions" + "$ref": "NotebookRuntimeOptions", + "description": "Optional. The default notebook runtime options." }, "defaultSchema": { "description": "Optional. The default schema (BigQuery dataset ID).", @@ -2297,7 +2369,7 @@ "additionalProperties": { "$ref": "FileOperation" }, - "description": "A map to the path of the file to the operation. The path is the full file path including filename, from repository root.", + "description": "Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root.", "type": "object" }, "requiredHeadCommitSha": { @@ -2340,6 +2412,12 @@ }, "type": "object" }, + "CommitWorkspaceChangesResponse": { + "description": "`CommitWorkspaceChanges` response message.", + "id": "CommitWorkspaceChangesResponse", + "properties": {}, + "type": "object" + }, "CompilationError": { "description": "An error encountered when attempting to compile a Dataform project.", "id": "CompilationError", @@ -2516,7 +2594,7 @@ "id": "DataEncryptionState", "properties": { "kmsKeyVersionName": { - "description": "The KMS key version name with which data of a resource is encrypted.", + "description": "Required. The KMS key version name with which data of a resource is encrypted.", "type": "string" } }, @@ -3103,6 +3181,7 @@ "type": "object" }, "Notebook": { + "description": "Represents a notebook.", "id": "Notebook", "properties": { "contents": { @@ -3148,6 +3227,7 @@ "type": "object" }, "NotebookRuntimeOptions": { + "description": "Configures various aspects of Dataform notebook runtime.", "id": "NotebookRuntimeOptions", "properties": { "gcsOutputBucket": { @@ -3280,6 +3360,12 @@ }, "type": "object" }, + "PullGitCommitsResponse": { + "description": "`PullGitCommits` response message.", + "id": "PullGitCommitsResponse", + "properties": {}, + "type": "object" + }, "PushGitCommitsRequest": { "description": "`PushGitCommits` request message.", "id": "PushGitCommitsRequest", @@ -3291,6 +3377,12 @@ }, "type": "object" }, + "PushGitCommitsResponse": { + "description": "`PushGitCommits` response message.", + "id": "PushGitCommitsResponse", + "properties": {}, + "type": "object" + }, "QueryCompilationResultActionsResponse": { "description": "`QueryCompilationResultActions` response message.", "id": "QueryCompilationResultActionsResponse", @@ -3567,6 +3659,12 @@ }, "type": "object" }, + "RemoveDirectoryResponse": { + "description": "`RemoveDirectory` response message.", + "id": "RemoveDirectoryResponse", + "properties": {}, + "type": "object" + }, "RemoveFileRequest": { "description": "`RemoveFile` request message.", "id": "RemoveFileRequest", @@ -3578,6 +3676,12 @@ }, "type": "object" }, + "RemoveFileResponse": { + "description": "`RemoveFile` response message.", + "id": "RemoveFileResponse", + "properties": {}, + "type": "object" + }, "Repository": { "description": "Represents a Dataform Git repository.", "id": "Repository", @@ -3658,6 +3762,12 @@ }, "type": "object" }, + "ResetWorkspaceChangesResponse": { + "description": "`ResetWorkspaceChanges` response message.", + "id": "ResetWorkspaceChangesResponse", + "properties": {}, + "type": "object" + }, "ScheduledExecutionRecord": { "description": "A record of an attempt to create a workflow invocation for this workflow config.", "id": "ScheduledExecutionRecord", @@ -3667,8 +3777,9 @@ "description": "The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful." }, "executionTime": { - "description": "The timestamp of this execution attempt.", + "description": "Output only. The timestamp of this execution attempt.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "workflowInvocation": { @@ -3691,8 +3802,9 @@ "description": "The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful." }, "releaseTime": { - "description": "The timestamp of this release attempt.", + "description": "Output only. The timestamp of this release attempt.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -3789,15 +3901,15 @@ "id": "Target", "properties": { "database": { - "description": "The action's database (Google Cloud project ID) .", + "description": "Optional. The action's database (Google Cloud project ID) .", "type": "string" }, "name": { - "description": "The action's name, within `database` and `schema`.", + "description": "Optional. The action's name, within `database` and `schema`.", "type": "string" }, "schema": { - "description": "The action's schema (BigQuery dataset ID), within `database`.", + "description": "Optional. The action's schema (BigQuery dataset ID), within `database`.", "type": "string" } }, @@ -3840,7 +3952,7 @@ "type": "string" }, "state": { - "description": "Indicates the status of the file.", + "description": "Output only. Indicates the status of the file.", "enum": [ "STATE_UNSPECIFIED", "ADDED", @@ -3855,6 +3967,7 @@ "The file has been modified.", "The file contains merge conflicts." ], + "readOnly": true, "type": "string" } }, diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index fe4c87d9772..6661d9d1312 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -187,6 +187,10 @@ export namespace dataform_v1beta1 { * `CancelWorkflowInvocation` request message. */ export interface Schema$CancelWorkflowInvocationRequest {} + /** + * `CancelWorkflowInvocation` response message. + */ + export interface Schema$CancelWorkflowInvocationResponse {} /** * Configures various aspects of Dataform code compilation. */ @@ -207,6 +211,9 @@ export namespace dataform_v1beta1 { * Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. */ defaultLocation?: string | null; + /** + * Optional. The default notebook runtime options. + */ defaultNotebookRuntimeOptions?: Schema$NotebookRuntimeOptions; /** * Optional. The default schema (BigQuery dataset ID). @@ -298,7 +305,7 @@ export namespace dataform_v1beta1 { */ commitMetadata?: Schema$CommitMetadata; /** - * A map to the path of the file to the operation. The path is the full file path including filename, from repository root. + * Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root. */ fileOperations?: {[key: string]: Schema$FileOperation} | null; /** @@ -332,6 +339,10 @@ export namespace dataform_v1beta1 { */ paths?: string[] | null; } + /** + * `CommitWorkspaceChanges` response message. + */ + export interface Schema$CommitWorkspaceChangesResponse {} /** * An error encountered when attempting to compile a Dataform project. */ @@ -470,7 +481,7 @@ export namespace dataform_v1beta1 { */ export interface Schema$DataEncryptionState { /** - * The KMS key version name with which data of a resource is encrypted. + * Required. The KMS key version name with which data of a resource is encrypted. */ kmsKeyVersionName?: string | null; } @@ -900,6 +911,9 @@ export namespace dataform_v1beta1 { * `MoveFile` response message. */ export interface Schema$MoveFileResponse {} + /** + * Represents a notebook. + */ export interface Schema$Notebook { /** * The contents of the notebook. @@ -931,6 +945,9 @@ export namespace dataform_v1beta1 { */ jobId?: string | null; } + /** + * Configures various aspects of Dataform notebook runtime. + */ export interface Schema$NotebookRuntimeOptions { /** * Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. @@ -1029,6 +1046,10 @@ export namespace dataform_v1beta1 { */ remoteBranch?: string | null; } + /** + * `PullGitCommits` response message. + */ + export interface Schema$PullGitCommitsResponse {} /** * `PushGitCommits` request message. */ @@ -1038,6 +1059,10 @@ export namespace dataform_v1beta1 { */ remoteBranch?: string | null; } + /** + * `PushGitCommits` response message. + */ + export interface Schema$PushGitCommitsResponse {} /** * `QueryCompilationResultActions` response message. */ @@ -1236,6 +1261,10 @@ export namespace dataform_v1beta1 { */ path?: string | null; } + /** + * `RemoveDirectory` response message. + */ + export interface Schema$RemoveDirectoryResponse {} /** * `RemoveFile` request message. */ @@ -1245,6 +1274,10 @@ export namespace dataform_v1beta1 { */ path?: string | null; } + /** + * `RemoveFile` response message. + */ + export interface Schema$RemoveFileResponse {} /** * Represents a Dataform Git repository. */ @@ -1311,6 +1344,10 @@ export namespace dataform_v1beta1 { */ paths?: string[] | null; } + /** + * `ResetWorkspaceChanges` response message. + */ + export interface Schema$ResetWorkspaceChangesResponse {} /** * A record of an attempt to create a workflow invocation for this workflow config. */ @@ -1320,7 +1357,7 @@ export namespace dataform_v1beta1 { */ errorStatus?: Schema$Status; /** - * The timestamp of this execution attempt. + * Output only. The timestamp of this execution attempt. */ executionTime?: string | null; /** @@ -1341,7 +1378,7 @@ export namespace dataform_v1beta1 { */ errorStatus?: Schema$Status; /** - * The timestamp of this release attempt. + * Output only. The timestamp of this release attempt. */ releaseTime?: string | null; } @@ -1415,15 +1452,15 @@ export namespace dataform_v1beta1 { */ export interface Schema$Target { /** - * The action's database (Google Cloud project ID) . + * Optional. The action's database (Google Cloud project ID) . */ database?: string | null; /** - * The action's name, within `database` and `schema`. + * Optional. The action's name, within `database` and `schema`. */ name?: string | null; /** - * The action's schema (BigQuery dataset ID), within `database`. + * Optional. The action's schema (BigQuery dataset ID), within `database`. */ schema?: string | null; } @@ -1454,7 +1491,7 @@ export namespace dataform_v1beta1 { */ path?: string | null; /** - * Indicates the status of the file. + * Output only. Indicates the status of the file. */ state?: string | null; } @@ -3420,7 +3457,7 @@ export namespace dataform_v1beta1 { export interface Params$Resource$Projects$Locations$Repositories$Delete extends StandardParameters { /** - * If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) + * Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) */ force?: boolean; /** @@ -5061,7 +5098,7 @@ export namespace dataform_v1beta1 { cancel( params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; cancel( params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, options: StreamMethodOptions | BodyResponseCallback, @@ -5069,28 +5106,35 @@ export namespace dataform_v1beta1 { ): void; cancel( params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; cancel( params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, - callback: BodyResponseCallback + callback: BodyResponseCallback + ): void; + cancel( + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel - | BodyResponseCallback + | 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$Repositories$Workflowinvocations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; @@ -5126,12 +5170,14 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -5697,7 +5743,7 @@ export namespace dataform_v1beta1 { commit( params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; commit( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, options: StreamMethodOptions | BodyResponseCallback, @@ -5705,28 +5751,35 @@ export namespace dataform_v1beta1 { ): void; commit( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; commit( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, - callback: BodyResponseCallback + callback: BodyResponseCallback + ): void; + commit( + callback: BodyResponseCallback ): void; - commit(callback: BodyResponseCallback): void; commit( paramsOrCallback?: | Params$Resource$Projects$Locations$Repositories$Workspaces$Commit - | BodyResponseCallback + | 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$Repositories$Workspaces$Commit; let options = (optionsOrCallback || {}) as MethodOptions; @@ -5762,12 +5815,14 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -6897,7 +6952,7 @@ export namespace dataform_v1beta1 { pull( params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; pull( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, options: StreamMethodOptions | BodyResponseCallback, @@ -6905,28 +6960,33 @@ export namespace dataform_v1beta1 { ): void; pull( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; pull( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - pull(callback: BodyResponseCallback): void; + pull(callback: BodyResponseCallback): void; pull( paramsOrCallback?: | Params$Resource$Projects$Locations$Repositories$Workspaces$Pull - | BodyResponseCallback + | 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$Repositories$Workspaces$Pull; let options = (optionsOrCallback || {}) as MethodOptions; @@ -6962,12 +7022,12 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -6986,7 +7046,7 @@ export namespace dataform_v1beta1 { push( params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; push( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, options: StreamMethodOptions | BodyResponseCallback, @@ -6994,28 +7054,33 @@ export namespace dataform_v1beta1 { ): void; push( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; push( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - push(callback: BodyResponseCallback): void; + push(callback: BodyResponseCallback): void; push( paramsOrCallback?: | Params$Resource$Projects$Locations$Repositories$Workspaces$Push - | BodyResponseCallback + | 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$Repositories$Workspaces$Push; let options = (optionsOrCallback || {}) as MethodOptions; @@ -7051,12 +7116,12 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -7261,7 +7326,7 @@ export namespace dataform_v1beta1 { removeDirectory( params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; removeDirectory( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, options: StreamMethodOptions | BodyResponseCallback, @@ -7269,28 +7334,35 @@ export namespace dataform_v1beta1 { ): void; removeDirectory( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; removeDirectory( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, - callback: BodyResponseCallback + callback: BodyResponseCallback + ): void; + removeDirectory( + callback: BodyResponseCallback ): void; - removeDirectory(callback: BodyResponseCallback): void; removeDirectory( paramsOrCallback?: | Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory - | BodyResponseCallback + | 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$Repositories$Workspaces$Removedirectory; let options = (optionsOrCallback || {}) as MethodOptions; @@ -7326,12 +7398,12 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -7350,7 +7422,7 @@ export namespace dataform_v1beta1 { removeFile( params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; removeFile( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, options: StreamMethodOptions | BodyResponseCallback, @@ -7358,28 +7430,31 @@ export namespace dataform_v1beta1 { ): void; removeFile( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; removeFile( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - removeFile(callback: BodyResponseCallback): void; + removeFile(callback: BodyResponseCallback): void; removeFile( paramsOrCallback?: | Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile - | BodyResponseCallback + | 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$Repositories$Workspaces$Removefile; let options = (optionsOrCallback || {}) as MethodOptions; @@ -7415,12 +7490,12 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -7439,7 +7514,7 @@ export namespace dataform_v1beta1 { reset( params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; reset( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, options: StreamMethodOptions | BodyResponseCallback, @@ -7447,28 +7522,35 @@ export namespace dataform_v1beta1 { ): void; reset( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; reset( params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, - callback: BodyResponseCallback + callback: BodyResponseCallback + ): void; + reset( + callback: BodyResponseCallback ): void; - reset(callback: BodyResponseCallback): void; reset( paramsOrCallback?: | Params$Resource$Projects$Locations$Repositories$Workspaces$Reset - | BodyResponseCallback + | 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$Repositories$Workspaces$Reset; let options = (optionsOrCallback || {}) as MethodOptions; @@ -7504,12 +7586,14 @@ export namespace dataform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } From fbee7b7b2222dde9ab5deff7fc902b6cc63f42fb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 044/144] feat(datafusion): update the API #### datafusion:v1beta1 The following keys were added: - schemas.Instance.properties.loggingConfig.$ref - schemas.Instance.properties.loggingConfig.description - schemas.Instance.properties.satisfiesPzi.description - schemas.Instance.properties.satisfiesPzi.readOnly - schemas.Instance.properties.satisfiesPzi.type - schemas.LoggingConfig.description - schemas.LoggingConfig.id - schemas.LoggingConfig.properties.instanceCloudLoggingDisabled.description - schemas.LoggingConfig.properties.instanceCloudLoggingDisabled.type - schemas.LoggingConfig.type The following keys were changed: - schemas.Instance.properties.enableStackdriverLogging.description #### datafusion:v1 The following keys were added: - schemas.Instance.properties.loggingConfig.$ref - schemas.Instance.properties.loggingConfig.description - schemas.Instance.properties.satisfiesPzi.description - schemas.Instance.properties.satisfiesPzi.readOnly - schemas.Instance.properties.satisfiesPzi.type - schemas.LoggingConfig.description - schemas.LoggingConfig.id - schemas.LoggingConfig.properties.instanceCloudLoggingDisabled.description - schemas.LoggingConfig.properties.instanceCloudLoggingDisabled.type - schemas.LoggingConfig.type The following keys were changed: - schemas.Instance.properties.enableStackdriverLogging.description --- discovery/datafusion-v1.json | 24 ++++++++++++++++++++++-- discovery/datafusion-v1beta1.json | 24 ++++++++++++++++++++++-- src/apis/datafusion/v1.ts | 19 ++++++++++++++++++- src/apis/datafusion/v1beta1.ts | 19 ++++++++++++++++++- 4 files changed, 80 insertions(+), 6 deletions(-) diff --git a/discovery/datafusion-v1.json b/discovery/datafusion-v1.json index 418d2cea91e..5140c3e13c1 100644 --- a/discovery/datafusion-v1.json +++ b/discovery/datafusion-v1.json @@ -732,7 +732,7 @@ } } }, - "revision": "20250122", + "revision": "20250224", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1007,7 +1007,7 @@ "type": "boolean" }, "enableStackdriverLogging": { - "description": "Optional. Option to enable Stackdriver Logging.", + "description": "Optional. Option to enable Dataproc Stackdriver Logging.", "type": "boolean" }, "enableStackdriverMonitoring": { @@ -1035,6 +1035,10 @@ "description": "The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.", "type": "object" }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The logging configuration for this instance. This field is supported only in CDF versions 6.11.0 and above." + }, "maintenanceEvents": { "description": "Output only. The maintenance events for this instance.", "items": { @@ -1076,6 +1080,11 @@ "description": "Optional. Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.", "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -1310,6 +1319,17 @@ }, "type": "object" }, + "LoggingConfig": { + "description": "Logging configuration for a Data Fusion instance.", + "id": "LoggingConfig", + "properties": { + "instanceCloudLoggingDisabled": { + "description": "Optional. Option to determine whether instance logs should be written to Cloud Logging. By default, instance logs are written to Cloud Logging.", + "type": "boolean" + } + }, + "type": "object" + }, "MaintenanceEvent": { "description": "Represents a maintenance event.", "id": "MaintenanceEvent", diff --git a/discovery/datafusion-v1beta1.json b/discovery/datafusion-v1beta1.json index fbd6c15402f..9c59190257e 100644 --- a/discovery/datafusion-v1beta1.json +++ b/discovery/datafusion-v1beta1.json @@ -930,7 +930,7 @@ } } }, - "revision": "20250122", + "revision": "20250224", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1220,7 +1220,7 @@ "type": "boolean" }, "enableStackdriverLogging": { - "description": "Option to enable Stackdriver Logging.", + "description": "Option to enable Dataproc Stackdriver Logging.", "type": "boolean" }, "enableStackdriverMonitoring": { @@ -1247,6 +1247,10 @@ "description": "The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.", "type": "object" }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The logging configuration for this instance. This field is supported only in CDF versions 6.11.0 and above." + }, "maintenanceEvents": { "description": "Output only. The maintenance events for this instance.", "items": { @@ -1288,6 +1292,11 @@ "description": "Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.", "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -1540,6 +1549,17 @@ }, "type": "object" }, + "LoggingConfig": { + "description": "Logging configuration for a Data Fusion instance.", + "id": "LoggingConfig", + "properties": { + "instanceCloudLoggingDisabled": { + "description": "Optional. Option to determine whether instance logs should be written to Cloud Logging. By default, instance logs are written to Cloud Logging.", + "type": "boolean" + } + }, + "type": "object" + }, "MaintenanceEvent": { "description": "Represents a maintenance event.", "id": "MaintenanceEvent", diff --git a/src/apis/datafusion/v1.ts b/src/apis/datafusion/v1.ts index d31cf035db6..9e47a7e5b0d 100644 --- a/src/apis/datafusion/v1.ts +++ b/src/apis/datafusion/v1.ts @@ -305,7 +305,7 @@ export namespace datafusion_v1 { */ enableRbac?: boolean | null; /** - * Optional. Option to enable Stackdriver Logging. + * Optional. Option to enable Dataproc Stackdriver Logging. */ enableStackdriverLogging?: boolean | null; /** @@ -328,6 +328,10 @@ export namespace datafusion_v1 { * The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. */ labels?: {[key: string]: string} | null; + /** + * Optional. The logging configuration for this instance. This field is supported only in CDF versions 6.11.0 and above. + */ + loggingConfig?: Schema$LoggingConfig; /** * Output only. The maintenance events for this instance. */ @@ -360,6 +364,10 @@ export namespace datafusion_v1 { * Optional. Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. */ privateInstance?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * Output only. Reserved for future use. */ @@ -503,6 +511,15 @@ export namespace datafusion_v1 { */ name?: string | null; } + /** + * Logging configuration for a Data Fusion instance. + */ + export interface Schema$LoggingConfig { + /** + * Optional. Option to determine whether instance logs should be written to Cloud Logging. By default, instance logs are written to Cloud Logging. + */ + instanceCloudLoggingDisabled?: boolean | null; + } /** * Represents a maintenance event. */ diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index b9f9cbec82e..e4bf9295dcd 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -318,7 +318,7 @@ export namespace datafusion_v1beta1 { */ enableRbac?: boolean | null; /** - * Option to enable Stackdriver Logging. + * Option to enable Dataproc Stackdriver Logging. */ enableStackdriverLogging?: boolean | null; /** @@ -341,6 +341,10 @@ export namespace datafusion_v1beta1 { * The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. */ labels?: {[key: string]: string} | null; + /** + * Optional. The logging configuration for this instance. This field is supported only in CDF versions 6.11.0 and above. + */ + loggingConfig?: Schema$LoggingConfig; /** * Output only. The maintenance events for this instance. */ @@ -373,6 +377,10 @@ export namespace datafusion_v1beta1 { * Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. */ privateInstance?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * Output only. Reserved for future use. */ @@ -529,6 +537,15 @@ export namespace datafusion_v1beta1 { */ name?: string | null; } + /** + * Logging configuration for a Data Fusion instance. + */ + export interface Schema$LoggingConfig { + /** + * Optional. Option to determine whether instance logs should be written to Cloud Logging. By default, instance logs are written to Cloud Logging. + */ + instanceCloudLoggingDisabled?: boolean | null; + } /** * Represents a maintenance event. */ From 7b92d30c9cdb21331c0b9a1ef6b7818513e9496e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 045/144] fix(datalabeling): update the API #### datalabeling:v1beta1 The following keys were changed: - resources.projects.resources.datasets.methods.create.description - resources.projects.resources.datasets.resources.annotatedDatasets.resources.feedbackThreads.methods.get.description - resources.projects.resources.datasets.resources.evaluations.methods.get.description - resources.projects.resources.datasets.resources.image.methods.label.description - resources.projects.resources.evaluationJobs.methods.create.description - schemas.GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest.description - schemas.GoogleCloudDatalabelingV1beta1LabelImageRequest.description - schemas.GoogleCloudDatalabelingV1beta1LabelVideoRequest.description --- discovery/datalabeling-v1beta1.json | 18 +++++++++--------- src/apis/datalabeling/v1beta1.ts | 16 ++++++++-------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/discovery/datalabeling-v1beta1.json b/discovery/datalabeling-v1beta1.json index 98eee84045d..46104937724 100644 --- a/discovery/datalabeling-v1beta1.json +++ b/discovery/datalabeling-v1beta1.json @@ -233,7 +233,7 @@ "datasets": { "methods": { "create": { - "description": "Creates dataset. If success return a Dataset resource.", + "description": " Creates dataset. If success return a Dataset resource.", "flatPath": "v1beta1/projects/{projectsId}/datasets", "httpMethod": "POST", "id": "datalabeling.projects.datasets.create", @@ -677,7 +677,7 @@ ] }, "get": { - "description": "Get a FeedbackThread object.", + "description": " Get a FeedbackThread object.", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}", "httpMethod": "GET", "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get", @@ -934,7 +934,7 @@ "evaluations": { "methods": { "get": { - "description": "Gets an evaluation by resource name (to search, use projects.evaluations.search).", + "description": " Gets an evaluation by resource name (to search, use projects.evaluations.search).", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}", "httpMethod": "GET", "id": "datalabeling.projects.datasets.evaluations.get", @@ -997,7 +997,7 @@ "image": { "methods": { "label": { - "description": "Starts a labeling task for image. The type of image labeling task is configured by feature in the request.", + "description": " Starts a labeling task for image. The type of image labeling task is configured by feature in the request.", "flatPath": "v1beta1/projects/{projectsId}/datasets/{datasetsId}/image:label", "httpMethod": "POST", "id": "datalabeling.projects.datasets.image.label", @@ -1095,7 +1095,7 @@ "evaluationJobs": { "methods": { "create": { - "description": "Creates an evaluation job.", + "description": " Creates an evaluation job.", "flatPath": "v1beta1/projects/{projectsId}/evaluationJobs", "httpMethod": "POST", "id": "datalabeling.projects.evaluationJobs.create", @@ -1596,7 +1596,7 @@ } } }, - "revision": "20241117", + "revision": "20250127", "rootUrl": "https://datalabeling.googleapis.com/", "schemas": { "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { @@ -2560,7 +2560,7 @@ "type": "object" }, "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest": { - "description": "Request message for CreateEvaluationJob.", + "description": " Request message for CreateEvaluationJob.", "id": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest", "properties": { "job": { @@ -3614,7 +3614,7 @@ "type": "object" }, "GoogleCloudDatalabelingV1beta1LabelImageRequest": { - "description": "Request message for starting an image labeling task.", + "description": " Request message for starting an image labeling task.", "id": "GoogleCloudDatalabelingV1beta1LabelImageRequest", "properties": { "basicConfig": { @@ -3868,7 +3868,7 @@ "type": "object" }, "GoogleCloudDatalabelingV1beta1LabelVideoRequest": { - "description": "Request message for LabelVideo.", + "description": " Request message for LabelVideo.", "id": "GoogleCloudDatalabelingV1beta1LabelVideoRequest", "properties": { "basicConfig": { diff --git a/src/apis/datalabeling/v1beta1.ts b/src/apis/datalabeling/v1beta1.ts index eca74e38612..e71b59f41d2 100644 --- a/src/apis/datalabeling/v1beta1.ts +++ b/src/apis/datalabeling/v1beta1.ts @@ -868,7 +868,7 @@ export namespace datalabeling_v1beta1 { dataset?: Schema$GoogleCloudDatalabelingV1beta1Dataset; } /** - * Request message for CreateEvaluationJob. + * Request message for CreateEvaluationJob. */ export interface Schema$GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest { /** @@ -1622,7 +1622,7 @@ export namespace datalabeling_v1beta1 { basicConfig?: Schema$GoogleCloudDatalabelingV1beta1HumanAnnotationConfig; } /** - * Request message for starting an image labeling task. + * Request message for starting an image labeling task. */ export interface Schema$GoogleCloudDatalabelingV1beta1LabelImageRequest { /** @@ -1817,7 +1817,7 @@ export namespace datalabeling_v1beta1 { basicConfig?: Schema$GoogleCloudDatalabelingV1beta1HumanAnnotationConfig; } /** - * Request message for LabelVideo. + * Request message for LabelVideo. */ export interface Schema$GoogleCloudDatalabelingV1beta1LabelVideoRequest { /** @@ -3695,7 +3695,7 @@ export namespace datalabeling_v1beta1 { } /** - * Creates dataset. If success return a Dataset resource. + * Creates dataset. If success return a Dataset resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5225,7 +5225,7 @@ export namespace datalabeling_v1beta1 { } /** - * Get a FeedbackThread object. + * Get a FeedbackThread object. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6112,7 +6112,7 @@ export namespace datalabeling_v1beta1 { } /** - * Gets an evaluation by resource name (to search, use projects.evaluations.search). + * Gets an evaluation by resource name (to search, use projects.evaluations.search). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6338,7 +6338,7 @@ export namespace datalabeling_v1beta1 { } /** - * Starts a labeling task for image. The type of image labeling task is configured by feature in the request. + * Starts a labeling task for image. The type of image labeling task is configured by feature in the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6683,7 +6683,7 @@ export namespace datalabeling_v1beta1 { } /** - * Creates an evaluation job. + * Creates an evaluation job. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From eff23a74122ca057d165f2d55aa19572c42eec76 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 046/144] feat(datamigration): update the API #### datamigration:v1 The following keys were added: - schemas.CloudSqlSettings.properties.dataDiskProvisionedIops.description - schemas.CloudSqlSettings.properties.dataDiskProvisionedIops.format - schemas.CloudSqlSettings.properties.dataDiskProvisionedIops.type - schemas.CloudSqlSettings.properties.dataDiskProvisionedThroughput.description - schemas.CloudSqlSettings.properties.dataDiskProvisionedThroughput.format - schemas.CloudSqlSettings.properties.dataDiskProvisionedThroughput.type - schemas.EntityDdl.properties.ddlKind.description - schemas.EntityDdl.properties.ddlKind.enum - schemas.EntityDdl.properties.ddlKind.enumDescriptions - schemas.EntityDdl.properties.ddlKind.type - schemas.EntityDdl.properties.editedDdlKind.description - schemas.EntityDdl.properties.editedDdlKind.enum - schemas.EntityDdl.properties.editedDdlKind.enumDescriptions - schemas.EntityDdl.properties.editedDdlKind.type The following keys were changed: - resources.projects.resources.locations.resources.conversionWorkspaces.methods.describeDatabaseEntities.parameters.view.enum - resources.projects.resources.locations.resources.conversionWorkspaces.methods.describeDatabaseEntities.parameters.view.enumDescriptions - schemas.CloudSqlSettings.properties.dataDiskType.description - schemas.CloudSqlSettings.properties.dataDiskType.enum - schemas.CloudSqlSettings.properties.dataDiskType.enumDescriptions - schemas.ConnectionProfile.properties.satisfiesPzi.description - schemas.ConnectionProfile.properties.satisfiesPzs.description - schemas.MigrationJob.properties.satisfiesPzi.description - schemas.MigrationJob.properties.satisfiesPzs.description - schemas.PrivateConnection.properties.satisfiesPzi.description - schemas.PrivateConnection.properties.satisfiesPzs.description --- discovery/datamigration-v1.json | 74 +++++++++++++++++++++++++++------ src/apis/datamigration/v1.ts | 30 +++++++++---- 2 files changed, 85 insertions(+), 19 deletions(-) diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index da00ae25461..ea3c40d69c6 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -761,13 +761,15 @@ "DATABASE_ENTITY_VIEW_UNSPECIFIED", "DATABASE_ENTITY_VIEW_BASIC", "DATABASE_ENTITY_VIEW_FULL", - "DATABASE_ENTITY_VIEW_ROOT_SUMMARY" + "DATABASE_ENTITY_VIEW_ROOT_SUMMARY", + "DATABASE_ENTITY_VIEW_FULL_COMPACT" ], "enumDescriptions": [ "Unspecified view. Defaults to basic view.", "Default view. Does not return DDLs or Issues.", "Return full entity details including mappings, ddl and issues.", - "Top-most (Database, Schema) nodes which are returned contains summary details for their decendents such as the number of entities per type and issues rollups. When this view is used, only a single page of result is returned and the page_size property of the request is ignored. The returned page will only include the top-most node types." + "Top-most (Database, Schema) nodes which are returned contains summary details for their descendants such as the number of entities per type and issues rollups. When this view is used, only a single page of result is returned and the page_size property of the request is ignored. The returned page will only include the top-most node types.", + "Returns full entity details except for ddls and schema custom features." ], "location": "query", "type": "string" @@ -2332,7 +2334,7 @@ } } }, - "revision": "20250115", + "revision": "20250226", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2722,22 +2724,34 @@ "$ref": "DataCacheConfig", "description": "Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation." }, + "dataDiskProvisionedIops": { + "description": "Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.", + "format": "int64", + "type": "string" + }, + "dataDiskProvisionedThroughput": { + "description": "Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.", + "format": "int64", + "type": "string" + }, "dataDiskSizeGb": { "description": "The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.", "format": "int64", "type": "string" }, "dataDiskType": { - "description": "The type of storage: `PD_SSD` (default) or `PD_HDD`.", + "description": "The type of storage: `PD_SSD` (default) or `PD_HDD` or `HYPERDISK_BALANCED`.", "enum": [ "SQL_DATA_DISK_TYPE_UNSPECIFIED", "PD_SSD", - "PD_HDD" + "PD_HDD", + "HYPERDISK_BALANCED" ], "enumDescriptions": [ "Unspecified.", "SSD disk.", - "HDD disk." + "HDD disk.", + "A Hyperdisk Balanced data disk." ], "type": "string" }, @@ -3087,12 +3101,12 @@ "type": "string" }, "satisfiesPzi": { - "description": "Output only. Zone Isolation compliance state of the resource.", + "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "satisfiesPzs": { - "description": "Output only. Zone Separation compliance state of the resource.", + "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, @@ -3651,10 +3665,46 @@ "description": "The actual ddl code.", "type": "string" }, + "ddlKind": { + "description": "The DDL Kind selected for apply, or UNSPECIFIED if the entity wasn't converted yet.", + "enum": [ + "DDL_KIND_UNSPECIFIED", + "SOURCE", + "DETERMINISTIC", + "AI", + "USER_EDIT" + ], + "enumDescriptions": [ + "The kind of the DDL is unknown.", + "DDL of the source entity", + "Deterministic converted DDL", + "Gemini AI converted DDL", + "User edited DDL" + ], + "type": "string" + }, "ddlType": { "description": "Type of DDL (Create, Alter).", "type": "string" }, + "editedDdlKind": { + "description": "If ddl_kind is USER_EDIT, this holds the DDL kind of the original content - DETERMINISTIC or AI. Otherwise, this is DDL_KIND_UNSPECIFIED.", + "enum": [ + "DDL_KIND_UNSPECIFIED", + "SOURCE", + "DETERMINISTIC", + "AI", + "USER_EDIT" + ], + "enumDescriptions": [ + "The kind of the DDL is unknown.", + "DDL of the source entity", + "Deterministic converted DDL", + "Gemini AI converted DDL", + "User edited DDL" + ], + "type": "string" + }, "entity": { "description": "The name of the database entity the ddl refers to.", "type": "string" @@ -4860,12 +4910,12 @@ "description": "The details needed to communicate to the source over Reverse SSH tunnel connectivity." }, "satisfiesPzi": { - "description": "Output only. Zone Isolation compliance state of the resource.", + "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "satisfiesPzs": { - "description": "Output only. Zone Separation compliance state of the resource.", + "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, @@ -5695,12 +5745,12 @@ "type": "string" }, "satisfiesPzi": { - "description": "Output only. Zone Isolation compliance state of the resource.", + "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "satisfiesPzs": { - "description": "Output only. Zone Separation compliance state of the resource.", + "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index f0b8651d0f4..bc1aa23115d 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -398,12 +398,20 @@ export namespace datamigration_v1 { * Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation. */ dataCacheConfig?: Schema$DataCacheConfig; + /** + * Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. + */ + dataDiskProvisionedIops?: string | null; + /** + * Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. + */ + dataDiskProvisionedThroughput?: string | null; /** * The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. */ dataDiskSizeGb?: string | null; /** - * The type of storage: `PD_SSD` (default) or `PD_HDD`. + * The type of storage: `PD_SSD` (default) or `PD_HDD` or `HYPERDISK_BALANCED`. */ dataDiskType?: string | null; /** @@ -611,11 +619,11 @@ export namespace datamigration_v1 { */ role?: string | null; /** - * Output only. Zone Isolation compliance state of the resource. + * Output only. Reserved for future use. */ satisfiesPzi?: boolean | null; /** - * Output only. Zone Separation compliance state of the resource. + * Output only. Reserved for future use. */ satisfiesPzs?: boolean | null; /** @@ -960,10 +968,18 @@ export namespace datamigration_v1 { * The actual ddl code. */ ddl?: string | null; + /** + * The DDL Kind selected for apply, or UNSPECIFIED if the entity wasn't converted yet. + */ + ddlKind?: string | null; /** * Type of DDL (Create, Alter). */ ddlType?: string | null; + /** + * If ddl_kind is USER_EDIT, this holds the DDL kind of the original content - DETERMINISTIC or AI. Otherwise, this is DDL_KIND_UNSPECIFIED. + */ + editedDdlKind?: string | null; /** * The name of the database entity the ddl refers to. */ @@ -1702,11 +1718,11 @@ export namespace datamigration_v1 { */ reverseSshConnectivity?: Schema$ReverseSshConnectivity; /** - * Output only. Zone Isolation compliance state of the resource. + * Output only. Reserved for future use. */ satisfiesPzi?: boolean | null; /** - * Output only. Zone Separation compliance state of the resource. + * Output only. Reserved for future use. */ satisfiesPzs?: boolean | null; /** @@ -2233,11 +2249,11 @@ export namespace datamigration_v1 { */ name?: string | null; /** - * Output only. Zone Isolation compliance state of the resource. + * Output only. Reserved for future use. */ satisfiesPzi?: boolean | null; /** - * Output only. Zone Separation compliance state of the resource. + * Output only. Reserved for future use. */ satisfiesPzs?: boolean | null; /** From c796b507d30a4b94e71e74072eefc286fd93fd51 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 047/144] feat(dataplex)!: update the API BREAKING CHANGE: This release has breaking changes. #### dataplex:v1 The following keys were deleted: - resources.projects.resources.locations.resources.dataTaxonomies.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.dataTaxonomies.methods.get.parameters.name.description The following keys were added: - resources.projects.resources.locations.resources.dataAttributeBindings.methods.create.deprecated - resources.projects.resources.locations.resources.dataAttributeBindings.methods.delete.deprecated - resources.projects.resources.locations.resources.dataAttributeBindings.methods.get.deprecated - resources.projects.resources.locations.resources.dataAttributeBindings.methods.list.deprecated - resources.projects.resources.locations.resources.dataAttributeBindings.methods.patch.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.methods.create.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.methods.delete.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.methods.get.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.methods.list.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.methods.patch.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.create.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.delete.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.get.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.list.deprecated - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.patch.deprecated - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.description - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.id - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.properties.eventType.description - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.properties.eventType.enum - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.properties.eventType.enumDescriptions - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.properties.eventType.type - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.properties.message.description - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.properties.message.type - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.properties.resource.description - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.properties.resource.type - schemas.GoogleCloudDataplexV1BusinessGlossaryEvent.type - schemas.GoogleCloudDataplexV1DataAttribute.deprecated - schemas.GoogleCloudDataplexV1DataAttributeBinding.deprecated - schemas.GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig.properties.location.description - schemas.GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig.properties.location.type - schemas.GoogleCloudDataplexV1DataTaxonomy.deprecated The following keys were changed: - resources.projects.resources.locations.methods.lookupEntry.description - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.get.description - schemas.GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing.properties.dataset.description - schemas.GoogleCloudDataplexV1DataProfileSpec.properties.rowFilter.description - schemas.GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation.description - schemas.GoogleCloudDataplexV1DataQualityRuleSqlAssertion.description - schemas.GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation.description - schemas.GoogleCloudDataplexV1DataQualitySpec.properties.rowFilter.description - schemas.GoogleCloudDataplexV1ImportItem.properties.aspectKeys.description - schemas.GoogleCloudDataplexV1ImportItem.properties.updateMask.description - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpec.description - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpec.properties.aspectSyncMode.description - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpec.properties.aspectSyncMode.enum - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpec.properties.aspectSyncMode.enumDescriptions - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpec.properties.entrySyncMode.description - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpec.properties.entrySyncMode.enum - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpec.properties.entrySyncMode.enumDescriptions - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope.properties.aspectTypes.description - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope.properties.entryGroups.description - schemas.GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope.properties.entryTypes.description --- discovery/dataplex-v1.json | 117 +++++++++++++++++++++++++++++-------- src/apis/dataplex/v1.ts | 57 ++++++++++++------ 2 files changed, 131 insertions(+), 43 deletions(-) diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 5597397a471..918affb7e47 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -635,7 +635,7 @@ ] }, "lookupEntry": { - "description": "Looks up a single Entry by name using the permission on the source system.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).", + "description": "Looks up an entry by name using the permission on the source system.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry", "httpMethod": "GET", "id": "dataplex.projects.locations.lookupEntry", @@ -1020,6 +1020,7 @@ "dataAttributeBindings": { "methods": { "create": { + "deprecated": true, "description": "Create a DataAttributeBinding resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings", "httpMethod": "POST", @@ -1058,6 +1059,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}", "httpMethod": "DELETE", @@ -1088,6 +1090,7 @@ ] }, "get": { + "deprecated": true, "description": "Retrieves a DataAttributeBinding resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}", "httpMethod": "GET", @@ -1144,6 +1147,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists DataAttributeBinding resources in a project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings", "httpMethod": "GET", @@ -1190,6 +1194,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a DataAttributeBinding resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}", "httpMethod": "PATCH", @@ -1744,6 +1749,7 @@ "dataTaxonomies": { "methods": { "create": { + "deprecated": true, "description": "Create a DataTaxonomy resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies", "httpMethod": "POST", @@ -1758,7 +1764,6 @@ "type": "string" }, "parent": { - "description": "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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1782,6 +1787,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}", "httpMethod": "DELETE", @@ -1812,6 +1818,7 @@ ] }, "get": { + "deprecated": true, "description": "Retrieves a DataTaxonomy resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}", "httpMethod": "GET", @@ -1821,7 +1828,6 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", "required": true, @@ -1868,6 +1874,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists DataTaxonomy resources in a project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies", "httpMethod": "GET", @@ -1914,6 +1921,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a DataTaxonomy resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}", "httpMethod": "PATCH", @@ -2013,6 +2021,7 @@ "attributes": { "methods": { "create": { + "deprecated": true, "description": "Create a DataAttribute resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes", "httpMethod": "POST", @@ -2051,6 +2060,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a Data Attribute resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}", "httpMethod": "DELETE", @@ -2081,6 +2091,7 @@ ] }, "get": { + "deprecated": true, "description": "Retrieves a Data Attribute resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}", "httpMethod": "GET", @@ -2137,6 +2148,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists Data Attribute resources in a DataTaxonomy.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes", "httpMethod": "GET", @@ -2183,6 +2195,7 @@ ] }, "patch": { + "deprecated": true, "description": "Updates a DataAttribute resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}", "httpMethod": "PATCH", @@ -2611,7 +2624,7 @@ ] }, "get": { - "description": "Gets an Entry.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).", + "description": "Gets an Entry.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entries.get", @@ -6244,7 +6257,7 @@ } } }, - "revision": "20250116", + "revision": "20250307", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -7095,6 +7108,49 @@ }, "type": "object" }, + "GoogleCloudDataplexV1BusinessGlossaryEvent": { + "description": "Payload associated with Business Glossary related log events.", + "id": "GoogleCloudDataplexV1BusinessGlossaryEvent", + "properties": { + "eventType": { + "description": "The type of the event.", + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "GLOSSARY_CREATE", + "GLOSSARY_UPDATE", + "GLOSSARY_DELETE", + "GLOSSARY_CATEGORY_CREATE", + "GLOSSARY_CATEGORY_UPDATE", + "GLOSSARY_CATEGORY_DELETE", + "GLOSSARY_TERM_CREATE", + "GLOSSARY_TERM_UPDATE", + "GLOSSARY_TERM_DELETE" + ], + "enumDescriptions": [ + "An unspecified event type.", + "Glossary create event.", + "Glossary update event.", + "Glossary delete event.", + "Glossary category create event.", + "Glossary category update event.", + "Glossary category delete event.", + "Glossary term create event.", + "Glossary term update event.", + "Glossary term delete event." + ], + "type": "string" + }, + "message": { + "description": "The log message.", + "type": "string" + }, + "resource": { + "description": "Name of the resource.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1CancelJobRequest": { "description": "Cancel task jobs.", "id": "GoogleCloudDataplexV1CancelJobRequest", @@ -7216,6 +7272,7 @@ "type": "object" }, "GoogleCloudDataplexV1DataAttribute": { + "deprecated": true, "description": "Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types PII - ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers :bar@foo.com ", "id": "GoogleCloudDataplexV1DataAttribute", "properties": { @@ -7282,6 +7339,7 @@ "type": "object" }, "GoogleCloudDataplexV1DataAttributeBinding": { + "deprecated": true, "description": "DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.", "id": "GoogleCloudDataplexV1DataAttributeBinding", "properties": { @@ -7382,7 +7440,7 @@ "id": "GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing", "properties": { "dataset": { - "description": "Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id}/datasets/{dataset_id}. If not set, the service creates a default publishing dataset.", + "description": "Output only. The BigQuery dataset the discovered tables are published to.", "readOnly": true, "type": "string" } @@ -7412,6 +7470,10 @@ "description": "Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id}", "type": "string" }, + "location": { + "description": "Optional. The location of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. 1. If the Cloud Storage bucket is located in a multi-region bucket, then BigQuery dataset can be in the same multi-region bucket or any single region that is included in the same multi-region bucket. The datascan can be created in any single region that is included in the same multi-region bucket 2. If the Cloud Storage bucket is located in a dual-region bucket, then BigQuery dataset can be located in regions that are included in the dual-region bucket, or in a multi-region that includes the dual-region. The datascan can be created in any single region that is included in the same dual-region bucket. 3. If the Cloud Storage bucket is located in a single region, then BigQuery dataset can be in the same single region or any multi-region bucket that includes the same single region. The datascan will be created in the same single region as the bucket. 4. If the BigQuery dataset is in single region, it must be in the same single region as the datascan.For supported values, refer to https://cloud.google.com/bigquery/docs/locations#supported_locations.", + "type": "string" + }, "tableType": { "description": "Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables.", "enum": [ @@ -7770,7 +7832,7 @@ "description": "Optional. Actions to take upon job completion.." }, "rowFilter": { - "description": "Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10", + "description": "Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10", "type": "string" }, "samplingPercent": { @@ -8120,7 +8182,7 @@ "type": "object" }, "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation": { - "description": "Evaluates whether each row passes the specified condition.The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10", + "description": "Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10", "id": "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation", "properties": { "sqlExpression": { @@ -8145,7 +8207,7 @@ "type": "object" }, "GoogleCloudDataplexV1DataQualityRuleSqlAssertion": { - "description": "A SQL statement that is evaluated to return rows that match an invalid state. If any rows are are returned, this rule fails.The SQL statement must use BigQuery standard SQL syntax, and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: SELECT * FROM ${data()} WHERE price < 0", + "description": "A SQL statement that is evaluated to return rows that match an invalid state. If any rows are are returned, this rule fails.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: SELECT * FROM ${data()} WHERE price < 0", "id": "GoogleCloudDataplexV1DataQualityRuleSqlAssertion", "properties": { "sqlStatement": { @@ -8195,7 +8257,7 @@ "type": "object" }, "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation": { - "description": "Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0", + "description": "Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0", "id": "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation", "properties": { "sqlExpression": { @@ -8328,7 +8390,7 @@ "description": "Optional. Actions to take upon job completion." }, "rowFilter": { - "description": "Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10", + "description": "Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10", "type": "string" }, "rules": { @@ -8968,6 +9030,7 @@ "type": "object" }, "GoogleCloudDataplexV1DataTaxonomy": { + "deprecated": true, "description": "DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.", "id": "GoogleCloudDataplexV1DataTaxonomy", "properties": { @@ -9946,7 +10009,7 @@ "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. @* : matches aspects of the given type for all paths. *@path : matches aspects of all types on the given path. 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.", + "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 of the given type for all paths. *@path : matches aspects of all types on the given path.Replace {aspect_type_reference} with a reference to the aspect type, in the format {project_id_or_number}.{location_id}.{aspect_type_id}.In FULL entry sync mode, if you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry. Dataplex implicitly adds the keys for all of the required aspects of an entry.", "items": { "type": "string" }, @@ -9957,7 +10020,7 @@ "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).", + "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.In an aspect-only metadata job (when entry sync mode is NONE), set this value to aspects.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" } @@ -10850,34 +10913,38 @@ "type": "object" }, "GoogleCloudDataplexV1MetadataJobImportJobSpec": { - "description": "Job specification for a metadata import job", + "description": "Job specification for a metadata import job.You can run the following kinds of metadata import jobs: Full sync of entries with incremental import of their aspects. Supported for custom entries. Incremental import of aspects only. Supported for aspects that belong to custom entries and system entries. For custom entries, you can modify both optional aspects and required aspects. For system entries, you can modify optional aspects.", "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.", + "description": "Required. The sync mode for aspects.", "enum": [ "SYNC_MODE_UNSPECIFIED", "FULL", - "INCREMENTAL" + "INCREMENTAL", + "NONE" ], "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." + "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.This sync mode is supported for entries.", + "Only the resources 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.This sync mode is supported for aspects.", + "If entry sync mode is NONE, then aspects are modified according to the aspect sync mode. Other metadata that belongs to entries in the job's scope isn't modified.This sync mode is supported for entries." ], "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.", + "description": "Required. The sync mode for entries.", "enum": [ "SYNC_MODE_UNSPECIFIED", "FULL", - "INCREMENTAL" + "INCREMENTAL", + "NONE" ], "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." + "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.This sync mode is supported for entries.", + "Only the resources 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.This sync mode is supported for aspects.", + "If entry sync mode is NONE, then aspects are modified according to the aspect sync mode. Other metadata that belongs to entries in the job's scope isn't modified.This sync mode is supported for entries." ], "type": "string" }, @@ -10916,21 +10983,21 @@ "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.", + "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.This field is required when creating an aspect-only import job.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.", + "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 and aspects 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.", + "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 and aspects 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" }, diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index ddfde2194b4..c36fc90d912 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -725,6 +725,23 @@ export namespace dataplex_v1 { */ updateTime?: string | null; } + /** + * Payload associated with Business Glossary related log events. + */ + export interface Schema$GoogleCloudDataplexV1BusinessGlossaryEvent { + /** + * The type of the event. + */ + eventType?: string | null; + /** + * The log message. + */ + message?: string | null; + /** + * Name of the resource. + */ + resource?: string | null; + } /** * Cancel task jobs. */ @@ -934,7 +951,7 @@ export namespace dataplex_v1 { */ export interface Schema$GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing { /** - * Output only. The BigQuery dataset to publish to. It takes the form projects/{project_id\}/datasets/{dataset_id\}. If not set, the service creates a default publishing dataset. + * Output only. The BigQuery dataset the discovered tables are published to. */ dataset?: string | null; } @@ -959,6 +976,10 @@ export namespace dataplex_v1 { * Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id\}/locations/{location_id\}/connections/{connection_id\} */ connection?: string | null; + /** + * Optional. The location of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. 1. If the Cloud Storage bucket is located in a multi-region bucket, then BigQuery dataset can be in the same multi-region bucket or any single region that is included in the same multi-region bucket. The datascan can be created in any single region that is included in the same multi-region bucket 2. If the Cloud Storage bucket is located in a dual-region bucket, then BigQuery dataset can be located in regions that are included in the dual-region bucket, or in a multi-region that includes the dual-region. The datascan can be created in any single region that is included in the same dual-region bucket. 3. If the Cloud Storage bucket is located in a single region, then BigQuery dataset can be in the same single region or any multi-region bucket that includes the same single region. The datascan will be created in the same single region as the bucket. 4. If the BigQuery dataset is in single region, it must be in the same single region as the datascan.For supported values, refer to https://cloud.google.com/bigquery/docs/locations#supported_locations. + */ + location?: string | null; /** * Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. */ @@ -1226,7 +1247,7 @@ export namespace dataplex_v1 { */ postScanActions?: Schema$GoogleCloudDataplexV1DataProfileSpecPostScanActions; /** - * Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 \>= 0 AND col2 < 10 + * Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 \>= 0 AND col2 < 10 */ rowFilter?: string | null; /** @@ -1500,7 +1521,7 @@ export namespace dataplex_v1 { rule?: Schema$GoogleCloudDataplexV1DataQualityRule; } /** - * Evaluates whether each row passes the specified condition.The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean value per row as the result.Example: col1 \>= 0 AND col2 < 10 + * Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 \>= 0 AND col2 < 10 */ export interface Schema$GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation { /** @@ -1518,7 +1539,7 @@ export namespace dataplex_v1 { values?: string[] | null; } /** - * A SQL statement that is evaluated to return rows that match an invalid state. If any rows are are returned, this rule fails.The SQL statement must use BigQuery standard SQL syntax, and must not contain any semicolons.You can use the data reference parameter ${data()\} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: SELECT * FROM ${data()\} WHERE price < 0 + * A SQL statement that is evaluated to return rows that match an invalid state. If any rows are are returned, this rule fails.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()\} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: SELECT * FROM ${data()\} WHERE price < 0 */ export interface Schema$GoogleCloudDataplexV1DataQualityRuleSqlAssertion { /** @@ -1552,7 +1573,7 @@ export namespace dataplex_v1 { strictMinEnabled?: boolean | null; } /** - * Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) \>= 0 + * Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) \>= 0 */ export interface Schema$GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation { /** @@ -1630,7 +1651,7 @@ export namespace dataplex_v1 { */ postScanActions?: Schema$GoogleCloudDataplexV1DataQualitySpecPostScanActions; /** - * Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 \>= 0 AND col2 < 10 + * Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 \>= 0 AND col2 < 10 */ rowFilter?: string | null; /** @@ -2716,7 +2737,7 @@ export namespace dataplex_v1 { */ 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. @* : matches aspects of the given type for all paths. *@path : matches aspects of all types on the given path. 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. + * 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 of the given type for all paths. *@path : matches aspects of all types on the given path.Replace {aspect_type_reference\} with a reference to the aspect type, in the format {project_id_or_number\}.{location_id\}.{aspect_type_id\}.In FULL entry sync mode, if you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry. Dataplex implicitly adds the keys for all of the required aspects of an entry. */ aspectKeys?: string[] | null; /** @@ -2724,7 +2745,7 @@ export namespace dataplex_v1 { */ 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). + * 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.In an aspect-only metadata job (when entry sync mode is NONE), set this value to aspects.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; } @@ -3293,15 +3314,15 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * Job specification for a metadata import job + * Job specification for a metadata import job.You can run the following kinds of metadata import jobs: Full sync of entries with incremental import of their aspects. Supported for custom entries. Incremental import of aspects only. Supported for aspects that belong to custom entries and system entries. For custom entries, you can modify both optional aspects and required aspects. For system entries, you can modify optional aspects. */ 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. + * Required. The sync mode for aspects. */ 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. + * Required. The sync mode for entries. */ entrySyncMode?: string | null; /** @@ -3326,15 +3347,15 @@ export namespace dataplex_v1 { */ 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. + * 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.This field is required when creating an aspect-only import job.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. + * 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 and aspects 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. + * 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 and aspects 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; } @@ -5372,7 +5393,7 @@ export namespace dataplex_v1 { } /** - * Looks up a single Entry by name using the permission on the source system.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). + * Looks up an 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`. @@ -9617,7 +9638,7 @@ export namespace dataplex_v1 { */ 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; /** @@ -9644,7 +9665,7 @@ export namespace dataplex_v1 { 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; } @@ -11692,7 +11713,7 @@ export namespace dataplex_v1 { } /** - * Gets an Entry.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). + * Gets an Entry. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From 10bb7ff1f4dbb0eb085dc890f3eb6de92ff2c3ac Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 048/144] feat(dataportability): update the API #### dataportability:v1beta The following keys were added: - resources.accessType.methods.check.description - resources.accessType.methods.check.flatPath - resources.accessType.methods.check.httpMethod - resources.accessType.methods.check.id - resources.accessType.methods.check.parameterOrder - resources.accessType.methods.check.path - resources.accessType.methods.check.request.$ref - resources.accessType.methods.check.response.$ref - resources.accessType.methods.check.scopes - resources.archiveJobs.methods.cancel.description - resources.archiveJobs.methods.cancel.flatPath - resources.archiveJobs.methods.cancel.httpMethod - resources.archiveJobs.methods.cancel.id - resources.archiveJobs.methods.cancel.parameterOrder - resources.archiveJobs.methods.cancel.parameters.name.description - resources.archiveJobs.methods.cancel.parameters.name.location - resources.archiveJobs.methods.cancel.parameters.name.pattern - resources.archiveJobs.methods.cancel.parameters.name.required - resources.archiveJobs.methods.cancel.parameters.name.type - resources.archiveJobs.methods.cancel.path - resources.archiveJobs.methods.cancel.request.$ref - resources.archiveJobs.methods.cancel.response.$ref - resources.archiveJobs.methods.cancel.scopes - schemas.CancelPortabilityArchiveRequest.description - schemas.CancelPortabilityArchiveRequest.id - schemas.CancelPortabilityArchiveRequest.type - schemas.CancelPortabilityArchiveResponse.description - schemas.CancelPortabilityArchiveResponse.id - schemas.CancelPortabilityArchiveResponse.type - schemas.CheckAccessTypeRequest.description - schemas.CheckAccessTypeRequest.id - schemas.CheckAccessTypeRequest.type - schemas.CheckAccessTypeResponse.description - schemas.CheckAccessTypeResponse.id - schemas.CheckAccessTypeResponse.properties.oneTimeResources.description - schemas.CheckAccessTypeResponse.properties.oneTimeResources.items.type - schemas.CheckAccessTypeResponse.properties.oneTimeResources.type - schemas.CheckAccessTypeResponse.properties.timeBasedResources.description - schemas.CheckAccessTypeResponse.properties.timeBasedResources.items.type - schemas.CheckAccessTypeResponse.properties.timeBasedResources.type - schemas.CheckAccessTypeResponse.type - schemas.InitiatePortabilityArchiveRequest.properties.endTime.description - schemas.InitiatePortabilityArchiveRequest.properties.endTime.format - schemas.InitiatePortabilityArchiveRequest.properties.endTime.type - schemas.InitiatePortabilityArchiveRequest.properties.startTime.description - schemas.InitiatePortabilityArchiveRequest.properties.startTime.format - schemas.InitiatePortabilityArchiveRequest.properties.startTime.type - schemas.InitiatePortabilityArchiveResponse.properties.accessType.description - schemas.InitiatePortabilityArchiveResponse.properties.accessType.enum - schemas.InitiatePortabilityArchiveResponse.properties.accessType.enumDescriptions - schemas.InitiatePortabilityArchiveResponse.properties.accessType.type - schemas.PortabilityArchiveState.properties.exportTime.description - schemas.PortabilityArchiveState.properties.exportTime.format - schemas.PortabilityArchiveState.properties.exportTime.type - schemas.PortabilityArchiveState.properties.startTime.description - schemas.PortabilityArchiveState.properties.startTime.format - schemas.PortabilityArchiveState.properties.startTime.type #### dataportability:v1 The following keys were added: - resources.accessType.methods.check.description - resources.accessType.methods.check.flatPath - resources.accessType.methods.check.httpMethod - resources.accessType.methods.check.id - resources.accessType.methods.check.parameterOrder - resources.accessType.methods.check.path - resources.accessType.methods.check.request.$ref - resources.accessType.methods.check.response.$ref - resources.accessType.methods.check.scopes - resources.archiveJobs.methods.cancel.description - resources.archiveJobs.methods.cancel.flatPath - resources.archiveJobs.methods.cancel.httpMethod - resources.archiveJobs.methods.cancel.id - resources.archiveJobs.methods.cancel.parameterOrder - resources.archiveJobs.methods.cancel.parameters.name.description - resources.archiveJobs.methods.cancel.parameters.name.location - resources.archiveJobs.methods.cancel.parameters.name.pattern - resources.archiveJobs.methods.cancel.parameters.name.required - resources.archiveJobs.methods.cancel.parameters.name.type - resources.archiveJobs.methods.cancel.path - resources.archiveJobs.methods.cancel.request.$ref - resources.archiveJobs.methods.cancel.response.$ref - resources.archiveJobs.methods.cancel.scopes - schemas.CancelPortabilityArchiveRequest.description - schemas.CancelPortabilityArchiveRequest.id - schemas.CancelPortabilityArchiveRequest.type - schemas.CancelPortabilityArchiveResponse.description - schemas.CancelPortabilityArchiveResponse.id - schemas.CancelPortabilityArchiveResponse.type - schemas.CheckAccessTypeRequest.description - schemas.CheckAccessTypeRequest.id - schemas.CheckAccessTypeRequest.type - schemas.CheckAccessTypeResponse.description - schemas.CheckAccessTypeResponse.id - schemas.CheckAccessTypeResponse.properties.oneTimeResources.description - schemas.CheckAccessTypeResponse.properties.oneTimeResources.items.type - schemas.CheckAccessTypeResponse.properties.oneTimeResources.type - schemas.CheckAccessTypeResponse.properties.timeBasedResources.description - schemas.CheckAccessTypeResponse.properties.timeBasedResources.items.type - schemas.CheckAccessTypeResponse.properties.timeBasedResources.type - schemas.CheckAccessTypeResponse.type - schemas.InitiatePortabilityArchiveRequest.properties.endTime.description - schemas.InitiatePortabilityArchiveRequest.properties.endTime.format - schemas.InitiatePortabilityArchiveRequest.properties.endTime.type - schemas.InitiatePortabilityArchiveRequest.properties.startTime.description - schemas.InitiatePortabilityArchiveRequest.properties.startTime.format - schemas.InitiatePortabilityArchiveRequest.properties.startTime.type - schemas.InitiatePortabilityArchiveResponse.properties.accessType.description - schemas.InitiatePortabilityArchiveResponse.properties.accessType.enum - schemas.InitiatePortabilityArchiveResponse.properties.accessType.enumDescriptions - schemas.InitiatePortabilityArchiveResponse.properties.accessType.type - schemas.PortabilityArchiveState.properties.exportTime.description - schemas.PortabilityArchiveState.properties.exportTime.format - schemas.PortabilityArchiveState.properties.exportTime.type - schemas.PortabilityArchiveState.properties.startTime.description - schemas.PortabilityArchiveState.properties.startTime.format - schemas.PortabilityArchiveState.properties.startTime.type --- discovery/dataportability-v1.json | 255 ++++++++++++++++++++++++- discovery/dataportability-v1beta.json | 255 ++++++++++++++++++++++++- src/apis/dataportability/v1.ts | 261 +++++++++++++++++++++++++ src/apis/dataportability/v1beta.ts | 264 ++++++++++++++++++++++++++ 4 files changed, 1033 insertions(+), 2 deletions(-) diff --git a/discovery/dataportability-v1.json b/discovery/dataportability-v1.json index 31398c94cbd..35c64fe7a02 100644 --- a/discovery/dataportability-v1.json +++ b/discovery/dataportability-v1.json @@ -300,8 +300,188 @@ }, "protocol": "rest", "resources": { + "accessType": { + "methods": { + "check": { + "description": "Gets the access type of the token.", + "flatPath": "v1/accessType:check", + "httpMethod": "POST", + "id": "dataportability.accessType.check", + "parameterOrder": [], + "parameters": {}, + "path": "v1/accessType:check", + "request": { + "$ref": "CheckAccessTypeRequest" + }, + "response": { + "$ref": "CheckAccessTypeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", + "https://www.googleapis.com/auth/dataportability.maps.commute_routes", + "https://www.googleapis.com/auth/dataportability.maps.commute_settings", + "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", + "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", + "https://www.googleapis.com/auth/dataportability.maps.reviews", + "https://www.googleapis.com/auth/dataportability.maps.starred_places", + "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", + "https://www.googleapis.com/auth/dataportability.myactivity.search", + "https://www.googleapis.com/auth/dataportability.myactivity.shopping", + "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", + "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", + "https://www.googleapis.com/auth/dataportability.shopping.addresses", + "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", + "https://www.googleapis.com/auth/dataportability.youtube.channel", + "https://www.googleapis.com/auth/dataportability.youtube.clips", + "https://www.googleapis.com/auth/dataportability.youtube.comments", + "https://www.googleapis.com/auth/dataportability.youtube.live_chat", + "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.private_videos", + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.public_videos", + "https://www.googleapis.com/auth/dataportability.youtube.shopping", + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos" + ] + } + } + }, "archiveJobs": { "methods": { + "cancel": { + "description": "Cancels a Portability Archive job.", + "flatPath": "v1/archiveJobs/{archiveJobsId}:cancel", + "httpMethod": "POST", + "id": "dataportability.archiveJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The Archive job ID you're canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job}. Canceling is only executed if the job is in progress.", + "location": "path", + "pattern": "^archiveJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelPortabilityArchiveRequest" + }, + "response": { + "$ref": "CancelPortabilityArchiveResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", + "https://www.googleapis.com/auth/dataportability.maps.commute_routes", + "https://www.googleapis.com/auth/dataportability.maps.commute_settings", + "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", + "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", + "https://www.googleapis.com/auth/dataportability.maps.reviews", + "https://www.googleapis.com/auth/dataportability.maps.starred_places", + "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", + "https://www.googleapis.com/auth/dataportability.myactivity.search", + "https://www.googleapis.com/auth/dataportability.myactivity.shopping", + "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", + "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", + "https://www.googleapis.com/auth/dataportability.shopping.addresses", + "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", + "https://www.googleapis.com/auth/dataportability.youtube.channel", + "https://www.googleapis.com/auth/dataportability.youtube.clips", + "https://www.googleapis.com/auth/dataportability.youtube.comments", + "https://www.googleapis.com/auth/dataportability.youtube.live_chat", + "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.private_videos", + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.public_videos", + "https://www.googleapis.com/auth/dataportability.youtube.shopping", + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos" + ] + }, "getPortabilityArchiveState": { "description": "Retrieves the state of an Archive job for the Portability API.", "flatPath": "v1/archiveJobs/{archiveJobsId}/portabilityArchiveState", @@ -662,9 +842,48 @@ } } }, - "revision": "20250120", + "revision": "20250305", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { + "CancelPortabilityArchiveRequest": { + "description": "Request to cancel a Portability Archive job.", + "id": "CancelPortabilityArchiveRequest", + "properties": {}, + "type": "object" + }, + "CancelPortabilityArchiveResponse": { + "description": "Response to canceling a Data Portability Archive job.", + "id": "CancelPortabilityArchiveResponse", + "properties": {}, + "type": "object" + }, + "CheckAccessTypeRequest": { + "description": "Request to check the token's access type. All required information is derived from the attached OAuth token.", + "id": "CheckAccessTypeRequest", + "properties": {}, + "type": "object" + }, + "CheckAccessTypeResponse": { + "description": "Response to checking the token's access type.", + "id": "CheckAccessTypeResponse", + "properties": { + "oneTimeResources": { + "description": "Jobs initiated with this token will be one-time if any requested resources have one-time access.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeBasedResources": { + "description": "Jobs initiated with this token will be time-based if all requested resources have time-based access.", + "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", @@ -675,12 +894,22 @@ "description": "Request to kick off an Archive job.", "id": "InitiatePortabilityArchiveRequest", "properties": { + "endTime": { + "description": "Optional. The timestamp that represents the end point for the data you are exporting. If the end_time is not specified in the InitiatePortabilityArchiveRequest, this field is set to the latest available data.", + "format": "google-datetime", + "type": "string" + }, "resources": { "description": "The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes.", "items": { "type": "string" }, "type": "array" + }, + "startTime": { + "description": "Optional. The timestamp that represents the starting point for the data you are exporting. If the start_time is not specified in the InitiatePortabilityArchiveRequest, the field is set to the earliest available data.", + "format": "google-datetime", + "type": "string" } }, "type": "object" @@ -689,6 +918,20 @@ "description": "Response from initiating an Archive job.", "id": "InitiatePortabilityArchiveResponse", "properties": { + "accessType": { + "description": "The access type of the Archive job initiated by the API.", + "enum": [ + "ACCESS_TYPE_UNSPECIFIED", + "ACCESS_TYPE_ONE_TIME", + "ACCESS_TYPE_TIME_BASED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "One-time access to the requested scopes.", + "Multiple exports allowed over 30 days. Enum value subject to change before launch." + ], + "type": "string" + }, "archiveJobId": { "description": "The archive job ID that is initiated in the API. This can be used to get the state of the job.", "type": "string" @@ -700,10 +943,20 @@ "description": "Resource that contains the state of an Archive job.", "id": "PortabilityArchiveState", "properties": { + "exportTime": { + "description": "The timestamp that represents the end point for the data you are exporting. If the end_time value is set in the InitiatePortabilityArchiveRequest, this field is set to that value. If end_time is not set, this value is set to the time the export was requested.", + "format": "google-datetime", + "type": "string" + }, "name": { "description": "The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request.", "type": "string" }, + "startTime": { + "description": "The timestamp that represents the starting point for the data you are exporting. This field is set only if the start_time field is specified in the InitiatePortabilityArchiveRequest.", + "format": "google-datetime", + "type": "string" + }, "state": { "description": "Resource that represents the state of the Archive job.", "enum": [ diff --git a/discovery/dataportability-v1beta.json b/discovery/dataportability-v1beta.json index 31ef1fdce95..622b5ed4f66 100644 --- a/discovery/dataportability-v1beta.json +++ b/discovery/dataportability-v1beta.json @@ -300,8 +300,188 @@ }, "protocol": "rest", "resources": { + "accessType": { + "methods": { + "check": { + "description": "Gets the access type of the token.", + "flatPath": "v1beta/accessType:check", + "httpMethod": "POST", + "id": "dataportability.accessType.check", + "parameterOrder": [], + "parameters": {}, + "path": "v1beta/accessType:check", + "request": { + "$ref": "CheckAccessTypeRequest" + }, + "response": { + "$ref": "CheckAccessTypeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", + "https://www.googleapis.com/auth/dataportability.maps.commute_routes", + "https://www.googleapis.com/auth/dataportability.maps.commute_settings", + "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", + "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", + "https://www.googleapis.com/auth/dataportability.maps.reviews", + "https://www.googleapis.com/auth/dataportability.maps.starred_places", + "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", + "https://www.googleapis.com/auth/dataportability.myactivity.search", + "https://www.googleapis.com/auth/dataportability.myactivity.shopping", + "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", + "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", + "https://www.googleapis.com/auth/dataportability.shopping.addresses", + "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", + "https://www.googleapis.com/auth/dataportability.youtube.channel", + "https://www.googleapis.com/auth/dataportability.youtube.clips", + "https://www.googleapis.com/auth/dataportability.youtube.comments", + "https://www.googleapis.com/auth/dataportability.youtube.live_chat", + "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.private_videos", + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.public_videos", + "https://www.googleapis.com/auth/dataportability.youtube.shopping", + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos" + ] + } + } + }, "archiveJobs": { "methods": { + "cancel": { + "description": "Cancels a Portability Archive job.", + "flatPath": "v1beta/archiveJobs/{archiveJobsId}:cancel", + "httpMethod": "POST", + "id": "dataportability.archiveJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The Archive job ID you're canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job}. Canceling is only executed if the job is in progress.", + "location": "path", + "pattern": "^archiveJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:cancel", + "request": { + "$ref": "CancelPortabilityArchiveRequest" + }, + "response": { + "$ref": "CancelPortabilityArchiveResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", + "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", + "https://www.googleapis.com/auth/dataportability.chrome.autofill", + "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", + "https://www.googleapis.com/auth/dataportability.chrome.dictionary", + "https://www.googleapis.com/auth/dataportability.chrome.extensions", + "https://www.googleapis.com/auth/dataportability.chrome.history", + "https://www.googleapis.com/auth/dataportability.chrome.reading_list", + "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", + "https://www.googleapis.com/auth/dataportability.maps.commute_routes", + "https://www.googleapis.com/auth/dataportability.maps.commute_settings", + "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", + "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", + "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", + "https://www.googleapis.com/auth/dataportability.maps.reviews", + "https://www.googleapis.com/auth/dataportability.maps.starred_places", + "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", + "https://www.googleapis.com/auth/dataportability.myactivity.search", + "https://www.googleapis.com/auth/dataportability.myactivity.shopping", + "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", + "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.comments", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", + "https://www.googleapis.com/auth/dataportability.shopping.addresses", + "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", + "https://www.googleapis.com/auth/dataportability.youtube.channel", + "https://www.googleapis.com/auth/dataportability.youtube.clips", + "https://www.googleapis.com/auth/dataportability.youtube.comments", + "https://www.googleapis.com/auth/dataportability.youtube.live_chat", + "https://www.googleapis.com/auth/dataportability.youtube.music", + "https://www.googleapis.com/auth/dataportability.youtube.playable", + "https://www.googleapis.com/auth/dataportability.youtube.posts", + "https://www.googleapis.com/auth/dataportability.youtube.private_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.private_videos", + "https://www.googleapis.com/auth/dataportability.youtube.public_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.public_videos", + "https://www.googleapis.com/auth/dataportability.youtube.shopping", + "https://www.googleapis.com/auth/dataportability.youtube.subscriptions", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists", + "https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos" + ] + }, "getPortabilityArchiveState": { "description": "Retrieves the state of an Archive job for the Portability API.", "flatPath": "v1beta/archiveJobs/{archiveJobsId}/portabilityArchiveState", @@ -662,9 +842,48 @@ } } }, - "revision": "20250120", + "revision": "20250305", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { + "CancelPortabilityArchiveRequest": { + "description": "Request to cancel a Portability Archive job.", + "id": "CancelPortabilityArchiveRequest", + "properties": {}, + "type": "object" + }, + "CancelPortabilityArchiveResponse": { + "description": "Response to canceling a Data Portability Archive job.", + "id": "CancelPortabilityArchiveResponse", + "properties": {}, + "type": "object" + }, + "CheckAccessTypeRequest": { + "description": "Request to check the token's access type. All required information is derived from the attached OAuth token.", + "id": "CheckAccessTypeRequest", + "properties": {}, + "type": "object" + }, + "CheckAccessTypeResponse": { + "description": "Response to checking the token's access type.", + "id": "CheckAccessTypeResponse", + "properties": { + "oneTimeResources": { + "description": "Jobs initiated with this token will be one-time if any requested resources have one-time access.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeBasedResources": { + "description": "Jobs initiated with this token will be time-based if all requested resources have time-based access.", + "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", @@ -675,12 +894,22 @@ "description": "Request to kick off an Archive job.", "id": "InitiatePortabilityArchiveRequest", "properties": { + "endTime": { + "description": "Optional. The timestamp that represents the end point for the data you are exporting. If the end_time is not specified in the InitiatePortabilityArchiveRequest, this field is set to the latest available data.", + "format": "google-datetime", + "type": "string" + }, "resources": { "description": "The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes.", "items": { "type": "string" }, "type": "array" + }, + "startTime": { + "description": "Optional. The timestamp that represents the starting point for the data you are exporting. If the start_time is not specified in the InitiatePortabilityArchiveRequest, the field is set to the earliest available data.", + "format": "google-datetime", + "type": "string" } }, "type": "object" @@ -689,6 +918,20 @@ "description": "Response from initiating an Archive job.", "id": "InitiatePortabilityArchiveResponse", "properties": { + "accessType": { + "description": "The access type of the Archive job initiated by the API.", + "enum": [ + "ACCESS_TYPE_UNSPECIFIED", + "ACCESS_TYPE_ONE_TIME", + "ACCESS_TYPE_TIME_BASED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "One-time access to the requested scopes.", + "Multiple exports allowed over 30 days. Enum value subject to change before launch." + ], + "type": "string" + }, "archiveJobId": { "description": "The archive job ID that is initiated in the API. This can be used to get the state of the job.", "type": "string" @@ -700,10 +943,20 @@ "description": "Resource that contains the state of an Archive job.", "id": "PortabilityArchiveState", "properties": { + "exportTime": { + "description": "The timestamp that represents the end point for the data you are exporting. If the end_time value is set in the InitiatePortabilityArchiveRequest, this field is set to that value. If end_time is not set, this value is set to the time the export was requested.", + "format": "google-datetime", + "type": "string" + }, "name": { "description": "The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request.", "type": "string" }, + "startTime": { + "description": "The timestamp that represents the starting point for the data you are exporting. This field is set only if the start_time field is specified in the InitiatePortabilityArchiveRequest.", + "format": "google-datetime", + "type": "string" + }, "state": { "description": "Resource that represents the state of the Archive job.", "enum": [ diff --git a/src/apis/dataportability/v1.ts b/src/apis/dataportability/v1.ts index 218a031c943..31b77fd6fbe 100644 --- a/src/apis/dataportability/v1.ts +++ b/src/apis/dataportability/v1.ts @@ -112,6 +112,7 @@ export namespace dataportability_v1 { */ export class Dataportability { context: APIRequestContext; + accessType: Resource$Accesstype; archiveJobs: Resource$Archivejobs; authorization: Resource$Authorization; portabilityArchive: Resource$Portabilityarchive; @@ -122,12 +123,38 @@ export namespace dataportability_v1 { google, }; + this.accessType = new Resource$Accesstype(this.context); this.archiveJobs = new Resource$Archivejobs(this.context); this.authorization = new Resource$Authorization(this.context); this.portabilityArchive = new Resource$Portabilityarchive(this.context); } } + /** + * Request to cancel a Portability Archive job. + */ + export interface Schema$CancelPortabilityArchiveRequest {} + /** + * Response to canceling a Data Portability Archive job. + */ + export interface Schema$CancelPortabilityArchiveResponse {} + /** + * Request to check the token's access type. All required information is derived from the attached OAuth token. + */ + export interface Schema$CheckAccessTypeRequest {} + /** + * Response to checking the token's access type. + */ + export interface Schema$CheckAccessTypeResponse { + /** + * Jobs initiated with this token will be one-time if any requested resources have one-time access. + */ + oneTimeResources?: string[] | null; + /** + * Jobs initiated with this token will be time-based if all requested resources have time-based access. + */ + timeBasedResources?: 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); \} */ @@ -136,15 +163,27 @@ export namespace dataportability_v1 { * Request to kick off an Archive job. */ export interface Schema$InitiatePortabilityArchiveRequest { + /** + * Optional. The timestamp that represents the end point for the data you are exporting. If the end_time is not specified in the InitiatePortabilityArchiveRequest, this field is set to the latest available data. + */ + endTime?: string | null; /** * The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes. */ resources?: string[] | null; + /** + * Optional. The timestamp that represents the starting point for the data you are exporting. If the start_time is not specified in the InitiatePortabilityArchiveRequest, the field is set to the earliest available data. + */ + startTime?: string | null; } /** * Response from initiating an Archive job. */ export interface Schema$InitiatePortabilityArchiveResponse { + /** + * The access type of the Archive job initiated by the API. + */ + accessType?: string | null; /** * The archive job ID that is initiated in the API. This can be used to get the state of the job. */ @@ -154,10 +193,18 @@ export namespace dataportability_v1 { * Resource that contains the state of an Archive job. */ export interface Schema$PortabilityArchiveState { + /** + * The timestamp that represents the end point for the data you are exporting. If the end_time value is set in the InitiatePortabilityArchiveRequest, this field is set to that value. If end_time is not set, this value is set to the time the export was requested. + */ + exportTime?: string | null; /** * The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job\}/portabilityArchiveState. archive_job is the job ID provided in the request. */ name?: string | null; + /** + * The timestamp that represents the starting point for the data you are exporting. This field is set only if the start_time field is specified in the InitiatePortabilityArchiveRequest. + */ + startTime?: string | null; /** * Resource that represents the state of the Archive job. */ @@ -185,12 +232,214 @@ export namespace dataportability_v1 { archiveJobId?: string | null; } + export class Resource$Accesstype { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access type of the token. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Accesstype$Check, + options: StreamMethodOptions + ): GaxiosPromise; + check( + params?: Params$Resource$Accesstype$Check, + options?: MethodOptions + ): GaxiosPromise; + check( + params: Params$Resource$Accesstype$Check, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + check( + params: Params$Resource$Accesstype$Check, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + check( + params: Params$Resource$Accesstype$Check, + callback: BodyResponseCallback + ): void; + check(callback: BodyResponseCallback): void; + check( + paramsOrCallback?: + | Params$Resource$Accesstype$Check + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accesstype$Check; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accesstype$Check; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://dataportability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/accessType:check').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accesstype$Check extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$CheckAccessTypeRequest; + } + export class Resource$Archivejobs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } + /** + * Cancels a Portability Archive 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$Archivejobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Archivejobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Archivejobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Archivejobs$Cancel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Archivejobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel( + callback: BodyResponseCallback + ): void; + cancel( + paramsOrCallback?: + | Params$Resource$Archivejobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Archivejobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Archivejobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://dataportability.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 + ); + } + } + /** * Retrieves the state of an Archive job for the Portability API. * @@ -380,6 +629,18 @@ export namespace dataportability_v1 { } } + export interface Params$Resource$Archivejobs$Cancel + extends StandardParameters { + /** + * Required. The Archive job ID you're canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job\}. Canceling is only executed if the job is in progress. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelPortabilityArchiveRequest; + } export interface Params$Resource$Archivejobs$Getportabilityarchivestate extends StandardParameters { /** diff --git a/src/apis/dataportability/v1beta.ts b/src/apis/dataportability/v1beta.ts index e93f58180e4..98d7a6021fb 100644 --- a/src/apis/dataportability/v1beta.ts +++ b/src/apis/dataportability/v1beta.ts @@ -112,6 +112,7 @@ export namespace dataportability_v1beta { */ export class Dataportability { context: APIRequestContext; + accessType: Resource$Accesstype; archiveJobs: Resource$Archivejobs; authorization: Resource$Authorization; portabilityArchive: Resource$Portabilityarchive; @@ -122,12 +123,38 @@ export namespace dataportability_v1beta { google, }; + this.accessType = new Resource$Accesstype(this.context); this.archiveJobs = new Resource$Archivejobs(this.context); this.authorization = new Resource$Authorization(this.context); this.portabilityArchive = new Resource$Portabilityarchive(this.context); } } + /** + * Request to cancel a Portability Archive job. + */ + export interface Schema$CancelPortabilityArchiveRequest {} + /** + * Response to canceling a Data Portability Archive job. + */ + export interface Schema$CancelPortabilityArchiveResponse {} + /** + * Request to check the token's access type. All required information is derived from the attached OAuth token. + */ + export interface Schema$CheckAccessTypeRequest {} + /** + * Response to checking the token's access type. + */ + export interface Schema$CheckAccessTypeResponse { + /** + * Jobs initiated with this token will be one-time if any requested resources have one-time access. + */ + oneTimeResources?: string[] | null; + /** + * Jobs initiated with this token will be time-based if all requested resources have time-based access. + */ + timeBasedResources?: 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); \} */ @@ -136,15 +163,27 @@ export namespace dataportability_v1beta { * Request to kick off an Archive job. */ export interface Schema$InitiatePortabilityArchiveRequest { + /** + * Optional. The timestamp that represents the end point for the data you are exporting. If the end_time is not specified in the InitiatePortabilityArchiveRequest, this field is set to the latest available data. + */ + endTime?: string | null; /** * The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes. */ resources?: string[] | null; + /** + * Optional. The timestamp that represents the starting point for the data you are exporting. If the start_time is not specified in the InitiatePortabilityArchiveRequest, the field is set to the earliest available data. + */ + startTime?: string | null; } /** * Response from initiating an Archive job. */ export interface Schema$InitiatePortabilityArchiveResponse { + /** + * The access type of the Archive job initiated by the API. + */ + accessType?: string | null; /** * The archive job ID that is initiated in the API. This can be used to get the state of the job. */ @@ -154,10 +193,18 @@ export namespace dataportability_v1beta { * Resource that contains the state of an Archive job. */ export interface Schema$PortabilityArchiveState { + /** + * The timestamp that represents the end point for the data you are exporting. If the end_time value is set in the InitiatePortabilityArchiveRequest, this field is set to that value. If end_time is not set, this value is set to the time the export was requested. + */ + exportTime?: string | null; /** * The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job\}/portabilityArchiveState. archive_job is the job ID provided in the request. */ name?: string | null; + /** + * The timestamp that represents the starting point for the data you are exporting. This field is set only if the start_time field is specified in the InitiatePortabilityArchiveRequest. + */ + startTime?: string | null; /** * Resource that represents the state of the Archive job. */ @@ -185,12 +232,217 @@ export namespace dataportability_v1beta { archiveJobId?: string | null; } + export class Resource$Accesstype { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access type of the token. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Accesstype$Check, + options: StreamMethodOptions + ): GaxiosPromise; + check( + params?: Params$Resource$Accesstype$Check, + options?: MethodOptions + ): GaxiosPromise; + check( + params: Params$Resource$Accesstype$Check, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + check( + params: Params$Resource$Accesstype$Check, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + check( + params: Params$Resource$Accesstype$Check, + callback: BodyResponseCallback + ): void; + check(callback: BodyResponseCallback): void; + check( + paramsOrCallback?: + | Params$Resource$Accesstype$Check + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accesstype$Check; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accesstype$Check; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://dataportability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/accessType:check').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accesstype$Check extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$CheckAccessTypeRequest; + } + export class Resource$Archivejobs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } + /** + * Cancels a Portability Archive 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$Archivejobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Archivejobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Archivejobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Archivejobs$Cancel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Archivejobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel( + callback: BodyResponseCallback + ): void; + cancel( + paramsOrCallback?: + | Params$Resource$Archivejobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Archivejobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Archivejobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://dataportability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+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 + ); + } + } + /** * Retrieves the state of an Archive job for the Portability API. * @@ -383,6 +635,18 @@ export namespace dataportability_v1beta { } } + export interface Params$Resource$Archivejobs$Cancel + extends StandardParameters { + /** + * Required. The Archive job ID you're canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job\}. Canceling is only executed if the job is in progress. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelPortabilityArchiveRequest; + } export interface Params$Resource$Archivejobs$Getportabilityarchivestate extends StandardParameters { /** From ab6cf1f9a0f96239309df889e2ff8749de3c1fad Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:43 +0000 Subject: [PATCH 049/144] feat(dataproc): update the API #### dataproc:v1 The following keys were added: - schemas.BuildInfo.description - schemas.BuildInfo.id - schemas.BuildInfo.properties.buildKey.description - schemas.BuildInfo.properties.buildKey.type - schemas.BuildInfo.properties.buildValue.description - schemas.BuildInfo.properties.buildValue.type - schemas.BuildInfo.type - schemas.FallbackReason.description - schemas.FallbackReason.id - schemas.FallbackReason.properties.fallbackNode.description - schemas.FallbackReason.properties.fallbackNode.type - schemas.FallbackReason.properties.fallbackReason.description - schemas.FallbackReason.properties.fallbackReason.type - schemas.FallbackReason.type - schemas.GceClusterConfig.properties.resourceManagerTags.additionalProperties.type - schemas.GceClusterConfig.properties.resourceManagerTags.description - schemas.GceClusterConfig.properties.resourceManagerTags.type - schemas.NativeBuildInfoUiData.id - schemas.NativeBuildInfoUiData.properties.buildClass.description - schemas.NativeBuildInfoUiData.properties.buildClass.type - schemas.NativeBuildInfoUiData.properties.buildInfo.description - schemas.NativeBuildInfoUiData.properties.buildInfo.items.$ref - schemas.NativeBuildInfoUiData.properties.buildInfo.type - schemas.NativeBuildInfoUiData.type - schemas.NativeSqlExecutionUiData.description - schemas.NativeSqlExecutionUiData.id - schemas.NativeSqlExecutionUiData.properties.description.description - schemas.NativeSqlExecutionUiData.properties.description.type - schemas.NativeSqlExecutionUiData.properties.executionId.description - schemas.NativeSqlExecutionUiData.properties.executionId.format - schemas.NativeSqlExecutionUiData.properties.executionId.type - schemas.NativeSqlExecutionUiData.properties.fallbackDescription.description - schemas.NativeSqlExecutionUiData.properties.fallbackDescription.type - schemas.NativeSqlExecutionUiData.properties.fallbackNodeToReason.description - schemas.NativeSqlExecutionUiData.properties.fallbackNodeToReason.items.$ref - schemas.NativeSqlExecutionUiData.properties.fallbackNodeToReason.type - schemas.NativeSqlExecutionUiData.properties.numFallbackNodes.description - schemas.NativeSqlExecutionUiData.properties.numFallbackNodes.format - schemas.NativeSqlExecutionUiData.properties.numFallbackNodes.type - schemas.NativeSqlExecutionUiData.properties.numNativeNodes.description - schemas.NativeSqlExecutionUiData.properties.numNativeNodes.format - schemas.NativeSqlExecutionUiData.properties.numNativeNodes.type - schemas.NativeSqlExecutionUiData.type - schemas.SparkWrapperObject.properties.nativeBuildInfoUiData.$ref - schemas.SparkWrapperObject.properties.nativeBuildInfoUiData.description - schemas.SparkWrapperObject.properties.nativeSqlExecutionUiData.$ref - schemas.SparkWrapperObject.properties.nativeSqlExecutionUiData.description The following keys were changed: - schemas.Session.properties.name.description - schemas.SoftwareConfig.properties.optionalComponents.items.enum - schemas.SoftwareConfig.properties.optionalComponents.items.enumDescriptions --- discovery/dataproc-v1.json | 105 ++++++++++++++++++++++++++++++++++++- src/apis/dataproc/v1.ts | 79 +++++++++++++++++++++++++++- 2 files changed, 181 insertions(+), 3 deletions(-) diff --git a/discovery/dataproc-v1.json b/discovery/dataproc-v1.json index b647c1001c6..c2aa5051f28 100644 --- a/discovery/dataproc-v1.json +++ b/discovery/dataproc-v1.json @@ -4978,7 +4978,7 @@ } } }, - "revision": "20250111", + "revision": "20250207", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5745,6 +5745,21 @@ }, "type": "object" }, + "BuildInfo": { + "description": "Native Build Info", + "id": "BuildInfo", + "properties": { + "buildKey": { + "description": "Optional. Build key.", + "type": "string" + }, + "buildValue": { + "description": "Optional. Build value.", + "type": "string" + } + }, + "type": "object" + }, "CancelJobRequest": { "description": "A request to cancel a job.", "id": "CancelJobRequest", @@ -6847,6 +6862,21 @@ }, "type": "object" }, + "FallbackReason": { + "description": "Native SQL Execution Data", + "id": "FallbackReason", + "properties": { + "fallbackNode": { + "description": "Optional. Fallback node information.", + "type": "string" + }, + "fallbackReason": { + "description": "Optional. Fallback to Spark reason.", + "type": "string" + } + }, + "type": "object" + }, "FlinkJob": { "description": "A Dataproc job for running Apache Flink applications on YARN.", "id": "FlinkJob", @@ -6938,6 +6968,13 @@ "$ref": "ReservationAffinity", "description": "Optional. Reservation Affinity for consuming Zonal reservation." }, + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)).", + "type": "object" + }, "serviceAccount": { "description": "Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", "type": "string" @@ -8467,6 +8504,60 @@ }, "type": "object" }, + "NativeBuildInfoUiData": { + "id": "NativeBuildInfoUiData", + "properties": { + "buildClass": { + "description": "Optional. Build class of Native.", + "type": "string" + }, + "buildInfo": { + "description": "Optional. Build related details.", + "items": { + "$ref": "BuildInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "NativeSqlExecutionUiData": { + "description": "Native SQL Execution Data", + "id": "NativeSqlExecutionUiData", + "properties": { + "description": { + "description": "Optional. Description of the execution.", + "type": "string" + }, + "executionId": { + "description": "Required. Execution ID of the Native SQL Execution.", + "format": "int64", + "type": "string" + }, + "fallbackDescription": { + "description": "Optional. Description of the fallback.", + "type": "string" + }, + "fallbackNodeToReason": { + "description": "Optional. Fallback node to reason.", + "items": { + "$ref": "FallbackReason" + }, + "type": "array" + }, + "numFallbackNodes": { + "description": "Optional. Number of nodes fallen back to Spark.", + "format": "int32", + "type": "integer" + }, + "numNativeNodes": { + "description": "Optional. Number of nodes in Native.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "NodeGroup": { "description": "Dataproc Node Group. The Dataproc NodeGroup resource is not related to the Dataproc NodeGroupAffinity resource.", "id": "NodeGroup", @@ -9960,7 +10051,7 @@ "type": "object" }, "name": { - "description": "Required. The resource name of the session.", + "description": "Identifier. The resource name of the session.", "type": "string" }, "runtimeConfig": { @@ -10447,6 +10538,7 @@ "HIVE_WEBHCAT", "HUDI", "JUPYTER", + "PIG", "PRESTO", "TRINO", "RANGER", @@ -10464,6 +10556,7 @@ "The Hive Web HCatalog (the REST service for accessing HCatalog).", "Hudi.", "The Jupyter Notebook.", + "The Pig component.", "The Presto query engine.", "The Trino query engine.", "The Ranger service.", @@ -10976,6 +11069,14 @@ "jobData": { "$ref": "JobData" }, + "nativeBuildInfoUiData": { + "$ref": "NativeBuildInfoUiData", + "description": "Native Build Info" + }, + "nativeSqlExecutionUiData": { + "$ref": "NativeSqlExecutionUiData", + "description": "Native SQL Execution Info" + }, "poolData": { "$ref": "PoolData" }, diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 4c5a624af46..a1d7e660d67 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -597,6 +597,19 @@ export namespace dataproc_v1 { */ role?: string | null; } + /** + * Native Build Info + */ + export interface Schema$BuildInfo { + /** + * Optional. Build key. + */ + buildKey?: string | null; + /** + * Optional. Build value. + */ + buildValue?: string | null; + } /** * A request to cancel a job. */ @@ -1167,6 +1180,19 @@ export namespace dataproc_v1 { */ title?: string | null; } + /** + * Native SQL Execution Data + */ + export interface Schema$FallbackReason { + /** + * Optional. Fallback node information. + */ + fallbackNode?: string | null; + /** + * Optional. Fallback to Spark reason. + */ + fallbackReason?: string | null; + } /** * A Dataproc job for running Apache Flink applications on YARN. */ @@ -1232,6 +1258,10 @@ export namespace dataproc_v1 { * Optional. Reservation Affinity for consuming Zonal reservation. */ reservationAffinity?: Schema$ReservationAffinity; + /** + * Optional. Resource manager tags to add to all instances (see Resource manager tags resources (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing)). + */ + resourceManagerTags?: {[key: string]: string} | null; /** * Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. */ @@ -2232,6 +2262,45 @@ export namespace dataproc_v1 { */ targetGkeCluster?: string | null; } + export interface Schema$NativeBuildInfoUiData { + /** + * Optional. Build class of Native. + */ + buildClass?: string | null; + /** + * Optional. Build related details. + */ + buildInfo?: Schema$BuildInfo[]; + } + /** + * Native SQL Execution Data + */ + export interface Schema$NativeSqlExecutionUiData { + /** + * Optional. Description of the execution. + */ + description?: string | null; + /** + * Required. Execution ID of the Native SQL Execution. + */ + executionId?: string | null; + /** + * Optional. Description of the fallback. + */ + fallbackDescription?: string | null; + /** + * Optional. Fallback node to reason. + */ + fallbackNodeToReason?: Schema$FallbackReason[]; + /** + * Optional. Number of nodes fallen back to Spark. + */ + numFallbackNodes?: number | null; + /** + * Optional. Number of nodes in Native. + */ + numNativeNodes?: number | null; + } /** * Dataproc Node Group. The Dataproc NodeGroup resource is not related to the Dataproc NodeGroupAffinity resource. */ @@ -3148,7 +3217,7 @@ export namespace dataproc_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. The resource name of the session. + * Identifier. The resource name of the session. */ name?: string | null; /** @@ -3695,6 +3764,14 @@ export namespace dataproc_v1 { executorStageSummary?: Schema$ExecutorStageSummary; executorSummary?: Schema$ExecutorSummary; jobData?: Schema$JobData; + /** + * Native Build Info + */ + nativeBuildInfoUiData?: Schema$NativeBuildInfoUiData; + /** + * Native SQL Execution Info + */ + nativeSqlExecutionUiData?: Schema$NativeSqlExecutionUiData; poolData?: Schema$PoolData; processSummary?: Schema$ProcessSummary; rddOperationGraph?: Schema$RddOperationGraph; From 14cde891fbcccf0575ab2d3aeed31f7c11ed1941 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 050/144] fix(datastore): update the API #### datastore:v1beta1 The following keys were changed: - schemas.GoogleDatastoreAdminV1RedirectWritesStepDetails.properties.concurrencyMode.description #### datastore:v1beta3 The following keys were changed: - schemas.GoogleDatastoreAdminV1RedirectWritesStepDetails.properties.concurrencyMode.description - schemas.RunQueryResponse.properties.batch.description #### datastore:v1 The following keys were changed: - schemas.GoogleDatastoreAdminV1RedirectWritesStepDetails.properties.concurrencyMode.description - schemas.RunQueryResponse.properties.batch.description --- discovery/datastore-v1.json | 6 +++--- discovery/datastore-v1beta1.json | 4 ++-- discovery/datastore-v1beta3.json | 6 +++--- src/apis/datastore/v1.ts | 4 ++-- src/apis/datastore/v1beta1.ts | 2 +- src/apis/datastore/v1beta3.ts | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/discovery/datastore-v1.json b/discovery/datastore-v1.json index 9ddc71a0362..3be98a6b43c 100644 --- a/discovery/datastore-v1.json +++ b/discovery/datastore-v1.json @@ -654,7 +654,7 @@ } } }, - "revision": "20241204", + "revision": "20250212", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -1582,7 +1582,7 @@ "id": "GoogleDatastoreAdminV1RedirectWritesStepDetails", "properties": { "concurrencyMode": { - "description": "Ths concurrency mode for this database.", + "description": "The concurrency mode for this database.", "enum": [ "CONCURRENCY_MODE_UNSPECIFIED", "PESSIMISTIC", @@ -2609,7 +2609,7 @@ "properties": { "batch": { "$ref": "QueryResultBatch", - "description": "A batch of query results (always present)." + "description": "A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false." }, "explainMetrics": { "$ref": "ExplainMetrics", diff --git a/discovery/datastore-v1beta1.json b/discovery/datastore-v1beta1.json index ee469cde7d3..0ac35677ffd 100644 --- a/discovery/datastore-v1beta1.json +++ b/discovery/datastore-v1beta1.json @@ -168,7 +168,7 @@ } } }, - "revision": "20230806", + "revision": "20250212", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "GoogleDatastoreAdminV1CommonMetadata": { @@ -496,7 +496,7 @@ "id": "GoogleDatastoreAdminV1RedirectWritesStepDetails", "properties": { "concurrencyMode": { - "description": "Ths concurrency mode for this database.", + "description": "The concurrency mode for this database.", "enum": [ "CONCURRENCY_MODE_UNSPECIFIED", "PESSIMISTIC", diff --git a/discovery/datastore-v1beta3.json b/discovery/datastore-v1beta3.json index 0f691f48eb4..d9e19aa7c8a 100644 --- a/discovery/datastore-v1beta3.json +++ b/discovery/datastore-v1beta3.json @@ -336,7 +336,7 @@ } } }, - "revision": "20241018", + "revision": "20250212", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -1094,7 +1094,7 @@ "id": "GoogleDatastoreAdminV1RedirectWritesStepDetails", "properties": { "concurrencyMode": { - "description": "Ths concurrency mode for this database.", + "description": "The concurrency mode for this database.", "enum": [ "CONCURRENCY_MODE_UNSPECIFIED", "PESSIMISTIC", @@ -2034,7 +2034,7 @@ "properties": { "batch": { "$ref": "QueryResultBatch", - "description": "A batch of query results (always present)." + "description": "A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false." }, "explainMetrics": { "$ref": "ExplainMetrics", diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index e0cdbab8c29..768a9874ab8 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -816,7 +816,7 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1RedirectWritesStepDetails { /** - * Ths concurrency mode for this database. + * The concurrency mode for this database. */ concurrencyMode?: string | null; } @@ -1419,7 +1419,7 @@ export namespace datastore_v1 { */ export interface Schema$RunQueryResponse { /** - * A batch of query results (always present). + * A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. */ batch?: Schema$QueryResultBatch; /** diff --git a/src/apis/datastore/v1beta1.ts b/src/apis/datastore/v1beta1.ts index 23c96dd08bb..536d5c9c225 100644 --- a/src/apis/datastore/v1beta1.ts +++ b/src/apis/datastore/v1beta1.ts @@ -448,7 +448,7 @@ export namespace datastore_v1beta1 { */ export interface Schema$GoogleDatastoreAdminV1RedirectWritesStepDetails { /** - * Ths concurrency mode for this database. + * The concurrency mode for this database. */ concurrencyMode?: string | null; } diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index cdce1f02175..4ed40513402 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -707,7 +707,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$GoogleDatastoreAdminV1RedirectWritesStepDetails { /** - * Ths concurrency mode for this database. + * The concurrency mode for this database. */ concurrencyMode?: string | null; } @@ -1240,7 +1240,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$RunQueryResponse { /** - * A batch of query results (always present). + * A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. */ batch?: Schema$QueryResultBatch; /** From fa1ad55a469b6b09481ace0a24dafdb128c97b15 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 051/144] feat(datastream): update the API #### datastream:v1 The following keys were added: - schemas.BackfillAllStrategy.properties.salesforceExcludedObjects.$ref - schemas.BackfillAllStrategy.properties.salesforceExcludedObjects.description - schemas.BigQueryDestinationConfig.properties.blmtConfig.$ref - schemas.BigQueryDestinationConfig.properties.blmtConfig.description - schemas.BlmtConfig.description - schemas.BlmtConfig.id - schemas.BlmtConfig.properties.bucket.description - schemas.BlmtConfig.properties.bucket.type - schemas.BlmtConfig.properties.connectionName.description - schemas.BlmtConfig.properties.connectionName.type - schemas.BlmtConfig.properties.fileFormat.description - schemas.BlmtConfig.properties.fileFormat.enum - schemas.BlmtConfig.properties.fileFormat.enumDescriptions - schemas.BlmtConfig.properties.fileFormat.type - schemas.BlmtConfig.properties.rootPath.description - schemas.BlmtConfig.properties.rootPath.type - schemas.BlmtConfig.properties.tableFormat.description - schemas.BlmtConfig.properties.tableFormat.enum - schemas.BlmtConfig.properties.tableFormat.enumDescriptions - schemas.BlmtConfig.properties.tableFormat.type - schemas.BlmtConfig.type - schemas.ConnectionProfile.properties.salesforceProfile.$ref - schemas.ConnectionProfile.properties.salesforceProfile.description - schemas.MysqlGtidPosition.description - schemas.MysqlGtidPosition.id - schemas.MysqlGtidPosition.properties.gtidSet.description - schemas.MysqlGtidPosition.properties.gtidSet.type - schemas.MysqlGtidPosition.type - schemas.MysqlProfile.properties.secretManagerStoredPassword.description - schemas.MysqlProfile.properties.secretManagerStoredPassword.type - schemas.Oauth2ClientCredentials.description - schemas.Oauth2ClientCredentials.id - schemas.Oauth2ClientCredentials.properties.clientId.description - schemas.Oauth2ClientCredentials.properties.clientId.type - schemas.Oauth2ClientCredentials.properties.clientSecret.description - schemas.Oauth2ClientCredentials.properties.clientSecret.type - schemas.Oauth2ClientCredentials.properties.secretManagerStoredClientSecret.description - schemas.Oauth2ClientCredentials.properties.secretManagerStoredClientSecret.type - schemas.Oauth2ClientCredentials.type - schemas.OracleAsmConfig.properties.secretManagerStoredPassword.description - schemas.OracleAsmConfig.properties.secretManagerStoredPassword.type - schemas.PostgresqlProfile.properties.secretManagerStoredPassword.description - schemas.PostgresqlProfile.properties.secretManagerStoredPassword.type - schemas.SalesforceField.description - schemas.SalesforceField.id - schemas.SalesforceField.properties.dataType.description - schemas.SalesforceField.properties.dataType.type - schemas.SalesforceField.properties.name.description - schemas.SalesforceField.properties.name.type - schemas.SalesforceField.properties.nillable.description - schemas.SalesforceField.properties.nillable.type - schemas.SalesforceField.type - schemas.SalesforceObject.description - schemas.SalesforceObject.id - schemas.SalesforceObject.properties.fields.description - schemas.SalesforceObject.properties.fields.items.$ref - schemas.SalesforceObject.properties.fields.type - schemas.SalesforceObject.properties.objectName.description - schemas.SalesforceObject.properties.objectName.type - schemas.SalesforceObject.type - schemas.SalesforceObjectIdentifier.description - schemas.SalesforceObjectIdentifier.id - schemas.SalesforceObjectIdentifier.properties.objectName.description - schemas.SalesforceObjectIdentifier.properties.objectName.type - schemas.SalesforceObjectIdentifier.type - schemas.SalesforceOrg.description - schemas.SalesforceOrg.id - schemas.SalesforceOrg.properties.objects.description - schemas.SalesforceOrg.properties.objects.items.$ref - schemas.SalesforceOrg.properties.objects.type - schemas.SalesforceOrg.type - schemas.SalesforceProfile.description - schemas.SalesforceProfile.id - schemas.SalesforceProfile.properties.domain.description - schemas.SalesforceProfile.properties.domain.type - schemas.SalesforceProfile.properties.oauth2ClientCredentials.$ref - schemas.SalesforceProfile.properties.oauth2ClientCredentials.description - schemas.SalesforceProfile.properties.userCredentials.$ref - schemas.SalesforceProfile.properties.userCredentials.description - schemas.SalesforceProfile.type - schemas.SalesforceSourceConfig.description - schemas.SalesforceSourceConfig.id - schemas.SalesforceSourceConfig.properties.excludeObjects.$ref - schemas.SalesforceSourceConfig.properties.excludeObjects.description - schemas.SalesforceSourceConfig.properties.includeObjects.$ref - schemas.SalesforceSourceConfig.properties.includeObjects.description - schemas.SalesforceSourceConfig.properties.pollingInterval.description - schemas.SalesforceSourceConfig.properties.pollingInterval.format - schemas.SalesforceSourceConfig.properties.pollingInterval.type - schemas.SalesforceSourceConfig.type - schemas.SourceConfig.properties.salesforceSourceConfig.$ref - schemas.SourceConfig.properties.salesforceSourceConfig.description - schemas.SourceObjectIdentifier.properties.salesforceIdentifier.$ref - schemas.SourceObjectIdentifier.properties.salesforceIdentifier.description - schemas.SpecificStartPosition.properties.mysqlGtidPosition.$ref - schemas.SpecificStartPosition.properties.mysqlGtidPosition.description - schemas.SqlServerProfile.properties.secretManagerStoredPassword.description - schemas.SqlServerProfile.properties.secretManagerStoredPassword.type - schemas.UserCredentials.description - schemas.UserCredentials.id - schemas.UserCredentials.properties.password.description - schemas.UserCredentials.properties.password.type - schemas.UserCredentials.properties.secretManagerStoredPassword.description - schemas.UserCredentials.properties.secretManagerStoredPassword.type - schemas.UserCredentials.properties.secretManagerStoredSecurityToken.description - schemas.UserCredentials.properties.secretManagerStoredSecurityToken.type - schemas.UserCredentials.properties.securityToken.description - schemas.UserCredentials.properties.securityToken.type - schemas.UserCredentials.properties.username.description - schemas.UserCredentials.properties.username.type - schemas.UserCredentials.type The following keys were changed: - schemas.MysqlProfile.description - schemas.MysqlSslConfig.properties.clientKey.description - schemas.OracleAsmConfig.description - schemas.OracleAsmConfig.properties.password.description - schemas.OracleProfile.description - schemas.ServerAndClientVerification.properties.clientKey.description - schemas.SourceConfig.properties.sourceConnectionProfile.description - schemas.SqlServerProfile.description --- discovery/datastream-v1.json | 259 +++++++++++++++++++++++++++++++++-- src/apis/datastream/v1.ts | 214 +++++++++++++++++++++++++++-- 2 files changed, 456 insertions(+), 17 deletions(-) diff --git a/discovery/datastream-v1.json b/discovery/datastream-v1.json index c3b4ecf325d..fbb88450309 100644 --- a/discovery/datastream-v1.json +++ b/discovery/datastream-v1.json @@ -1250,7 +1250,7 @@ } } }, - "revision": "20250115", + "revision": "20250310", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -1281,6 +1281,10 @@ "$ref": "PostgresqlRdbms", "description": "PostgreSQL data source objects to avoid backfilling." }, + "salesforceExcludedObjects": { + "$ref": "SalesforceOrg", + "description": "Salesforce data source objects to avoid backfilling" + }, "sqlServerExcludedObjects": { "$ref": "SqlServerRdbms", "description": "SQLServer data source objects to avoid backfilling" @@ -1368,6 +1372,10 @@ "$ref": "AppendOnly", "description": "Append only mode" }, + "blmtConfig": { + "$ref": "BlmtConfig", + "description": "Optional. Big Lake Managed Tables (BLMT) configuration." + }, "dataFreshness": { "description": "The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.", "format": "google-duration", @@ -1415,6 +1423,49 @@ "properties": {}, "type": "object" }, + "BlmtConfig": { + "description": "The configuration for BLMT.", + "id": "BlmtConfig", + "properties": { + "bucket": { + "description": "Required. The Cloud Storage bucket name.", + "type": "string" + }, + "connectionName": { + "description": "Required. The bigquery connection. Format: `{project}.{location}.{name}`", + "type": "string" + }, + "fileFormat": { + "description": "Required. The file format.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "PARQUET" + ], + "enumDescriptions": [ + "Default value.", + "Parquet file format." + ], + "type": "string" + }, + "rootPath": { + "description": "The root path inside the Cloud Storage bucket.", + "type": "string" + }, + "tableFormat": { + "description": "Required. The table format.", + "enum": [ + "TABLE_FORMAT_UNSPECIFIED", + "ICEBERG" + ], + "enumDescriptions": [ + "Default value.", + "Iceberg table format." + ], + "type": "string" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -1494,6 +1545,10 @@ "$ref": "PrivateConnectivity", "description": "Private connectivity." }, + "salesforceProfile": { + "$ref": "SalesforceProfile", + "description": "Salesforce Connection Profile configuration." + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -2093,6 +2148,17 @@ }, "type": "object" }, + "MysqlGtidPosition": { + "description": "MySQL GTID position", + "id": "MysqlGtidPosition", + "properties": { + "gtidSet": { + "description": "Required. The gtid set to start replication from.", + "type": "string" + } + }, + "type": "object" + }, "MysqlLogPosition": { "description": "MySQL log position", "id": "MysqlLogPosition", @@ -2125,7 +2191,7 @@ "type": "object" }, "MysqlProfile": { - "description": "MySQL database profile. Next ID: 7.", + "description": "MySQL database profile.", "id": "MysqlProfile", "properties": { "hostname": { @@ -2141,6 +2207,10 @@ "format": "int32", "type": "integer" }, + "secretManagerStoredPassword": { + "description": "Optional. A reference to a Secret Manager resource name storing the MySQL connection password. Mutually exclusive with the `password` field.", + "type": "string" + }, "sslConfig": { "$ref": "MysqlSslConfig", "description": "SSL configuration for the MySQL connection." @@ -2222,7 +2292,7 @@ "type": "boolean" }, "clientKey": { - "description": "Optional. Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory. Mutually exclusive with the `secret_manager_stored_client_key` field.", + "description": "Optional. Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.", "type": "string" }, "clientKeySet": { @@ -2257,6 +2327,25 @@ "properties": {}, "type": "object" }, + "Oauth2ClientCredentials": { + "description": "OAuth2 Client Credentials.", + "id": "Oauth2ClientCredentials", + "properties": { + "clientId": { + "description": "Required. Client ID for Salesforce OAuth2 Client Credentials.", + "type": "string" + }, + "clientSecret": { + "description": "Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field.", + "type": "string" + }, + "secretManagerStoredClientSecret": { + "description": "Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field.", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -2342,7 +2431,7 @@ "type": "object" }, "OracleAsmConfig": { - "description": "Configuration for Oracle Automatic Storage Management (ASM) connection. .", + "description": "Configuration for Oracle Automatic Storage Management (ASM) connection.", "id": "OracleAsmConfig", "properties": { "asmService": { @@ -2365,7 +2454,7 @@ "description": "Optional. SSL configuration for the Oracle connection." }, "password": { - "description": "Optional. Password for the Oracle ASM connection.", + "description": "Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" }, "port": { @@ -2373,6 +2462,10 @@ "format": "int32", "type": "integer" }, + "secretManagerStoredPassword": { + "description": "Optional. A reference to a Secret Manager resource name storing the Oracle ASM connection password. Mutually exclusive with the `password` field.", + "type": "string" + }, "username": { "description": "Required. Username for the Oracle ASM connection.", "type": "string" @@ -2449,7 +2542,7 @@ "type": "object" }, "OracleProfile": { - "description": "Oracle database profile. Next ID: 10.", + "description": "Oracle database profile.", "id": "OracleProfile", "properties": { "connectionAttributes": { @@ -2693,6 +2786,10 @@ "format": "int32", "type": "integer" }, + "secretManagerStoredPassword": { + "description": "Optional. A reference to a Secret Manager resource name storing the PostgreSQL connection password. Mutually exclusive with the `password` field.", + "type": "string" + }, "sslConfig": { "$ref": "PostgresqlSslConfig", "description": "Optional. SSL configuration for the PostgreSQL connection. In case PostgresqlSslConfig is not set, the connection will use the default SSL mode, which is `prefer` (i.e. this mode will only use encryption if enabled from database side, otherwise will use unencrypted communication)" @@ -2942,6 +3039,107 @@ }, "type": "object" }, + "SalesforceField": { + "description": "Salesforce field.", + "id": "SalesforceField", + "properties": { + "dataType": { + "description": "The data type.", + "type": "string" + }, + "name": { + "description": "Field name.", + "type": "string" + }, + "nillable": { + "description": "Indicates whether the field can accept nil values.", + "type": "boolean" + } + }, + "type": "object" + }, + "SalesforceObject": { + "description": "Salesforce object.", + "id": "SalesforceObject", + "properties": { + "fields": { + "description": "Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.", + "items": { + "$ref": "SalesforceField" + }, + "type": "array" + }, + "objectName": { + "description": "Object name.", + "type": "string" + } + }, + "type": "object" + }, + "SalesforceObjectIdentifier": { + "description": "Salesforce data source object identifier.", + "id": "SalesforceObjectIdentifier", + "properties": { + "objectName": { + "description": "Required. The object name.", + "type": "string" + } + }, + "type": "object" + }, + "SalesforceOrg": { + "description": "Salesforce organization structure.", + "id": "SalesforceOrg", + "properties": { + "objects": { + "description": "Salesforce objects in the database server.", + "items": { + "$ref": "SalesforceObject" + }, + "type": "array" + } + }, + "type": "object" + }, + "SalesforceProfile": { + "description": "Salesforce profile", + "id": "SalesforceProfile", + "properties": { + "domain": { + "description": "Required. Domain endpoint for the Salesforce connection.", + "type": "string" + }, + "oauth2ClientCredentials": { + "$ref": "Oauth2ClientCredentials", + "description": "Connected app authentication." + }, + "userCredentials": { + "$ref": "UserCredentials", + "description": "User-password authentication." + } + }, + "type": "object" + }, + "SalesforceSourceConfig": { + "description": "Salesforce source configuration", + "id": "SalesforceSourceConfig", + "properties": { + "excludeObjects": { + "$ref": "SalesforceOrg", + "description": "Salesforce objects to exclude from the stream." + }, + "includeObjects": { + "$ref": "SalesforceOrg", + "description": "Salesforce objects to retrieve from the source." + }, + "pollingInterval": { + "description": "Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "ServerAndClientVerification": { "description": "Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option.", "id": "ServerAndClientVerification", @@ -2955,7 +3153,7 @@ "type": "string" }, "clientKey": { - "description": "Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. Mutually exclusive with the `secret_manager_stored_client_key` field.", + "description": "Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream.", "type": "string" } }, @@ -2999,8 +3197,12 @@ "$ref": "PostgresqlSourceConfig", "description": "PostgreSQL data source configuration." }, + "salesforceSourceConfig": { + "$ref": "SalesforceSourceConfig", + "description": "Salesforce data source configuration." + }, "sourceConnectionProfile": { - "description": "Required. Source connection profile resoource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`", + "description": "Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`", "type": "string" }, "sqlServerSourceConfig": { @@ -3037,6 +3239,10 @@ "$ref": "PostgresqlObjectIdentifier", "description": "PostgreSQL data source object identifier." }, + "salesforceIdentifier": { + "$ref": "SalesforceObjectIdentifier", + "description": "Salesforce data source object identifier." + }, "sqlServerIdentifier": { "$ref": "SqlServerObjectIdentifier", "description": "SQLServer data source object identifier." @@ -3048,6 +3254,10 @@ "description": "CDC strategy to start replicating from a specific position in the source.", "id": "SpecificStartPosition", "properties": { + "mysqlGtidPosition": { + "$ref": "MysqlGtidPosition", + "description": "MySQL GTID set to start replicating from." + }, "mysqlLogPosition": { "$ref": "MysqlLogPosition", "description": "MySQL specific log position to start replicating from." @@ -3139,7 +3349,7 @@ "type": "object" }, "SqlServerProfile": { - "description": "SQLServer database profile. Next ID: 8.", + "description": "SQLServer database profile.", "id": "SqlServerProfile", "properties": { "database": { @@ -3159,6 +3369,10 @@ "format": "int32", "type": "integer" }, + "secretManagerStoredPassword": { + "description": "Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the `password` field.", + "type": "string" + }, "username": { "description": "Required. Username for the SQLServer connection.", "type": "string" @@ -3477,6 +3691,33 @@ }, "type": "object" }, + "UserCredentials": { + "description": "Username-password credentials.", + "id": "UserCredentials", + "properties": { + "password": { + "description": "Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field.", + "type": "string" + }, + "secretManagerStoredPassword": { + "description": "Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field.", + "type": "string" + }, + "secretManagerStoredSecurityToken": { + "description": "Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field.", + "type": "string" + }, + "securityToken": { + "description": "Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field.", + "type": "string" + }, + "username": { + "description": "Required. Username for the Salesforce connection.", + "type": "string" + } + }, + "type": "object" + }, "Validation": { "description": "A validation to perform on a stream.", "id": "Validation", diff --git a/src/apis/datastream/v1.ts b/src/apis/datastream/v1.ts index d34ed2817e5..73514d3d064 100644 --- a/src/apis/datastream/v1.ts +++ b/src/apis/datastream/v1.ts @@ -148,6 +148,10 @@ export namespace datastream_v1 { * PostgreSQL data source objects to avoid backfilling. */ postgresqlExcludedObjects?: Schema$PostgresqlRdbms; + /** + * Salesforce data source objects to avoid backfilling + */ + salesforceExcludedObjects?: Schema$SalesforceOrg; /** * SQLServer data source objects to avoid backfilling */ @@ -190,6 +194,10 @@ export namespace datastream_v1 { * Append only mode */ appendOnly?: Schema$AppendOnly; + /** + * Optional. Big Lake Managed Tables (BLMT) configuration. + */ + blmtConfig?: Schema$BlmtConfig; /** * The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. */ @@ -228,6 +236,31 @@ export namespace datastream_v1 { * Use Binary log position based replication. */ export interface Schema$BinaryLogPosition {} + /** + * The configuration for BLMT. + */ + export interface Schema$BlmtConfig { + /** + * Required. The Cloud Storage bucket name. + */ + bucket?: string | null; + /** + * Required. The bigquery connection. Format: `{project\}.{location\}.{name\}` + */ + connectionName?: string | null; + /** + * Required. The file format. + */ + fileFormat?: string | null; + /** + * The root path inside the Cloud Storage bucket. + */ + rootPath?: string | null; + /** + * Required. The table format. + */ + tableFormat?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -297,6 +330,10 @@ export namespace datastream_v1 { * Private connectivity. */ privateConnectivity?: Schema$PrivateConnectivity; + /** + * Salesforce Connection Profile configuration. + */ + salesforceProfile?: Schema$SalesforceProfile; /** * Output only. Reserved for future use. */ @@ -756,6 +793,15 @@ export namespace datastream_v1 { */ mysqlTables?: Schema$MysqlTable[]; } + /** + * MySQL GTID position + */ + export interface Schema$MysqlGtidPosition { + /** + * Required. The gtid set to start replication from. + */ + gtidSet?: string | null; + } /** * MySQL log position */ @@ -783,7 +829,7 @@ export namespace datastream_v1 { table?: string | null; } /** - * MySQL database profile. Next ID: 7. + * MySQL database profile. */ export interface Schema$MysqlProfile { /** @@ -798,6 +844,10 @@ export namespace datastream_v1 { * Port for the MySQL connection, default value is 3306. */ port?: number | null; + /** + * Optional. A reference to a Secret Manager resource name storing the MySQL connection password. Mutually exclusive with the `password` field. + */ + secretManagerStoredPassword?: string | null; /** * SSL configuration for the MySQL connection. */ @@ -866,7 +916,7 @@ export namespace datastream_v1 { */ clientCertificateSet?: boolean | null; /** - * Optional. Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory. Mutually exclusive with the `secret_manager_stored_client_key` field. + * Optional. Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory. */ clientKey?: string | null; /** @@ -891,6 +941,23 @@ export namespace datastream_v1 { * CDC strategy to resume replication from the next available position in the source. */ export interface Schema$NextAvailableStartPosition {} + /** + * OAuth2 Client Credentials. + */ + export interface Schema$Oauth2ClientCredentials { + /** + * Required. Client ID for Salesforce OAuth2 Client Credentials. + */ + clientId?: string | null; + /** + * Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field. + */ + clientSecret?: string | null; + /** + * Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field. + */ + secretManagerStoredClientSecret?: string | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -954,7 +1021,7 @@ export namespace datastream_v1 { verb?: string | null; } /** - * Configuration for Oracle Automatic Storage Management (ASM) connection. . + * Configuration for Oracle Automatic Storage Management (ASM) connection. */ export interface Schema$OracleAsmConfig { /** @@ -974,13 +1041,17 @@ export namespace datastream_v1 { */ oracleSslConfig?: Schema$OracleSslConfig; /** - * Optional. Password for the Oracle ASM connection. + * Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field. */ password?: string | null; /** * Required. Port for the Oracle ASM connection. */ port?: number | null; + /** + * Optional. A reference to a Secret Manager resource name storing the Oracle ASM connection password. Mutually exclusive with the `password` field. + */ + secretManagerStoredPassword?: string | null; /** * Required. Username for the Oracle ASM connection. */ @@ -1045,7 +1116,7 @@ export namespace datastream_v1 { table?: string | null; } /** - * Oracle database profile. Next ID: 10. + * Oracle database profile. */ export interface Schema$OracleProfile { /** @@ -1249,6 +1320,10 @@ export namespace datastream_v1 { * Port for the PostgreSQL connection, default value is 5432. */ port?: number | null; + /** + * Optional. A reference to a Secret Manager resource name storing the PostgreSQL connection password. Mutually exclusive with the `password` field. + */ + secretManagerStoredPassword?: string | null; /** * Optional. SSL configuration for the PostgreSQL connection. In case PostgresqlSslConfig is not set, the connection will use the default SSL mode, which is `prefer` (i.e. this mode will only use encryption if enabled from database side, otherwise will use unencrypted communication) */ @@ -1431,6 +1506,88 @@ export namespace datastream_v1 { */ force?: boolean | null; } + /** + * Salesforce field. + */ + export interface Schema$SalesforceField { + /** + * The data type. + */ + dataType?: string | null; + /** + * Field name. + */ + name?: string | null; + /** + * Indicates whether the field can accept nil values. + */ + nillable?: boolean | null; + } + /** + * Salesforce object. + */ + export interface Schema$SalesforceObject { + /** + * Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. + */ + fields?: Schema$SalesforceField[]; + /** + * Object name. + */ + objectName?: string | null; + } + /** + * Salesforce data source object identifier. + */ + export interface Schema$SalesforceObjectIdentifier { + /** + * Required. The object name. + */ + objectName?: string | null; + } + /** + * Salesforce organization structure. + */ + export interface Schema$SalesforceOrg { + /** + * Salesforce objects in the database server. + */ + objects?: Schema$SalesforceObject[]; + } + /** + * Salesforce profile + */ + export interface Schema$SalesforceProfile { + /** + * Required. Domain endpoint for the Salesforce connection. + */ + domain?: string | null; + /** + * Connected app authentication. + */ + oauth2ClientCredentials?: Schema$Oauth2ClientCredentials; + /** + * User-password authentication. + */ + userCredentials?: Schema$UserCredentials; + } + /** + * Salesforce source configuration + */ + export interface Schema$SalesforceSourceConfig { + /** + * Salesforce objects to exclude from the stream. + */ + excludeObjects?: Schema$SalesforceOrg; + /** + * Salesforce objects to retrieve from the source. + */ + includeObjects?: Schema$SalesforceOrg; + /** + * Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. + */ + pollingInterval?: string | null; + } /** * Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option. */ @@ -1444,7 +1601,7 @@ export namespace datastream_v1 { */ clientCertificate?: string | null; /** - * Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. Mutually exclusive with the `secret_manager_stored_client_key` field. + * Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. */ clientKey?: string | null; } @@ -1483,7 +1640,11 @@ export namespace datastream_v1 { */ postgresqlSourceConfig?: Schema$PostgresqlSourceConfig; /** - * Required. Source connection profile resoource. Format: `projects/{project\}/locations/{location\}/connectionProfiles/{name\}` + * Salesforce data source configuration. + */ + salesforceSourceConfig?: Schema$SalesforceSourceConfig; + /** + * Required. Source connection profile resource. Format: `projects/{project\}/locations/{location\}/connectionProfiles/{name\}` */ sourceConnectionProfile?: string | null; /** @@ -1516,6 +1677,10 @@ export namespace datastream_v1 { * PostgreSQL data source object identifier. */ postgresqlIdentifier?: Schema$PostgresqlObjectIdentifier; + /** + * Salesforce data source object identifier. + */ + salesforceIdentifier?: Schema$SalesforceObjectIdentifier; /** * SQLServer data source object identifier. */ @@ -1525,6 +1690,10 @@ export namespace datastream_v1 { * CDC strategy to start replicating from a specific position in the source. */ export interface Schema$SpecificStartPosition { + /** + * MySQL GTID set to start replicating from. + */ + mysqlGtidPosition?: Schema$MysqlGtidPosition; /** * MySQL specific log position to start replicating from. */ @@ -1602,7 +1771,7 @@ export namespace datastream_v1 { table?: string | null; } /** - * SQLServer database profile. Next ID: 8. + * SQLServer database profile. */ export interface Schema$SqlServerProfile { /** @@ -1621,6 +1790,10 @@ export namespace datastream_v1 { * Port for the SQLServer connection, default value is 1433. */ port?: number | null; + /** + * Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the `password` field. + */ + secretManagerStoredPassword?: string | null; /** * Required. Username for the SQLServer connection. */ @@ -1843,6 +2016,31 @@ export namespace datastream_v1 { */ updateTime?: string | null; } + /** + * Username-password credentials. + */ + export interface Schema$UserCredentials { + /** + * Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field. + */ + password?: string | null; + /** + * Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field. + */ + secretManagerStoredPassword?: string | null; + /** + * Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field. + */ + secretManagerStoredSecurityToken?: string | null; + /** + * Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field. + */ + securityToken?: string | null; + /** + * Required. Username for the Salesforce connection. + */ + username?: string | null; + } /** * A validation to perform on a stream. */ From d8719bb580baca5e191a3d64b45179227cdd1aee Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 052/144] feat(developerconnect): update the API #### developerconnect:v1 The following keys were added: - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.description - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.flatPath - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.httpMethod - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.id - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.parameterOrder - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.parameters.name.description - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.parameters.name.location - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.parameters.name.pattern - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.parameters.name.required - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.parameters.name.type - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.path - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.request.$ref - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketCloudWebhook.response.$ref - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.description - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.flatPath - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.httpMethod - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.id - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.parameterOrder - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.parameters.name.description - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.parameters.name.location - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.parameters.name.pattern - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.parameters.name.required - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.parameters.name.type - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.path - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.request.$ref - resources.projects.resources.locations.resources.connections.resources.gitRepositoryLinks.methods.processBitbucketDataCenterWebhook.response.$ref - schemas.BitbucketCloudConfig.description - schemas.BitbucketCloudConfig.id - schemas.BitbucketCloudConfig.properties.authorizerCredential.$ref - schemas.BitbucketCloudConfig.properties.authorizerCredential.description - schemas.BitbucketCloudConfig.properties.readAuthorizerCredential.$ref - schemas.BitbucketCloudConfig.properties.readAuthorizerCredential.description - schemas.BitbucketCloudConfig.properties.webhookSecretSecretVersion.description - schemas.BitbucketCloudConfig.properties.webhookSecretSecretVersion.type - schemas.BitbucketCloudConfig.properties.workspace.description - schemas.BitbucketCloudConfig.properties.workspace.type - schemas.BitbucketCloudConfig.type - schemas.BitbucketDataCenterConfig.description - schemas.BitbucketDataCenterConfig.id - schemas.BitbucketDataCenterConfig.properties.authorizerCredential.$ref - schemas.BitbucketDataCenterConfig.properties.authorizerCredential.description - schemas.BitbucketDataCenterConfig.properties.hostUri.description - schemas.BitbucketDataCenterConfig.properties.hostUri.type - schemas.BitbucketDataCenterConfig.properties.readAuthorizerCredential.$ref - schemas.BitbucketDataCenterConfig.properties.readAuthorizerCredential.description - schemas.BitbucketDataCenterConfig.properties.serverVersion.description - schemas.BitbucketDataCenterConfig.properties.serverVersion.readOnly - schemas.BitbucketDataCenterConfig.properties.serverVersion.type - schemas.BitbucketDataCenterConfig.properties.serviceDirectoryConfig.$ref - schemas.BitbucketDataCenterConfig.properties.serviceDirectoryConfig.description - schemas.BitbucketDataCenterConfig.properties.sslCaCertificate.description - schemas.BitbucketDataCenterConfig.properties.sslCaCertificate.type - schemas.BitbucketDataCenterConfig.properties.webhookSecretSecretVersion.description - schemas.BitbucketDataCenterConfig.properties.webhookSecretSecretVersion.type - schemas.BitbucketDataCenterConfig.type - schemas.Connection.properties.bitbucketCloudConfig.$ref - schemas.Connection.properties.bitbucketCloudConfig.description - schemas.Connection.properties.bitbucketDataCenterConfig.$ref - schemas.Connection.properties.bitbucketDataCenterConfig.description - schemas.Connection.properties.gitProxyConfig.$ref - schemas.Connection.properties.gitProxyConfig.description - schemas.GitProxyConfig.description - schemas.GitProxyConfig.id - schemas.GitProxyConfig.properties.enabled.description - schemas.GitProxyConfig.properties.enabled.type - schemas.GitProxyConfig.type - schemas.GitRepositoryLink.properties.gitProxyUri.description - schemas.GitRepositoryLink.properties.gitProxyUri.readOnly - schemas.GitRepositoryLink.properties.gitProxyUri.type - schemas.ProcessBitbucketCloudWebhookRequest.description - schemas.ProcessBitbucketCloudWebhookRequest.id - schemas.ProcessBitbucketCloudWebhookRequest.properties.body.$ref - schemas.ProcessBitbucketCloudWebhookRequest.properties.body.description - schemas.ProcessBitbucketCloudWebhookRequest.type - schemas.ProcessBitbucketDataCenterWebhookRequest.description - schemas.ProcessBitbucketDataCenterWebhookRequest.id - schemas.ProcessBitbucketDataCenterWebhookRequest.properties.body.$ref - schemas.ProcessBitbucketDataCenterWebhookRequest.properties.body.description - schemas.ProcessBitbucketDataCenterWebhookRequest.type --- discovery/developerconnect-v1.json | 161 ++++++++++++++- src/apis/developerconnect/v1.ts | 304 +++++++++++++++++++++++++++++ 2 files changed, 464 insertions(+), 1 deletion(-) diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index bed58808b8e..cbea2168f00 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -785,6 +785,56 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "processBitbucketCloudWebhook": { + "description": "ProcessBitbucketCloudWebhook is called by the external Bitbucket Cloud instances for notifying events.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:processBitbucketCloudWebhook", + "httpMethod": "POST", + "id": "developerconnect.projects.locations.connections.gitRepositoryLinks.processBitbucketCloudWebhook", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The GitRepositoryLink where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:processBitbucketCloudWebhook", + "request": { + "$ref": "ProcessBitbucketCloudWebhookRequest" + }, + "response": { + "$ref": "Empty" + } + }, + "processBitbucketDataCenterWebhook": { + "description": "ProcessBitbucketDataCenterWebhook is called by the external Bitbucket Data Center instances for notifying events.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:processBitbucketDataCenterWebhook", + "httpMethod": "POST", + "id": "developerconnect.projects.locations.connections.gitRepositoryLinks.processBitbucketDataCenterWebhook", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The GitRepositoryLink where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:processBitbucketDataCenterWebhook", + "request": { + "$ref": "ProcessBitbucketDataCenterWebhookRequest" + }, + "response": { + "$ref": "Empty" + } + }, "processGitLabEnterpriseWebhook": { "description": "ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:processGitLabEnterpriseWebhook", @@ -967,9 +1017,68 @@ } } }, - "revision": "20241205", + "revision": "20250129", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { + "BitbucketCloudConfig": { + "description": "Configuration for connections to an instance of Bitbucket Cloud.", + "id": "BitbucketCloudConfig", + "properties": { + "authorizerCredential": { + "$ref": "UserCredential", + "description": "Required. An access token with the minimum `repository`, `pullrequest` and `webhook` scope access. It can either be a workspace, project or repository access token. This is needed to create webhooks. It's recommended to use a system account to generate these credentials." + }, + "readAuthorizerCredential": { + "$ref": "UserCredential", + "description": "Required. An access token with the minimum `repository` access. It can either be a workspace, project or repository access token. It's recommended to use a system account to generate the credentials." + }, + "webhookSecretSecretVersion": { + "description": "Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate and create webhooks.", + "type": "string" + }, + "workspace": { + "description": "Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.", + "type": "string" + } + }, + "type": "object" + }, + "BitbucketDataCenterConfig": { + "description": "Configuration for connections to an instance of Bitbucket Data Center.", + "id": "BitbucketDataCenterConfig", + "properties": { + "authorizerCredential": { + "$ref": "UserCredential", + "description": "Required. An http access token with the minimum `Repository admin` scope access. This is needed to create webhooks. It's recommended to use a system account to generate these credentials." + }, + "hostUri": { + "description": "Required. The URI of the Bitbucket Data Center host this connection is for.", + "type": "string" + }, + "readAuthorizerCredential": { + "$ref": "UserCredential", + "description": "Required. An http access token with the minimum `Repository read` access. It's recommended to use a system account to generate the credentials." + }, + "serverVersion": { + "description": "Output only. Version of the Bitbucket Data Center server running on the `host_uri`.", + "readOnly": true, + "type": "string" + }, + "serviceDirectoryConfig": { + "$ref": "ServiceDirectoryConfig", + "description": "Optional. Configuration for using Service Directory to privately connect to a Bitbucket Data Center instance. This should only be set if the Bitbucket Data Center is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the Bitbucket Data Center will be made over the public internet." + }, + "sslCaCertificate": { + "description": "Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.", + "type": "string" + }, + "webhookSecretSecretVersion": { + "description": "Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.", + "type": "string" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -987,6 +1096,14 @@ "description": "Optional. Allows clients to store small amounts of arbitrary data.", "type": "object" }, + "bitbucketCloudConfig": { + "$ref": "BitbucketCloudConfig", + "description": "Configuration for connections to an instance of Bitbucket Clouds." + }, + "bitbucketDataCenterConfig": { + "$ref": "BitbucketDataCenterConfig", + "description": "Configuration for connections to an instance of Bitbucket Data Center." + }, "createTime": { "description": "Output only. [Output only] Create timestamp", "format": "google-datetime", @@ -1011,6 +1128,10 @@ "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.", "type": "string" }, + "gitProxyConfig": { + "$ref": "GitProxyConfig", + "description": "Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection." + }, "githubConfig": { "$ref": "GitHubConfig", "description": "Configuration for connections to github.com." @@ -1323,6 +1444,17 @@ }, "type": "object" }, + "GitProxyConfig": { + "description": "The git proxy configuration.", + "id": "GitProxyConfig", + "properties": { + "enabled": { + "description": "Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection.", + "type": "boolean" + } + }, + "type": "object" + }, "GitRepositoryLink": { "description": "Message describing the GitRepositoryLink object", "id": "GitRepositoryLink", @@ -1354,6 +1486,11 @@ "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.", "type": "string" }, + "gitProxyUri": { + "description": "Output only. URI to access the linked repository through the Git Proxy. This field is only populated if the git proxy is enabled for the connection.", + "readOnly": true, + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -1698,6 +1835,28 @@ }, "type": "object" }, + "ProcessBitbucketCloudWebhookRequest": { + "description": "RPC request object accepted by the ProcessBitbucketCloudWebhook RPC method.", + "id": "ProcessBitbucketCloudWebhookRequest", + "properties": { + "body": { + "$ref": "HttpBody", + "description": "Required. HTTP request body." + } + }, + "type": "object" + }, + "ProcessBitbucketDataCenterWebhookRequest": { + "description": "RPC request object accepted by the ProcessBitbucketDataCenterWebhook RPC method.", + "id": "ProcessBitbucketDataCenterWebhookRequest", + "properties": { + "body": { + "$ref": "HttpBody", + "description": "Required. HTTP request body." + } + }, + "type": "object" + }, "ProcessGitHubEnterpriseWebhookRequest": { "description": "RPC request object accepted by the ProcessGitHubEnterpriseWebhook RPC method.", "id": "ProcessGitHubEnterpriseWebhookRequest", diff --git a/src/apis/developerconnect/v1.ts b/src/apis/developerconnect/v1.ts index 224b44f7b0f..4d372ae441d 100644 --- a/src/apis/developerconnect/v1.ts +++ b/src/apis/developerconnect/v1.ts @@ -124,6 +124,60 @@ export namespace developerconnect_v1 { } } + /** + * Configuration for connections to an instance of Bitbucket Cloud. + */ + export interface Schema$BitbucketCloudConfig { + /** + * Required. An access token with the minimum `repository`, `pullrequest` and `webhook` scope access. It can either be a workspace, project or repository access token. This is needed to create webhooks. It's recommended to use a system account to generate these credentials. + */ + authorizerCredential?: Schema$UserCredential; + /** + * Required. An access token with the minimum `repository` access. It can either be a workspace, project or repository access token. It's recommended to use a system account to generate the credentials. + */ + readAuthorizerCredential?: Schema$UserCredential; + /** + * Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/x/secrets/x/versions/x`. This is used to validate and create webhooks. + */ + webhookSecretSecretVersion?: string | null; + /** + * Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform. + */ + workspace?: string | null; + } + /** + * Configuration for connections to an instance of Bitbucket Data Center. + */ + export interface Schema$BitbucketDataCenterConfig { + /** + * Required. An http access token with the minimum `Repository admin` scope access. This is needed to create webhooks. It's recommended to use a system account to generate these credentials. + */ + authorizerCredential?: Schema$UserCredential; + /** + * Required. The URI of the Bitbucket Data Center host this connection is for. + */ + hostUri?: string | null; + /** + * Required. An http access token with the minimum `Repository read` access. It's recommended to use a system account to generate the credentials. + */ + readAuthorizerCredential?: Schema$UserCredential; + /** + * Output only. Version of the Bitbucket Data Center server running on the `host_uri`. + */ + serverVersion?: string | null; + /** + * Optional. Configuration for using Service Directory to privately connect to a Bitbucket Data Center instance. This should only be set if the Bitbucket Data Center is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the Bitbucket Data Center will be made over the public internet. + */ + serviceDirectoryConfig?: Schema$ServiceDirectoryConfig; + /** + * Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center. + */ + sslCaCertificate?: string | null; + /** + * Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/x/secrets/x/versions/x`. This is used to validate webhooks. + */ + webhookSecretSecretVersion?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -136,6 +190,14 @@ export namespace developerconnect_v1 { * Optional. Allows clients to store small amounts of arbitrary data. */ annotations?: {[key: string]: string} | null; + /** + * Configuration for connections to an instance of Bitbucket Clouds. + */ + bitbucketCloudConfig?: Schema$BitbucketCloudConfig; + /** + * Configuration for connections to an instance of Bitbucket Data Center. + */ + bitbucketDataCenterConfig?: Schema$BitbucketDataCenterConfig; /** * Output only. [Output only] Create timestamp */ @@ -172,6 +234,10 @@ export namespace developerconnect_v1 { * Configuration for connections to an instance of GitLab Enterprise. */ gitlabEnterpriseConfig?: Schema$GitLabEnterpriseConfig; + /** + * Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. + */ + gitProxyConfig?: Schema$GitProxyConfig; /** * Output only. Installation state of the Connection. */ @@ -403,6 +469,15 @@ export namespace developerconnect_v1 { */ webhookSecretSecretVersion?: string | null; } + /** + * The git proxy configuration. + */ + export interface Schema$GitProxyConfig { + /** + * Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection. + */ + enabled?: boolean | null; + } /** * Message describing the GitRepositoryLink object */ @@ -427,6 +502,10 @@ export namespace developerconnect_v1 { * 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. */ etag?: string | null; + /** + * Output only. URI to access the linked repository through the Git Proxy. This field is only populated if the git proxy is enabled for the connection. + */ + gitProxyUri?: string | null; /** * Optional. Labels as key value pairs */ @@ -668,6 +747,24 @@ export namespace developerconnect_v1 { */ verb?: string | null; } + /** + * RPC request object accepted by the ProcessBitbucketCloudWebhook RPC method. + */ + export interface Schema$ProcessBitbucketCloudWebhookRequest { + /** + * Required. HTTP request body. + */ + body?: Schema$HttpBody; + } + /** + * RPC request object accepted by the ProcessBitbucketDataCenterWebhook RPC method. + */ + export interface Schema$ProcessBitbucketDataCenterWebhookRequest { + /** + * Required. HTTP request body. + */ + body?: Schema$HttpBody; + } /** * RPC request object accepted by the ProcessGitHubEnterpriseWebhook RPC method. */ @@ -2505,6 +2602,189 @@ export namespace developerconnect_v1 { } } + /** + * ProcessBitbucketCloudWebhook is called by the external Bitbucket Cloud instances for notifying 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. + */ + processBitbucketCloudWebhook( + params: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook, + options: StreamMethodOptions + ): GaxiosPromise; + processBitbucketCloudWebhook( + params?: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook, + options?: MethodOptions + ): GaxiosPromise; + processBitbucketCloudWebhook( + params: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + processBitbucketCloudWebhook( + params: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + processBitbucketCloudWebhook( + params: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook, + callback: BodyResponseCallback + ): void; + processBitbucketCloudWebhook( + callback: BodyResponseCallback + ): void; + processBitbucketCloudWebhook( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://developerconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:processBitbucketCloudWebhook').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); + } + } + + /** + * ProcessBitbucketDataCenterWebhook is called by the external Bitbucket Data Center instances for notifying 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. + */ + processBitbucketDataCenterWebhook( + params: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook, + options: StreamMethodOptions + ): GaxiosPromise; + processBitbucketDataCenterWebhook( + params?: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook, + options?: MethodOptions + ): GaxiosPromise; + processBitbucketDataCenterWebhook( + params: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + processBitbucketDataCenterWebhook( + params: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + processBitbucketDataCenterWebhook( + params: Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook, + callback: BodyResponseCallback + ): void; + processBitbucketDataCenterWebhook( + callback: BodyResponseCallback + ): void; + processBitbucketDataCenterWebhook( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://developerconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+name}:processBitbucketDataCenterWebhook' + ).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); + } + } + /** * ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events. * @@ -2803,6 +3083,30 @@ export namespace developerconnect_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketcloudwebhook + extends StandardParameters { + /** + * Required. The GitRepositoryLink where the webhook will be received. Format: `projects/x/locations/x/connections/x/gitRepositoryLinks/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProcessBitbucketCloudWebhookRequest; + } + export interface Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processbitbucketdatacenterwebhook + extends StandardParameters { + /** + * Required. The GitRepositoryLink where the webhook will be received. Format: `projects/x/locations/x/connections/x/gitRepositoryLinks/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProcessBitbucketDataCenterWebhookRequest; + } export interface Params$Resource$Projects$Locations$Connections$Gitrepositorylinks$Processgitlabenterprisewebhook extends StandardParameters { /** From 0fc0177a2a034064c1a43762ab5b2e711f2a5586 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 053/144] feat(dfareporting): update the API #### dfareporting:v4 The following keys were added: - schemas.TagSetting.properties.includeUnescapedlpurlMacro.description - schemas.TagSetting.properties.includeUnescapedlpurlMacro.type The following keys were changed: - schemas.CartData.properties.merchantFeedLabel.description - schemas.CartData.properties.merchantFeedLanguage.description - schemas.CartData.properties.merchantId.description - schemas.Conversion.properties.value.description --- discovery/dfareporting-v4.json | 14 +++++++++----- src/apis/dfareporting/v4.ts | 12 ++++++++---- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json index ec0a3d35028..d82893d08b3 100644 --- a/discovery/dfareporting-v4.json +++ b/discovery/dfareporting-v4.json @@ -10152,7 +10152,7 @@ } } }, - "revision": "20240926", + "revision": "20250218", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -11760,15 +11760,15 @@ "type": "array" }, "merchantFeedLabel": { - "description": "The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field.", + "description": "The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details.", "type": "string" }, "merchantFeedLanguage": { - "description": "The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds.", + "description": "The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details.", "type": "string" }, "merchantId": { - "description": "The Merchant Center ID where the items are uploaded. This is a required field.", + "description": "The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details.", "format": "int64", "type": "string" } @@ -12281,7 +12281,7 @@ "type": "array" }, "value": { - "description": "The value of the conversion. This is a required field.", + "description": "The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field.", "format": "double", "type": "number" } @@ -20324,6 +20324,10 @@ "description": "Whether click-tracking string should be included in the tags.", "type": "boolean" }, + "includeUnescapedlpurlMacro": { + "description": "Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.", + "type": "boolean" + }, "keywordOption": { "description": "Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.", "enum": [ diff --git a/src/apis/dfareporting/v4.ts b/src/apis/dfareporting/v4.ts index 2fb35002368..4330a92e56c 100644 --- a/src/apis/dfareporting/v4.ts +++ b/src/apis/dfareporting/v4.ts @@ -1394,15 +1394,15 @@ export namespace dfareporting_v4 { */ items?: Schema$CartDataItem[]; /** - * The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. This is a required field. + * The feed labels associated with the feed where your items are uploaded. For more information, please refer to ​​ https://support.google.com/merchants/answer/12453549. Providing the feed label reduces ambiguity in identifying the right offer details. */ merchantFeedLabel?: string | null; /** - * The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds. + * The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Providing the feed language reduces ambiguity in identifying the right offer details. */ merchantFeedLanguage?: string | null; /** - * The Merchant Center ID where the items are uploaded. This is a required field. + * The Merchant Center ID where the items are uploaded. Providing Merchant Center ID reduces ambiguity in identifying the right offer details. */ merchantId?: string | null; } @@ -1824,7 +1824,7 @@ export namespace dfareporting_v4 { */ userIdentifiers?: Schema$UserIdentifier[]; /** - * The value of the conversion. This is a required field. + * The value of the conversion. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field. */ value?: number | null; } @@ -6385,6 +6385,10 @@ export namespace dfareporting_v4 { * Whether click-tracking string should be included in the tags. */ includeClickTracking?: boolean | null; + /** + * Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. + */ + includeUnescapedlpurlMacro?: boolean | null; /** * Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. */ From 833e20ab33cbb27efcdd6f3b4dac12a1c30854a1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 054/144] feat(dialogflow)!: update the API BREAKING CHANGE: This release has breaking changes. #### dialogflow:v2beta1 The following keys were deleted: - resources.projects.resources.answerRecords.methods.list.parameters.filter.deprecated - resources.projects.resources.locations.resources.answerRecords.methods.list.parameters.filter.deprecated The following keys were added: - resources.projects.resources.conversations.resources.suggestions.methods.generate.description - resources.projects.resources.conversations.resources.suggestions.methods.generate.flatPath - resources.projects.resources.conversations.resources.suggestions.methods.generate.httpMethod - resources.projects.resources.conversations.resources.suggestions.methods.generate.id - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameterOrder - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.description - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.location - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.pattern - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.required - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.type - resources.projects.resources.conversations.resources.suggestions.methods.generate.path - resources.projects.resources.conversations.resources.suggestions.methods.generate.request.$ref - resources.projects.resources.conversations.resources.suggestions.methods.generate.response.$ref - resources.projects.resources.conversations.resources.suggestions.methods.generate.scopes - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.description - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.flatPath - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.httpMethod - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.id - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameterOrder - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.description - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.location - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.pattern - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.required - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.type - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.path - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.request.$ref - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.response.$ref - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.scopes - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.description - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.flatPath - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.httpMethod - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.id - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameterOrder - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.description - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.location - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.pattern - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.required - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.type - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.path - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.request.$ref - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.response.$ref - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.scopes - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.description - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.flatPath - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.httpMethod - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.id - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.parameterOrder - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.path - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.response.$ref - resources.projects.resources.locations.resources.phoneNumbers.methods.delete.scopes - resources.projects.resources.locations.resources.phoneNumbers.methods.list.description - resources.projects.resources.locations.resources.phoneNumbers.methods.list.flatPath - resources.projects.resources.locations.resources.phoneNumbers.methods.list.httpMethod - resources.projects.resources.locations.resources.phoneNumbers.methods.list.id - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameterOrder - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.showDeleted.description - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.showDeleted.location - resources.projects.resources.locations.resources.phoneNumbers.methods.list.parameters.showDeleted.type - resources.projects.resources.locations.resources.phoneNumbers.methods.list.path - resources.projects.resources.locations.resources.phoneNumbers.methods.list.response.$ref - resources.projects.resources.locations.resources.phoneNumbers.methods.list.scopes - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.description - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.flatPath - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.httpMethod - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.id - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameterOrder - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.path - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.request.$ref - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.response.$ref - resources.projects.resources.locations.resources.phoneNumbers.methods.patch.scopes - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.description - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.flatPath - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.httpMethod - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.id - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.parameterOrder - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.parameters.name.description - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.parameters.name.location - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.parameters.name.pattern - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.parameters.name.required - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.parameters.name.type - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.path - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.request.$ref - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.response.$ref - resources.projects.resources.locations.resources.phoneNumbers.methods.undelete.scopes - resources.projects.resources.phoneNumbers.methods.delete.description - resources.projects.resources.phoneNumbers.methods.delete.flatPath - resources.projects.resources.phoneNumbers.methods.delete.httpMethod - resources.projects.resources.phoneNumbers.methods.delete.id - resources.projects.resources.phoneNumbers.methods.delete.parameterOrder - resources.projects.resources.phoneNumbers.methods.delete.parameters.name.description - resources.projects.resources.phoneNumbers.methods.delete.parameters.name.location - resources.projects.resources.phoneNumbers.methods.delete.parameters.name.pattern - resources.projects.resources.phoneNumbers.methods.delete.parameters.name.required - resources.projects.resources.phoneNumbers.methods.delete.parameters.name.type - resources.projects.resources.phoneNumbers.methods.delete.path - resources.projects.resources.phoneNumbers.methods.delete.response.$ref - resources.projects.resources.phoneNumbers.methods.delete.scopes - resources.projects.resources.phoneNumbers.methods.list.description - resources.projects.resources.phoneNumbers.methods.list.flatPath - resources.projects.resources.phoneNumbers.methods.list.httpMethod - resources.projects.resources.phoneNumbers.methods.list.id - resources.projects.resources.phoneNumbers.methods.list.parameterOrder - resources.projects.resources.phoneNumbers.methods.list.parameters.pageSize.description - resources.projects.resources.phoneNumbers.methods.list.parameters.pageSize.format - resources.projects.resources.phoneNumbers.methods.list.parameters.pageSize.location - resources.projects.resources.phoneNumbers.methods.list.parameters.pageSize.type - resources.projects.resources.phoneNumbers.methods.list.parameters.pageToken.description - resources.projects.resources.phoneNumbers.methods.list.parameters.pageToken.location - resources.projects.resources.phoneNumbers.methods.list.parameters.pageToken.type - resources.projects.resources.phoneNumbers.methods.list.parameters.parent.description - resources.projects.resources.phoneNumbers.methods.list.parameters.parent.location - resources.projects.resources.phoneNumbers.methods.list.parameters.parent.pattern - resources.projects.resources.phoneNumbers.methods.list.parameters.parent.required - resources.projects.resources.phoneNumbers.methods.list.parameters.parent.type - resources.projects.resources.phoneNumbers.methods.list.parameters.showDeleted.description - resources.projects.resources.phoneNumbers.methods.list.parameters.showDeleted.location - resources.projects.resources.phoneNumbers.methods.list.parameters.showDeleted.type - resources.projects.resources.phoneNumbers.methods.list.path - resources.projects.resources.phoneNumbers.methods.list.response.$ref - resources.projects.resources.phoneNumbers.methods.list.scopes - resources.projects.resources.phoneNumbers.methods.patch.description - resources.projects.resources.phoneNumbers.methods.patch.flatPath - resources.projects.resources.phoneNumbers.methods.patch.httpMethod - resources.projects.resources.phoneNumbers.methods.patch.id - resources.projects.resources.phoneNumbers.methods.patch.parameterOrder - resources.projects.resources.phoneNumbers.methods.patch.parameters.name.description - resources.projects.resources.phoneNumbers.methods.patch.parameters.name.location - resources.projects.resources.phoneNumbers.methods.patch.parameters.name.pattern - resources.projects.resources.phoneNumbers.methods.patch.parameters.name.required - resources.projects.resources.phoneNumbers.methods.patch.parameters.name.type - resources.projects.resources.phoneNumbers.methods.patch.parameters.updateMask.description - resources.projects.resources.phoneNumbers.methods.patch.parameters.updateMask.format - resources.projects.resources.phoneNumbers.methods.patch.parameters.updateMask.location - resources.projects.resources.phoneNumbers.methods.patch.parameters.updateMask.type - resources.projects.resources.phoneNumbers.methods.patch.path - resources.projects.resources.phoneNumbers.methods.patch.request.$ref - resources.projects.resources.phoneNumbers.methods.patch.response.$ref - resources.projects.resources.phoneNumbers.methods.patch.scopes - resources.projects.resources.phoneNumbers.methods.undelete.description - resources.projects.resources.phoneNumbers.methods.undelete.flatPath - resources.projects.resources.phoneNumbers.methods.undelete.httpMethod - resources.projects.resources.phoneNumbers.methods.undelete.id - resources.projects.resources.phoneNumbers.methods.undelete.parameterOrder - resources.projects.resources.phoneNumbers.methods.undelete.parameters.name.description - resources.projects.resources.phoneNumbers.methods.undelete.parameters.name.location - resources.projects.resources.phoneNumbers.methods.undelete.parameters.name.pattern - resources.projects.resources.phoneNumbers.methods.undelete.parameters.name.required - resources.projects.resources.phoneNumbers.methods.undelete.parameters.name.type - resources.projects.resources.phoneNumbers.methods.undelete.path - resources.projects.resources.phoneNumbers.methods.undelete.request.$ref - resources.projects.resources.phoneNumbers.methods.undelete.response.$ref - resources.projects.resources.phoneNumbers.methods.undelete.scopes - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.description - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.id - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.properties.response.description - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.properties.response.type - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.items.$ref - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.$ref - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.type - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.id - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.freeFormSuggestion.$ref - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.freeFormSuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.summarySuggestion.$ref - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.summarySuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.type - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateSuggestionsResponse.$ref - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.id - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.items.$ref - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.type - schemas.GoogleCloudDialogflowV2SummarySuggestion.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.id - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.section.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.section.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.summary.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.summary.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.type - schemas.GoogleCloudDialogflowV2beta1Conversation.properties.ingestedContextReferences.additionalProperties.$ref - schemas.GoogleCloudDialogflowV2beta1Conversation.properties.ingestedContextReferences.description - schemas.GoogleCloudDialogflowV2beta1Conversation.properties.ingestedContextReferences.readOnly - schemas.GoogleCloudDialogflowV2beta1Conversation.properties.ingestedContextReferences.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.id - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.contextContents.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.contextContents.items.$ref - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.contextContents.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.createTime.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.createTime.format - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.createTime.readOnly - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.createTime.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.languageCode.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.languageCode.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.updateMode.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.updateMode.enum - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.updateMode.enumDescriptions - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.properties.updateMode.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReference.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.id - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.content.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.content.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.contentFormat.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.contentFormat.enum - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.contentFormat.enumDescriptions - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.contentFormat.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.ingestionTime.description - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.ingestionTime.format - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.ingestionTime.readOnly - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.properties.ingestionTime.type - schemas.GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent.type - schemas.GoogleCloudDialogflowV2beta1FreeFormContext.description - schemas.GoogleCloudDialogflowV2beta1FreeFormContext.id - schemas.GoogleCloudDialogflowV2beta1FreeFormContext.properties.text.description - schemas.GoogleCloudDialogflowV2beta1FreeFormContext.properties.text.type - schemas.GoogleCloudDialogflowV2beta1FreeFormContext.type - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.id - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.properties.response.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.properties.response.type - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.type - schemas.GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest.properties.contextReferences.additionalProperties.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest.properties.contextReferences.description - schemas.GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest.properties.contextReferences.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.properties.triggerEvents.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.properties.triggerEvents.items.enum - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.properties.triggerEvents.items.enumDescriptions - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.properties.triggerEvents.items.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.properties.triggerEvents.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.items.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.type - schemas.GoogleCloudDialogflowV2beta1Generator.properties.freeFormContext.$ref - schemas.GoogleCloudDialogflowV2beta1Generator.properties.freeFormContext.description - schemas.GoogleCloudDialogflowV2beta1Generator.properties.publishedModel.description - schemas.GoogleCloudDialogflowV2beta1Generator.properties.publishedModel.type - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.freeFormSuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.freeFormSuggestion.description - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesRequest.description - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesRequest.id - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesRequest.properties.contextReferences.additionalProperties.$ref - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesRequest.properties.contextReferences.description - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesRequest.properties.contextReferences.type - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesRequest.type - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesResponse.description - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesResponse.id - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesResponse.properties.ingestedContextReferences.additionalProperties.$ref - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesResponse.properties.ingestedContextReferences.description - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesResponse.properties.ingestedContextReferences.type - schemas.GoogleCloudDialogflowV2beta1IngestContextReferencesResponse.type - schemas.GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse.description - schemas.GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse.id - schemas.GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse.properties.nextPageToken.description - schemas.GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse.properties.nextPageToken.type - schemas.GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse.properties.phoneNumbers.description - schemas.GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse.properties.phoneNumbers.items.$ref - schemas.GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse.properties.phoneNumbers.type - schemas.GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse.type - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.description - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.id - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.conversationProfile.description - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.conversationProfile.type - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.lifecycleState.description - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.lifecycleState.enum - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.lifecycleState.enumDescriptions - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.lifecycleState.readOnly - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.lifecycleState.type - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.name.description - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.name.type - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.phoneNumber.description - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.phoneNumber.readOnly - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.properties.phoneNumber.type - schemas.GoogleCloudDialogflowV2beta1PhoneNumber.type - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateSuggestionsResponse.$ref - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest.description - schemas.GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest.id - schemas.GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest.type The following keys were changed: - resources.projects.resources.answerRecords.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.answerRecords.methods.list.parameters.filter.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3Page.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3beta1Page.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowV2Message.properties.sendTime.description - schemas.GoogleCloudDialogflowV2beta1AgentAssistantFeedback.properties.documentCorrectness.description - schemas.GoogleCloudDialogflowV2beta1AnalyzeContentRequest.properties.cxCurrentPage.description - schemas.GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest.properties.triggerEvents.items.enum - schemas.GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest.properties.triggerEvents.items.enumDescriptions - schemas.GoogleCloudDialogflowV2beta1Generator.properties.triggerEvent.enum - schemas.GoogleCloudDialogflowV2beta1Generator.properties.triggerEvent.enumDescriptions - schemas.GoogleCloudDialogflowV2beta1Message.properties.sendTime.description - schemas.GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff.description - schemas.GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfig.properties.filterSpecs.description - schemas.GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs.description - schemas.GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec.properties.conditionBoostSpecs.description - schemas.GoogleCloudDialogflowV2beta1SpeechToTextConfig.properties.phraseSets.description - schemas.GoogleCloudDialogflowV2beta1SpeechToTextConfig.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistRequest.properties.previousSuggestedQuery.description - schemas.GoogleCloudDialogflowV2beta1SummarizationSection.properties.type.enum - schemas.GoogleCloudDialogflowV2beta1SummarizationSection.properties.type.enumDescriptions #### dialogflow:v3beta1 The following keys were added: - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.flatPath - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.httpMethod - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.id - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.parameterOrder - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.path - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.request.$ref - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.response.$ref - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.create.scopes - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.flatPath - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.httpMethod - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.id - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameterOrder - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameters.force.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameters.force.location - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameters.force.type - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.path - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.response.$ref - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.delete.scopes - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.flatPath - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.httpMethod - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.id - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.parameterOrder - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.parameters.name.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.parameters.name.location - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.parameters.name.required - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.parameters.name.type - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.path - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.response.$ref - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.get.scopes - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.flatPath - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.httpMethod - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.id - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameterOrder - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.path - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.response.$ref - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.list.scopes - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.flatPath - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.httpMethod - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.id - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.parameterOrder - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.parameters.name.description - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.parameters.name.location - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.parameters.name.pattern - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.parameters.name.required - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.parameters.name.type - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.path - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.request.$ref - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.response.$ref - resources.projects.resources.locations.resources.agents.resources.tools.resources.versions.methods.restore.scopes - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettings.properties.gitConnectionSettings.$ref - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettings.properties.gitConnectionSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.description - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.id - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.accessTokenSecret.description - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.accessTokenSecret.type - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.branches.description - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.branches.items.type - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.branches.type - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.displayName.description - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.displayName.type - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.repositoryUri.description - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.repositoryUri.type - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.trackingBranch.description - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.properties.trackingBranch.type - schemas.GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings.type - schemas.GoogleCloudDialogflowCxV3beta1Handler.description - schemas.GoogleCloudDialogflowCxV3beta1Handler.id - schemas.GoogleCloudDialogflowCxV3beta1Handler.properties.eventHandler.$ref - schemas.GoogleCloudDialogflowCxV3beta1Handler.properties.eventHandler.description - schemas.GoogleCloudDialogflowCxV3beta1Handler.properties.lifecycleHandler.$ref - schemas.GoogleCloudDialogflowCxV3beta1Handler.properties.lifecycleHandler.description - schemas.GoogleCloudDialogflowCxV3beta1Handler.type - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.description - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.id - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.properties.condition.description - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.properties.condition.type - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.properties.event.description - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.properties.event.type - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.properties.fulfillment.$ref - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.properties.fulfillment.description - schemas.GoogleCloudDialogflowCxV3beta1HandlerEventHandler.type - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.description - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.id - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.properties.condition.description - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.properties.condition.type - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.properties.fulfillment.$ref - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.properties.fulfillment.description - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.properties.lifecycleStage.description - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.properties.lifecycleStage.type - schemas.GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler.type - schemas.GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse.properties.nextPageToken.description - schemas.GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse.properties.nextPageToken.type - schemas.GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse.properties.toolVersions.description - schemas.GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse.properties.toolVersions.items.$ref - schemas.GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse.properties.toolVersions.type - schemas.GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1Playbook.properties.handlers.description - schemas.GoogleCloudDialogflowCxV3beta1Playbook.properties.handlers.items.$ref - schemas.GoogleCloudDialogflowCxV3beta1Playbook.properties.handlers.type - schemas.GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest.description - schemas.GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest.id - schemas.GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest.type - schemas.GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse.description - schemas.GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse.id - schemas.GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse.properties.tool.$ref - schemas.GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse.properties.tool.description - schemas.GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse.type - schemas.GoogleCloudDialogflowCxV3beta1Tool.properties.connectorSpec.$ref - schemas.GoogleCloudDialogflowCxV3beta1Tool.properties.connectorSpec.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.id - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.properties.actions.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.properties.actions.items.$ref - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.properties.actions.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.properties.endUserAuthConfig.$ref - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.properties.endUserAuthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.properties.name.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.properties.name.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorTool.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.id - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.connectionActionId.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.connectionActionId.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.entityOperation.$ref - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.entityOperation.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.inputFields.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.inputFields.items.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.inputFields.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.outputFields.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.outputFields.items.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.properties.outputFields.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.id - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.properties.entityId.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.properties.entityId.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.properties.operation.description - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.properties.operation.enum - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.properties.operation.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.properties.operation.type - schemas.GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation.type - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig.id - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig.properties.oauth2AuthCodeConfig.$ref - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig.properties.oauth2AuthCodeConfig.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig.properties.oauth2JwtBearerConfig.$ref - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig.properties.oauth2JwtBearerConfig.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig.type - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig.id - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig.properties.oauthToken.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig.properties.oauthToken.type - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig.type - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.id - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.properties.clientKey.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.properties.clientKey.type - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.properties.issuer.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.properties.issuer.type - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.properties.subject.description - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.properties.subject.type - schemas.GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig.type - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.description - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.id - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.createTime.description - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.createTime.format - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.createTime.readOnly - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.createTime.type - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.displayName.description - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.displayName.type - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.name.description - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.name.type - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.tool.$ref - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.tool.description - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.updateTime.description - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.updateTime.format - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.updateTime.readOnly - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.properties.updateTime.type - schemas.GoogleCloudDialogflowCxV3beta1ToolVersion.type - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.description - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.id - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.properties.response.description - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.properties.response.type - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.items.$ref - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.$ref - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.type - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.id - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.freeFormSuggestion.$ref - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.freeFormSuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.summarySuggestion.$ref - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.summarySuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.type - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateSuggestionsResponse.$ref - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.id - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.items.$ref - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.type - schemas.GoogleCloudDialogflowV2SummarySuggestion.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.id - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.section.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.section.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.summary.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.summary.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.type - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.id - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.properties.response.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.properties.response.type - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.items.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.type - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.id - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.freeFormSuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.freeFormSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.summarySuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.summarySuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.type - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateSuggestionsResponse.$ref - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.id - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.items.$ref - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.id - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.section.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.section.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.summary.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.summary.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.type The following keys were changed: - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3Page.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3beta1BoostSpec.properties.conditionBoostSpecs.description - schemas.GoogleCloudDialogflowCxV3beta1Flow.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3beta1Page.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3beta1SearchConfig.properties.boostSpecs.description - schemas.GoogleCloudDialogflowCxV3beta1SearchConfig.properties.filterSpecs.description - schemas.GoogleCloudDialogflowCxV3beta1ToolTLSConfigCACert.properties.cert.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowV2Message.properties.sendTime.description - schemas.GoogleCloudDialogflowV2beta1Message.properties.sendTime.description - schemas.GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff.description #### dialogflow:v2 The following keys were deleted: - resources.projects.resources.answerRecords.methods.list.parameters.filter.deprecated - resources.projects.resources.locations.resources.answerRecords.methods.list.parameters.filter.deprecated The following keys were added: - resources.projects.resources.conversations.resources.suggestions.methods.generate.description - resources.projects.resources.conversations.resources.suggestions.methods.generate.flatPath - resources.projects.resources.conversations.resources.suggestions.methods.generate.httpMethod - resources.projects.resources.conversations.resources.suggestions.methods.generate.id - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameterOrder - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.description - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.location - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.pattern - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.required - resources.projects.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.type - resources.projects.resources.conversations.resources.suggestions.methods.generate.path - resources.projects.resources.conversations.resources.suggestions.methods.generate.request.$ref - resources.projects.resources.conversations.resources.suggestions.methods.generate.response.$ref - resources.projects.resources.conversations.resources.suggestions.methods.generate.scopes - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.description - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.flatPath - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.httpMethod - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.id - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameterOrder - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.description - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.location - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.pattern - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.required - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.parameters.conversation.type - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.path - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.request.$ref - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.response.$ref - resources.projects.resources.locations.resources.conversations.methods.ingestContextReferences.scopes - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.description - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.flatPath - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.httpMethod - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.id - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameterOrder - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.description - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.location - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.pattern - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.required - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.parameters.conversation.type - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.path - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.request.$ref - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.response.$ref - resources.projects.resources.locations.resources.conversations.resources.suggestions.methods.generate.scopes - schemas.GoogleCloudDialogflowV2Conversation.properties.ingestedContextReferences.additionalProperties.$ref - schemas.GoogleCloudDialogflowV2Conversation.properties.ingestedContextReferences.description - schemas.GoogleCloudDialogflowV2Conversation.properties.ingestedContextReferences.readOnly - schemas.GoogleCloudDialogflowV2Conversation.properties.ingestedContextReferences.type - schemas.GoogleCloudDialogflowV2ConversationContextReference.description - schemas.GoogleCloudDialogflowV2ConversationContextReference.id - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.contextContents.description - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.contextContents.items.$ref - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.contextContents.type - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.createTime.description - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.createTime.format - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.createTime.readOnly - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.createTime.type - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.languageCode.description - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.languageCode.type - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.updateMode.description - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.updateMode.enum - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.updateMode.enumDescriptions - schemas.GoogleCloudDialogflowV2ConversationContextReference.properties.updateMode.type - schemas.GoogleCloudDialogflowV2ConversationContextReference.type - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.description - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.id - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.content.description - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.content.type - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.contentFormat.description - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.contentFormat.enum - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.contentFormat.enumDescriptions - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.contentFormat.type - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.ingestionTime.description - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.ingestionTime.format - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.ingestionTime.readOnly - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.properties.ingestionTime.type - schemas.GoogleCloudDialogflowV2ConversationContextReferenceContextContent.type - schemas.GoogleCloudDialogflowV2FreeFormContext.description - schemas.GoogleCloudDialogflowV2FreeFormContext.id - schemas.GoogleCloudDialogflowV2FreeFormContext.properties.text.description - schemas.GoogleCloudDialogflowV2FreeFormContext.properties.text.type - schemas.GoogleCloudDialogflowV2FreeFormContext.type - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.description - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.id - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.properties.response.description - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.properties.response.type - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.type - schemas.GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest.properties.contextReferences.additionalProperties.$ref - schemas.GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest.properties.contextReferences.description - schemas.GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest.properties.contextReferences.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.properties.triggerEvents.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.properties.triggerEvents.items.enum - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.properties.triggerEvents.items.enumDescriptions - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.properties.triggerEvents.items.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.properties.triggerEvents.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsRequest.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.items.$ref - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.$ref - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.type - schemas.GoogleCloudDialogflowV2Generator.properties.freeFormContext.$ref - schemas.GoogleCloudDialogflowV2Generator.properties.freeFormContext.description - schemas.GoogleCloudDialogflowV2Generator.properties.publishedModel.description - schemas.GoogleCloudDialogflowV2Generator.properties.publishedModel.type - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.freeFormSuggestion.$ref - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.freeFormSuggestion.description - schemas.GoogleCloudDialogflowV2IngestContextReferencesRequest.description - schemas.GoogleCloudDialogflowV2IngestContextReferencesRequest.id - schemas.GoogleCloudDialogflowV2IngestContextReferencesRequest.properties.contextReferences.additionalProperties.$ref - schemas.GoogleCloudDialogflowV2IngestContextReferencesRequest.properties.contextReferences.description - schemas.GoogleCloudDialogflowV2IngestContextReferencesRequest.properties.contextReferences.type - schemas.GoogleCloudDialogflowV2IngestContextReferencesRequest.type - schemas.GoogleCloudDialogflowV2IngestContextReferencesResponse.description - schemas.GoogleCloudDialogflowV2IngestContextReferencesResponse.id - schemas.GoogleCloudDialogflowV2IngestContextReferencesResponse.properties.ingestedContextReferences.additionalProperties.$ref - schemas.GoogleCloudDialogflowV2IngestContextReferencesResponse.properties.ingestedContextReferences.description - schemas.GoogleCloudDialogflowV2IngestContextReferencesResponse.properties.ingestedContextReferences.type - schemas.GoogleCloudDialogflowV2IngestContextReferencesResponse.type - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateSuggestionsResponse.$ref - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.id - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.properties.response.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.properties.response.type - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.items.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.type - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.id - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.freeFormSuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.freeFormSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.summarySuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.summarySuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.type - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateSuggestionsResponse.$ref - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.id - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.items.$ref - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.id - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.section.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.section.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.summary.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.summary.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.type The following keys were changed: - resources.projects.resources.answerRecords.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.answerRecords.methods.list.parameters.filter.description - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3Page.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3beta1Page.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowV2AgentAssistantFeedback.properties.documentCorrectness.description - schemas.GoogleCloudDialogflowV2ConversationModelEvaluation.properties.rawHumanEvalTemplateCsv.description - schemas.GoogleCloudDialogflowV2EvaluationConfig.properties.smartComposeConfig.description - schemas.GoogleCloudDialogflowV2EvaluationConfig.properties.smartReplyConfig.description - schemas.GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest.properties.triggerEvents.items.enum - schemas.GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest.properties.triggerEvents.items.enumDescriptions - schemas.GoogleCloudDialogflowV2Generator.properties.triggerEvent.enum - schemas.GoogleCloudDialogflowV2Generator.properties.triggerEvent.enumDescriptions - schemas.GoogleCloudDialogflowV2Message.properties.sendTime.description - schemas.GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig.properties.boostSpecs.description - schemas.GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig.properties.filterSpecs.description - schemas.GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec.properties.conditionBoostSpecs.description - schemas.GoogleCloudDialogflowV2SpeechToTextConfig.properties.phraseSets.description - schemas.GoogleCloudDialogflowV2SpeechToTextConfig.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest.properties.previousSuggestedQuery.description - schemas.GoogleCloudDialogflowV2SummarizationSection.properties.type.enum - schemas.GoogleCloudDialogflowV2SummarizationSection.properties.type.enumDescriptions - schemas.GoogleCloudDialogflowV2beta1Message.properties.sendTime.description - schemas.GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff.description #### dialogflow:v3 The following keys were added: - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.description - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.id - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.properties.response.description - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.properties.response.type - schemas.GoogleCloudDialogflowV2FreeFormSuggestion.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.items.$ref - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponse.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.id - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.$ref - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.description - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.type - schemas.GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer.type - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.id - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.freeFormSuggestion.$ref - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.freeFormSuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.summarySuggestion.$ref - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.properties.summarySuggestion.description - schemas.GoogleCloudDialogflowV2GeneratorSuggestion.type - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateSuggestionsResponse.$ref - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.id - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.description - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.items.$ref - schemas.GoogleCloudDialogflowV2SummarySuggestion.properties.summarySections.type - schemas.GoogleCloudDialogflowV2SummarySuggestion.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.id - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.section.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.section.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.summary.description - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.properties.summary.type - schemas.GoogleCloudDialogflowV2SummarySuggestionSummarySection.type - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.id - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.properties.response.description - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.properties.response.type - schemas.GoogleCloudDialogflowV2beta1FreeFormSuggestion.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.items.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.generatorSuggestionAnswers.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.latestMessage.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.properties.latestMessage.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.id - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.answerRecord.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.generatorSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.description - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.properties.sourceGenerator.type - schemas.GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer.type - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.id - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.freeFormSuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.freeFormSuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.summarySuggestion.$ref - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.properties.summarySuggestion.description - schemas.GoogleCloudDialogflowV2beta1GeneratorSuggestion.type - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateSuggestionsResponse.$ref - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateSuggestionsResponse.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.id - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.items.$ref - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.properties.summarySections.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestion.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.id - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.section.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.section.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.summary.description - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.properties.summary.type - schemas.GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection.type The following keys were changed: - schemas.GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3BoostSpec.properties.conditionBoostSpecs.description - schemas.GoogleCloudDialogflowCxV3Flow.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3Page.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3SearchConfig.properties.boostSpecs.description - schemas.GoogleCloudDialogflowCxV3SearchConfig.properties.filterSpecs.description - schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings.properties.useTimeoutBasedEndpointing.description - schemas.GoogleCloudDialogflowCxV3beta1Page.properties.transitionRoutes.description - schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig.properties.clientSecret.description - schemas.GoogleCloudDialogflowV2Message.properties.sendTime.description - schemas.GoogleCloudDialogflowV2beta1Message.properties.sendTime.description - schemas.GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff.description --- discovery/dialogflow-v2.json | 472 +++++++- discovery/dialogflow-v2beta1.json | 799 ++++++++++++- discovery/dialogflow-v3.json | 220 +++- discovery/dialogflow-v3beta1.json | 671 ++++++++++- src/apis/dialogflow/v2.ts | 598 +++++++++- src/apis/dialogflow/v2beta1.ts | 1764 ++++++++++++++++++++++++++--- src/apis/dialogflow/v3.ts | 182 ++- src/apis/dialogflow/v3beta1.ts | 956 +++++++++++++++- 8 files changed, 5392 insertions(+), 270 deletions(-) diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index bf0f3d91140..0ccabe378ae 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -2613,8 +2613,7 @@ ], "parameters": { "filter": { - "deprecated": true, - "description": "Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160).", + "description": "Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * `conversation_id=bar` matches answer records in the `projects/foo/locations/global/conversations/bar` conversation (assuming the parent is `projects/foo/locations/global`). For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, @@ -3708,6 +3707,35 @@ }, "suggestions": { "methods": { + "generate": { + "description": "Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched.", + "flatPath": "v2/projects/{projectsId}/conversations/{conversationsId}/suggestions:generate", + "httpMethod": "POST", + "id": "dialogflow.projects.conversations.suggestions.generate", + "parameterOrder": [ + "conversation" + ], + "parameters": { + "conversation": { + "description": "Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.", + "location": "path", + "pattern": "^projects/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+conversation}/suggestions:generate", + "request": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "searchKnowledge": { "description": "Get answers for the given query based on knowledge documents.", "flatPath": "v2/projects/{projectsId}/conversations/{conversationsId}/suggestions:searchKnowledge", @@ -6502,8 +6530,7 @@ ], "parameters": { "filter": { - "deprecated": true, - "description": "Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160).", + "description": "Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * `conversation_id=bar` matches answer records in the `projects/foo/locations/global/conversations/bar` conversation (assuming the parent is `projects/foo/locations/global`). For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, @@ -7307,6 +7334,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "ingestContextReferences": { + "description": "Data ingestion API. Ingests context references for an existing conversation.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:ingestContextReferences", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.conversations.ingestContextReferences", + "parameterOrder": [ + "conversation" + ], + "parameters": { + "conversation": { + "description": "Required. Resource identifier of the conversation to ingest context information for. Format: `projects//locations//conversations/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+conversation}:ingestContextReferences", + "request": { + "$ref": "GoogleCloudDialogflowV2IngestContextReferencesRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2IngestContextReferencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all conversations in the specified project.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/conversations", @@ -7681,6 +7737,35 @@ }, "suggestions": { "methods": { + "generate": { + "description": "Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/suggestions:generate", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.conversations.suggestions.generate", + "parameterOrder": [ + "conversation" + ], + "parameters": { + "conversation": { + "description": "Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+conversation}/suggestions:generate", + "request": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "searchKnowledge": { "description": "Get answers for the given query based on knowledge documents.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/suggestions:searchKnowledge", @@ -8714,7 +8799,7 @@ } } }, - "revision": "20250121", + "revision": "20250310", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8811,7 +8896,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -9978,7 +10063,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "items": { "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" }, @@ -10800,7 +10885,7 @@ "type": "string" }, "clientSecret": { - "description": "Required. The client secret provided by the 3rd party platform.", + "description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -11133,7 +11218,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -12300,7 +12385,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute" }, @@ -13175,7 +13260,7 @@ "type": "string" }, "clientSecret": { - "description": "Required. The client secret provided by the 3rd party platform.", + "description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -13533,7 +13618,7 @@ "type": "string" }, "documentCorrectness": { - "description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * [document_correctness]: INCORRECT", + "description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * document_correctness: INCORRECT", "enum": [ "DOCUMENT_CORRECTNESS_UNSPECIFIED", "INCORRECT", @@ -14302,6 +14387,14 @@ "readOnly": true, "type": "string" }, + "ingestedContextReferences": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2ConversationContextReference" + }, + "description": "Output only. The context reference updates provided by external systems.", + "readOnly": true, + "type": "object" + }, "lifecycleState": { "description": "Output only. The current state of the Conversation.", "enum": [ @@ -14355,6 +14448,75 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2ConversationContextReference": { + "description": "Represents a section of ingested context information.", + "id": "GoogleCloudDialogflowV2ConversationContextReference", + "properties": { + "contextContents": { + "description": "Required. The list of content updates for a context reference.", + "items": { + "$ref": "GoogleCloudDialogflowV2ConversationContextReferenceContextContent" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The time the context reference was first created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "languageCode": { + "description": "Optional. The language of the information ingested, defaults to \"en-US\" if not set.", + "type": "string" + }, + "updateMode": { + "description": "Required. The mode in which context reference contents are updated.", + "enum": [ + "UPDATE_MODE_UNSPECIFIED", + "APPEND", + "OVERWRITE" + ], + "enumDescriptions": [ + "Unspecified update mode.", + "Context content updates are applied in append mode.", + "Context content updates are applied in overwrite mode." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ConversationContextReferenceContextContent": { + "description": "Contents ingested.", + "id": "GoogleCloudDialogflowV2ConversationContextReferenceContextContent", + "properties": { + "content": { + "description": "Required. The information ingested in a single request.", + "type": "string" + }, + "contentFormat": { + "description": "Required. The format of the ingested string.", + "enum": [ + "CONTENT_FORMAT_UNSPECIFIED", + "JSON", + "PLAIN_TEXT" + ], + "enumDescriptions": [ + "Unspecified content format.", + "Content was provided in JSON format.", + "Content was provided as plain text." + ], + "type": "string" + }, + "ingestionTime": { + "description": "Output only. The time when this information was incorporated into the relevant context reference.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2ConversationDataset": { "description": "Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed).", "id": "GoogleCloudDialogflowV2ConversationDataset", @@ -14563,7 +14725,7 @@ "type": "string" }, "rawHumanEvalTemplateCsv": { - "description": "Output only. Human eval template in csv format. It tooks real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: \"Would you send it as the next message of agent?\" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: \"Does the suggestion move the conversation closer to resolution?\" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context.", + "description": "Output only. Human eval template in csv format. It takes real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: \"Would you send it as the next message of agent?\" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: \"Does the suggestion move the conversation closer to resolution?\" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context.", "readOnly": true, "type": "string" }, @@ -15274,11 +15436,11 @@ }, "smartComposeConfig": { "$ref": "GoogleCloudDialogflowV2EvaluationConfigSmartComposeConfig", - "description": "Configuration for smart compose model evalution." + "description": "Configuration for smart compose model evaluation." }, "smartReplyConfig": { "$ref": "GoogleCloudDialogflowV2EvaluationConfigSmartReplyConfig", - "description": "Configuration for smart reply model evalution." + "description": "Configuration for smart reply model evaluation." } }, "type": "object" @@ -15456,6 +15618,28 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2FreeFormContext": { + "description": "Free form generator context that customer can configure.", + "id": "GoogleCloudDialogflowV2FreeFormContext", + "properties": { + "text": { + "description": "Optional. Free form text input to LLM.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2FreeFormSuggestion": { + "description": "Suggestion generated using free form generator.", + "id": "GoogleCloudDialogflowV2FreeFormSuggestion", + "properties": { + "response": { + "description": "Required. Free form suggestion.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2Fulfillment": { "description": "By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).", "id": "GoogleCloudDialogflowV2Fulfillment", @@ -15565,6 +15749,13 @@ "description": "The request message for Conversations.GenerateStatelessSuggestion.", "id": "GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest", "properties": { + "contextReferences": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2ConversationContextReference" + }, + "description": "Optional. A section of ingested context information. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator.", + "type": "object" + }, "conversationContext": { "$ref": "GoogleCloudDialogflowV2ConversationContext", "description": "Optional. Context of the conversation, including transcripts." @@ -15583,12 +15774,16 @@ "enum": [ "TRIGGER_EVENT_UNSPECIFIED", "END_OF_UTTERANCE", - "MANUAL_CALL" + "MANUAL_CALL", + "CUSTOMER_MESSAGE", + "AGENT_MESSAGE" ], "enumDescriptions": [ "Default value for TriggerEvent.", "Triggers when each chat message or voice utterance ends.", - "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions." + "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.", + "Triggers after each customer message only.", + "Triggers after each agent message only." ], "type": "string" }, @@ -15688,6 +15883,75 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2GenerateSuggestionsRequest": { + "description": "The request message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsRequest", + "properties": { + "latestMessage": { + "description": "Optional. The name of the latest conversation message for which the request is triggered. Format: `projects//locations//conversations//messages/`.", + "type": "string" + }, + "triggerEvents": { + "description": "Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered.", + "items": { + "enum": [ + "TRIGGER_EVENT_UNSPECIFIED", + "END_OF_UTTERANCE", + "MANUAL_CALL", + "CUSTOMER_MESSAGE", + "AGENT_MESSAGE" + ], + "enumDescriptions": [ + "Default value for TriggerEvent.", + "Triggers when each chat message or voice utterance ends.", + "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.", + "Triggers after each customer message only.", + "Triggers after each agent message only." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GenerateSuggestionsResponse": { + "description": "The response message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", + "properties": { + "generatorSuggestionAnswers": { + "description": "The answers generated for the conversation based on context.", + "items": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer": { + "description": "A GeneratorSuggestion answer.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer", + "properties": { + "answerRecord": { + "description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.", + "type": "string" + }, + "generatorSuggestion": { + "$ref": "GoogleCloudDialogflowV2GeneratorSuggestion", + "description": "Suggestion details." + }, + "sourceGenerator": { + "description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2Generator": { "description": "LLM generator.", "id": "GoogleCloudDialogflowV2Generator", @@ -15702,6 +15966,10 @@ "description": "Optional. Human readable description of the generator.", "type": "string" }, + "freeFormContext": { + "$ref": "GoogleCloudDialogflowV2FreeFormContext", + "description": "Input of free from generator to LLM." + }, "inferenceParameter": { "$ref": "GoogleCloudDialogflowV2InferenceParameter", "description": "Optional. Inference parameters for this generator." @@ -15711,6 +15979,10 @@ "readOnly": true, "type": "string" }, + "publishedModel": { + "description": "Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.", + "type": "string" + }, "summarizationContext": { "$ref": "GoogleCloudDialogflowV2SummarizationContext", "description": "Input of prebuilt Summarization feature." @@ -15720,12 +15992,16 @@ "enum": [ "TRIGGER_EVENT_UNSPECIFIED", "END_OF_UTTERANCE", - "MANUAL_CALL" + "MANUAL_CALL", + "CUSTOMER_MESSAGE", + "AGENT_MESSAGE" ], "enumDescriptions": [ "Default value for TriggerEvent.", "Triggers when each chat message or voice utterance ends.", - "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions." + "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.", + "Triggers after each customer message only.", + "Triggers after each agent message only." ], "type": "string" }, @@ -15742,6 +16018,10 @@ "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2GeneratorSuggestion", "properties": { + "freeFormSuggestion": { + "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", + "description": "Optional. Free form suggestion." + }, "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2SummarySuggestion", "description": "Optional. Suggested summary." @@ -16288,6 +16568,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2IngestContextReferencesRequest": { + "description": "The request message for ConversationsService.IngestContextReferences.", + "id": "GoogleCloudDialogflowV2IngestContextReferencesRequest", + "properties": { + "contextReferences": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2ConversationContextReference" + }, + "description": "Required. The context references to ingest. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IngestContextReferencesResponse": { + "description": "The response message for ConversationsService.IngestContextReferences.", + "id": "GoogleCloudDialogflowV2IngestContextReferencesResponse", + "properties": { + "ingestedContextReferences": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2ConversationContextReference" + }, + "description": "All context references ingested.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", @@ -17905,7 +18213,7 @@ "type": "string" }, "sendTime": { - "description": "Optional. The time when the message was sent.", + "description": "Optional. The time when the message was sent. For voice messages, this is the time when an utterance started.", "format": "google-datetime", "type": "string" }, @@ -18465,14 +18773,14 @@ "id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig", "properties": { "boostSpecs": { - "description": "Optional. Boost specifications for data stores.", + "description": "Optional. Boost specifications for data stores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.", "items": { "$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecs" }, "type": "array" }, "filterSpecs": { - "description": "Optional. Filter specification for data store queries.", + "description": "Optional. Filter specification for data store queries. TMaps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.", "items": { "$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigFilterSpecs" }, @@ -18507,7 +18815,7 @@ "id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Optional. 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.", + "description": "Optional. Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { "$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec" }, @@ -18928,7 +19236,7 @@ "type": "string" }, "phraseSets": { - "description": "List of names of Cloud Speech phrase sets that are used for transcription.", + "description": "List of names of Cloud Speech phrase sets that are used for transcription. For phrase set limitations, please refer to [Cloud Speech API quotas and limits](https://cloud.google.com/speech-to-text/quotas#content).", "items": { "type": "string" }, @@ -18956,7 +19264,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -19204,7 +19512,7 @@ "type": "string" }, "previousSuggestedQuery": { - "description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", + "description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", "type": "string" } }, @@ -19323,6 +19631,10 @@ "$ref": "GoogleRpcStatus", "description": "Error status if the request failed." }, + "generateSuggestionsResponse": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", + "description": "Suggestions generated using generators triggered by customer or agent messages." + }, "suggestArticlesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." @@ -19393,7 +19705,9 @@ "REASON_FOR_CANCELLATION", "CUSTOMER_SATISFACTION", "ENTITIES", - "CUSTOMER_DEFINED" + "CUSTOMER_DEFINED", + "SITUATION_CONCISE", + "ACTION_CONCISE" ], "enumDescriptions": [ "Undefined section type, does not return anything.", @@ -19403,7 +19717,9 @@ "Reason for cancellation if the customer requests for a cancellation. \"N/A\" otherwise. Section name: \"reason_for_cancellation\".", "\"Unsatisfied\" or \"Satisfied\" depending on the customer's feelings at the end of the conversation. Section name: \"customer_satisfaction\".", "Key entities extracted from the conversation, such as ticket number, order number, dollar amount, etc. Section names are prefixed by \"entities/\".", - "Customer defined sections." + "Customer defined sections.", + "Concise version of the situation section. This type is only available if type SITUATION is not selected.", + "Concise version of the action section. This type is only available if type ACTION is not selected." ], "type": "string" } @@ -20163,6 +20479,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1FreeFormSuggestion": { + "description": "Suggestion generated using free form generator.", + "id": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", + "properties": { + "response": { + "description": "Required. Free form suggestion.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1GcsDestination": { "description": "Google Cloud Storage location for the output.", "id": "GoogleCloudDialogflowV2beta1GcsDestination", @@ -20174,6 +20501,58 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse": { + "description": "The response message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", + "properties": { + "generatorSuggestionAnswers": { + "description": "The answers generated for the conversation based on context.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer": { + "description": "A GeneratorSuggestion answer.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer", + "properties": { + "answerRecord": { + "description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.", + "type": "string" + }, + "generatorSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", + "description": "Suggestion details." + }, + "sourceGenerator": { + "description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorSuggestion": { + "description": "Suggestion generated using a Generator.", + "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", + "properties": { + "freeFormSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", + "description": "Optional. Free form suggestion." + }, + "summarySuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion", + "description": "Optional. Suggested summary." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent": { "description": "Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation.", "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent", @@ -21709,7 +22088,7 @@ "type": "array" }, "sendTime": { - "description": "Optional. The time when the message was sent.", + "description": "Optional. The time when the message was sent. For voice messages, this is the time when an utterance started.", "format": "google-datetime", "type": "string" }, @@ -21899,7 +22278,7 @@ "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.", + "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 Dialogflow 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": { @@ -22322,6 +22701,10 @@ "$ref": "GoogleRpcStatus", "description": "Error status if the request failed." }, + "generateSuggestionsResponse": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", + "description": "Suggestions generated using generators triggered by customer or agent messages." + }, "suggestArticlesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." @@ -22349,6 +22732,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SummarySuggestion": { + "description": "Suggested summary of the conversation.", + "id": "GoogleCloudDialogflowV2beta1SummarySuggestion", + "properties": { + "summarySections": { + "description": "Required. All the parts of generated summary.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection": { + "description": "A component of the generated summary.", + "id": "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection", + "properties": { + "section": { + "description": "Required. Name of the section.", + "type": "string" + }, + "summary": { + "description": "Required. Summary text for the section.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents": { "description": "A wrapper of repeated TelephonyDtmf digits.", "id": "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents", diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index d605795511c..b00d6b25594 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -2645,8 +2645,7 @@ ], "parameters": { "filter": { - "deprecated": true, - "description": "Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160).", + "description": "Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * \"conversation_id=bar\" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, @@ -3497,6 +3496,35 @@ }, "suggestions": { "methods": { + "generate": { + "description": "Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched.", + "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/suggestions:generate", + "httpMethod": "POST", + "id": "dialogflow.projects.conversations.suggestions.generate", + "parameterOrder": [ + "conversation" + ], + "parameters": { + "conversation": { + "description": "Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.", + "location": "path", + "pattern": "^projects/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+conversation}/suggestions:generate", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "searchKnowledge": { "description": "Get answers for the given query based on knowledge documents.", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/suggestions:searchKnowledge", @@ -6294,8 +6322,7 @@ ], "parameters": { "filter": { - "deprecated": true, - "description": "Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160).", + "description": "Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * \"conversation_id=bar\" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, @@ -6670,6 +6697,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "ingestContextReferences": { + "description": "Data ingestion API. Ingests context references for an existing conversation.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:ingestContextReferences", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.conversations.ingestContextReferences", + "parameterOrder": [ + "conversation" + ], + "parameters": { + "conversation": { + "description": "Required. Resource identifier of the conversation to ingest context information for. Format: `projects//locations//conversations/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+conversation}:ingestContextReferences", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1IngestContextReferencesRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1IngestContextReferencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all conversations in the specified project.", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations", @@ -7073,6 +7129,35 @@ }, "suggestions": { "methods": { + "generate": { + "description": "Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/suggestions:generate", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.conversations.suggestions.generate", + "parameterOrder": [ + "conversation" + ], + "parameters": { + "conversation": { + "description": "Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+conversation}/suggestions:generate", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "searchKnowledge": { "description": "Get answers for the given query based on knowledge documents.", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/suggestions:searchKnowledge", @@ -7822,6 +7907,142 @@ } } }, + "phoneNumbers": { + "methods": { + "delete": { + "description": "Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/phoneNumbers/{phoneNumbersId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.phoneNumbers.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/phoneNumbers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all phone numbers in the specified project.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/phoneNumbers", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.phoneNumbers.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. Format: `projects//locations/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v2beta1/{+parent}/phoneNumbers", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified `PhoneNumber`.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/phoneNumbers/{phoneNumbersId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.phoneNumbers.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/phoneNumbers/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "undelete": { + "description": "Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED state.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/phoneNumbers/{phoneNumbersId}:undelete", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.phoneNumbers.undelete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/phoneNumbers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}:undelete", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, "sipTrunks": { "methods": { "create": { @@ -8174,6 +8395,142 @@ } } }, + "phoneNumbers": { + "methods": { + "delete": { + "description": "Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state.", + "flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.phoneNumbers.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", + "location": "path", + "pattern": "^projects/[^/]+/phoneNumbers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all phone numbers in the specified project.", + "flatPath": "v2beta1/projects/{projectsId}/phoneNumbers", + "httpMethod": "GET", + "id": "dialogflow.projects.phoneNumbers.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. Format: `projects//locations/`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v2beta1/{+parent}/phoneNumbers", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified `PhoneNumber`.", + "flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}", + "httpMethod": "PATCH", + "id": "dialogflow.projects.phoneNumbers.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", + "location": "path", + "pattern": "^projects/[^/]+/phoneNumbers/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "undelete": { + "description": "Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED state.", + "flatPath": "v2beta1/projects/{projectsId}/phoneNumbers/{phoneNumbersId}:undelete", + "httpMethod": "POST", + "id": "dialogflow.projects.phoneNumbers.undelete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", + "location": "path", + "pattern": "^projects/[^/]+/phoneNumbers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}:undelete", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, "suggestions": { "methods": { "generateStatelessSummary": { @@ -8239,7 +8596,7 @@ } } }, - "revision": "20250121", + "revision": "20250310", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8336,7 +8693,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -9503,7 +9860,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "items": { "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" }, @@ -10325,7 +10682,7 @@ "type": "string" }, "clientSecret": { - "description": "Required. The client secret provided by the 3rd party platform.", + "description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -10658,7 +11015,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -11825,7 +12182,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute" }, @@ -12700,7 +13057,7 @@ "type": "string" }, "clientSecret": { - "description": "Required. The client secret provided by the 3rd party platform.", + "description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -13544,6 +13901,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2FreeFormSuggestion": { + "description": "Suggestion generated using free form generator.", + "id": "GoogleCloudDialogflowV2FreeFormSuggestion", + "properties": { + "response": { + "description": "Required. Free form suggestion.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2GcsDestination": { "description": "Google Cloud Storage location for the output.", "id": "GoogleCloudDialogflowV2GcsDestination", @@ -13555,6 +13923,58 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2GenerateSuggestionsResponse": { + "description": "The response message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", + "properties": { + "generatorSuggestionAnswers": { + "description": "The answers generated for the conversation based on context.", + "items": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer": { + "description": "A GeneratorSuggestion answer.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer", + "properties": { + "answerRecord": { + "description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.", + "type": "string" + }, + "generatorSuggestion": { + "$ref": "GoogleCloudDialogflowV2GeneratorSuggestion", + "description": "Suggestion details." + }, + "sourceGenerator": { + "description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorSuggestion": { + "description": "Suggestion generated using a Generator.", + "id": "GoogleCloudDialogflowV2GeneratorSuggestion", + "properties": { + "freeFormSuggestion": { + "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", + "description": "Optional. Free form suggestion." + }, + "summarySuggestion": { + "$ref": "GoogleCloudDialogflowV2SummarySuggestion", + "description": "Optional. Suggested summary." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2HumanAgentAssistantEvent": { "description": "Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.", "id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent", @@ -14763,7 +15183,7 @@ "type": "string" }, "sendTime": { - "description": "Optional. The time when the message was sent.", + "description": "Optional. The time when the message was sent. For voice messages, this is the time when an utterance started.", "format": "google-datetime", "type": "string" }, @@ -15237,6 +15657,10 @@ "$ref": "GoogleRpcStatus", "description": "Error status if the request failed." }, + "generateSuggestionsResponse": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", + "description": "Suggestions generated using generators triggered by customer or agent messages." + }, "suggestArticlesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." @@ -15256,6 +15680,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2SummarySuggestion": { + "description": "Suggested summary of the conversation.", + "id": "GoogleCloudDialogflowV2SummarySuggestion", + "properties": { + "summarySections": { + "description": "Required. All the parts of generated summary.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarySuggestionSummarySection" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarySuggestionSummarySection": { + "description": "A component of the generated summary.", + "id": "GoogleCloudDialogflowV2SummarySuggestionSummarySection", + "properties": { + "section": { + "description": "Required. Name of the section.", + "type": "string" + }, + "summary": { + "description": "Required. Summary text for the section.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "description": "Metadata for a ConversationModels.UndeployConversationModel operation.", "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", @@ -15462,7 +15915,7 @@ "type": "string" }, "documentCorrectness": { - "description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * [document_correctness]: INCORRECT", + "description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * document_correctness: INCORRECT", "enum": [ "DOCUMENT_CORRECTNESS_UNSPECIFIED", "INCORRECT", @@ -15603,7 +16056,7 @@ "description": "The natural language speech audio to be processed." }, "cxCurrentPage": { - "description": "The unique identifier of the CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent.", + "description": "The unique identifier of the Dialogflow CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent.", "type": "string" }, "cxParameters": { @@ -16427,6 +16880,14 @@ "readOnly": true, "type": "string" }, + "ingestedContextReferences": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2beta1ConversationContextReference" + }, + "description": "Output only. The context reference updates provided by external systems.", + "readOnly": true, + "type": "object" + }, "lifecycleState": { "description": "Output only. The current state of the Conversation.", "enum": [ @@ -16480,6 +16941,75 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ConversationContextReference": { + "description": "Represents a piece of ingested context information.", + "id": "GoogleCloudDialogflowV2beta1ConversationContextReference", + "properties": { + "contextContents": { + "description": "Required. The list of content updates for a context reference.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The time the context reference was first created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "languageCode": { + "description": "Optional. The language of the information ingested, defaults to \"en-US\" if not set.", + "type": "string" + }, + "updateMode": { + "description": "Required. The mode in which context reference contents are updated.", + "enum": [ + "UPDATE_MODE_UNSPECIFIED", + "APPEND", + "OVERWRITE" + ], + "enumDescriptions": [ + "Unspecified update mode.", + "Context content updates are applied in append mode.", + "Context content updates are applied in overwrite mode." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent": { + "description": "Contents ingested.", + "id": "GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent", + "properties": { + "content": { + "description": "Required. The information ingested in a single request.", + "type": "string" + }, + "contentFormat": { + "description": "Required. The format of the ingested string.", + "enum": [ + "CONTENT_FORMAT_UNSPECIFIED", + "JSON", + "PLAIN_TEXT" + ], + "enumDescriptions": [ + "Unspecified content format.", + "Content was provided in JSON format.", + "Content was provided as plain text." + ], + "type": "string" + }, + "ingestionTime": { + "description": "Output only. The time when this information was incorporated into the relevant context reference.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1ConversationEvent": { "description": "Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.", "id": "GoogleCloudDialogflowV2beta1ConversationEvent", @@ -17218,6 +17748,28 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1FreeFormContext": { + "description": "Free form generator context that customer can configure.", + "id": "GoogleCloudDialogflowV2beta1FreeFormContext", + "properties": { + "text": { + "description": "Optional. Free form text input to LLM.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1FreeFormSuggestion": { + "description": "Suggestion generated using free form generator.", + "id": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", + "properties": { + "response": { + "description": "Required. Free form suggestion.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Fulfillment": { "description": "By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).", "id": "GoogleCloudDialogflowV2beta1Fulfillment", @@ -17338,6 +17890,13 @@ "description": "The request message for Conversations.GenerateStatelessSuggestion.", "id": "GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest", "properties": { + "contextReferences": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2beta1ConversationContextReference" + }, + "description": "Optional. A section of ingested context information. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator.", + "type": "object" + }, "conversationContext": { "$ref": "GoogleCloudDialogflowV2beta1ConversationContext", "description": "Optional. Context of the conversation, including transcripts." @@ -17356,12 +17915,16 @@ "enum": [ "TRIGGER_EVENT_UNSPECIFIED", "END_OF_UTTERANCE", - "MANUAL_CALL" + "MANUAL_CALL", + "CUSTOMER_MESSAGE", + "AGENT_MESSAGE" ], "enumDescriptions": [ "Default value for TriggerEvent.", "Triggers when each chat message or voice utterance ends.", - "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions." + "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.", + "Triggers after each customer message only.", + "Triggers after each agent message only." ], "type": "string" }, @@ -17461,6 +18024,75 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest": { + "description": "The request message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest", + "properties": { + "latestMessage": { + "description": "Optional. The name of the latest conversation message for which the request is triggered. Format: `projects//locations//conversations//messages/`.", + "type": "string" + }, + "triggerEvents": { + "description": "Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered.", + "items": { + "enum": [ + "TRIGGER_EVENT_UNSPECIFIED", + "END_OF_UTTERANCE", + "MANUAL_CALL", + "CUSTOMER_MESSAGE", + "AGENT_MESSAGE" + ], + "enumDescriptions": [ + "Default value for TriggerEvent.", + "Triggers when each chat message or voice utterance ends.", + "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.", + "Triggers after each customer message only.", + "Triggers after each agent message only." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse": { + "description": "The response message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", + "properties": { + "generatorSuggestionAnswers": { + "description": "The answers generated for the conversation based on context.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer": { + "description": "A GeneratorSuggestion answer.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer", + "properties": { + "answerRecord": { + "description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.", + "type": "string" + }, + "generatorSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", + "description": "Suggestion details." + }, + "sourceGenerator": { + "description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Generator": { "description": "LLM generator.", "id": "GoogleCloudDialogflowV2beta1Generator", @@ -17475,6 +18107,10 @@ "description": "Optional. Human readable description of the generator.", "type": "string" }, + "freeFormContext": { + "$ref": "GoogleCloudDialogflowV2beta1FreeFormContext", + "description": "Input of free from generator to LLM." + }, "inferenceParameter": { "$ref": "GoogleCloudDialogflowV2beta1InferenceParameter", "description": "Optional. Inference parameters for this generator." @@ -17484,6 +18120,10 @@ "readOnly": true, "type": "string" }, + "publishedModel": { + "description": "Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.", + "type": "string" + }, "summarizationContext": { "$ref": "GoogleCloudDialogflowV2beta1SummarizationContext", "description": "Input of Summarization feature." @@ -17493,12 +18133,16 @@ "enum": [ "TRIGGER_EVENT_UNSPECIFIED", "END_OF_UTTERANCE", - "MANUAL_CALL" + "MANUAL_CALL", + "CUSTOMER_MESSAGE", + "AGENT_MESSAGE" ], "enumDescriptions": [ "Default value for TriggerEvent.", "Triggers when each chat message or voice utterance ends.", - "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions." + "Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.", + "Triggers after each customer message only.", + "Triggers after each agent message only." ], "type": "string" }, @@ -17515,6 +18159,10 @@ "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", "properties": { + "freeFormSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", + "description": "Optional. Free form suggestion." + }, "summarySuggestion": { "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion", "description": "Optional. Suggested summary." @@ -18013,6 +18661,34 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1IngestContextReferencesRequest": { + "description": "The request message for ConversationsService.IngestContextReferences.", + "id": "GoogleCloudDialogflowV2beta1IngestContextReferencesRequest", + "properties": { + "contextReferences": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2beta1ConversationContextReference" + }, + "description": "Required. The context references to ingest. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IngestContextReferencesResponse": { + "description": "The response message for ConversationsService.IngestContextReferences.", + "id": "GoogleCloudDialogflowV2beta1IngestContextReferencesResponse", + "properties": { + "ingestedContextReferences": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowV2beta1ConversationContextReference" + }, + "description": "All context references ingested.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { "description": "Metadata for initializing a location-level encryption specification.", "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", @@ -19832,6 +20508,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse": { + "description": "The response message for PhoneNumbers.ListPhoneNumbers.", + "id": "GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "phoneNumbers": { + "description": "The list of `PhoneNumber` resources. There is a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1PhoneNumber" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse": { "description": "The response message for SessionEntityTypes.ListSessionEntityTypes.", "id": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse", @@ -19973,7 +20667,7 @@ "type": "array" }, "sendTime": { - "description": "Optional. The time when the message was sent.", + "description": "Optional. The time when the message was sent. For voice messages, this is the time when an utterance started.", "format": "google-datetime", "type": "string" }, @@ -20179,6 +20873,41 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1PhoneNumber": { + "description": "Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.", + "id": "GoogleCloudDialogflowV2beta1PhoneNumber", + "properties": { + "conversationProfile": { + "description": "Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`.", + "type": "string" + }, + "lifecycleState": { + "description": "Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days.", + "enum": [ + "LIFECYCLE_STATE_UNSPECIFIED", + "ACTIVE", + "DELETE_REQUESTED" + ], + "enumDescriptions": [ + "This value is never used.", + "Number is active and can receive phone calls.", + "Number is pending deletion, and cannot receive calls." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`.", + "type": "string" + }, + "phoneNumber": { + "description": "Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1QueryInput": { "description": "Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text. 3. An event that specifies which intent to trigger.", "id": "GoogleCloudDialogflowV2beta1QueryInput", @@ -20424,7 +21153,7 @@ "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.", + "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 Dialogflow 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": { @@ -20673,7 +21402,7 @@ "type": "array" }, "filterSpecs": { - "description": "Optional. Filter specification for data store queries.", + "description": "Optional. Filter specification for data store queries. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.", "items": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigFilterSpecs" }, @@ -20683,7 +21412,7 @@ "type": "object" }, "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs": { - "description": "Boost specifications for data stores.", + "description": "Boost specifications for data stores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.", "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs", "properties": { "dataStores": { @@ -20708,7 +21437,7 @@ "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Optional. 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.", + "description": "Optional. Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec" }, @@ -21099,7 +21828,7 @@ "type": "string" }, "phraseSets": { - "description": "List of names of Cloud Speech phrase sets that are used for transcription.", + "description": "List of names of Cloud Speech phrase sets that are used for transcription. For phrase set limitations, please refer to [Cloud Speech API quotas and limits](https://cloud.google.com/speech-to-text/quotas#content).", "items": { "type": "string" }, @@ -21127,7 +21856,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -21426,7 +22155,7 @@ "type": "string" }, "previousSuggestedQuery": { - "description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", + "description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", "type": "string" } }, @@ -21665,6 +22394,10 @@ "$ref": "GoogleRpcStatus", "description": "Error status if the request failed." }, + "generateSuggestionsResponse": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", + "description": "Suggestions generated using generators triggered by customer or agent messages." + }, "suggestArticlesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." @@ -21743,7 +22476,9 @@ "REASON_FOR_CANCELLATION", "CUSTOMER_SATISFACTION", "ENTITIES", - "CUSTOMER_DEFINED" + "CUSTOMER_DEFINED", + "SITUATION_CONCISE", + "ACTION_CONCISE" ], "enumDescriptions": [ "Undefined section type, does not return anything.", @@ -21753,7 +22488,9 @@ "Reason for cancellation if the customer requests for a cancellation. \"N/A\" otherwise. Section name: \"reason_for_cancellation\".", "\"Unsatisfied\" or \"Satisfied\" depending on the customer's feelings at the end of the conversation. Section name: \"customer_satisfaction\".", "Key entities extracted from the conversation, such as ticket number, order number, dollar amount, etc. Section names are prefixed by \"entities/\".", - "Customer defined sections." + "Customer defined sections.", + "Concise version of the situation section. This type is only available if type SITUATION is not selected.", + "Concise version of the action section. This type is only available if type ACTION is not selected." ], "type": "string" } @@ -21954,6 +22691,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest": { + "description": "The request message for PhoneNumbers.UndeletePhoneNumber.", + "id": "GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudDialogflowV2beta1ValidationError": { "description": "Represents a single validation error.", "id": "GoogleCloudDialogflowV2beta1ValidationError", diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 023a0a2f3c4..1d9aa2ee09a 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -4453,7 +4453,7 @@ } } }, - "revision": "20250121", + "revision": "20250310", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4550,7 +4550,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -4921,7 +4921,7 @@ "id": "GoogleCloudDialogflowCxV3BoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Optional. 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.", + "description": "Optional. Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { "$ref": "GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec" }, @@ -6523,7 +6523,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.", + "description": "A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evaluated in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.", "items": { "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" }, @@ -8167,7 +8167,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "items": { "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" }, @@ -8920,14 +8920,14 @@ "id": "GoogleCloudDialogflowCxV3SearchConfig", "properties": { "boostSpecs": { - "description": "Optional. Boosting configuration for the datastores.", + "description": "Optional. Boosting configuration for the datastores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.", "items": { "$ref": "GoogleCloudDialogflowCxV3BoostSpecs" }, "type": "array" }, "filterSpecs": { - "description": "Optional. Filter configuration for the datastores.", + "description": "Optional. Filter configuration for the datastores. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.", "items": { "$ref": "GoogleCloudDialogflowCxV3FilterSpecs" }, @@ -10041,7 +10041,7 @@ "type": "string" }, "clientSecret": { - "description": "Required. The client secret provided by the 3rd party platform.", + "description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -10374,7 +10374,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -11541,7 +11541,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute" }, @@ -12416,7 +12416,7 @@ "type": "string" }, "clientSecret": { - "description": "Required. The client secret provided by the 3rd party platform.", + "description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -13260,6 +13260,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2FreeFormSuggestion": { + "description": "Suggestion generated using free form generator.", + "id": "GoogleCloudDialogflowV2FreeFormSuggestion", + "properties": { + "response": { + "description": "Required. Free form suggestion.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2GcsDestination": { "description": "Google Cloud Storage location for the output.", "id": "GoogleCloudDialogflowV2GcsDestination", @@ -13271,6 +13282,58 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2GenerateSuggestionsResponse": { + "description": "The response message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", + "properties": { + "generatorSuggestionAnswers": { + "description": "The answers generated for the conversation based on context.", + "items": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer": { + "description": "A GeneratorSuggestion answer.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer", + "properties": { + "answerRecord": { + "description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.", + "type": "string" + }, + "generatorSuggestion": { + "$ref": "GoogleCloudDialogflowV2GeneratorSuggestion", + "description": "Suggestion details." + }, + "sourceGenerator": { + "description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorSuggestion": { + "description": "Suggestion generated using a Generator.", + "id": "GoogleCloudDialogflowV2GeneratorSuggestion", + "properties": { + "freeFormSuggestion": { + "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", + "description": "Optional. Free form suggestion." + }, + "summarySuggestion": { + "$ref": "GoogleCloudDialogflowV2SummarySuggestion", + "description": "Optional. Suggested summary." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2HumanAgentAssistantEvent": { "description": "Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.", "id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent", @@ -14479,7 +14542,7 @@ "type": "string" }, "sendTime": { - "description": "Optional. The time when the message was sent.", + "description": "Optional. The time when the message was sent. For voice messages, this is the time when an utterance started.", "format": "google-datetime", "type": "string" }, @@ -14953,6 +15016,10 @@ "$ref": "GoogleRpcStatus", "description": "Error status if the request failed." }, + "generateSuggestionsResponse": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", + "description": "Suggestions generated using generators triggered by customer or agent messages." + }, "suggestArticlesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." @@ -14972,6 +15039,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2SummarySuggestion": { + "description": "Suggested summary of the conversation.", + "id": "GoogleCloudDialogflowV2SummarySuggestion", + "properties": { + "summarySections": { + "description": "Required. All the parts of generated summary.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarySuggestionSummarySection" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarySuggestionSummarySection": { + "description": "A component of the generated summary.", + "id": "GoogleCloudDialogflowV2SummarySuggestionSummarySection", + "properties": { + "section": { + "description": "Required. Name of the section.", + "type": "string" + }, + "summary": { + "description": "Required. Summary text for the section.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "description": "Metadata for a ConversationModels.UndeployConversationModel operation.", "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", @@ -15455,6 +15551,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1FreeFormSuggestion": { + "description": "Suggestion generated using free form generator.", + "id": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", + "properties": { + "response": { + "description": "Required. Free form suggestion.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1GcsDestination": { "description": "Google Cloud Storage location for the output.", "id": "GoogleCloudDialogflowV2beta1GcsDestination", @@ -15466,6 +15573,58 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse": { + "description": "The response message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", + "properties": { + "generatorSuggestionAnswers": { + "description": "The answers generated for the conversation based on context.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer": { + "description": "A GeneratorSuggestion answer.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer", + "properties": { + "answerRecord": { + "description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.", + "type": "string" + }, + "generatorSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", + "description": "Suggestion details." + }, + "sourceGenerator": { + "description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorSuggestion": { + "description": "Suggestion generated using a Generator.", + "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", + "properties": { + "freeFormSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", + "description": "Optional. Free form suggestion." + }, + "summarySuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion", + "description": "Optional. Suggested summary." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent": { "description": "Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation.", "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent", @@ -17001,7 +17160,7 @@ "type": "array" }, "sendTime": { - "description": "Optional. The time when the message was sent.", + "description": "Optional. The time when the message was sent. For voice messages, this is the time when an utterance started.", "format": "google-datetime", "type": "string" }, @@ -17191,7 +17350,7 @@ "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.", + "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 Dialogflow 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": { @@ -17614,6 +17773,10 @@ "$ref": "GoogleRpcStatus", "description": "Error status if the request failed." }, + "generateSuggestionsResponse": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", + "description": "Suggestions generated using generators triggered by customer or agent messages." + }, "suggestArticlesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." @@ -17641,6 +17804,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SummarySuggestion": { + "description": "Suggested summary of the conversation.", + "id": "GoogleCloudDialogflowV2beta1SummarySuggestion", + "properties": { + "summarySections": { + "description": "Required. All the parts of generated summary.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection": { + "description": "A component of the generated summary.", + "id": "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection", + "properties": { + "section": { + "description": "Required. Name of the section.", + "type": "string" + }, + "summary": { + "description": "Required. Summary text for the section.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents": { "description": "A wrapper of repeated TelephonyDtmf digits.", "id": "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents", diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index eb867ae53ab..4c79e2183d8 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -4479,6 +4479,164 @@ "https://www.googleapis.com/auth/dialogflow" ] } + }, + "resources": { + "versions": { + "methods": { + "create": { + "description": "Creates a version for the specified Tool.", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}/versions", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.tools.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The tool to create a version for. Format: `projects//locations//agents//tools/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+parent}/versions", + "request": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolVersion" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified version of the Tool.", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.tools.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. This field has no effect for Tools not being used. For Tools that are used: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the tool, as well as any references to the tool.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the tool version to delete. Format: `projects//locations//agents//tools//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified version of the Tool.", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.tools.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the tool version. Format: `projects//locations//agents//tools//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "List versions of the specified Tool.", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}/versions", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.tools.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of the tool versions. Format: `projects//locations//agents//tools/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+parent}/versions", + "response": { + "$ref": "GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "restore": { + "description": "Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}/versions/{versionsId}:restore", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.tools.versions.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the tool version. Format: `projects//locations//agents//tools//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+name}:restore", + "request": { + "$ref": "GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } } }, "transitionRouteGroups": { @@ -5185,7 +5343,7 @@ } } }, - "revision": "20250121", + "revision": "20250310", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5282,7 +5440,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -6449,7 +6607,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "items": { "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" }, @@ -7271,7 +7429,7 @@ "type": "string" }, "clientSecret": { - "description": "Required. The client secret provided by the 3rd party platform.", + "description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -7631,7 +7789,7 @@ "type": "string" }, "useTimeoutBasedEndpointing": { - "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", + "description": "Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.", "type": "boolean" } }, @@ -7795,6 +7953,10 @@ "description": "Settings for connecting to Git repository for an agent.", "id": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettings", "properties": { + "gitConnectionSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings", + "description": "Git connection settings." + }, "githubSettings": { "$ref": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGithubSettings", "description": "GitHub settings." @@ -7802,6 +7964,36 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings": { + "description": "Integration settings for a Git service hosted on Cloud Run.", + "id": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings", + "properties": { + "accessTokenSecret": { + "description": "The name of the SecretManager secret version resource storing the git access token. Format: `projects/{project}/secrets/{secret}/versions/{version}`", + "type": "string" + }, + "branches": { + "description": "Optional. List of branches configured for the repository.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. Display name for the repository", + "type": "string" + }, + "repositoryUri": { + "description": "Required. Git server reporitory URI.", + "type": "string" + }, + "trackingBranch": { + "description": "Required. Default branch of the repository.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGithubSettings": { "description": "Settings of integration with GitHub.", "id": "GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGithubSettings", @@ -8036,7 +8228,7 @@ "id": "GoogleCloudDialogflowCxV3beta1BoostSpec", "properties": { "conditionBoostSpecs": { - "description": "Optional. 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.", + "description": "Optional. Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpec" }, @@ -10043,7 +10235,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.", + "description": "A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evaluated in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute" }, @@ -10600,6 +10792,59 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1Handler": { + "description": "Handler can be used to define custom logic to be executed based on the user-specified triggers.", + "id": "GoogleCloudDialogflowCxV3beta1Handler", + "properties": { + "eventHandler": { + "$ref": "GoogleCloudDialogflowCxV3beta1HandlerEventHandler", + "description": "A handler triggered by event." + }, + "lifecycleHandler": { + "$ref": "GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler", + "description": "A handler triggered during specific lifecycle of the playbook execution." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1HandlerEventHandler": { + "description": "A handler that is triggered by the specified event.", + "id": "GoogleCloudDialogflowCxV3beta1HandlerEventHandler", + "properties": { + "condition": { + "description": "Optional. The condition that must be satisfied to trigger this handler.", + "type": "string" + }, + "event": { + "description": "Required. The name of the event that triggers this handler.", + "type": "string" + }, + "fulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "Required. The fulfillment to call when the event occurs." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler": { + "description": "A handler that is triggered on the specific lifecycle_stage of the playbook execution.", + "id": "GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler", + "properties": { + "condition": { + "description": "Optional. The condition that must be satisfied to trigger this handler.", + "type": "string" + }, + "fulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "Required. The fulfillment to call when this handler is triggered." + }, + "lifecycleStage": { + "description": "Required. The name of the lifecycle stage that triggers this handler. Supported values: * `playbook-start` * `pre-action-selection` * `pre-action-execution`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata", @@ -11547,6 +11792,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse": { + "description": "The response message for Tools.ListToolVersions.", + "id": "GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "toolVersions": { + "description": "The list of tool versions. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolVersion" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ListToolsResponse": { "description": "The response message for Tools.ListTools.", "id": "GoogleCloudDialogflowCxV3beta1ListToolsResponse", @@ -11899,7 +12162,7 @@ "type": "array" }, "transitionRoutes": { - "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute" }, @@ -12051,6 +12314,13 @@ "description": "Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.", "type": "string" }, + "handlers": { + "description": "Optional. A list of registered handlers to execute based on the specified triggers.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1Handler" + }, + "type": "array" + }, "inputParameterDefinitions": { "description": "Optional. Defined structured input parameters for this playbook.", "items": { @@ -12812,6 +13082,23 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest": { + "description": "The request message for Tools.RestoreToolVersion.", + "id": "GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse": { + "description": "The response message for Tools.RestoreToolVersion.", + "id": "GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse", + "properties": { + "tool": { + "$ref": "GoogleCloudDialogflowCxV3beta1Tool", + "description": "The updated tool." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1RolloutConfig": { "description": "The configuration for auto rollout.", "id": "GoogleCloudDialogflowCxV3beta1RolloutConfig", @@ -12983,14 +13270,14 @@ "id": "GoogleCloudDialogflowCxV3beta1SearchConfig", "properties": { "boostSpecs": { - "description": "Optional. Boosting configuration for the datastores.", + "description": "Optional. Boosting configuration for the datastores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1BoostSpecs" }, "type": "array" }, "filterSpecs": { - "description": "Optional. Filter configuration for the datastores.", + "description": "Optional. Filter configuration for the datastores. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1FilterSpecs" }, @@ -13484,6 +13771,10 @@ "description": "A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.", "id": "GoogleCloudDialogflowCxV3beta1Tool", "properties": { + "connectorSpec": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolConnectorTool", + "description": "Integration connectors tool specification." + }, "dataStoreSpec": { "$ref": "GoogleCloudDialogflowCxV3beta1ToolDataStoreTool", "description": "Data store search tool specification." @@ -13713,6 +14004,88 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ToolConnectorTool": { + "description": "A ConnectorTool enabling using Integration Connectors Connections as tools.", + "id": "GoogleCloudDialogflowCxV3beta1ToolConnectorTool", + "properties": { + "actions": { + "description": "Required. Actions for the tool to use.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction" + }, + "type": "array" + }, + "endUserAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig", + "description": "Optional. Integration Connectors end-user authentication configuration. If configured, the end-user authentication fields will be passed in the Integration Connectors API request and override the admin, default authentication configured for the Connection. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override" + }, + "name": { + "description": "Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/*/locations/*/connections/*`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction": { + "description": "Configuration of a Connection operation for the tool to use.", + "id": "GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction", + "properties": { + "connectionActionId": { + "description": "ID of a Connection action for the tool to use.", + "type": "string" + }, + "entityOperation": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation", + "description": "Entity operation configuration for the tool to use." + }, + "inputFields": { + "description": "Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.", + "items": { + "type": "string" + }, + "type": "array" + }, + "outputFields": { + "description": "Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation": { + "description": "Entity CRUD operation specification.", + "id": "GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation", + "properties": { + "entityId": { + "description": "Required. ID of the entity.", + "type": "string" + }, + "operation": { + "description": "Required. Operation to perform on the entity.", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "LIST", + "GET", + "CREATE", + "UPDATE", + "DELETE" + ], + "enumDescriptions": [ + "Operation type unspecified. Invalid, ConnectorTool create/update will fail.", + "List operation.", + "Get operation.", + "Create operation.", + "Update operation.", + "Delete operation." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ToolDataStoreTool": { "description": "A DataStoreTool is a way to provide specifications needed to search a list of data stores.", "id": "GoogleCloudDialogflowCxV3beta1ToolDataStoreTool", @@ -13737,6 +14110,51 @@ "properties": {}, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig": { + "description": "End-user authentication configuration used for Connection calls. The field values can either be hardcoded authentication values or the names of [session parameters](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) or [request parameters](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#request-scoped). If parameter names are provided, then those parameters can be used to pass the authentication values dynamically, through `$session.params.param-id` or `$request.payload.param-id`.", + "id": "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig", + "properties": { + "oauth2AuthCodeConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig", + "description": "Oauth 2.0 Authorization Code authentication." + }, + "oauth2JwtBearerConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig", + "description": "JWT Profile Oauth 2.0 Authorization Grant authentication." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig": { + "description": "Oauth 2.0 Authorization Code authentication configuration.", + "id": "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig", + "properties": { + "oauthToken": { + "description": "Required. Oauth token value or parameter name to pass it through.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig": { + "description": "JWT Profile Oauth 2.0 Authorization Grant authentication configuration.", + "id": "GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig", + "properties": { + "clientKey": { + "description": "Required. Client key value or parameter name to pass it through.", + "type": "string" + }, + "issuer": { + "description": "Required. Issuer value or parameter name to pass it through.", + "type": "string" + }, + "subject": { + "description": "Required. Subject value or parameter name to pass it through.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ToolExtensionTool": { "description": "An ExtensionTool is a way to use Vertex Extensions as a tool.", "id": "GoogleCloudDialogflowCxV3beta1ToolExtensionTool", @@ -13824,7 +14242,7 @@ "id": "GoogleCloudDialogflowCxV3beta1ToolTLSConfigCACert", "properties": { "cert": { - "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")", + "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "format": "byte", "type": "string" }, @@ -13871,6 +14289,37 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ToolVersion": { + "description": "Tool version is a snapshot of the tool at certain timestamp.", + "id": "GoogleCloudDialogflowCxV3beta1ToolVersion", + "properties": { + "createTime": { + "description": "Output only. Last time the tool version was created or modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the tool version.", + "type": "string" + }, + "name": { + "description": "Identifier. The unique identifier of the tool version. Format: `projects//locations//agents//tools//versions/`.", + "type": "string" + }, + "tool": { + "$ref": "GoogleCloudDialogflowCxV3beta1Tool", + "description": "Required. Snapshot of the tool to be associated with this version." + }, + "updateTime": { + "description": "Output only. Last time the tool version was created or modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1TrainFlowRequest": { "description": "The request message for Flows.TrainFlow.", "id": "GoogleCloudDialogflowCxV3beta1TrainFlowRequest", @@ -14536,7 +14985,7 @@ "type": "string" }, "clientSecret": { - "description": "Required. The client secret provided by the 3rd party platform.", + "description": "Optional. The client secret provided by the 3rd party platform.", "type": "string" }, "scopes": { @@ -15380,6 +15829,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2FreeFormSuggestion": { + "description": "Suggestion generated using free form generator.", + "id": "GoogleCloudDialogflowV2FreeFormSuggestion", + "properties": { + "response": { + "description": "Required. Free form suggestion.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2GcsDestination": { "description": "Google Cloud Storage location for the output.", "id": "GoogleCloudDialogflowV2GcsDestination", @@ -15391,6 +15851,58 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2GenerateSuggestionsResponse": { + "description": "The response message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", + "properties": { + "generatorSuggestionAnswers": { + "description": "The answers generated for the conversation based on context.", + "items": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer": { + "description": "A GeneratorSuggestion answer.", + "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer", + "properties": { + "answerRecord": { + "description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.", + "type": "string" + }, + "generatorSuggestion": { + "$ref": "GoogleCloudDialogflowV2GeneratorSuggestion", + "description": "Suggestion details." + }, + "sourceGenerator": { + "description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2GeneratorSuggestion": { + "description": "Suggestion generated using a Generator.", + "id": "GoogleCloudDialogflowV2GeneratorSuggestion", + "properties": { + "freeFormSuggestion": { + "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", + "description": "Optional. Free form suggestion." + }, + "summarySuggestion": { + "$ref": "GoogleCloudDialogflowV2SummarySuggestion", + "description": "Optional. Suggested summary." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2HumanAgentAssistantEvent": { "description": "Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.", "id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent", @@ -16599,7 +17111,7 @@ "type": "string" }, "sendTime": { - "description": "Optional. The time when the message was sent.", + "description": "Optional. The time when the message was sent. For voice messages, this is the time when an utterance started.", "format": "google-datetime", "type": "string" }, @@ -17073,6 +17585,10 @@ "$ref": "GoogleRpcStatus", "description": "Error status if the request failed." }, + "generateSuggestionsResponse": { + "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", + "description": "Suggestions generated using generators triggered by customer or agent messages." + }, "suggestArticlesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." @@ -17092,6 +17608,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2SummarySuggestion": { + "description": "Suggested summary of the conversation.", + "id": "GoogleCloudDialogflowV2SummarySuggestion", + "properties": { + "summarySections": { + "description": "Required. All the parts of generated summary.", + "items": { + "$ref": "GoogleCloudDialogflowV2SummarySuggestionSummarySection" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SummarySuggestionSummarySection": { + "description": "A component of the generated summary.", + "id": "GoogleCloudDialogflowV2SummarySuggestionSummarySection", + "properties": { + "section": { + "description": "Required. Name of the section.", + "type": "string" + }, + "summary": { + "description": "Required. Summary text for the section.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "description": "Metadata for a ConversationModels.UndeployConversationModel operation.", "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", @@ -17575,6 +18120,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1FreeFormSuggestion": { + "description": "Suggestion generated using free form generator.", + "id": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", + "properties": { + "response": { + "description": "Required. Free form suggestion.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1GcsDestination": { "description": "Google Cloud Storage location for the output.", "id": "GoogleCloudDialogflowV2beta1GcsDestination", @@ -17586,6 +18142,58 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse": { + "description": "The response message for Conversations.GenerateSuggestions.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", + "properties": { + "generatorSuggestionAnswers": { + "description": "The answers generated for the conversation based on context.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer" + }, + "type": "array" + }, + "latestMessage": { + "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer": { + "description": "A GeneratorSuggestion answer.", + "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer", + "properties": { + "answerRecord": { + "description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.", + "type": "string" + }, + "generatorSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", + "description": "Suggestion details." + }, + "sourceGenerator": { + "description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1GeneratorSuggestion": { + "description": "Suggestion generated using a Generator.", + "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", + "properties": { + "freeFormSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", + "description": "Optional. Free form suggestion." + }, + "summarySuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion", + "description": "Optional. Suggested summary." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent": { "description": "Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation.", "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent", @@ -19121,7 +19729,7 @@ "type": "array" }, "sendTime": { - "description": "Optional. The time when the message was sent.", + "description": "Optional. The time when the message was sent. For voice messages, this is the time when an utterance started.", "format": "google-datetime", "type": "string" }, @@ -19311,7 +19919,7 @@ "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.", + "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 Dialogflow 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": { @@ -19734,6 +20342,10 @@ "$ref": "GoogleRpcStatus", "description": "Error status if the request failed." }, + "generateSuggestionsResponse": { + "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", + "description": "Suggestions generated using generators triggered by customer or agent messages." + }, "suggestArticlesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION." @@ -19761,6 +20373,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SummarySuggestion": { + "description": "Suggested summary of the conversation.", + "id": "GoogleCloudDialogflowV2beta1SummarySuggestion", + "properties": { + "summarySections": { + "description": "Required. All the parts of generated summary.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection": { + "description": "A component of the generated summary.", + "id": "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection", + "properties": { + "section": { + "description": "Required. Name of the section.", + "type": "string" + }, + "summary": { + "description": "Required. Summary text for the section.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents": { "description": "A wrapper of repeated TelephonyDtmf digits.", "id": "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents", diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 3f2d5f9eb1f..48d4525141b 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -204,7 +204,7 @@ export namespace dialogflow_v2 { */ noSpeechTimeout?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -332,7 +332,7 @@ export namespace dialogflow_v2 { */ noSpeechTimeout?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -1195,7 +1195,7 @@ export namespace dialogflow_v2 { */ transitionRouteGroups?: string[] | null; /** - * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3beta1TransitionRoute[]; } @@ -1827,7 +1827,7 @@ export namespace dialogflow_v2 { */ clientId?: string | null; /** - * Required. The client secret provided by the 3rd party platform. + * Optional. The client secret provided by the 3rd party platform. */ clientSecret?: string | null; /** @@ -2834,7 +2834,7 @@ export namespace dialogflow_v2 { */ transitionRouteGroups?: string[] | null; /** - * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3TransitionRoute[]; } @@ -3415,7 +3415,7 @@ export namespace dialogflow_v2 { */ clientId?: string | null; /** - * Required. The client secret provided by the 3rd party platform. + * Optional. The client secret provided by the 3rd party platform. */ clientSecret?: string | null; /** @@ -3669,7 +3669,7 @@ export namespace dialogflow_v2 { */ answerRelevance?: string | null; /** - * Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + * Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT */ documentCorrectness?: string | null; /** @@ -4369,6 +4369,15 @@ export namespace dialogflow_v2 { */ source?: string | null; } + /** + * Suggestion generated using free form generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1FreeFormSuggestion { + /** + * Required. Free form suggestion. + */ + response?: string | null; + } /** * Google Cloud Storage location for the output. */ @@ -4378,6 +4387,49 @@ export namespace dialogflow_v2 { */ uri?: string | null; } + /** + * The response message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse { + /** + * The answers generated for the conversation based on context. + */ + generatorSuggestionAnswers?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer[]; + /** + * The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + } + /** + * A GeneratorSuggestion answer. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer { + /** + * Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. + */ + answerRecord?: string | null; + /** + * Suggestion details. + */ + generatorSuggestion?: Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestion; + /** + * The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`. + */ + sourceGenerator?: string | null; + } + /** + * Suggestion generated using a Generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestion { + /** + * Optional. Free form suggestion. + */ + freeFormSuggestion?: Schema$GoogleCloudDialogflowV2beta1FreeFormSuggestion; + /** + * Optional. Suggested summary. + */ + summarySuggestion?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestion; + } /** * Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation. */ @@ -5471,7 +5523,7 @@ export namespace dialogflow_v2 { */ responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** - * Optional. The time when the message was sent. + * Optional. The time when the message was sent. For voice messages, this is the time when an utterance started. */ sendTime?: string | null; /** @@ -5616,7 +5668,7 @@ export namespace dialogflow_v2 { */ 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. + * 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 Dialogflow 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 { /** @@ -5870,6 +5922,10 @@ export namespace dialogflow_v2 { * Error status if the request failed. */ error?: Schema$GoogleRpcStatus; + /** + * Suggestions generated using generators triggered by customer or agent messages. + */ + generateSuggestionsResponse?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse; /** * SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. */ @@ -5929,6 +5985,28 @@ export namespace dialogflow_v2 { */ smartReplyAnswers?: Schema$GoogleCloudDialogflowV2beta1SmartReplyAnswer[]; } + /** + * Suggested summary of the conversation. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarySuggestion { + /** + * Required. All the parts of generated summary. + */ + summarySections?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection[]; + } + /** + * A component of the generated summary. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection { + /** + * Required. Name of the section. + */ + section?: string | null; + /** + * Required. Summary text for the section. + */ + summary?: string | null; + } /** * A wrapper of repeated TelephonyDtmf digits. */ @@ -6075,6 +6153,12 @@ export namespace dialogflow_v2 { * Output only. The time the conversation was finished. */ endTime?: string | null; + /** + * Output only. The context reference updates provided by external systems. + */ + ingestedContextReferences?: { + [key: string]: Schema$GoogleCloudDialogflowV2ConversationContextReference; + } | null; /** * Output only. The current state of the Conversation. */ @@ -6105,6 +6189,44 @@ export namespace dialogflow_v2 { */ messageEntries?: Schema$GoogleCloudDialogflowV2MessageEntry[]; } + /** + * Represents a section of ingested context information. + */ + export interface Schema$GoogleCloudDialogflowV2ConversationContextReference { + /** + * Required. The list of content updates for a context reference. + */ + contextContents?: Schema$GoogleCloudDialogflowV2ConversationContextReferenceContextContent[]; + /** + * Output only. The time the context reference was first created. + */ + createTime?: string | null; + /** + * Optional. The language of the information ingested, defaults to "en-US" if not set. + */ + languageCode?: string | null; + /** + * Required. The mode in which context reference contents are updated. + */ + updateMode?: string | null; + } + /** + * Contents ingested. + */ + export interface Schema$GoogleCloudDialogflowV2ConversationContextReferenceContextContent { + /** + * Required. The information ingested in a single request. + */ + content?: string | null; + /** + * Required. The format of the ingested string. + */ + contentFormat?: string | null; + /** + * Output only. The time when this information was incorporated into the relevant context reference. + */ + ingestionTime?: string | null; + } /** * Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed). */ @@ -6246,7 +6368,7 @@ export namespace dialogflow_v2 { */ name?: string | null; /** - * Output only. Human eval template in csv format. It tooks real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. + * Output only. Human eval template in csv format. It takes real-world conversations provided through input dataset, generates example suggestions for customer to verify quality of the model. For Smart Reply, the generated csv file contains columns of Context, (Suggestions,Q1,Q2)*3, Actual reply. Context contains at most 10 latest messages in the conversation prior to the current suggestion. Q1: "Would you send it as the next message of agent?" Evaluated based on whether the suggest is appropriate to be sent by agent in current context. Q2: "Does the suggestion move the conversation closer to resolution?" Evaluated based on whether the suggestion provide solutions, or answers customer's question or collect information from customer to resolve the customer's issue. Actual reply column contains the actual agent reply sent in the context. */ rawHumanEvalTemplateCsv?: string | null; /** @@ -6747,11 +6869,11 @@ export namespace dialogflow_v2 { */ datasets?: Schema$GoogleCloudDialogflowV2InputDataset[]; /** - * Configuration for smart compose model evalution. + * Configuration for smart compose model evaluation. */ smartComposeConfig?: Schema$GoogleCloudDialogflowV2EvaluationConfigSmartComposeConfig; /** - * Configuration for smart reply model evalution. + * Configuration for smart reply model evaluation. */ smartReplyConfig?: Schema$GoogleCloudDialogflowV2EvaluationConfigSmartReplyConfig; } @@ -6896,6 +7018,24 @@ export namespace dialogflow_v2 { */ summarizationSectionList?: Schema$GoogleCloudDialogflowV2SummarizationSectionList; } + /** + * Free form generator context that customer can configure. + */ + export interface Schema$GoogleCloudDialogflowV2FreeFormContext { + /** + * Optional. Free form text input to LLM. + */ + text?: string | null; + } + /** + * Suggestion generated using free form generator. + */ + export interface Schema$GoogleCloudDialogflowV2FreeFormSuggestion { + /** + * Required. Free form suggestion. + */ + response?: string | null; + } /** * By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). */ @@ -6977,6 +7117,12 @@ export namespace dialogflow_v2 { * The request message for Conversations.GenerateStatelessSuggestion. */ export interface Schema$GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest { + /** + * Optional. A section of ingested context information. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator. + */ + contextReferences?: { + [key: string]: Schema$GoogleCloudDialogflowV2ConversationContextReference; + } | null; /** * Optional. Context of the conversation, including transcripts. */ @@ -7067,6 +7213,49 @@ export namespace dialogflow_v2 { */ textSections?: {[key: string]: string} | null; } + /** + * The request message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsRequest { + /** + * Optional. The name of the latest conversation message for which the request is triggered. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + /** + * Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered. + */ + triggerEvents?: string[] | null; + } + /** + * The response message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponse { + /** + * The answers generated for the conversation based on context. + */ + generatorSuggestionAnswers?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer[]; + /** + * The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + } + /** + * A GeneratorSuggestion answer. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer { + /** + * Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. + */ + answerRecord?: string | null; + /** + * Suggestion details. + */ + generatorSuggestion?: Schema$GoogleCloudDialogflowV2GeneratorSuggestion; + /** + * The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`. + */ + sourceGenerator?: string | null; + } /** * LLM generator. */ @@ -7079,6 +7268,10 @@ export namespace dialogflow_v2 { * Optional. Human readable description of the generator. */ description?: string | null; + /** + * Input of free from generator to LLM. + */ + freeFormContext?: Schema$GoogleCloudDialogflowV2FreeFormContext; /** * Optional. Inference parameters for this generator. */ @@ -7087,6 +7280,10 @@ export namespace dialogflow_v2 { * Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` */ name?: string | null; + /** + * Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + */ + publishedModel?: string | null; /** * Input of prebuilt Summarization feature. */ @@ -7104,6 +7301,10 @@ export namespace dialogflow_v2 { * Suggestion generated using a Generator. */ export interface Schema$GoogleCloudDialogflowV2GeneratorSuggestion { + /** + * Optional. Free form suggestion. + */ + freeFormSuggestion?: Schema$GoogleCloudDialogflowV2FreeFormSuggestion; /** * Optional. Suggested summary. */ @@ -7523,6 +7724,28 @@ export namespace dialogflow_v2 { */ topP?: number | null; } + /** + * The request message for ConversationsService.IngestContextReferences. + */ + export interface Schema$GoogleCloudDialogflowV2IngestContextReferencesRequest { + /** + * Required. The context references to ingest. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator. + */ + contextReferences?: { + [key: string]: Schema$GoogleCloudDialogflowV2ConversationContextReference; + } | null; + } + /** + * The response message for ConversationsService.IngestContextReferences. + */ + export interface Schema$GoogleCloudDialogflowV2IngestContextReferencesResponse { + /** + * All context references ingested. + */ + ingestedContextReferences?: { + [key: string]: Schema$GoogleCloudDialogflowV2ConversationContextReference; + } | null; + } /** * Metadata for initializing a location-level encryption specification. */ @@ -8670,7 +8893,7 @@ export namespace dialogflow_v2 { */ participantRole?: string | null; /** - * Optional. The time when the message was sent. + * Optional. The time when the message was sent. For voice messages, this is the time when an utterance started. */ sendTime?: string | null; /** @@ -9059,11 +9282,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig { /** - * Optional. Boost specifications for data stores. + * Optional. Boost specifications for data stores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined. */ boostSpecs?: Schema$GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecs[]; /** - * Optional. Filter specification for data store queries. + * Optional. Filter specification for data store queries. TMaps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined. */ filterSpecs?: Schema$GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigFilterSpecs[]; } @@ -9085,7 +9308,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec { /** - * Optional. 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. + * Optional. Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ conditionBoostSpecs?: Schema$GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec[]; } @@ -9338,7 +9561,7 @@ export namespace dialogflow_v2 { */ model?: string | null; /** - * List of names of Cloud Speech phrase sets that are used for transcription. + * List of names of Cloud Speech phrase sets that are used for transcription. For phrase set limitations, please refer to [Cloud Speech API quotas and limits](https://cloud.google.com/speech-to-text/quotas#content). */ phraseSets?: string[] | null; /** @@ -9350,7 +9573,7 @@ export namespace dialogflow_v2 { */ speechModelVariant?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -9557,6 +9780,10 @@ export namespace dialogflow_v2 { * Error status if the request failed. */ error?: Schema$GoogleRpcStatus; + /** + * Suggestions generated using generators triggered by customer or agent messages. + */ + generateSuggestionsResponse?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponse; /** * SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. */ @@ -9587,7 +9814,7 @@ export namespace dialogflow_v2 { */ latestMessage?: string | null; /** - * Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation. + * Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation. */ previousSuggestedQuery?: string | null; } @@ -18537,7 +18764,7 @@ export namespace dialogflow_v2 { export interface Params$Resource$Projects$Answerrecords$List extends StandardParameters { /** - * Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). + * Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * `conversation_id=bar` matches answer records in the `projects/foo/locations/global/conversations/bar` conversation (assuming the parent is `projects/foo/locations/global`). For more information about filtering, see [API Filtering](https://aip.dev/160). */ filter?: string; /** @@ -22104,6 +22331,104 @@ export namespace dialogflow_v2 { this.context = context; } + /** + * Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generate( + params: Params$Resource$Projects$Conversations$Suggestions$Generate, + options: StreamMethodOptions + ): GaxiosPromise; + generate( + params?: Params$Resource$Projects$Conversations$Suggestions$Generate, + options?: MethodOptions + ): GaxiosPromise; + generate( + params: Params$Resource$Projects$Conversations$Suggestions$Generate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Projects$Conversations$Suggestions$Generate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Projects$Conversations$Suggestions$Generate, + callback: BodyResponseCallback + ): void; + generate( + callback: BodyResponseCallback + ): void; + generate( + paramsOrCallback?: + | Params$Resource$Projects$Conversations$Suggestions$Generate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Conversations$Suggestions$Generate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Conversations$Suggestions$Generate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+conversation}/suggestions:generate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['conversation'], + pathParams: ['conversation'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Get answers for the given query based on knowledge documents. * @@ -22300,6 +22625,18 @@ export namespace dialogflow_v2 { } } + export interface Params$Resource$Projects$Conversations$Suggestions$Generate + extends StandardParameters { + /** + * Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions. + */ + conversation?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsRequest; + } export interface Params$Resource$Projects$Conversations$Suggestions$Searchknowledge extends StandardParameters { /** @@ -31585,7 +31922,7 @@ export namespace dialogflow_v2 { export interface Params$Resource$Projects$Locations$Answerrecords$List extends StandardParameters { /** - * Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). + * Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * `conversation_id=bar` matches answer records in the `projects/foo/locations/global/conversations/bar` conversation (assuming the parent is `projects/foo/locations/global`). For more information about filtering, see [API Filtering](https://aip.dev/160). */ filter?: string; /** @@ -34199,6 +34536,103 @@ export namespace dialogflow_v2 { } } + /** + * Data ingestion API. Ingests context references for an existing 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. + */ + ingestContextReferences( + params: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + options: StreamMethodOptions + ): GaxiosPromise; + ingestContextReferences( + params?: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + options?: MethodOptions + ): GaxiosPromise; + ingestContextReferences( + params: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingestContextReferences( + params: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingestContextReferences( + params: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + callback: BodyResponseCallback + ): void; + ingestContextReferences( + callback: BodyResponseCallback + ): void; + ingestContextReferences( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2/{+conversation}:ingestContextReferences' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['conversation'], + pathParams: ['conversation'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Returns the list of all conversations in the specified project. * @@ -34332,6 +34766,18 @@ export namespace dialogflow_v2 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences + extends StandardParameters { + /** + * Required. Resource identifier of the conversation to ingest context information for. Format: `projects//locations//conversations/`. + */ + conversation?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2IngestContextReferencesRequest; + } export interface Params$Resource$Projects$Locations$Conversations$List extends StandardParameters { /** @@ -35486,6 +35932,104 @@ export namespace dialogflow_v2 { this.context = context; } + /** + * Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generate( + params: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + options: StreamMethodOptions + ): GaxiosPromise; + generate( + params?: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + options?: MethodOptions + ): GaxiosPromise; + generate( + params: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + callback: BodyResponseCallback + ): void; + generate( + callback: BodyResponseCallback + ): void; + generate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Suggestions$Generate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Suggestions$Generate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Suggestions$Generate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+conversation}/suggestions:generate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['conversation'], + pathParams: ['conversation'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Get answers for the given query based on knowledge documents. * @@ -35682,6 +36226,18 @@ export namespace dialogflow_v2 { } } + export interface Params$Resource$Projects$Locations$Conversations$Suggestions$Generate + extends StandardParameters { + /** + * Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions. + */ + conversation?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsRequest; + } export interface Params$Resource$Projects$Locations$Conversations$Suggestions$Searchknowledge extends StandardParameters { /** diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 8bb782942ff..e4c2ad4f4b1 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -204,7 +204,7 @@ export namespace dialogflow_v2beta1 { */ noSpeechTimeout?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -332,7 +332,7 @@ export namespace dialogflow_v2beta1 { */ noSpeechTimeout?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -1195,7 +1195,7 @@ export namespace dialogflow_v2beta1 { */ transitionRouteGroups?: string[] | null; /** - * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3beta1TransitionRoute[]; } @@ -1827,7 +1827,7 @@ export namespace dialogflow_v2beta1 { */ clientId?: string | null; /** - * Required. The client secret provided by the 3rd party platform. + * Optional. The client secret provided by the 3rd party platform. */ clientSecret?: string | null; /** @@ -2834,7 +2834,7 @@ export namespace dialogflow_v2beta1 { */ transitionRouteGroups?: string[] | null; /** - * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3TransitionRoute[]; } @@ -3415,7 +3415,7 @@ export namespace dialogflow_v2beta1 { */ clientId?: string | null; /** - * Required. The client secret provided by the 3rd party platform. + * Optional. The client secret provided by the 3rd party platform. */ clientSecret?: string | null; /** @@ -3742,7 +3742,7 @@ export namespace dialogflow_v2beta1 { */ answerRelevance?: string | null; /** - * Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT + * Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * document_correctness: INCORRECT */ documentCorrectness?: string | null; /** @@ -3839,7 +3839,7 @@ export namespace dialogflow_v2beta1 { */ audioInput?: Schema$GoogleCloudDialogflowV2beta1AudioInput; /** - * The unique identifier of the CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent. + * The unique identifier of the Dialogflow CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent. */ cxCurrentPage?: string | null; /** @@ -4375,6 +4375,14 @@ export namespace dialogflow_v2beta1 { * Output only. The time the conversation was finished. */ endTime?: string | null; + /** + * Output only. The context reference updates provided by external systems. + */ + ingestedContextReferences?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowV2beta1ConversationContextReference; + } | null; /** * Output only. The current state of the Conversation. */ @@ -4405,6 +4413,44 @@ export namespace dialogflow_v2beta1 { */ messageEntries?: Schema$GoogleCloudDialogflowV2beta1MessageEntry[]; } + /** + * Represents a piece of ingested context information. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ConversationContextReference { + /** + * Required. The list of content updates for a context reference. + */ + contextContents?: Schema$GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent[]; + /** + * Output only. The time the context reference was first created. + */ + createTime?: string | null; + /** + * Optional. The language of the information ingested, defaults to "en-US" if not set. + */ + languageCode?: string | null; + /** + * Required. The mode in which context reference contents are updated. + */ + updateMode?: string | null; + } + /** + * Contents ingested. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent { + /** + * Required. The information ingested in a single request. + */ + content?: string | null; + /** + * Required. The format of the ingested string. + */ + contentFormat?: string | null; + /** + * Output only. The time when this information was incorporated into the relevant context reference. + */ + ingestionTime?: string | null; + } /** * Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events. */ @@ -4943,6 +4989,24 @@ export namespace dialogflow_v2beta1 { */ summarizationSectionList?: Schema$GoogleCloudDialogflowV2beta1SummarizationSectionList; } + /** + * Free form generator context that customer can configure. + */ + export interface Schema$GoogleCloudDialogflowV2beta1FreeFormContext { + /** + * Optional. Free form text input to LLM. + */ + text?: string | null; + } + /** + * Suggestion generated using free form generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1FreeFormSuggestion { + /** + * Required. Free form suggestion. + */ + response?: string | null; + } /** * By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). */ @@ -5033,6 +5097,14 @@ export namespace dialogflow_v2beta1 { * The request message for Conversations.GenerateStatelessSuggestion. */ export interface Schema$GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest { + /** + * Optional. A section of ingested context information. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator. + */ + contextReferences?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowV2beta1ConversationContextReference; + } | null; /** * Optional. Context of the conversation, including transcripts. */ @@ -5123,6 +5195,49 @@ export namespace dialogflow_v2beta1 { */ textSections?: {[key: string]: string} | null; } + /** + * The request message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest { + /** + * Optional. The name of the latest conversation message for which the request is triggered. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + /** + * Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered. + */ + triggerEvents?: string[] | null; + } + /** + * The response message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse { + /** + * The answers generated for the conversation based on context. + */ + generatorSuggestionAnswers?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer[]; + /** + * The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + } + /** + * A GeneratorSuggestion answer. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer { + /** + * Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. + */ + answerRecord?: string | null; + /** + * Suggestion details. + */ + generatorSuggestion?: Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestion; + /** + * The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`. + */ + sourceGenerator?: string | null; + } /** * LLM generator. */ @@ -5135,6 +5250,10 @@ export namespace dialogflow_v2beta1 { * Optional. Human readable description of the generator. */ description?: string | null; + /** + * Input of free from generator to LLM. + */ + freeFormContext?: Schema$GoogleCloudDialogflowV2beta1FreeFormContext; /** * Optional. Inference parameters for this generator. */ @@ -5143,6 +5262,10 @@ export namespace dialogflow_v2beta1 { * Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/` */ name?: string | null; + /** + * Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`. + */ + publishedModel?: string | null; /** * Input of Summarization feature. */ @@ -5160,6 +5283,10 @@ export namespace dialogflow_v2beta1 { * Suggestion generated using a Generator. */ export interface Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestion { + /** + * Optional. Free form suggestion. + */ + freeFormSuggestion?: Schema$GoogleCloudDialogflowV2beta1FreeFormSuggestion; /** * Optional. Suggested summary. */ @@ -5540,6 +5667,32 @@ export namespace dialogflow_v2beta1 { */ topP?: number | null; } + /** + * The request message for ConversationsService.IngestContextReferences. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IngestContextReferencesRequest { + /** + * Required. The context references to ingest. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator. + */ + contextReferences?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowV2beta1ConversationContextReference; + } | null; + } + /** + * The response message for ConversationsService.IngestContextReferences. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IngestContextReferencesResponse { + /** + * All context references ingested. + */ + ingestedContextReferences?: { + [ + key: string + ]: Schema$GoogleCloudDialogflowV2beta1ConversationContextReference; + } | null; + } /** * Metadata for initializing a location-level encryption specification. */ @@ -6830,6 +6983,19 @@ export namespace dialogflow_v2beta1 { */ participants?: Schema$GoogleCloudDialogflowV2beta1Participant[]; } + /** + * The response message for PhoneNumbers.ListPhoneNumbers. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * The list of `PhoneNumber` resources. There is a maximum number of items returned based on the page_size field in the request. + */ + phoneNumbers?: Schema$GoogleCloudDialogflowV2beta1PhoneNumber[]; + } /** * The response message for SessionEntityTypes.ListSessionEntityTypes. */ @@ -6928,7 +7094,7 @@ export namespace dialogflow_v2beta1 { */ responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** - * Optional. The time when the message was sent. + * Optional. The time when the message was sent. For voice messages, this is the time when an utterance started. */ sendTime?: string | null; /** @@ -7051,6 +7217,27 @@ export namespace dialogflow_v2beta1 { */ role?: string | null; } + /** + * Represents a phone number. `PhoneNumber` resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder. + */ + export interface Schema$GoogleCloudDialogflowV2beta1PhoneNumber { + /** + * Optional. The conversation profile calls to this `PhoneNumber` should use. The project ID here should be the same as the one in name. Format: `projects//conversationProfiles/`. Format: `projects//locations//conversationProfiles/`. + */ + conversationProfile?: string | null; + /** + * Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming calls and can be removed completely within 30 days. + */ + lifecycleState?: string | null; + /** + * Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. + */ + name?: string | null; + /** + * Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888. + */ + phoneNumber?: string | null; + } /** * Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text. 3. An event that specifies which intent to trigger. */ @@ -7241,7 +7428,7 @@ export namespace dialogflow_v2beta1 { */ 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. + * 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 Dialogflow 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 { /** @@ -7419,12 +7606,12 @@ export namespace dialogflow_v2beta1 { */ boostSpecs?: Schema$GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs[]; /** - * Optional. Filter specification for data store queries. + * Optional. Filter specification for data store queries. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined. */ filterSpecs?: Schema$GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigFilterSpecs[]; } /** - * Boost specifications for data stores. + * Boost specifications for data stores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined. */ export interface Schema$GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs { /** @@ -7441,7 +7628,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec { /** - * Optional. 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. + * Optional. Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ conditionBoostSpecs?: Schema$GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec[]; } @@ -7676,7 +7863,7 @@ export namespace dialogflow_v2beta1 { */ model?: string | null; /** - * List of names of Cloud Speech phrase sets that are used for transcription. + * List of names of Cloud Speech phrase sets that are used for transcription. For phrase set limitations, please refer to [Cloud Speech API quotas and limits](https://cloud.google.com/speech-to-text/quotas#content). */ phraseSets?: string[] | null; /** @@ -7688,7 +7875,7 @@ export namespace dialogflow_v2beta1 { */ speechModelVariant?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -8024,6 +8211,10 @@ export namespace dialogflow_v2beta1 { * Error status if the request failed. */ error?: Schema$GoogleRpcStatus; + /** + * Suggestions generated using generators triggered by customer or agent messages. + */ + generateSuggestionsResponse?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse; /** * SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. */ @@ -8062,7 +8253,7 @@ export namespace dialogflow_v2beta1 { */ latestMessage?: string | null; /** - * Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation. + * Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is reasonably different from the previous one. This is useful to avoid similar suggestions within the conversation. */ previousSuggestedQuery?: string | null; } @@ -8260,6 +8451,10 @@ export namespace dialogflow_v2beta1 { * The request message for Agents.TrainAgent. */ export interface Schema$GoogleCloudDialogflowV2beta1TrainAgentRequest {} + /** + * The request message for PhoneNumbers.UndeletePhoneNumber. + */ + export interface Schema$GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest {} /** * Represents a single validation error. */ @@ -8698,6 +8893,15 @@ export namespace dialogflow_v2beta1 { */ source?: string | null; } + /** + * Suggestion generated using free form generator. + */ + export interface Schema$GoogleCloudDialogflowV2FreeFormSuggestion { + /** + * Required. Free form suggestion. + */ + response?: string | null; + } /** * Google Cloud Storage location for the output. */ @@ -8707,6 +8911,49 @@ export namespace dialogflow_v2beta1 { */ uri?: string | null; } + /** + * The response message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponse { + /** + * The answers generated for the conversation based on context. + */ + generatorSuggestionAnswers?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer[]; + /** + * The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + } + /** + * A GeneratorSuggestion answer. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer { + /** + * Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. + */ + answerRecord?: string | null; + /** + * Suggestion details. + */ + generatorSuggestion?: Schema$GoogleCloudDialogflowV2GeneratorSuggestion; + /** + * The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`. + */ + sourceGenerator?: string | null; + } + /** + * Suggestion generated using a Generator. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorSuggestion { + /** + * Optional. Free form suggestion. + */ + freeFormSuggestion?: Schema$GoogleCloudDialogflowV2FreeFormSuggestion; + /** + * Optional. Suggested summary. + */ + summarySuggestion?: Schema$GoogleCloudDialogflowV2SummarySuggestion; + } /** * Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation. */ @@ -9571,7 +9818,7 @@ export namespace dialogflow_v2beta1 { */ participantRole?: string | null; /** - * Optional. The time when the message was sent. + * Optional. The time when the message was sent. For voice messages, this is the time when an utterance started. */ sendTime?: string | null; /** @@ -9860,6 +10107,10 @@ export namespace dialogflow_v2beta1 { * Error status if the request failed. */ error?: Schema$GoogleRpcStatus; + /** + * Suggestions generated using generators triggered by customer or agent messages. + */ + generateSuggestionsResponse?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponse; /** * SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. */ @@ -9911,6 +10162,28 @@ export namespace dialogflow_v2beta1 { */ smartReplyAnswers?: Schema$GoogleCloudDialogflowV2SmartReplyAnswer[]; } + /** + * Suggested summary of the conversation. + */ + export interface Schema$GoogleCloudDialogflowV2SummarySuggestion { + /** + * Required. All the parts of generated summary. + */ + summarySections?: Schema$GoogleCloudDialogflowV2SummarySuggestionSummarySection[]; + } + /** + * A component of the generated summary. + */ + export interface Schema$GoogleCloudDialogflowV2SummarySuggestionSummarySection { + /** + * Required. Name of the section. + */ + section?: string | null; + /** + * Required. Summary text for the section. + */ + summary?: string | null; + } /** * Metadata for a ConversationModels.UndeployConversationModel operation. */ @@ -10157,6 +10430,7 @@ export namespace dialogflow_v2beta1 { knowledgeBases: Resource$Projects$Knowledgebases; locations: Resource$Projects$Locations; operations: Resource$Projects$Operations; + phoneNumbers: Resource$Projects$Phonenumbers; suggestions: Resource$Projects$Suggestions; constructor(context: APIRequestContext) { this.context = context; @@ -10170,6 +10444,7 @@ export namespace dialogflow_v2beta1 { this.knowledgeBases = new Resource$Projects$Knowledgebases(this.context); this.locations = new Resource$Projects$Locations(this.context); this.operations = new Resource$Projects$Operations(this.context); + this.phoneNumbers = new Resource$Projects$Phonenumbers(this.context); this.suggestions = new Resource$Projects$Suggestions(this.context); } @@ -18701,7 +18976,7 @@ export namespace dialogflow_v2beta1 { export interface Params$Resource$Projects$Answerrecords$List extends StandardParameters { /** - * Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). + * Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). */ filter?: string; /** @@ -21412,6 +21687,103 @@ export namespace dialogflow_v2beta1 { this.context = context; } + /** + * Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generate( + params: Params$Resource$Projects$Conversations$Suggestions$Generate, + options: StreamMethodOptions + ): GaxiosPromise; + generate( + params?: Params$Resource$Projects$Conversations$Suggestions$Generate, + options?: MethodOptions + ): GaxiosPromise; + generate( + params: Params$Resource$Projects$Conversations$Suggestions$Generate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Projects$Conversations$Suggestions$Generate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Projects$Conversations$Suggestions$Generate, + callback: BodyResponseCallback + ): void; + generate( + callback: BodyResponseCallback + ): void; + generate( + paramsOrCallback?: + | Params$Resource$Projects$Conversations$Suggestions$Generate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Conversations$Suggestions$Generate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Conversations$Suggestions$Generate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta1/{+conversation}/suggestions:generate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['conversation'], + pathParams: ['conversation'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Get answers for the given query based on knowledge documents. * @@ -21608,6 +21980,18 @@ export namespace dialogflow_v2beta1 { } } + export interface Params$Resource$Projects$Conversations$Suggestions$Generate + extends StandardParameters { + /** + * Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions. + */ + conversation?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest; + } export interface Params$Resource$Projects$Conversations$Suggestions$Searchknowledge extends StandardParameters { /** @@ -23180,6 +23564,7 @@ export namespace dialogflow_v2beta1 { generators: Resource$Projects$Locations$Generators; knowledgeBases: Resource$Projects$Locations$Knowledgebases; operations: Resource$Projects$Locations$Operations; + phoneNumbers: Resource$Projects$Locations$Phonenumbers; sipTrunks: Resource$Projects$Locations$Siptrunks; statelessSuggestion: Resource$Projects$Locations$Statelesssuggestion; suggestions: Resource$Projects$Locations$Suggestions; @@ -23206,6 +23591,9 @@ export namespace dialogflow_v2beta1 { this.operations = new Resource$Projects$Locations$Operations( this.context ); + this.phoneNumbers = new Resource$Projects$Locations$Phonenumbers( + this.context + ); this.sipTrunks = new Resource$Projects$Locations$Siptrunks(this.context); this.statelessSuggestion = new Resource$Projects$Locations$Statelesssuggestion(this.context); @@ -30890,7 +31278,7 @@ export namespace dialogflow_v2beta1 { export interface Params$Resource$Projects$Locations$Answerrecords$List extends StandardParameters { /** - * Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). + * Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). */ filter?: string; /** @@ -31986,6 +32374,103 @@ export namespace dialogflow_v2beta1 { } } + /** + * Data ingestion API. Ingests context references for an existing 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. + */ + ingestContextReferences( + params: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + options: StreamMethodOptions + ): GaxiosPromise; + ingestContextReferences( + params?: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + options?: MethodOptions + ): GaxiosPromise; + ingestContextReferences( + params: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingestContextReferences( + params: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingestContextReferences( + params: Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences, + callback: BodyResponseCallback + ): void; + ingestContextReferences( + callback: BodyResponseCallback + ): void; + ingestContextReferences( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta1/{+conversation}:ingestContextReferences' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['conversation'], + pathParams: ['conversation'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Returns the list of all conversations in the specified project. * @@ -32119,6 +32604,18 @@ export namespace dialogflow_v2beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Conversations$Ingestcontextreferences + extends StandardParameters { + /** + * Required. Resource identifier of the conversation to ingest context information for. Format: `projects//locations//conversations/`. + */ + conversation?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1IngestContextReferencesRequest; + } export interface Params$Resource$Projects$Locations$Conversations$List extends StandardParameters { /** @@ -33383,6 +33880,103 @@ export namespace dialogflow_v2beta1 { this.context = context; } + /** + * Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generate( + params: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + options: StreamMethodOptions + ): GaxiosPromise; + generate( + params?: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + options?: MethodOptions + ): GaxiosPromise; + generate( + params: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Projects$Locations$Conversations$Suggestions$Generate, + callback: BodyResponseCallback + ): void; + generate( + callback: BodyResponseCallback + ): void; + generate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Suggestions$Generate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Suggestions$Generate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Suggestions$Generate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta1/{+conversation}/suggestions:generate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['conversation'], + pathParams: ['conversation'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Get answers for the given query based on knowledge documents. * @@ -33579,6 +34173,18 @@ export namespace dialogflow_v2beta1 { } } + export interface Params$Resource$Projects$Locations$Conversations$Suggestions$Generate + extends StandardParameters { + /** + * Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions. + */ + conversation?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest; + } export interface Params$Resource$Projects$Locations$Conversations$Suggestions$Searchknowledge extends StandardParameters { /** @@ -35891,111 +36497,14 @@ export namespace dialogflow_v2beta1 { pageToken?: string; } - export class Resource$Projects$Locations$Siptrunks { + export class Resource$Projects$Locations$Phonenumbers { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a SipTrunk for a specified 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$Siptrunks$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Siptrunks$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Siptrunks$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Siptrunks$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Siptrunks$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Siptrunks$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Siptrunks$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Siptrunks$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/sipTrunks').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 specified SipTrunk. + * Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the ACTIVE state. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -36003,52 +36512,593 @@ export namespace dialogflow_v2beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Siptrunks$Delete, + params: Params$Resource$Projects$Locations$Phonenumbers$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Siptrunks$Delete, + params?: Params$Resource$Projects$Locations$Phonenumbers$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Siptrunks$Delete, + params: Params$Resource$Projects$Locations$Phonenumbers$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Siptrunks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Phonenumbers$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Siptrunks$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Phonenumbers$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Siptrunks$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Phonenumbers$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$Siptrunks$Delete; + {}) as Params$Resource$Projects$Locations$Phonenumbers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Siptrunks$Delete; + params = {} as Params$Resource$Projects$Locations$Phonenumbers$Delete; + 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: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the list of all phone numbers 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. + */ + list( + params: Params$Resource$Projects$Locations$Phonenumbers$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Phonenumbers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Phonenumbers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Phonenumbers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Phonenumbers$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Phonenumbers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Phonenumbers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Phonenumbers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/phoneNumbers').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 `PhoneNumber`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Phonenumbers$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Phonenumbers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Phonenumbers$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Phonenumbers$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Phonenumbers$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Phonenumbers$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Phonenumbers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Phonenumbers$Patch; + 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: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED 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. + */ + undelete( + params: Params$Resource$Projects$Locations$Phonenumbers$Undelete, + options: StreamMethodOptions + ): GaxiosPromise; + undelete( + params?: Params$Resource$Projects$Locations$Phonenumbers$Undelete, + options?: MethodOptions + ): GaxiosPromise; + undelete( + params: Params$Resource$Projects$Locations$Phonenumbers$Undelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Phonenumbers$Undelete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Phonenumbers$Undelete, + callback: BodyResponseCallback + ): void; + undelete( + callback: BodyResponseCallback + ): void; + undelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Phonenumbers$Undelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Phonenumbers$Undelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Phonenumbers$Undelete; + 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}:undelete').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$Phonenumbers$Delete + extends StandardParameters { + /** + * Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Phonenumbers$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. Format: `projects//locations/`. + */ + parent?: string; + /** + * Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to false. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Locations$Phonenumbers$Patch + extends StandardParameters { + /** + * Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. + */ + name?: string; + /** + * Optional. The mask to control which fields get updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1PhoneNumber; + } + export interface Params$Resource$Projects$Locations$Phonenumbers$Undelete + extends StandardParameters { + /** + * Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest; + } + + export class Resource$Projects$Locations$Siptrunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a SipTrunk for a specified 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$Siptrunks$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Siptrunks$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Siptrunks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Siptrunks$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Siptrunks$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Siptrunks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Siptrunks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Siptrunks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/sipTrunks').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 specified SipTrunk. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Siptrunks$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Siptrunks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Siptrunks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Siptrunks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Siptrunks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Siptrunks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Siptrunks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Siptrunks$Delete; options = {}; } @@ -37091,6 +38141,450 @@ export namespace dialogflow_v2beta1 { pageToken?: string; } + export class Resource$Projects$Phonenumbers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on a `PhoneNumber` in the 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. + */ + delete( + params: Params$Resource$Projects$Phonenumbers$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Phonenumbers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Phonenumbers$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Phonenumbers$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Phonenumbers$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Phonenumbers$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Phonenumbers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Phonenumbers$Delete; + 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: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the list of all phone numbers 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. + */ + list( + params: Params$Resource$Projects$Phonenumbers$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Phonenumbers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Phonenumbers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Phonenumbers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Phonenumbers$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Phonenumbers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Phonenumbers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Phonenumbers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/phoneNumbers').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 `PhoneNumber`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Phonenumbers$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Phonenumbers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Phonenumbers$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Phonenumbers$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Phonenumbers$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Phonenumbers$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Phonenumbers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Phonenumbers$Patch; + 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: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Cancels the deletion request for a `PhoneNumber`. This method may only be called on a `PhoneNumber` in the DELETE_REQUESTED 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. + */ + undelete( + params: Params$Resource$Projects$Phonenumbers$Undelete, + options: StreamMethodOptions + ): GaxiosPromise; + undelete( + params?: Params$Resource$Projects$Phonenumbers$Undelete, + options?: MethodOptions + ): GaxiosPromise; + undelete( + params: Params$Resource$Projects$Phonenumbers$Undelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Phonenumbers$Undelete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Phonenumbers$Undelete, + callback: BodyResponseCallback + ): void; + undelete( + callback: BodyResponseCallback + ): void; + undelete( + paramsOrCallback?: + | Params$Resource$Projects$Phonenumbers$Undelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Phonenumbers$Undelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Phonenumbers$Undelete; + 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}:undelete').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$Phonenumbers$Delete + extends StandardParameters { + /** + * Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Phonenumbers$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. Format: `projects//locations/`. + */ + parent?: string; + /** + * Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to false. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Phonenumbers$Patch + extends StandardParameters { + /** + * Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. + */ + name?: string; + /** + * Optional. The mask to control which fields get updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1PhoneNumber; + } + export interface Params$Resource$Projects$Phonenumbers$Undelete + extends StandardParameters { + /** + * Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. Format: `projects//locations//phoneNumbers/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest; + } + export class Resource$Projects$Suggestions { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index 335d75c686d..f5bf3c9a478 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -204,7 +204,7 @@ export namespace dialogflow_v3 { */ noSpeechTimeout?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -572,7 +572,7 @@ export namespace dialogflow_v3 { */ noSpeechTimeout?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -1435,7 +1435,7 @@ export namespace dialogflow_v3 { */ transitionRouteGroups?: string[] | null; /** - * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3beta1TransitionRoute[]; } @@ -2067,7 +2067,7 @@ export namespace dialogflow_v3 { */ clientId?: string | null; /** - * Required. The client secret provided by the 3rd party platform. + * Optional. The client secret provided by the 3rd party platform. */ clientSecret?: string | null; /** @@ -2264,7 +2264,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3BoostSpec { /** - * Optional. 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. + * Optional. Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ conditionBoostSpecs?: Schema$GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec[]; } @@ -3395,7 +3395,7 @@ export namespace dialogflow_v3 { */ transitionRouteGroups?: string[] | null; /** - * A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. + * A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evaluated in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3TransitionRoute[]; } @@ -4561,7 +4561,7 @@ export namespace dialogflow_v3 { */ transitionRouteGroups?: string[] | null; /** - * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3TransitionRoute[]; } @@ -5122,11 +5122,11 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3SearchConfig { /** - * Optional. Boosting configuration for the datastores. + * Optional. Boosting configuration for the datastores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined. */ boostSpecs?: Schema$GoogleCloudDialogflowCxV3BoostSpecs[]; /** - * Optional. Filter configuration for the datastores. + * Optional. Filter configuration for the datastores. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined. */ filterSpecs?: Schema$GoogleCloudDialogflowCxV3FilterSpecs[]; } @@ -5865,7 +5865,7 @@ export namespace dialogflow_v3 { */ clientId?: string | null; /** - * Required. The client secret provided by the 3rd party platform. + * Optional. The client secret provided by the 3rd party platform. */ clientSecret?: string | null; /** @@ -6393,6 +6393,15 @@ export namespace dialogflow_v3 { */ source?: string | null; } + /** + * Suggestion generated using free form generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1FreeFormSuggestion { + /** + * Required. Free form suggestion. + */ + response?: string | null; + } /** * Google Cloud Storage location for the output. */ @@ -6402,6 +6411,49 @@ export namespace dialogflow_v3 { */ uri?: string | null; } + /** + * The response message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse { + /** + * The answers generated for the conversation based on context. + */ + generatorSuggestionAnswers?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer[]; + /** + * The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + } + /** + * A GeneratorSuggestion answer. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer { + /** + * Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. + */ + answerRecord?: string | null; + /** + * Suggestion details. + */ + generatorSuggestion?: Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestion; + /** + * The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`. + */ + sourceGenerator?: string | null; + } + /** + * Suggestion generated using a Generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestion { + /** + * Optional. Free form suggestion. + */ + freeFormSuggestion?: Schema$GoogleCloudDialogflowV2beta1FreeFormSuggestion; + /** + * Optional. Suggested summary. + */ + summarySuggestion?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestion; + } /** * Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation. */ @@ -7495,7 +7547,7 @@ export namespace dialogflow_v3 { */ responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** - * Optional. The time when the message was sent. + * Optional. The time when the message was sent. For voice messages, this is the time when an utterance started. */ sendTime?: string | null; /** @@ -7640,7 +7692,7 @@ export namespace dialogflow_v3 { */ 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. + * 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 Dialogflow 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 { /** @@ -7894,6 +7946,10 @@ export namespace dialogflow_v3 { * Error status if the request failed. */ error?: Schema$GoogleRpcStatus; + /** + * Suggestions generated using generators triggered by customer or agent messages. + */ + generateSuggestionsResponse?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse; /** * SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. */ @@ -7953,6 +8009,28 @@ export namespace dialogflow_v3 { */ smartReplyAnswers?: Schema$GoogleCloudDialogflowV2beta1SmartReplyAnswer[]; } + /** + * Suggested summary of the conversation. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarySuggestion { + /** + * Required. All the parts of generated summary. + */ + summarySections?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection[]; + } + /** + * A component of the generated summary. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection { + /** + * Required. Name of the section. + */ + section?: string | null; + /** + * Required. Summary text for the section. + */ + summary?: string | null; + } /** * A wrapper of repeated TelephonyDtmf digits. */ @@ -8336,6 +8414,15 @@ export namespace dialogflow_v3 { */ source?: string | null; } + /** + * Suggestion generated using free form generator. + */ + export interface Schema$GoogleCloudDialogflowV2FreeFormSuggestion { + /** + * Required. Free form suggestion. + */ + response?: string | null; + } /** * Google Cloud Storage location for the output. */ @@ -8345,6 +8432,49 @@ export namespace dialogflow_v3 { */ uri?: string | null; } + /** + * The response message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponse { + /** + * The answers generated for the conversation based on context. + */ + generatorSuggestionAnswers?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer[]; + /** + * The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + } + /** + * A GeneratorSuggestion answer. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer { + /** + * Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. + */ + answerRecord?: string | null; + /** + * Suggestion details. + */ + generatorSuggestion?: Schema$GoogleCloudDialogflowV2GeneratorSuggestion; + /** + * The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`. + */ + sourceGenerator?: string | null; + } + /** + * Suggestion generated using a Generator. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorSuggestion { + /** + * Optional. Free form suggestion. + */ + freeFormSuggestion?: Schema$GoogleCloudDialogflowV2FreeFormSuggestion; + /** + * Optional. Suggested summary. + */ + summarySuggestion?: Schema$GoogleCloudDialogflowV2SummarySuggestion; + } /** * Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation. */ @@ -9209,7 +9339,7 @@ export namespace dialogflow_v3 { */ participantRole?: string | null; /** - * Optional. The time when the message was sent. + * Optional. The time when the message was sent. For voice messages, this is the time when an utterance started. */ sendTime?: string | null; /** @@ -9498,6 +9628,10 @@ export namespace dialogflow_v3 { * Error status if the request failed. */ error?: Schema$GoogleRpcStatus; + /** + * Suggestions generated using generators triggered by customer or agent messages. + */ + generateSuggestionsResponse?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponse; /** * SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. */ @@ -9549,6 +9683,28 @@ export namespace dialogflow_v3 { */ smartReplyAnswers?: Schema$GoogleCloudDialogflowV2SmartReplyAnswer[]; } + /** + * Suggested summary of the conversation. + */ + export interface Schema$GoogleCloudDialogflowV2SummarySuggestion { + /** + * Required. All the parts of generated summary. + */ + summarySections?: Schema$GoogleCloudDialogflowV2SummarySuggestionSummarySection[]; + } + /** + * A component of the generated summary. + */ + export interface Schema$GoogleCloudDialogflowV2SummarySuggestionSummarySection { + /** + * Required. Name of the section. + */ + section?: string | null; + /** + * Required. Summary text for the section. + */ + summary?: string | null; + } /** * Metadata for a ConversationModels.UndeployConversationModel operation. */ diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index bc1292d9e8e..ad2d4d77f18 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -204,7 +204,7 @@ export namespace dialogflow_v3beta1 { */ noSpeechTimeout?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -357,7 +357,7 @@ export namespace dialogflow_v3beta1 { */ noSpeechTimeout?: string | null; /** - * Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. + * Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value. */ useTimeoutBasedEndpointing?: boolean | null; } @@ -505,11 +505,40 @@ export namespace dialogflow_v3beta1 { * Settings for connecting to Git repository for an agent. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettings { + /** + * Git connection settings. + */ + gitConnectionSettings?: Schema$GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings; /** * GitHub settings. */ githubSettings?: Schema$GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGithubSettings; } + /** + * Integration settings for a Git service hosted on Cloud Run. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettingsGitConnectionSettings { + /** + * The name of the SecretManager secret version resource storing the git access token. Format: `projects/{project\}/secrets/{secret\}/versions/{version\}` + */ + accessTokenSecret?: string | null; + /** + * Optional. List of branches configured for the repository. + */ + branches?: string[] | null; + /** + * Required. Display name for the repository + */ + displayName?: string | null; + /** + * Required. Git server reporitory URI. + */ + repositoryUri?: string | null; + /** + * Required. Default branch of the repository. + */ + trackingBranch?: string | null; + } /** * Settings of integration with GitHub. */ @@ -680,7 +709,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1BoostSpec { /** - * Optional. 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. + * Optional. Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ conditionBoostSpecs?: Schema$GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpec[]; } @@ -2104,7 +2133,7 @@ export namespace dialogflow_v3beta1 { */ transitionRouteGroups?: string[] | null; /** - * A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. + * A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evaluated in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3beta1TransitionRoute[]; } @@ -2527,6 +2556,53 @@ export namespace dialogflow_v3beta1 { */ name?: string | null; } + /** + * Handler can be used to define custom logic to be executed based on the user-specified triggers. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1Handler { + /** + * A handler triggered by event. + */ + eventHandler?: Schema$GoogleCloudDialogflowCxV3beta1HandlerEventHandler; + /** + * A handler triggered during specific lifecycle of the playbook execution. + */ + lifecycleHandler?: Schema$GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler; + } + /** + * A handler that is triggered by the specified event. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1HandlerEventHandler { + /** + * Optional. The condition that must be satisfied to trigger this handler. + */ + condition?: string | null; + /** + * Required. The name of the event that triggers this handler. + */ + event?: string | null; + /** + * Required. The fulfillment to call when the event occurs. + */ + fulfillment?: Schema$GoogleCloudDialogflowCxV3beta1Fulfillment; + } + /** + * A handler that is triggered on the specific lifecycle_stage of the playbook execution. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1HandlerLifecycleHandler { + /** + * Optional. The condition that must be satisfied to trigger this handler. + */ + condition?: string | null; + /** + * Required. The fulfillment to call when this handler is triggered. + */ + fulfillment?: Schema$GoogleCloudDialogflowCxV3beta1Fulfillment; + /** + * Required. The name of the lifecycle stage that triggers this handler. Supported values: * `playbook-start` * `pre-action-selection` * `pre-action-execution` + */ + lifecycleStage?: string | null; + } /** * Metadata returned for the EntityTypes.ImportEntityTypes long running operation. */ @@ -3183,6 +3259,19 @@ export namespace dialogflow_v3beta1 { */ tools?: Schema$GoogleCloudDialogflowCxV3beta1Tool[]; } + /** + * The response message for Tools.ListToolVersions. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ListToolVersionsResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * The list of tool versions. There will be a maximum number of items returned based on the page_size field in the request. + */ + toolVersions?: Schema$GoogleCloudDialogflowCxV3beta1ToolVersion[]; + } /** * The response message for TransitionRouteGroups.ListTransitionRouteGroups. */ @@ -3407,7 +3496,7 @@ export namespace dialogflow_v3beta1 { */ transitionRouteGroups?: string[] | null; /** - * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3beta1TransitionRoute[]; } @@ -3508,6 +3597,10 @@ export namespace dialogflow_v3beta1 { * Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. */ goal?: string | null; + /** + * Optional. A list of registered handlers to execute based on the specified triggers. + */ + handlers?: Schema$GoogleCloudDialogflowCxV3beta1Handler[]; /** * Optional. Defined structured input parameters for this playbook. */ @@ -4066,6 +4159,19 @@ export namespace dialogflow_v3beta1 { */ trackingBranch?: string | null; } + /** + * The request message for Tools.RestoreToolVersion. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest {} + /** + * The response message for Tools.RestoreToolVersion. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1RestoreToolVersionResponse { + /** + * The updated tool. + */ + tool?: Schema$GoogleCloudDialogflowCxV3beta1Tool; + } /** * The configuration for auto rollout. */ @@ -4192,11 +4298,11 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1SearchConfig { /** - * Optional. Boosting configuration for the datastores. + * Optional. Boosting configuration for the datastores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined. */ boostSpecs?: Schema$GoogleCloudDialogflowCxV3beta1BoostSpecs[]; /** - * Optional. Filter configuration for the datastores. + * Optional. Filter configuration for the datastores. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined. */ filterSpecs?: Schema$GoogleCloudDialogflowCxV3beta1FilterSpecs[]; } @@ -4533,6 +4639,10 @@ export namespace dialogflow_v3beta1 { * A tool provides a list of actions which are available to the Playbook to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information. */ export interface Schema$GoogleCloudDialogflowCxV3beta1Tool { + /** + * Integration connectors tool specification. + */ + connectorSpec?: Schema$GoogleCloudDialogflowCxV3beta1ToolConnectorTool; /** * Data store search tool specification. */ @@ -4694,6 +4804,57 @@ export namespace dialogflow_v3beta1 { */ message?: string | null; } + /** + * A ConnectorTool enabling using Integration Connectors Connections as tools. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolConnectorTool { + /** + * Required. Actions for the tool to use. + */ + actions?: Schema$GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction[]; + /** + * Optional. Integration Connectors end-user authentication configuration. If configured, the end-user authentication fields will be passed in the Integration Connectors API request and override the admin, default authentication configured for the Connection. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override + */ + endUserAuthConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig; + /** + * Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/x/locations/x/connections/x` + */ + name?: string | null; + } + /** + * Configuration of a Connection operation for the tool to use. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolConnectorToolAction { + /** + * ID of a Connection action for the tool to use. + */ + connectionActionId?: string | null; + /** + * Entity operation configuration for the tool to use. + */ + entityOperation?: Schema$GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation; + /** + * Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used. + */ + inputFields?: string[] | null; + /** + * Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned. + */ + outputFields?: string[] | null; + } + /** + * Entity CRUD operation specification. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolConnectorToolActionEntityOperation { + /** + * Required. ID of the entity. + */ + entityId?: string | null; + /** + * Required. Operation to perform on the entity. + */ + operation?: string | null; + } /** * A DataStoreTool is a way to provide specifications needed to search a list of data stores. */ @@ -4711,6 +4872,45 @@ export namespace dialogflow_v3beta1 { * A FallbackPrompt is a way to provide specifications for the Data Store fallback prompt when generating responses. */ export interface Schema$GoogleCloudDialogflowCxV3beta1ToolDataStoreToolFallbackPrompt {} + /** + * End-user authentication configuration used for Connection calls. The field values can either be hardcoded authentication values or the names of [session parameters](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) or [request parameters](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#request-scoped). If parameter names are provided, then those parameters can be used to pass the authentication values dynamically, through `$session.params.param-id` or `$request.payload.param-id`. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfig { + /** + * Oauth 2.0 Authorization Code authentication. + */ + oauth2AuthCodeConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig; + /** + * JWT Profile Oauth 2.0 Authorization Grant authentication. + */ + oauth2JwtBearerConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig; + } + /** + * Oauth 2.0 Authorization Code authentication configuration. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2AuthCodeConfig { + /** + * Required. Oauth token value or parameter name to pass it through. + */ + oauthToken?: string | null; + } + /** + * JWT Profile Oauth 2.0 Authorization Grant authentication configuration. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolEndUserAuthConfigOauth2JwtBearerConfig { + /** + * Required. Client key value or parameter name to pass it through. + */ + clientKey?: string | null; + /** + * Required. Issuer value or parameter name to pass it through. + */ + issuer?: string | null; + /** + * Required. Subject value or parameter name to pass it through. + */ + subject?: string | null; + } /** * An ExtensionTool is a way to use Vertex Extensions as a tool. */ @@ -4777,7 +4977,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1ToolTLSConfigCACert { /** - * Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + * Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` */ cert?: string | null; /** @@ -4810,6 +5010,31 @@ export namespace dialogflow_v3beta1 { */ tool?: string | null; } + /** + * Tool version is a snapshot of the tool at certain timestamp. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolVersion { + /** + * Output only. Last time the tool version was created or modified. + */ + createTime?: string | null; + /** + * Required. The display name of the tool version. + */ + displayName?: string | null; + /** + * Identifier. The unique identifier of the tool version. Format: `projects//locations//agents//tools//versions/`. + */ + name?: string | null; + /** + * Required. Snapshot of the tool to be associated with this version. + */ + tool?: Schema$GoogleCloudDialogflowCxV3beta1Tool; + /** + * Output only. Last time the tool version was created or modified. + */ + updateTime?: string | null; + } /** * The request message for Flows.TrainFlow. */ @@ -5253,7 +5478,7 @@ export namespace dialogflow_v3beta1 { */ clientId?: string | null; /** - * Required. The client secret provided by the 3rd party platform. + * Optional. The client secret provided by the 3rd party platform. */ clientSecret?: string | null; /** @@ -6260,7 +6485,7 @@ export namespace dialogflow_v3beta1 { */ transitionRouteGroups?: string[] | null; /** - * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. + * A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. */ transitionRoutes?: Schema$GoogleCloudDialogflowCxV3TransitionRoute[]; } @@ -6841,7 +7066,7 @@ export namespace dialogflow_v3beta1 { */ clientId?: string | null; /** - * Required. The client secret provided by the 3rd party platform. + * Optional. The client secret provided by the 3rd party platform. */ clientSecret?: string | null; /** @@ -7369,6 +7594,15 @@ export namespace dialogflow_v3beta1 { */ source?: string | null; } + /** + * Suggestion generated using free form generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1FreeFormSuggestion { + /** + * Required. Free form suggestion. + */ + response?: string | null; + } /** * Google Cloud Storage location for the output. */ @@ -7378,6 +7612,49 @@ export namespace dialogflow_v3beta1 { */ uri?: string | null; } + /** + * The response message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse { + /** + * The answers generated for the conversation based on context. + */ + generatorSuggestionAnswers?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer[]; + /** + * The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + } + /** + * A GeneratorSuggestion answer. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer { + /** + * Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. + */ + answerRecord?: string | null; + /** + * Suggestion details. + */ + generatorSuggestion?: Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestion; + /** + * The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`. + */ + sourceGenerator?: string | null; + } + /** + * Suggestion generated using a Generator. + */ + export interface Schema$GoogleCloudDialogflowV2beta1GeneratorSuggestion { + /** + * Optional. Free form suggestion. + */ + freeFormSuggestion?: Schema$GoogleCloudDialogflowV2beta1FreeFormSuggestion; + /** + * Optional. Suggested summary. + */ + summarySuggestion?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestion; + } /** * Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation. */ @@ -8471,7 +8748,7 @@ export namespace dialogflow_v3beta1 { */ responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** - * Optional. The time when the message was sent. + * Optional. The time when the message was sent. For voice messages, this is the time when an utterance started. */ sendTime?: string | null; /** @@ -8616,7 +8893,7 @@ export namespace dialogflow_v3beta1 { */ 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. + * 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 Dialogflow 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 { /** @@ -8870,6 +9147,10 @@ export namespace dialogflow_v3beta1 { * Error status if the request failed. */ error?: Schema$GoogleRpcStatus; + /** + * Suggestions generated using generators triggered by customer or agent messages. + */ + generateSuggestionsResponse?: Schema$GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse; /** * SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. */ @@ -8929,6 +9210,28 @@ export namespace dialogflow_v3beta1 { */ smartReplyAnswers?: Schema$GoogleCloudDialogflowV2beta1SmartReplyAnswer[]; } + /** + * Suggested summary of the conversation. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarySuggestion { + /** + * Required. All the parts of generated summary. + */ + summarySections?: Schema$GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection[]; + } + /** + * A component of the generated summary. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection { + /** + * Required. Name of the section. + */ + section?: string | null; + /** + * Required. Summary text for the section. + */ + summary?: string | null; + } /** * A wrapper of repeated TelephonyDtmf digits. */ @@ -9312,6 +9615,15 @@ export namespace dialogflow_v3beta1 { */ source?: string | null; } + /** + * Suggestion generated using free form generator. + */ + export interface Schema$GoogleCloudDialogflowV2FreeFormSuggestion { + /** + * Required. Free form suggestion. + */ + response?: string | null; + } /** * Google Cloud Storage location for the output. */ @@ -9321,6 +9633,49 @@ export namespace dialogflow_v3beta1 { */ uri?: string | null; } + /** + * The response message for Conversations.GenerateSuggestions. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponse { + /** + * The answers generated for the conversation based on context. + */ + generatorSuggestionAnswers?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer[]; + /** + * The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`. + */ + latestMessage?: string | null; + } + /** + * A GeneratorSuggestion answer. + */ + export interface Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer { + /** + * Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback. + */ + answerRecord?: string | null; + /** + * Suggestion details. + */ + generatorSuggestion?: Schema$GoogleCloudDialogflowV2GeneratorSuggestion; + /** + * The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`. + */ + sourceGenerator?: string | null; + } + /** + * Suggestion generated using a Generator. + */ + export interface Schema$GoogleCloudDialogflowV2GeneratorSuggestion { + /** + * Optional. Free form suggestion. + */ + freeFormSuggestion?: Schema$GoogleCloudDialogflowV2FreeFormSuggestion; + /** + * Optional. Suggested summary. + */ + summarySuggestion?: Schema$GoogleCloudDialogflowV2SummarySuggestion; + } /** * Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation. */ @@ -10185,7 +10540,7 @@ export namespace dialogflow_v3beta1 { */ participantRole?: string | null; /** - * Optional. The time when the message was sent. + * Optional. The time when the message was sent. For voice messages, this is the time when an utterance started. */ sendTime?: string | null; /** @@ -10474,6 +10829,10 @@ export namespace dialogflow_v3beta1 { * Error status if the request failed. */ error?: Schema$GoogleRpcStatus; + /** + * Suggestions generated using generators triggered by customer or agent messages. + */ + generateSuggestionsResponse?: Schema$GoogleCloudDialogflowV2GenerateSuggestionsResponse; /** * SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. */ @@ -10525,6 +10884,28 @@ export namespace dialogflow_v3beta1 { */ smartReplyAnswers?: Schema$GoogleCloudDialogflowV2SmartReplyAnswer[]; } + /** + * Suggested summary of the conversation. + */ + export interface Schema$GoogleCloudDialogflowV2SummarySuggestion { + /** + * Required. All the parts of generated summary. + */ + summarySections?: Schema$GoogleCloudDialogflowV2SummarySuggestionSummarySection[]; + } + /** + * A component of the generated summary. + */ + export interface Schema$GoogleCloudDialogflowV2SummarySuggestionSummarySection { + /** + * Required. Name of the section. + */ + section?: string | null; + /** + * Required. Summary text for the section. + */ + summary?: string | null; + } /** * Metadata for a ConversationModels.UndeployConversationModel operation. */ @@ -24792,8 +25173,12 @@ export namespace dialogflow_v3beta1 { export class Resource$Projects$Locations$Agents$Tools { context: APIRequestContext; + versions: Resource$Projects$Locations$Agents$Tools$Versions; constructor(context: APIRequestContext) { this.context = context; + this.versions = new Resource$Projects$Locations$Agents$Tools$Versions( + this.context + ); } /** @@ -25436,6 +25821,549 @@ export namespace dialogflow_v3beta1 { requestBody?: Schema$GoogleCloudDialogflowCxV3beta1Tool; } + export class Resource$Projects$Locations$Agents$Tools$Versions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a version for the specified Tool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Tools$Versions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Agents$Tools$Versions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Tools$Versions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Tools$Versions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Tools$Versions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3beta1/{+parent}/versions').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 version of the Tool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Tools$Versions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Agents$Tools$Versions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Tools$Versions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Tools$Versions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Tools$Versions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3beta1/{+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 the specified version of the Tool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Tools$Versions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Agents$Tools$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Tools$Versions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Tools$Versions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Tools$Versions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3beta1/{+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 versions of the specified Tool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Agents$Tools$Versions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Agents$Tools$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Tools$Versions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Tools$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Tools$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3beta1/{+parent}/versions').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 + ); + } + } + + /** + * Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources 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. + */ + restore( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore, + options: StreamMethodOptions + ): GaxiosPromise; + restore( + params?: Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore, + callback: BodyResponseCallback + ): void; + restore( + callback: BodyResponseCallback + ): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3beta1/{+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$Agents$Tools$Versions$Create + extends StandardParameters { + /** + * Required. The tool to create a version for. Format: `projects//locations//agents//tools/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3beta1ToolVersion; + } + export interface Params$Resource$Projects$Locations$Agents$Tools$Versions$Delete + extends StandardParameters { + /** + * Optional. This field has no effect for Tools not being used. For Tools that are used: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the tool, as well as any references to the tool. + */ + force?: boolean; + /** + * Required. The name of the tool version to delete. Format: `projects//locations//agents//tools//versions/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Tools$Versions$Get + extends StandardParameters { + /** + * Required. The name of the tool version. Format: `projects//locations//agents//tools//versions/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Tools$Versions$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The parent of the tool versions. Format: `projects//locations//agents//tools/`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Tools$Versions$Restore + extends StandardParameters { + /** + * Required. The name of the tool version. Format: `projects//locations//agents//tools//versions/`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3beta1RestoreToolVersionRequest; + } + export class Resource$Projects$Locations$Agents$Transitionroutegroups { context: APIRequestContext; constructor(context: APIRequestContext) { From 1051513022015b5211e1a1cbe2f097adbef1fd1a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 055/144] feat(digitalassetlinks): update the API #### digitalassetlinks:v1 The following keys were added: - resources.assetlinks.methods.bulkCheck.description - resources.assetlinks.methods.bulkCheck.flatPath - resources.assetlinks.methods.bulkCheck.httpMethod - resources.assetlinks.methods.bulkCheck.id - resources.assetlinks.methods.bulkCheck.parameterOrder - resources.assetlinks.methods.bulkCheck.path - resources.assetlinks.methods.bulkCheck.request.$ref - resources.assetlinks.methods.bulkCheck.response.$ref - schemas.BulkCheckRequest.description - schemas.BulkCheckRequest.id - schemas.BulkCheckRequest.properties.defaultRelation.description - schemas.BulkCheckRequest.properties.defaultRelation.type - schemas.BulkCheckRequest.properties.defaultSource.$ref - schemas.BulkCheckRequest.properties.defaultSource.description - schemas.BulkCheckRequest.properties.defaultTarget.$ref - schemas.BulkCheckRequest.properties.defaultTarget.description - schemas.BulkCheckRequest.properties.statements.description - schemas.BulkCheckRequest.properties.statements.items.$ref - schemas.BulkCheckRequest.properties.statements.type - schemas.BulkCheckRequest.type - schemas.BulkCheckResponse.description - schemas.BulkCheckResponse.id - schemas.BulkCheckResponse.properties.bulkErrorCode.description - schemas.BulkCheckResponse.properties.bulkErrorCode.enum - schemas.BulkCheckResponse.properties.bulkErrorCode.enumDescriptions - schemas.BulkCheckResponse.properties.bulkErrorCode.type - schemas.BulkCheckResponse.properties.checkResults.description - schemas.BulkCheckResponse.properties.checkResults.items.$ref - schemas.BulkCheckResponse.properties.checkResults.type - schemas.BulkCheckResponse.type - schemas.StatementTemplate.description - schemas.StatementTemplate.id - schemas.StatementTemplate.properties.relation.description - schemas.StatementTemplate.properties.relation.type - schemas.StatementTemplate.properties.source.$ref - schemas.StatementTemplate.properties.source.description - schemas.StatementTemplate.properties.target.$ref - schemas.StatementTemplate.properties.target.description - schemas.StatementTemplate.type --- discovery/digitalassetlinks-v1.json | 106 +++++++++++++++++++- src/apis/digitalassetlinks/v1.ts | 150 ++++++++++++++++++++++++++++ 2 files changed, 255 insertions(+), 1 deletion(-) diff --git a/discovery/digitalassetlinks-v1.json b/discovery/digitalassetlinks-v1.json index 110bcf6e024..9a7cd5f8453 100644 --- a/discovery/digitalassetlinks-v1.json +++ b/discovery/digitalassetlinks-v1.json @@ -97,6 +97,21 @@ "resources": { "assetlinks": { "methods": { + "bulkCheck": { + "description": "Send a bundle of statement checks in a single RPC to minimize latency and service load. Statements need not be all for the same source and/or target. We recommend using this method when you need to check more than one statement in a short period of time.", + "flatPath": "v1/assetlinks:bulkCheck", + "httpMethod": "POST", + "id": "digitalassetlinks.assetlinks.bulkCheck", + "parameterOrder": [], + "parameters": {}, + "path": "v1/assetlinks:bulkCheck", + "request": { + "$ref": "BulkCheckRequest" + }, + "response": { + "$ref": "BulkCheckResponse" + } + }, "check": { "description": "Determines whether the specified (directional) relationship exists between the specified source and target assets. The relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions. This command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed. A note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with `http://` instead of `https://`), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).", "flatPath": "v1/assetlinks:check", @@ -185,7 +200,7 @@ } } }, - "revision": "20241207", + "revision": "20250211", "rootUrl": "https://digitalassetlinks.googleapis.com/", "schemas": { "AndroidAppAsset": { @@ -218,6 +233,76 @@ }, "type": "object" }, + "BulkCheckRequest": { + "description": "Message used to check for the existence of multiple digital asset links within a single RPC.", + "id": "BulkCheckRequest", + "properties": { + "defaultRelation": { + "description": "If specified, will be used in any given template statement that doesn’t specify a relation.", + "type": "string" + }, + "defaultSource": { + "$ref": "Asset", + "description": "If specified, will be used in any given template statement that doesn’t specify a source." + }, + "defaultTarget": { + "$ref": "Asset", + "description": "If specified, will be used in any given template statement that doesn’t specify a target." + }, + "statements": { + "description": "List of statements to check. For each statement, you can omit a field if the corresponding default_* field below was supplied. Minimum 1 statement; maximum 1,000 statements. Any additional statements will be ignored.", + "items": { + "$ref": "StatementTemplate" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkCheckResponse": { + "description": "Response for BulkCheck call. Results are sent in a list in the same order in which they were sent. Individual check errors are described in the appropriate check_results entry. If the entire call fails, the response will include a bulk_error_code field describing the error.", + "id": "BulkCheckResponse", + "properties": { + "bulkErrorCode": { + "description": "Error code for the entire request. Present only if the entire request failed. Individual check errors will not trigger the presence of this field.", + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "ERROR_CODE_INVALID_QUERY", + "ERROR_CODE_FETCH_ERROR", + "ERROR_CODE_FAILED_SSL_VALIDATION", + "ERROR_CODE_REDIRECT", + "ERROR_CODE_TOO_LARGE", + "ERROR_CODE_MALFORMED_HTTP_RESPONSE", + "ERROR_CODE_WRONG_CONTENT_TYPE", + "ERROR_CODE_MALFORMED_CONTENT", + "ERROR_CODE_SECURE_ASSET_INCLUDES_INSECURE", + "ERROR_CODE_FETCH_BUDGET_EXHAUSTED" + ], + "enumDescriptions": [ + "Default value, otherwise unused.", + "Unable to parse query.", + "Unable to fetch the asset links data.", + "Invalid HTTPS certificate .", + "HTTP redirects (e.g, 301) are not allowed.", + "Asset links data exceeds maximum size.", + "Can't parse HTTP response.", + "HTTP Content-type should be application/json.", + "JSON content is malformed.", + "A secure asset includes an insecure asset (security downgrade).", + "Too many includes (maybe a loop)." + ], + "type": "string" + }, + "checkResults": { + "description": "List of results for each check request. Results are returned in the same order in which they were sent in the request.", + "items": { + "$ref": "CheckResponse" + }, + "type": "array" + } + }, + "type": "object" + }, "CertificateInfo": { "description": "Describes an X509 certificate.", "id": "CertificateInfo", @@ -357,6 +442,25 @@ }, "type": "object" }, + "StatementTemplate": { + "description": "A single statement to check in a bulk call using BulkCheck. See CheckRequest for details about each field.", + "id": "StatementTemplate", + "properties": { + "relation": { + "description": "The relationship being asserted between the source and target. If omitted, you must specify a BulkCheckRequest.default_relation value to use here.", + "type": "string" + }, + "source": { + "$ref": "Asset", + "description": "The source asset that is asserting the statement. If omitted, you must specify a BulkCheckRequest.default_source value to use here." + }, + "target": { + "$ref": "Asset", + "description": "The target that the source is declaring the relationship with. If omitted, you must specify a BulkCheckRequest.default_target to use here." + } + }, + "type": "object" + }, "WebAsset": { "description": "Describes a web asset.", "id": "WebAsset", diff --git a/src/apis/digitalassetlinks/v1.ts b/src/apis/digitalassetlinks/v1.ts index 59e298ed0c0..76451226266 100644 --- a/src/apis/digitalassetlinks/v1.ts +++ b/src/apis/digitalassetlinks/v1.ts @@ -152,6 +152,40 @@ export namespace digitalassetlinks_v1 { */ web?: Schema$WebAsset; } + /** + * Message used to check for the existence of multiple digital asset links within a single RPC. + */ + export interface Schema$BulkCheckRequest { + /** + * If specified, will be used in any given template statement that doesn’t specify a relation. + */ + defaultRelation?: string | null; + /** + * If specified, will be used in any given template statement that doesn’t specify a source. + */ + defaultSource?: Schema$Asset; + /** + * If specified, will be used in any given template statement that doesn’t specify a target. + */ + defaultTarget?: Schema$Asset; + /** + * List of statements to check. For each statement, you can omit a field if the corresponding default_* field below was supplied. Minimum 1 statement; maximum 1,000 statements. Any additional statements will be ignored. + */ + statements?: Schema$StatementTemplate[]; + } + /** + * Response for BulkCheck call. Results are sent in a list in the same order in which they were sent. Individual check errors are described in the appropriate check_results entry. If the entire call fails, the response will include a bulk_error_code field describing the error. + */ + export interface Schema$BulkCheckResponse { + /** + * Error code for the entire request. Present only if the entire request failed. Individual check errors will not trigger the presence of this field. + */ + bulkErrorCode?: string | null; + /** + * List of results for each check request. Results are returned in the same order in which they were sent in the request. + */ + checkResults?: Schema$CheckResponse[]; + } /** * Describes an X509 certificate. */ @@ -220,6 +254,23 @@ export namespace digitalassetlinks_v1 { */ target?: Schema$Asset; } + /** + * A single statement to check in a bulk call using BulkCheck. See CheckRequest for details about each field. + */ + export interface Schema$StatementTemplate { + /** + * The relationship being asserted between the source and target. If omitted, you must specify a BulkCheckRequest.default_relation value to use here. + */ + relation?: string | null; + /** + * The source asset that is asserting the statement. If omitted, you must specify a BulkCheckRequest.default_source value to use here. + */ + source?: Schema$Asset; + /** + * The target that the source is declaring the relationship with. If omitted, you must specify a BulkCheckRequest.default_target to use here. + */ + target?: Schema$Asset; + } /** * Describes a web asset. */ @@ -236,6 +287,98 @@ export namespace digitalassetlinks_v1 { this.context = context; } + /** + * Send a bundle of statement checks in a single RPC to minimize latency and service load. Statements need not be all for the same source and/or target. We recommend using this method when you need to check more than one statement in a short period of time. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkCheck( + params: Params$Resource$Assetlinks$Bulkcheck, + options: StreamMethodOptions + ): GaxiosPromise; + bulkCheck( + params?: Params$Resource$Assetlinks$Bulkcheck, + options?: MethodOptions + ): GaxiosPromise; + bulkCheck( + params: Params$Resource$Assetlinks$Bulkcheck, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkCheck( + params: Params$Resource$Assetlinks$Bulkcheck, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkCheck( + params: Params$Resource$Assetlinks$Bulkcheck, + callback: BodyResponseCallback + ): void; + bulkCheck(callback: BodyResponseCallback): void; + bulkCheck( + paramsOrCallback?: + | Params$Resource$Assetlinks$Bulkcheck + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Assetlinks$Bulkcheck; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Assetlinks$Bulkcheck; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://digitalassetlinks.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/assetlinks:bulkCheck').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Determines whether the specified (directional) relationship exists between the specified source and target assets. The relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions. This command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed. A note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with `http://` instead of `https://`), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). * @@ -325,6 +468,13 @@ export namespace digitalassetlinks_v1 { } } + export interface Params$Resource$Assetlinks$Bulkcheck + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$BulkCheckRequest; + } export interface Params$Resource$Assetlinks$Check extends StandardParameters { /** * Query string for the relation. We identify relations with strings of the format `/`, where `` must be one of a set of pre-defined purpose categories, and `` is a free-form lowercase alphanumeric string that describes the specific use case of the statement. Refer to [our API documentation](/digital-asset-links/v1/relation-strings) for the current list of supported relations. For a query to match an asset link, both the query's and the asset link's relation strings must match exactly. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`. From 5a217283b6fd3731d28be3c203900910c94080ca Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 056/144] feat(discoveryengine)!: update the API BREAKING CHANGE: This release has breaking changes. #### discoveryengine:v1alpha The following keys were deleted: - resources.projects.resources.locations.methods.generateGroundedContent.description - resources.projects.resources.locations.methods.generateGroundedContent.flatPath - resources.projects.resources.locations.methods.generateGroundedContent.httpMethod - resources.projects.resources.locations.methods.generateGroundedContent.id - resources.projects.resources.locations.methods.generateGroundedContent.parameterOrder - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.description - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.location - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.pattern - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.required - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.type - resources.projects.resources.locations.methods.generateGroundedContent.path - resources.projects.resources.locations.methods.generateGroundedContent.request.$ref - resources.projects.resources.locations.methods.generateGroundedContent.response.$ref - resources.projects.resources.locations.methods.generateGroundedContent.scopes - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.contents.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.contents.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.contents.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.generationSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.generationSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.groundingSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.groundingSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.systemInstruction.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.systemInstruction.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.userLabels.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.userLabels.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.properties.userLabels.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration.properties.predictor.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration.properties.predictor.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.enum - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.languageCode.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.languageCode.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.modelId.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.modelId.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.seed.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.seed.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.seed.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.temperature.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.temperature.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.temperature.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.topK.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.topK.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.topK.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.topP.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.topP.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.properties.topP.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.properties.googleSearchSource.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.properties.googleSearchSource.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.properties.searchSource.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.properties.searchSource.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.properties.dynamicRetrievalConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.properties.dynamicRetrievalConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.filter.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.filter.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.safeSearch.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.safeSearch.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.servingConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.servingConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec.properties.groundingSources.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec.properties.groundingSources.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec.properties.groundingSources.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse.properties.candidates.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse.properties.candidates.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse.properties.candidates.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.content.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.content.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.groundingMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.groundingMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.groundingScore.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.groundingScore.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.groundingScore.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.index.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.index.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.properties.index.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.searchEntryPoint.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.searchEntryPoint.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.items.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.properties.predictorMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.properties.predictorMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.enum - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.claimText.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.claimText.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.items.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.items.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.dynamicRetrievalMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.dynamicRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.enum - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.id - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.renderedContent.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.renderedContent.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.description - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.format - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.type - schemas.GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.type - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent.description - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent.id - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent.properties.parts.description - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent.properties.parts.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent.properties.parts.type - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent.properties.role.description - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent.properties.role.type - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent.type - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart.description - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart.id - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart.properties.text.description - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart.properties.text.type - schemas.GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart.type - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.description - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.id - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.properties.sitemapsMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.properties.sitemapsMetadata.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.properties.sitemapsMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.type - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.properties.sitemap.$ref - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.properties.sitemap.description - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.type The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/cloud_search.query.description - resources.media.methods.upload.description - resources.media.methods.upload.flatPath - resources.media.methods.upload.httpMethod - resources.media.methods.upload.id - resources.media.methods.upload.mediaUpload.accept - resources.media.methods.upload.mediaUpload.protocols.simple.multipart - resources.media.methods.upload.mediaUpload.protocols.simple.path - resources.media.methods.upload.parameterOrder - resources.media.methods.upload.parameters.parent.description - resources.media.methods.upload.parameters.parent.location - resources.media.methods.upload.parameters.parent.pattern - resources.media.methods.upload.parameters.parent.required - resources.media.methods.upload.parameters.parent.type - resources.media.methods.upload.path - resources.media.methods.upload.request.$ref - resources.media.methods.upload.response.$ref - resources.media.methods.upload.scopes - resources.media.methods.upload.supportsMediaUpload - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.description - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.flatPath - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.httpMethod - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.id - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.parameterOrder - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.path - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.response.$ref - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.repeated - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.acceptCache.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.acceptCache.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.acceptCache.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.acceptCache.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.acceptCache.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.acceptCache.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.scopes - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.description - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.id - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.acceptCache.description - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.acceptCache.location - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.acceptCache.type - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.path - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.create.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.create.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.create.id - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.path - resources.projects.resources.locations.resources.identityMappingStores.methods.create.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.create.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.create.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.description - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.id - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.path - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.get.description - resources.projects.resources.locations.resources.identityMappingStores.methods.get.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.get.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.get.id - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.description - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.location - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.required - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.type - resources.projects.resources.locations.resources.identityMappingStores.methods.get.path - resources.projects.resources.locations.resources.identityMappingStores.methods.get.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.get.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.list.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.list.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.list.id - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.path - resources.projects.resources.locations.resources.identityMappingStores.methods.list.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.list.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.format - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.scopes - schemas.ApiservingMediaRequestInfo.description - schemas.ApiservingMediaRequestInfo.id - schemas.ApiservingMediaRequestInfo.properties.currentBytes.description - schemas.ApiservingMediaRequestInfo.properties.currentBytes.format - schemas.ApiservingMediaRequestInfo.properties.currentBytes.type - schemas.ApiservingMediaRequestInfo.properties.customData.description - schemas.ApiservingMediaRequestInfo.properties.customData.type - schemas.ApiservingMediaRequestInfo.properties.diffObjectVersion.description - schemas.ApiservingMediaRequestInfo.properties.diffObjectVersion.type - schemas.ApiservingMediaRequestInfo.properties.finalStatus.description - schemas.ApiservingMediaRequestInfo.properties.finalStatus.format - schemas.ApiservingMediaRequestInfo.properties.finalStatus.type - schemas.ApiservingMediaRequestInfo.properties.notificationType.description - schemas.ApiservingMediaRequestInfo.properties.notificationType.enum - schemas.ApiservingMediaRequestInfo.properties.notificationType.enumDescriptions - schemas.ApiservingMediaRequestInfo.properties.notificationType.type - schemas.ApiservingMediaRequestInfo.properties.requestId.description - schemas.ApiservingMediaRequestInfo.properties.requestId.type - schemas.ApiservingMediaRequestInfo.properties.requestReceivedParamsServingInfo.description - schemas.ApiservingMediaRequestInfo.properties.requestReceivedParamsServingInfo.format - schemas.ApiservingMediaRequestInfo.properties.requestReceivedParamsServingInfo.type - schemas.ApiservingMediaRequestInfo.properties.totalBytes.description - schemas.ApiservingMediaRequestInfo.properties.totalBytes.format - schemas.ApiservingMediaRequestInfo.properties.totalBytes.type - schemas.ApiservingMediaRequestInfo.properties.totalBytesIsEstimated.description - schemas.ApiservingMediaRequestInfo.properties.totalBytesIsEstimated.type - schemas.ApiservingMediaRequestInfo.type - schemas.ApiservingMediaResponseInfo.description - schemas.ApiservingMediaResponseInfo.id - schemas.ApiservingMediaResponseInfo.properties.customData.description - schemas.ApiservingMediaResponseInfo.properties.customData.type - schemas.ApiservingMediaResponseInfo.properties.dataStorageTransform.description - schemas.ApiservingMediaResponseInfo.properties.dataStorageTransform.format - schemas.ApiservingMediaResponseInfo.properties.dataStorageTransform.type - schemas.ApiservingMediaResponseInfo.properties.dynamicDropTarget.description - schemas.ApiservingMediaResponseInfo.properties.dynamicDropTarget.format - schemas.ApiservingMediaResponseInfo.properties.dynamicDropTarget.type - schemas.ApiservingMediaResponseInfo.properties.dynamicDropzone.description - schemas.ApiservingMediaResponseInfo.properties.dynamicDropzone.type - schemas.ApiservingMediaResponseInfo.properties.mediaForDiff.$ref - schemas.ApiservingMediaResponseInfo.properties.mediaForDiff.description - schemas.ApiservingMediaResponseInfo.properties.requestClass.description - schemas.ApiservingMediaResponseInfo.properties.requestClass.enum - schemas.ApiservingMediaResponseInfo.properties.requestClass.enumDescriptions - schemas.ApiservingMediaResponseInfo.properties.requestClass.type - schemas.ApiservingMediaResponseInfo.properties.scottyAgentUserId.description - schemas.ApiservingMediaResponseInfo.properties.scottyAgentUserId.format - schemas.ApiservingMediaResponseInfo.properties.scottyAgentUserId.type - schemas.ApiservingMediaResponseInfo.properties.scottyCustomerLog.description - schemas.ApiservingMediaResponseInfo.properties.scottyCustomerLog.format - schemas.ApiservingMediaResponseInfo.properties.scottyCustomerLog.type - schemas.ApiservingMediaResponseInfo.properties.trafficClassField.description - schemas.ApiservingMediaResponseInfo.properties.trafficClassField.enum - schemas.ApiservingMediaResponseInfo.properties.trafficClassField.enumDescriptions - schemas.ApiservingMediaResponseInfo.properties.trafficClassField.type - schemas.ApiservingMediaResponseInfo.properties.verifyHashFromHeader.description - schemas.ApiservingMediaResponseInfo.properties.verifyHashFromHeader.type - schemas.ApiservingMediaResponseInfo.type - schemas.GdataBlobstore2Info.description - schemas.GdataBlobstore2Info.id - schemas.GdataBlobstore2Info.properties.blobGeneration.description - schemas.GdataBlobstore2Info.properties.blobGeneration.format - schemas.GdataBlobstore2Info.properties.blobGeneration.type - schemas.GdataBlobstore2Info.properties.blobId.description - schemas.GdataBlobstore2Info.properties.blobId.type - schemas.GdataBlobstore2Info.properties.downloadReadHandle.description - schemas.GdataBlobstore2Info.properties.downloadReadHandle.format - schemas.GdataBlobstore2Info.properties.downloadReadHandle.type - schemas.GdataBlobstore2Info.properties.readToken.description - schemas.GdataBlobstore2Info.properties.readToken.type - schemas.GdataBlobstore2Info.properties.uploadMetadataContainer.description - schemas.GdataBlobstore2Info.properties.uploadMetadataContainer.format - schemas.GdataBlobstore2Info.properties.uploadMetadataContainer.type - schemas.GdataBlobstore2Info.type - schemas.GdataCompositeMedia.description - schemas.GdataCompositeMedia.id - schemas.GdataCompositeMedia.properties.blobRef.deprecated - schemas.GdataCompositeMedia.properties.blobRef.description - schemas.GdataCompositeMedia.properties.blobRef.format - schemas.GdataCompositeMedia.properties.blobRef.type - schemas.GdataCompositeMedia.properties.blobstore2Info.$ref - schemas.GdataCompositeMedia.properties.blobstore2Info.description - schemas.GdataCompositeMedia.properties.cosmoBinaryReference.description - schemas.GdataCompositeMedia.properties.cosmoBinaryReference.format - schemas.GdataCompositeMedia.properties.cosmoBinaryReference.type - schemas.GdataCompositeMedia.properties.crc32cHash.description - schemas.GdataCompositeMedia.properties.crc32cHash.format - schemas.GdataCompositeMedia.properties.crc32cHash.type - schemas.GdataCompositeMedia.properties.inline.description - schemas.GdataCompositeMedia.properties.inline.format - schemas.GdataCompositeMedia.properties.inline.type - schemas.GdataCompositeMedia.properties.length.description - schemas.GdataCompositeMedia.properties.length.format - schemas.GdataCompositeMedia.properties.length.type - schemas.GdataCompositeMedia.properties.md5Hash.description - schemas.GdataCompositeMedia.properties.md5Hash.format - schemas.GdataCompositeMedia.properties.md5Hash.type - schemas.GdataCompositeMedia.properties.objectId.$ref - schemas.GdataCompositeMedia.properties.objectId.description - schemas.GdataCompositeMedia.properties.path.description - schemas.GdataCompositeMedia.properties.path.type - schemas.GdataCompositeMedia.properties.referenceType.description - schemas.GdataCompositeMedia.properties.referenceType.enum - schemas.GdataCompositeMedia.properties.referenceType.enumDescriptions - schemas.GdataCompositeMedia.properties.referenceType.type - schemas.GdataCompositeMedia.properties.sha1Hash.description - schemas.GdataCompositeMedia.properties.sha1Hash.format - schemas.GdataCompositeMedia.properties.sha1Hash.type - schemas.GdataCompositeMedia.type - schemas.GdataContentTypeInfo.description - schemas.GdataContentTypeInfo.id - schemas.GdataContentTypeInfo.properties.bestGuess.description - schemas.GdataContentTypeInfo.properties.bestGuess.type - schemas.GdataContentTypeInfo.properties.fromBytes.description - schemas.GdataContentTypeInfo.properties.fromBytes.type - schemas.GdataContentTypeInfo.properties.fromFileName.description - schemas.GdataContentTypeInfo.properties.fromFileName.type - schemas.GdataContentTypeInfo.properties.fromHeader.description - schemas.GdataContentTypeInfo.properties.fromHeader.type - schemas.GdataContentTypeInfo.properties.fromUrlPath.description - schemas.GdataContentTypeInfo.properties.fromUrlPath.type - schemas.GdataContentTypeInfo.type - schemas.GdataDiffChecksumsResponse.description - schemas.GdataDiffChecksumsResponse.id - schemas.GdataDiffChecksumsResponse.properties.checksumsLocation.$ref - schemas.GdataDiffChecksumsResponse.properties.checksumsLocation.description - schemas.GdataDiffChecksumsResponse.properties.chunkSizeBytes.description - schemas.GdataDiffChecksumsResponse.properties.chunkSizeBytes.format - schemas.GdataDiffChecksumsResponse.properties.chunkSizeBytes.type - schemas.GdataDiffChecksumsResponse.properties.objectLocation.$ref - schemas.GdataDiffChecksumsResponse.properties.objectLocation.description - schemas.GdataDiffChecksumsResponse.properties.objectSizeBytes.description - schemas.GdataDiffChecksumsResponse.properties.objectSizeBytes.format - schemas.GdataDiffChecksumsResponse.properties.objectSizeBytes.type - schemas.GdataDiffChecksumsResponse.properties.objectVersion.description - schemas.GdataDiffChecksumsResponse.properties.objectVersion.type - schemas.GdataDiffChecksumsResponse.type - schemas.GdataDiffDownloadResponse.description - schemas.GdataDiffDownloadResponse.id - schemas.GdataDiffDownloadResponse.properties.objectLocation.$ref - schemas.GdataDiffDownloadResponse.properties.objectLocation.description - schemas.GdataDiffDownloadResponse.type - schemas.GdataDiffUploadRequest.description - schemas.GdataDiffUploadRequest.id - schemas.GdataDiffUploadRequest.properties.checksumsInfo.$ref - schemas.GdataDiffUploadRequest.properties.checksumsInfo.description - schemas.GdataDiffUploadRequest.properties.objectInfo.$ref - schemas.GdataDiffUploadRequest.properties.objectInfo.description - schemas.GdataDiffUploadRequest.properties.objectVersion.description - schemas.GdataDiffUploadRequest.properties.objectVersion.type - schemas.GdataDiffUploadRequest.type - schemas.GdataDiffUploadResponse.description - schemas.GdataDiffUploadResponse.id - schemas.GdataDiffUploadResponse.properties.objectVersion.description - schemas.GdataDiffUploadResponse.properties.objectVersion.type - schemas.GdataDiffUploadResponse.properties.originalObject.$ref - schemas.GdataDiffUploadResponse.properties.originalObject.description - schemas.GdataDiffUploadResponse.type - schemas.GdataDiffVersionResponse.description - schemas.GdataDiffVersionResponse.id - schemas.GdataDiffVersionResponse.properties.objectSizeBytes.description - schemas.GdataDiffVersionResponse.properties.objectSizeBytes.format - schemas.GdataDiffVersionResponse.properties.objectSizeBytes.type - schemas.GdataDiffVersionResponse.properties.objectVersion.description - schemas.GdataDiffVersionResponse.properties.objectVersion.type - schemas.GdataDiffVersionResponse.type - schemas.GdataDownloadParameters.description - schemas.GdataDownloadParameters.id - schemas.GdataDownloadParameters.properties.allowGzipCompression.description - schemas.GdataDownloadParameters.properties.allowGzipCompression.type - schemas.GdataDownloadParameters.properties.ignoreRange.description - schemas.GdataDownloadParameters.properties.ignoreRange.type - schemas.GdataDownloadParameters.type - schemas.GdataMedia.description - schemas.GdataMedia.id - schemas.GdataMedia.properties.algorithm.deprecated - schemas.GdataMedia.properties.algorithm.description - schemas.GdataMedia.properties.algorithm.type - schemas.GdataMedia.properties.bigstoreObjectRef.deprecated - schemas.GdataMedia.properties.bigstoreObjectRef.description - schemas.GdataMedia.properties.bigstoreObjectRef.format - schemas.GdataMedia.properties.bigstoreObjectRef.type - schemas.GdataMedia.properties.blobRef.deprecated - schemas.GdataMedia.properties.blobRef.description - schemas.GdataMedia.properties.blobRef.format - schemas.GdataMedia.properties.blobRef.type - schemas.GdataMedia.properties.blobstore2Info.$ref - schemas.GdataMedia.properties.blobstore2Info.description - schemas.GdataMedia.properties.compositeMedia.description - schemas.GdataMedia.properties.compositeMedia.items.$ref - schemas.GdataMedia.properties.compositeMedia.type - schemas.GdataMedia.properties.contentType.description - schemas.GdataMedia.properties.contentType.type - schemas.GdataMedia.properties.contentTypeInfo.$ref - schemas.GdataMedia.properties.contentTypeInfo.description - schemas.GdataMedia.properties.cosmoBinaryReference.description - schemas.GdataMedia.properties.cosmoBinaryReference.format - schemas.GdataMedia.properties.cosmoBinaryReference.type - schemas.GdataMedia.properties.crc32cHash.description - schemas.GdataMedia.properties.crc32cHash.format - schemas.GdataMedia.properties.crc32cHash.type - schemas.GdataMedia.properties.diffChecksumsResponse.$ref - schemas.GdataMedia.properties.diffChecksumsResponse.description - schemas.GdataMedia.properties.diffDownloadResponse.$ref - schemas.GdataMedia.properties.diffDownloadResponse.description - schemas.GdataMedia.properties.diffUploadRequest.$ref - schemas.GdataMedia.properties.diffUploadRequest.description - schemas.GdataMedia.properties.diffUploadResponse.$ref - schemas.GdataMedia.properties.diffUploadResponse.description - schemas.GdataMedia.properties.diffVersionResponse.$ref - schemas.GdataMedia.properties.diffVersionResponse.description - schemas.GdataMedia.properties.downloadParameters.$ref - schemas.GdataMedia.properties.downloadParameters.description - schemas.GdataMedia.properties.filename.description - schemas.GdataMedia.properties.filename.type - schemas.GdataMedia.properties.hash.deprecated - schemas.GdataMedia.properties.hash.description - schemas.GdataMedia.properties.hash.type - schemas.GdataMedia.properties.hashVerified.description - schemas.GdataMedia.properties.hashVerified.type - schemas.GdataMedia.properties.inline.description - schemas.GdataMedia.properties.inline.format - schemas.GdataMedia.properties.inline.type - schemas.GdataMedia.properties.isPotentialRetry.description - schemas.GdataMedia.properties.isPotentialRetry.type - schemas.GdataMedia.properties.length.description - schemas.GdataMedia.properties.length.format - schemas.GdataMedia.properties.length.type - schemas.GdataMedia.properties.md5Hash.description - schemas.GdataMedia.properties.md5Hash.format - schemas.GdataMedia.properties.md5Hash.type - schemas.GdataMedia.properties.mediaId.description - schemas.GdataMedia.properties.mediaId.format - schemas.GdataMedia.properties.mediaId.type - schemas.GdataMedia.properties.objectId.$ref - schemas.GdataMedia.properties.objectId.description - schemas.GdataMedia.properties.path.description - schemas.GdataMedia.properties.path.type - schemas.GdataMedia.properties.referenceType.description - schemas.GdataMedia.properties.referenceType.enum - schemas.GdataMedia.properties.referenceType.enumDescriptions - schemas.GdataMedia.properties.referenceType.type - schemas.GdataMedia.properties.sha1Hash.description - schemas.GdataMedia.properties.sha1Hash.format - schemas.GdataMedia.properties.sha1Hash.type - schemas.GdataMedia.properties.sha256Hash.description - schemas.GdataMedia.properties.sha256Hash.format - schemas.GdataMedia.properties.sha256Hash.type - schemas.GdataMedia.properties.timestamp.description - schemas.GdataMedia.properties.timestamp.format - schemas.GdataMedia.properties.timestamp.type - schemas.GdataMedia.properties.token.description - schemas.GdataMedia.properties.token.type - schemas.GdataMedia.type - schemas.GdataObjectId.description - schemas.GdataObjectId.id - schemas.GdataObjectId.properties.bucketName.description - schemas.GdataObjectId.properties.bucketName.type - schemas.GdataObjectId.properties.generation.description - schemas.GdataObjectId.properties.generation.format - schemas.GdataObjectId.properties.generation.type - schemas.GdataObjectId.properties.objectName.description - schemas.GdataObjectId.properties.objectName.type - schemas.GdataObjectId.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.id - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.connectorRun.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.connectorRun.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.dataConnector.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.dataConnector.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.format - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.entity.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.entity.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.operation.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.operation.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.format - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.syncType.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.syncType.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.type - schemas.GoogleCloudDiscoveryengineLoggingErrorLog.properties.connectorRunPayload.$ref - schemas.GoogleCloudDiscoveryengineLoggingErrorLog.properties.connectorRunPayload.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1ControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.id - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1EngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1EngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.id - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.readOnly - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.readOnly - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.type - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion.properties.destinationUri.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion.properties.destinationUri.type - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion.properties.iconUri.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion.properties.iconUri.type - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion.properties.score.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion.properties.score.format - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion.properties.score.type - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion.properties.destinationUri.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion.properties.destinationUri.type - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion.properties.displayPhotoUri.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion.properties.displayPhotoUri.type - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion.properties.score.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion.properties.score.format - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion.properties.score.type - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion.properties.score.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion.properties.score.format - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion.properties.score.type - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion.properties.score.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion.properties.score.format - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion.properties.score.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertPolicyName.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertPolicyName.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.id - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.alertId.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.alertId.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.enum - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.type - schemas.GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec.properties.disableSpellCorrection.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec.properties.disableSpellCorrection.type - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.type - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.description - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.enum - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.progress.$ref - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.progress.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.id - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.bapConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.bapConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.startingSchema.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.startingSchema.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.id - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.properties.externalIdentity.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.properties.externalIdentity.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.properties.groupId.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.properties.groupId.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.properties.userId.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.properties.userId.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.id - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.cmekConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.cmekConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.cmekConfig.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.idpConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.idpConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.idpConfig.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.kmsKeyName.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.kmsKeyName.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest.id - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource.id - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse.properties.identityMappingStores.description - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse.properties.identityMappingStores.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse.properties.identityMappingStores.type - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.description - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.id - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.properties.filter.description - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.properties.filter.type - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.properties.force.description - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.properties.force.type - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest.type - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource.description - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource.id - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.items.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.description - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.id - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.removeAllSearchHistorySuggestions.description - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.removeAllSearchHistorySuggestions.type - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.removeTime.description - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.removeTime.format - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.removeTime.type - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.searchHistorySuggestion.description - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.searchHistorySuggestion.type - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.userInfo.$ref - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.properties.userPseudoId.type - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest.type - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.displaySpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.displaySpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceScoreSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo.properties.classifiedIntents.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo.properties.classifiedIntents.items.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo.properties.classifiedIntents.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult.properties.modelScores.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.accessSettings.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.accessSettings.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.allowPublicAccess.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.allowPublicAccess.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.allowPublicAccess.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.allowlistedDomains.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.allowlistedDomains.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.allowlistedDomains.items.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.allowlistedDomains.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.assistantSettings.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.assistantSettings.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.assistantSettings.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.collectionComponents.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.collectionComponents.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.collectionComponents.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.collectionComponents.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.configId.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.configId.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.configId.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.contentSearchSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.contentSearchSpec.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.contentSearchSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.createTime.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.customerProvidedConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.customerProvidedConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.customerProvidedConfig.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreType.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreType.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreUiConfigs.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreUiConfigs.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreUiConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.dataStoreUiConfigs.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.defaultSearchRequestOrderBy.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.defaultSearchRequestOrderBy.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.defaultSearchRequestOrderBy.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableAutocomplete.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableAutocomplete.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableAutocomplete.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableConversationalSearch.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableConversationalSearch.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableConversationalSearch.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableQualityFeedback.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableQualityFeedback.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableQualityFeedback.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableResultScore.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableResultScore.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSafeSearch.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSafeSearch.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSafeSearch.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSearchAsYouType.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSearchAsYouType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSearchAsYouType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSnippetResultSummary.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSnippetResultSummary.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSnippetResultSummary.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSummarization.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSummarization.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableSummarization.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableWebApp.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableWebApp.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableWebApp.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.experimentalFeatures.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.experimentalFeatures.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.experimentalFeatures.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.facetField.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.facetField.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.facetField.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.facetField.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.fieldsUiComponentsMap.additionalProperties.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.fieldsUiComponentsMap.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.fieldsUiComponentsMap.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.fieldsUiComponentsMap.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.homepageSetting.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.homepageSetting.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.industryVertical.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.industryVertical.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.industryVertical.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.industryVertical.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.industryVertical.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.llmEnabled.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.llmEnabled.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.llmEnabled.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.minimumDataTermAccepted.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.minimumDataTermAccepted.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.minimumDataTermAccepted.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.deprecated - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.solutionType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.solutionType.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.solutionType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.solutionType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.uiBranding.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.uiBranding.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.uiSettings.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.uiSettings.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.updateTime.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.allowPublicAccess.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.allowPublicAccess.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.allowlistedDomains.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.allowlistedDomains.items.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.allowlistedDomains.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.enableWebApp.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.enableWebApp.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.languageCode.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.languageCode.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.workforceIdentityPoolProvider.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.properties.workforceIdentityPoolProvider.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings.properties.googleSearchGroundingEnabled.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings.properties.googleSearchGroundingEnabled.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.connectorIconLink.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.connectorIconLink.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.connectorIconLink.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataSource.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataSource.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataStoreComponents.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataStoreComponents.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.dataStoreComponents.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.id.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.id.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.id.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig.properties.customerType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig.properties.customerType.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig.properties.customerType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig.properties.customerType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.contentConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.contentConfig.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.contentConfig.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.contentConfig.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.contentConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.entityName.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.entityName.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.id.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.id.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.id.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.workspaceType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.workspaceType.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.workspaceType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.workspaceType.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.properties.workspaceType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.facetField.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.facetField.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.facetField.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.fieldsUiComponentsMap.additionalProperties.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.fieldsUiComponentsMap.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.fieldsUiComponentsMap.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.id.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.id.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.id.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.properties.name.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField.properties.displayName.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField.properties.displayName.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField.properties.field.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField.properties.field.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting.properties.shortcuts.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting.properties.shortcuts.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting.properties.shortcuts.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.properties.destinationUri.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.properties.destinationUri.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.properties.icon.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.properties.icon.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.properties.title.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.properties.title.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigImage.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigImage.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigImage.properties.url.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigImage.properties.url.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigImage.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.deviceVisibility.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.deviceVisibility.items.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.deviceVisibility.items.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.deviceVisibility.items.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.deviceVisibility.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.displayTemplate.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.displayTemplate.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.field.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.properties.field.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings.properties.logo.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings.properties.logo.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.dataStoreUiConfigs.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.dataStoreUiConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.dataStoreUiConfigs.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.defaultSearchRequestOrderBy.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.defaultSearchRequestOrderBy.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.disableUserEventsCollection.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.disableUserEventsCollection.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableAutocomplete.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableAutocomplete.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableQualityFeedback.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableQualityFeedback.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableSafeSearch.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableSafeSearch.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableSearchAsYouType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableSearchAsYouType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableVisualContentSummary.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableVisualContentSummary.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.generativeAnswerConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.generativeAnswerConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.interactionType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.interactionType.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.interactionType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.interactionType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.resultDescriptionType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.resultDescriptionType.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.resultDescriptionType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.resultDescriptionType.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.disableRelatedQuestions.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.disableRelatedQuestions.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.ignoreAdversarialQuery.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.ignoreAdversarialQuery.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.ignoreLowRelevantContent.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.ignoreLowRelevantContent.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.ignoreNonAnswerSeekingQuery.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.ignoreNonAnswerSeekingQuery.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.imageSource.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.imageSource.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.imageSource.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.imageSource.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.languageCode.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.languageCode.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.maxRephraseSteps.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.maxRephraseSteps.format - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.maxRephraseSteps.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.modelPromptPreamble.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.modelPromptPreamble.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.modelVersion.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.modelVersion.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.resultCount.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.resultCount.format - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.properties.resultCount.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.properties.qpsTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.properties.qpsTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.dedicatedCrawlRateTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.dedicatedCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.organicCrawlRateTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.organicCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.type - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.googleOrganicCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.googleOrganicCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.vertexAiOrganicCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.vertexAiOrganicCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.displaySpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.displaySpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceScoreSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.type - schemas.GoogleCloudNotebooklmV1alphaSourceId.description - schemas.GoogleCloudNotebooklmV1alphaSourceId.id - schemas.GoogleCloudNotebooklmV1alphaSourceId.properties.id.description - schemas.GoogleCloudNotebooklmV1alphaSourceId.properties.id.type - schemas.GoogleCloudNotebooklmV1alphaSourceId.type - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileRequest.description - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileRequest.id - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileRequest.properties.blob.$ref - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileRequest.properties.blob.description - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileRequest.properties.mediaRequestInfo.$ref - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileRequest.properties.mediaRequestInfo.description - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileRequest.type - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileResponse.description - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileResponse.id - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileResponse.properties.mediaResponseInfo.$ref - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileResponse.properties.mediaResponseInfo.description - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileResponse.properties.sourceId.$ref - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileResponse.properties.sourceId.description - schemas.GoogleCloudNotebooklmV1alphaUploadSourceFileResponse.type The following keys were changed: - resources.projects.resources.locations.methods.updateCmekConfig.parameters.name.description - resources.projects.resources.locations.resources.cmekConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.completeQuery.scopes - resources.projects.resources.locations.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1SearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest.properties.queryModel.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerCitation.properties.endIndex.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerCitation.properties.startIndex.description - schemas.GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim.properties.endPos.description - schemas.GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim.properties.startPos.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRun.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRun.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.syncType.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.syncType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.syncMode.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.syncMode.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1alphaRankRequest.properties.model.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest.properties.siteCredential.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpression.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec.properties.condition.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec.properties.condition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec.properties.searchResultPersistenceCount.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult.properties.modelScores.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSummary.properties.summarySkippedReasons.items.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSummary.properties.summarySkippedReasons.items.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpression.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec.properties.condition.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec.properties.condition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec.properties.searchResultPersistenceCount.description #### discoveryengine:v1beta The following keys were deleted: - resources.projects.resources.locations.methods.generateGroundedContent.description - resources.projects.resources.locations.methods.generateGroundedContent.flatPath - resources.projects.resources.locations.methods.generateGroundedContent.httpMethod - resources.projects.resources.locations.methods.generateGroundedContent.id - resources.projects.resources.locations.methods.generateGroundedContent.parameterOrder - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.description - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.location - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.pattern - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.required - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.type - resources.projects.resources.locations.methods.generateGroundedContent.path - resources.projects.resources.locations.methods.generateGroundedContent.request.$ref - resources.projects.resources.locations.methods.generateGroundedContent.response.$ref - resources.projects.resources.locations.methods.generateGroundedContent.scopes - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.properties.sitemapsMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.properties.sitemapsMetadata.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.properties.sitemapsMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.properties.sitemap.$ref - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.properties.sitemap.description - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.contents.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.contents.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.contents.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.generationSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.generationSpec.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.groundingSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.groundingSpec.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.systemInstruction.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.systemInstruction.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.userLabels.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.userLabels.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.properties.userLabels.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration.properties.predictor.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration.properties.predictor.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.enum - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.languageCode.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.languageCode.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.modelId.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.modelId.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.seed.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.seed.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.seed.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.temperature.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.temperature.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.temperature.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.topK.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.topK.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.topK.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.topP.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.topP.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.properties.topP.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.properties.googleSearchSource.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.properties.googleSearchSource.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.properties.searchSource.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.properties.searchSource.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.properties.dynamicRetrievalConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.properties.dynamicRetrievalConfig.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.filter.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.filter.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.safeSearch.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.safeSearch.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.servingConfig.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.properties.servingConfig.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec.properties.groundingSources.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec.properties.groundingSources.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec.properties.groundingSources.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse.properties.candidates.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse.properties.candidates.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse.properties.candidates.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.content.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.content.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.groundingMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.groundingMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.groundingScore.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.groundingScore.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.groundingScore.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.index.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.index.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.properties.index.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.searchEntryPoint.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.searchEntryPoint.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.items.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.properties.predictorMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.properties.predictorMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.enum - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.claimText.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.claimText.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.items.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.items.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.dynamicRetrievalMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.dynamicRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.enum - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.id - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.renderedContent.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.renderedContent.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.description - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.format - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.type - schemas.GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.type - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContent.description - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContent.id - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContent.properties.parts.description - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContent.properties.parts.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContent.properties.parts.type - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContent.properties.role.description - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContent.properties.role.type - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContent.type - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart.description - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart.id - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart.properties.text.description - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart.properties.text.type - schemas.GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart.type The following keys were added: - resources.projects.resources.locations.methods.obtainCrawlRate.description - resources.projects.resources.locations.methods.obtainCrawlRate.flatPath - resources.projects.resources.locations.methods.obtainCrawlRate.httpMethod - resources.projects.resources.locations.methods.obtainCrawlRate.id - resources.projects.resources.locations.methods.obtainCrawlRate.parameterOrder - resources.projects.resources.locations.methods.obtainCrawlRate.parameters.location.description - resources.projects.resources.locations.methods.obtainCrawlRate.parameters.location.location - resources.projects.resources.locations.methods.obtainCrawlRate.parameters.location.pattern - resources.projects.resources.locations.methods.obtainCrawlRate.parameters.location.required - resources.projects.resources.locations.methods.obtainCrawlRate.parameters.location.type - resources.projects.resources.locations.methods.obtainCrawlRate.path - resources.projects.resources.locations.methods.obtainCrawlRate.request.$ref - resources.projects.resources.locations.methods.obtainCrawlRate.response.$ref - resources.projects.resources.locations.methods.obtainCrawlRate.scopes - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.description - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.flatPath - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.httpMethod - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.id - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.parameterOrder - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.parameters.location.description - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.parameters.location.location - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.parameters.location.pattern - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.parameters.location.required - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.parameters.location.type - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.path - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.request.$ref - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.response.$ref - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.scopes - resources.projects.resources.locations.methods.setDedicatedCrawlRate.description - resources.projects.resources.locations.methods.setDedicatedCrawlRate.flatPath - resources.projects.resources.locations.methods.setDedicatedCrawlRate.httpMethod - resources.projects.resources.locations.methods.setDedicatedCrawlRate.id - resources.projects.resources.locations.methods.setDedicatedCrawlRate.parameterOrder - resources.projects.resources.locations.methods.setDedicatedCrawlRate.parameters.location.description - resources.projects.resources.locations.methods.setDedicatedCrawlRate.parameters.location.location - resources.projects.resources.locations.methods.setDedicatedCrawlRate.parameters.location.pattern - resources.projects.resources.locations.methods.setDedicatedCrawlRate.parameters.location.required - resources.projects.resources.locations.methods.setDedicatedCrawlRate.parameters.location.type - resources.projects.resources.locations.methods.setDedicatedCrawlRate.path - resources.projects.resources.locations.methods.setDedicatedCrawlRate.request.$ref - resources.projects.resources.locations.methods.setDedicatedCrawlRate.response.$ref - resources.projects.resources.locations.methods.setDedicatedCrawlRate.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.repeated - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.parameters.completionConfig.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.create.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.create.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.create.id - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.path - resources.projects.resources.locations.resources.identityMappingStores.methods.create.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.create.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.create.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.description - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.id - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.path - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.get.description - resources.projects.resources.locations.resources.identityMappingStores.methods.get.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.get.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.get.id - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.description - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.location - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.required - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.type - resources.projects.resources.locations.resources.identityMappingStores.methods.get.path - resources.projects.resources.locations.resources.identityMappingStores.methods.get.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.get.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.list.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.list.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.list.id - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.path - resources.projects.resources.locations.resources.identityMappingStores.methods.list.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.list.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.format - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.scopes - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.id - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.connectorRun.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.connectorRun.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.dataConnector.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.dataConnector.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.format - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.entity.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.entity.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.operation.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.operation.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.format - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.syncType.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.syncType.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.type - schemas.GoogleCloudDiscoveryengineLoggingErrorLog.properties.connectorRunPayload.$ref - schemas.GoogleCloudDiscoveryengineLoggingErrorLog.properties.connectorRunPayload.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1ControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.id - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1EngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1EngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.id - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.readOnly - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.readOnly - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertPolicyName.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertPolicyName.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.id - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.alertId.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.alertId.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.enum - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.type - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.type - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.description - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.enum - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.progress.$ref - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.progress.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.id - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.bapConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.bapConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.startingSchema.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.startingSchema.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.items.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.displaySpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.displaySpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceScoreSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.type - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion.properties.destinationUri.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion.properties.destinationUri.type - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion.properties.iconUri.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion.properties.iconUri.type - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion.properties.score.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion.properties.score.format - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion.properties.score.type - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion.properties.destinationUri.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion.properties.destinationUri.type - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion.properties.displayPhotoUri.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion.properties.displayPhotoUri.type - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion.properties.score.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion.properties.score.format - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion.properties.score.type - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseQuerySuggestion.properties.score.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseQuerySuggestion.properties.score.format - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseQuerySuggestion.properties.score.type - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseRecentSearchSuggestion.properties.score.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseRecentSearchSuggestion.properties.score.format - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseRecentSearchSuggestion.properties.score.type - schemas.GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec.properties.disableSpellCorrection.description - schemas.GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec.properties.disableSpellCorrection.type - schemas.GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo.properties.title.description - schemas.GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo.properties.title.readOnly - schemas.GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo.properties.title.type - schemas.GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo.properties.uri.readOnly - schemas.GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.properties.qpsTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.properties.qpsTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.id - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.properties.externalIdentity.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.properties.externalIdentity.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.properties.groupId.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.properties.groupId.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.properties.userId.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.properties.userId.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntry.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.id - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.properties.cmekConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.properties.cmekConfig.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.properties.cmekConfig.readOnly - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.properties.kmsKeyName.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.properties.kmsKeyName.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.properties.name.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.properties.name.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest.id - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource.id - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse.description - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse.id - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse.properties.identityMappingStores.description - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse.properties.identityMappingStores.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse.properties.identityMappingStores.type - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse.type - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest.id - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest.properties.crawlRateScope.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest.properties.crawlRateScope.type - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest.type - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.dedicatedCrawlRateTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.dedicatedCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.organicCrawlRateTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.organicCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.type - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.googleOrganicCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.googleOrganicCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.vertexAiOrganicCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.vertexAiOrganicCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.description - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.id - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.properties.filter.description - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.properties.filter.type - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.properties.force.description - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.properties.force.type - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest.type - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource.description - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource.id - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest.properties.crawlRateScope.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest.properties.crawlRateScope.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.removeAllSearchHistorySuggestions.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.removeAllSearchHistorySuggestions.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.removeTime.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.removeTime.format - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.removeTime.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.searchHistorySuggestion.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.searchHistorySuggestion.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.userInfo.$ref - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.userPseudoId.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.properties.userPseudoId.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.displaySpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.displaySpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceScoreSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo.properties.classifiedIntents.description - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo.properties.classifiedIntents.items.type - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo.properties.classifiedIntents.type - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult.properties.modelScores.readOnly - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.id - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlRate.format - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlRate.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlRateScope.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlRateScope.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlType.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlType.enum - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.crawlType.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.mode.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.mode.enum - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.mode.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.properties.mode.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.type The following keys were changed: - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1SearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerCitation.properties.endIndex.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerCitation.properties.startIndex.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRun.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRun.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.syncType.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.syncType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.syncMode.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.syncMode.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpression.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec.properties.condition.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec.properties.condition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec.properties.searchResultPersistenceCount.description - schemas.GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest.properties.queryModel.description - schemas.GoogleCloudDiscoveryengineV1betaAnswerCitation.properties.endIndex.description - schemas.GoogleCloudDiscoveryengineV1betaAnswerCitation.properties.startIndex.description - schemas.GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim.properties.endPos.description - schemas.GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim.properties.startPos.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1betaRankRequest.properties.model.description - schemas.GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest.properties.siteCredential.description - schemas.GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpression.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec.properties.condition.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec.properties.condition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec.properties.searchResultPersistenceCount.description - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult.properties.modelScores.description - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseSummary.properties.summarySkippedReasons.items.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseSummary.properties.summarySkippedReasons.items.enumDescriptions #### discoveryengine:v1 The following keys were deleted: - resources.projects.resources.locations.methods.generateGroundedContent.description - resources.projects.resources.locations.methods.generateGroundedContent.flatPath - resources.projects.resources.locations.methods.generateGroundedContent.httpMethod - resources.projects.resources.locations.methods.generateGroundedContent.id - resources.projects.resources.locations.methods.generateGroundedContent.parameterOrder - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.description - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.location - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.pattern - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.required - resources.projects.resources.locations.methods.generateGroundedContent.parameters.location.type - resources.projects.resources.locations.methods.generateGroundedContent.path - resources.projects.resources.locations.methods.generateGroundedContent.request.$ref - resources.projects.resources.locations.methods.generateGroundedContent.response.$ref - resources.projects.resources.locations.methods.generateGroundedContent.scopes - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.contents.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.contents.items.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.contents.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.generationSpec.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.generationSpec.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.groundingSpec.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.groundingSpec.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.systemInstruction.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.systemInstruction.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.userLabels.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.userLabels.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.properties.userLabels.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration.properties.predictor.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration.properties.predictor.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.threshold.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.enum - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.properties.version.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.frequencyPenalty.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.languageCode.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.languageCode.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.maxOutputTokens.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.modelId.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.modelId.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.presencePenalty.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.seed.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.seed.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.seed.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.temperature.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.temperature.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.temperature.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.topK.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.topK.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.topK.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.topP.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.topP.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.properties.topP.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.properties.googleSearchSource.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.properties.googleSearchSource.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.properties.searchSource.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.properties.searchSource.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource.properties.dynamicRetrievalConfig.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource.properties.dynamicRetrievalConfig.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.additionalProperties.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.properties.attributes.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.items.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.properties.groundingFacts.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.filter.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.filter.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.maxResultCount.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.safeSearch.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.safeSearch.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.servingConfig.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.properties.servingConfig.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec.properties.groundingSources.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec.properties.groundingSources.items.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec.properties.groundingSources.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse.properties.candidates.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse.properties.candidates.items.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse.properties.candidates.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.content.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.content.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.groundingMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.groundingMetadata.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.groundingScore.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.groundingScore.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.groundingScore.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.index.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.index.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.properties.index.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.items.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.groundingSupport.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.items.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.retrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.searchEntryPoint.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.searchEntryPoint.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.items.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.supportChunks.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.items.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.properties.webSearchQueries.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.properties.predictorMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.properties.predictorMetadata.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.prediction.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.enum - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.properties.version.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.claimText.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.claimText.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.items.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.items.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportChunkIndices.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.properties.supportScore.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.dynamicRetrievalMetadata.$ref - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.dynamicRetrievalMetadata.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.enum - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.properties.source.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.id - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.renderedContent.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.renderedContent.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.description - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.format - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.properties.sdkBlob.type - schemas.GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint.type - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContent.description - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContent.id - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContent.properties.parts.description - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContent.properties.parts.items.$ref - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContent.properties.parts.type - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContent.properties.role.description - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContent.properties.role.type - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContent.type - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContentPart.description - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContentPart.id - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContentPart.properties.text.description - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContentPart.properties.text.type - schemas.GoogleCloudDiscoveryengineV1GroundedGenerationContentPart.type - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.properties.sitemapsMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.properties.sitemapsMetadata.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.properties.sitemapsMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.properties.sitemap.$ref - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.properties.sitemap.description - schemas.GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.description - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.id - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.properties.sitemapsMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.properties.sitemapsMetadata.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.properties.sitemapsMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse.type - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.properties.sitemap.$ref - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.properties.sitemap.description - schemas.GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata.type The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.request.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.scopes - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.repeated - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.flatPath - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.id - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.path - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.request.$ref - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.scopes - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.flatPath - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.id - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.path - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.scopes - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.flatPath - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.id - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.location - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.repeated - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.matcher.urisMatcher.uris.type - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.location - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.pattern - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.required - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.parameters.parent.type - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.path - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.create.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.create.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.create.id - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.cmekConfigName.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.disableCmek.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.identityMappingStoreId.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.identityMappingStores.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.identityMappingStores.methods.create.path - resources.projects.resources.locations.resources.identityMappingStores.methods.create.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.create.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.create.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.description - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.id - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.path - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.get.description - resources.projects.resources.locations.resources.identityMappingStores.methods.get.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.get.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.get.id - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.description - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.location - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.required - resources.projects.resources.locations.resources.identityMappingStores.methods.get.parameters.name.type - resources.projects.resources.locations.resources.identityMappingStores.methods.get.path - resources.projects.resources.locations.resources.identityMappingStores.methods.get.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.get.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.list.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.list.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.list.id - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.identityMappingStores.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.identityMappingStores.methods.list.path - resources.projects.resources.locations.resources.identityMappingStores.methods.list.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.list.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.format - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageSize.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.description - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.location - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.parameters.pageToken.type - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.scopes - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.description - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.flatPath - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.httpMethod - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.id - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameterOrder - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.description - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.location - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.pattern - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.required - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.parameters.identityMappingStore.type - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.path - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.request.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.response.$ref - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.scopes - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.id - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.connectorRun.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.connectorRun.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.dataConnector.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.dataConnector.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.format - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.endTime.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.entity.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.entity.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.operation.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.operation.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.format - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.startTime.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.syncType.description - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.properties.syncType.type - schemas.GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext.type - schemas.GoogleCloudDiscoveryengineLoggingErrorLog.properties.connectorRunPayload.$ref - schemas.GoogleCloudDiscoveryengineLoggingErrorLog.properties.connectorRunPayload.description - schemas.GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec.properties.disableSpellCorrection.description - schemas.GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec.properties.disableSpellCorrection.type - schemas.GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo.properties.title.description - schemas.GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo.properties.title.readOnly - schemas.GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo.properties.title.type - schemas.GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo.properties.uri.readOnly - schemas.GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1ControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1CreateSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.id - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1DeleteSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1DoubleList.description - schemas.GoogleCloudDiscoveryengineV1DoubleList.id - schemas.GoogleCloudDiscoveryengineV1DoubleList.properties.values.description - schemas.GoogleCloudDiscoveryengineV1DoubleList.properties.values.items.format - schemas.GoogleCloudDiscoveryengineV1DoubleList.properties.values.items.type - schemas.GoogleCloudDiscoveryengineV1DoubleList.properties.values.type - schemas.GoogleCloudDiscoveryengineV1DoubleList.type - schemas.GoogleCloudDiscoveryengineV1EngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1EngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponse.description - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponse.id - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponse.properties.sitemapsMetadata.description - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponse.properties.sitemapsMetadata.items.$ref - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponse.properties.sitemapsMetadata.type - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponse.type - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata.description - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata.id - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata.properties.sitemap.$ref - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata.properties.sitemap.description - schemas.GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.id - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.properties.externalIdentity.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.properties.externalIdentity.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.properties.groupId.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.properties.groupId.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.properties.userId.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.properties.userId.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntry.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.id - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.properties.cmekConfig.$ref - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.properties.cmekConfig.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.properties.cmekConfig.readOnly - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.properties.kmsKeyName.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.properties.kmsKeyName.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.properties.name.description - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.properties.name.type - schemas.GoogleCloudDiscoveryengineV1IdentityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest.id - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource.id - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse.description - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse.id - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse.properties.identityMappingStores.description - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse.properties.identityMappingStores.items.$ref - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse.properties.identityMappingStores.type - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse.type - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse.properties.nextPageToken.description - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse.properties.nextPageToken.type - schemas.GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.description - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.id - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.properties.filter.description - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.properties.filter.type - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.properties.force.description - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.properties.force.type - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.properties.inlineSource.$ref - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.properties.inlineSource.description - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest.type - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource.description - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource.id - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.description - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.items.$ref - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource.properties.identityMappingEntries.type - schemas.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource.type - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.displaySpec.$ref - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.displaySpec.description - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.relevanceScoreSpec.$ref - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.relevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.relevanceThreshold.enum - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.relevanceThreshold.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.relevanceThreshold.type - schemas.GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.description - schemas.GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.id - schemas.GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.properties.matchHighlightingCondition.description - schemas.GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.properties.matchHighlightingCondition.enum - schemas.GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.properties.matchHighlightingCondition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.properties.matchHighlightingCondition.type - schemas.GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.type - schemas.GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec.id - schemas.GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.description - schemas.GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.type - schemas.GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec.type - schemas.GoogleCloudDiscoveryengineV1SearchResponseSearchResult.properties.modelScores.additionalProperties.$ref - schemas.GoogleCloudDiscoveryengineV1SearchResponseSearchResult.properties.modelScores.description - schemas.GoogleCloudDiscoveryengineV1SearchResponseSearchResult.properties.modelScores.readOnly - schemas.GoogleCloudDiscoveryengineV1SearchResponseSearchResult.properties.modelScores.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.id - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.readOnly - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.readOnly - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.name.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1Sitemap.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1Sitemap.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertEnrollments.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertPolicyName.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.properties.alertPolicyName.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.id - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.alertId.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.alertId.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.description - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.enum - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.properties.enrollState.type - schemas.GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.type - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.title.type - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.description - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.enum - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.items.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.supportedConnectorModes.type - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.deletedRecordCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.progress.$ref - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.progress.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.id - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.currentCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.percentile.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.alertPolicyConfigs.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.bapConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.bapConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.connectorType.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.realtimeState.type - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.startingSchema.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.startingSchema.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.items.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUris.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.noindexUrisCount.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.displaySpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.displaySpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpressionBackend.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceScoreSpec.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.properties.matchHighlightingCondition.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostAction.properties.interpolationBoostSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaControlBoostAction.properties.interpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.id - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.enum - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.attributeType.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.controlPoints.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.fieldName.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.fieldName.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enum - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.properties.interpolationType.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.id - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.attributeValue.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.description - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.format - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.properties.boostAmount.type - schemas.GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint.type - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.properties.qpsTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.properties.qpsTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.healthcareFhirConfig.$ref - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.healthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.description - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.identityMappingStore.type - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.autoRefreshCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlErrorRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.properties.userTriggeredCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig.properties.allowCrossRegion.description - schemas.GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig.properties.allowCrossRegion.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.id - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableConfigurableSchema.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableConfigurableSchema.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.description - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.enableStaticIndexingForBatchIngestion.type - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.failureCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.description - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.format - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.properties.totalCount.type - schemas.GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.id - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.description - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.properties.errorSamples.type - schemas.GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse.type - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.dedicatedCrawlRateTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.dedicatedCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.organicCrawlRateTimeSeries.$ref - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.organicCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse.type - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.id - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.googleOrganicCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.googleOrganicCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.vertexAiOrganicCrawlRate.$ref - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.properties.vertexAiOrganicCrawlRate.description - schemas.GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.displaySpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.displaySpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpressionBackend.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceScoreSpec.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.properties.matchHighlightingCondition.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.id - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.properties.returnRelevanceScore.type - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.id - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.id - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.error.$ref - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.error.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.readOnly - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.properties.state.type - schemas.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse.type The following keys were changed: - schemas.GoogleCloudDiscoveryengineV1AnswerCitation.properties.endIndex.description - schemas.GoogleCloudDiscoveryengineV1AnswerCitation.properties.startIndex.description - schemas.GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim.properties.endPos.description - schemas.GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim.properties.startPos.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1CmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1RankRequest.properties.model.description - schemas.GoogleCloudDiscoveryengineV1RecrawlUrisRequest.properties.siteCredential.description - schemas.GoogleCloudDiscoveryengineV1SearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec.properties.condition.enum - schemas.GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec.properties.condition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1SearchRequestSessionSpec.properties.searchResultPersistenceCount.description - schemas.GoogleCloudDiscoveryengineV1SearchResponseSummary.properties.summarySkippedReasons.items.enum - schemas.GoogleCloudDiscoveryengineV1SearchResponseSummary.properties.summarySkippedReasons.items.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaAnswerCitation.properties.endIndex.description - schemas.GoogleCloudDiscoveryengineV1alphaAnswerCitation.properties.startIndex.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaCmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRun.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRun.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.syncType.enum - schemas.GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.properties.syncType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.syncMode.enum - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.syncMode.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.rankingExpression.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec.properties.condition.enum - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec.properties.condition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec.properties.searchResultPersistenceCount.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.kmsKey.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.kmsKeyVersion.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.name.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.description - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.enum - schemas.GoogleCloudDiscoveryengineV1betaCmekConfig.properties.state.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.defaultSchemaId.description - schemas.GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.dataStoreSpecs.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.rankingExpression.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.relevanceThreshold.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.userInfo.description - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec.properties.condition.enum - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec.properties.condition.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec.properties.searchResultPersistenceCount.description --- discovery/discoveryengine-v1.json | 2472 ++- discovery/discoveryengine-v1alpha.json | 20069 +++++++++++++---------- discovery/discoveryengine-v1beta.json | 2196 ++- src/apis/discoveryengine/v1.ts | 13008 ++++++++------- src/apis/discoveryengine/v1alpha.ts | 3798 ++++- src/apis/discoveryengine/v1beta.ts | 2482 ++- 6 files changed, 27696 insertions(+), 16329 deletions(-) diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 38a5af44f70..2830a4db41c 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -160,36 +160,6 @@ }, "resources": { "locations": { - "methods": { - "generateGroundedContent": { - "description": "Generates grounded content.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateGroundedContent", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.generateGroundedContent", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. Location resource. Format: `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+location}:generateGroundedContent", - "request": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest" - }, - "response": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "collections": { "resources": { @@ -2317,6 +2287,94 @@ } } }, + "sitemaps": { + "methods": { + "create": { + "description": "Creates a Sitemap.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Parent 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": "v1/{+parent}/sitemaps", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1Sitemap" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Sitemap.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetch": { + "description": "Fetch Sitemaps in a DataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The Sitemap uris.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent 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": "v1/{+parent}/sitemaps:fetch", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "targetSites": { "methods": { "batchCreate": { @@ -5582,6 +5640,94 @@ } }, "resources": { + "sitemaps": { + "methods": { + "create": { + "description": "Creates a Sitemap.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sitemaps", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1Sitemap" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Sitemap.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetch": { + "description": "Fetch Sitemaps in a DataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The Sitemap uris.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sitemaps:fetch", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "targetSites": { "methods": { "batchCreate": { @@ -5987,101 +6133,324 @@ } }, "identityMappingStores": { - "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}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/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}/identityMappingStores/{identityMappingStoresId}/operations", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.identityMappingStores.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/[^/]+/identityMappingStores/[^/]+$", - "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": { - "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": "discoveryengine.projects.locations.operations.get", + "create": { + "description": "Creates a new Identity Mapping Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource.", + "cmekConfigName": { + "description": "Resource name of the CmekConfig to use for protecting this Identity Mapping Store.", + "location": "query", + "type": "string" + }, + "disableCmek": { + "description": "Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", + "location": "query", + "type": "boolean" + }, + "identityMappingStoreId": { + "description": "Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+parent}/identityMappingStores", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the Identity Mapping Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.identityMappingStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the Identity Mapping Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "importIdentityMappings": { + "description": "Imports a list of Identity Mapping Entries to an Identity Mapping Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:importIdentityMappings", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.importIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+identityMappingStore}:importIdentityMappings", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Identity Mapping Stores.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed 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 `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/identityMappingStores", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listIdentityMappings": { + "description": "Lists Identity Mappings in an Identity Mapping Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.listIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed 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 `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+identityMappingStore}:listIdentityMappings", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purgeIdentityMappings": { + "description": "Purges specified or all Identity Mapping Entries from an Identity Mapping Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+identityMappingStore}:purgeIdentityMappings", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/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}/identityMappingStores/{identityMappingStoresId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.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/[^/]+/identityMappingStores/[^/]+$", + "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": { + "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": "discoveryengine.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": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -6371,7 +6740,7 @@ } } }, - "revision": "20250121", + "revision": "20250312", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -6627,6 +6996,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": { + "description": "The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`", + "id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext", + "properties": { + "connectorRun": { + "description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.", + "type": "string" + }, + "dataConnector": { + "description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.", + "type": "string" + }, + "endTime": { + "description": "The time when the connector run ended.", + "format": "google-datetime", + "type": "string" + }, + "entity": { + "description": "The entity to sync for the connector run.", + "type": "string" + }, + "operation": { + "description": "The operation resource name of the LRO to sync the connector.", + "type": "string" + }, + "startTime": { + "description": "The time when the connector run started.", + "format": "google-datetime", + "type": "string" + }, + "syncType": { + "description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineLoggingErrorContext": { "description": "A description of the context in which an error occurred.", "id": "GoogleCloudDiscoveryengineLoggingErrorContext", @@ -6646,6 +7052,10 @@ "description": "An error log which is reported to the Error Reporting system.", "id": "GoogleCloudDiscoveryengineLoggingErrorLog", "properties": { + "connectorRunPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext", + "description": "The error payload that is populated on LRO connector sync APIs." + }, "context": { "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", "description": "A description of the context in which the error occurred." @@ -6924,7 +7334,7 @@ "id": "GoogleCloudDiscoveryengineV1AnswerCitation", "properties": { "endIndex": { - "description": "End of the attributed segment, exclusive.", + "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -6936,7 +7346,7 @@ "type": "array" }, "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -7187,7 +7597,11 @@ "description": "Query understanding specification.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec", "properties": { - "queryClassificationSpec": { + "disableSpellCorrection": { + "description": "Optional. Whether to disable spell correction. The default value is `false`.", + "type": "boolean" + }, + "queryClassificationSpec": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", "description": "Query classification specification." }, @@ -7703,6 +8117,16 @@ }, "description": "Structured search data.", "type": "object" + }, + "title": { + "description": "Output only. The title of the document.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. The URI of the document.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -8302,7 +8726,7 @@ "type": "string" }, "endPos": { - "description": "Position indicating the end of the claim in the answer candidate, exclusive.", + "description": "Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).", "format": "int32", "type": "integer" }, @@ -8311,7 +8735,7 @@ "type": "boolean" }, "startPos": { - "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", + "description": "Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).", "format": "int32", "type": "integer" } @@ -8479,11 +8903,11 @@ "type": "boolean" }, "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "type": "string" }, "lastRotationTimestampMicros": { @@ -8493,7 +8917,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "type": "string" }, "singleRegionKeys": { @@ -8504,13 +8928,14 @@ "type": "array" }, "state": { - "description": "Output only. State of the CmekConfig.", + "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", + "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING" ], @@ -8520,6 +8945,7 @@ "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated." ], @@ -8786,6 +9212,70 @@ "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" + }, + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", + "properties": { + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "Optional. The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "Optional. 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" + }, + "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" + }, + "boostAmount": { + "description": "Optional. 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" @@ -9047,6 +9537,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1CreateSitemapMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata", + "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", @@ -9211,7 +9718,7 @@ "type": "string" }, "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -9223,6 +9730,14 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", + "type": "string" + }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -9335,6 +9850,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata": { + "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata", + "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" + }, "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", @@ -9403,6 +9935,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata", + "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", @@ -9695,6 +10244,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DoubleList": { + "description": "Double list.", + "id": "GoogleCloudDiscoveryengineV1DoubleList", + "properties": { + "values": { + "description": "Double values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "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", @@ -9821,6 +10385,10 @@ "$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." }, + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" @@ -9959,504 +10527,187 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1FhirStoreSource": { - "description": "Cloud FhirStore source import data from.", - "id": "GoogleCloudDiscoveryengineV1FhirStoreSource", - "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}`.", - "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.", - "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" - }, - "updateFromLatestPredefinedSchema": { - "description": "Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1FirestoreSource": { - "description": "Firestore source import data from.", - "id": "GoogleCloudDiscoveryengineV1FirestoreSource", - "properties": { - "collectionId": { - "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", - "type": "string" - }, - "databaseId": { - "description": "Required. The Firestore 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 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" - }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GcsSource": { - "description": "Cloud Storage location for input content.", - "id": "GoogleCloudDiscoveryengineV1GcsSource", - "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.", - "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest": { - "description": "Top-level message sent by the client for the `GenerateGroundedContent` method.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest", + "GoogleCloudDiscoveryengineV1FetchSitemapsResponse": { + "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", + "id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse", "properties": { - "contents": { - "description": "Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", + "sitemapsMetadata": { + "description": "List of Sitemaps fetched.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1GroundedGenerationContent" + "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata" }, "type": "array" - }, - "generationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec", - "description": "Content generation specification." - }, - "groundingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec", - "description": "Grounding specification." - }, - "systemInstruction": { - "$ref": "GoogleCloudDiscoveryengineV1GroundedGenerationContent", - "description": "Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them." - }, - "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" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration": { - "description": "Describes the options to customize dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration", - "properties": { - "predictor": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor", - "description": "Specification for the predictor for dynamic retrieval." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor": { - "description": "Describes the predictor settings for dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor", - "properties": { - "threshold": { - "description": "The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source.", - "format": "float", - "type": "number" - }, - "version": { - "description": "The version of the predictor to be used in dynamic retrieval.", - "enum": [ - "VERSION_UNSPECIFIED", - "V1_INDEPENDENT" - ], - "enumDescriptions": [ - "Automatically choose the best version of the retrieval predictor.", - "The V1 model which is evaluating each source independently." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec": { - "description": "Content generation specification.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec", - "properties": { - "frequencyPenalty": { - "description": "If specified, custom value for frequency penalty will be used.", - "format": "float", - "type": "number" - }, - "languageCode": { - "description": "Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).", - "type": "string" - }, - "maxOutputTokens": { - "description": "If specified, custom value for max output tokens will be used.", - "format": "int32", - "type": "integer" - }, - "modelId": { - "description": "Specifies which Vertex model id to use for generation.", - "type": "string" - }, - "presencePenalty": { - "description": "If specified, custom value for presence penalty will be used.", - "format": "float", - "type": "number" - }, - "seed": { - "description": "If specified, custom value for the seed will be used.", - "format": "int32", - "type": "integer" - }, - "temperature": { - "description": "If specified, custom value for the temperature will be used.", - "format": "float", - "type": "number" - }, - "topK": { - "description": "If specified, custom value for top-k sampling will be used.", - "format": "int32", - "type": "integer" - }, - "topP": { - "description": "If specified, custom value for nucleus sampling will be used.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource": { - "description": "Grounding source.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource", - "properties": { - "googleSearchSource": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource", - "description": "If set, grounding is performed with Google Search." - }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource", - "description": "If set, grounding is performed with inline content." - }, - "searchSource": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource", - "description": "If set, grounding is performed with Vertex AI Search." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource": { - "description": "Google Search config parameters.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource", - "properties": { - "dynamicRetrievalConfig": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration", - "description": "Optional. Specifies the dynamic retrieval configuration for the given source." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource": { - "description": "Message to be used for grounding based on inline content.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource", + "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata": { + "description": "Contains a Sitemap and its metadata.", + "id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata", "properties": { - "attributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content).", - "type": "object" - }, - "groundingFacts": { - "description": "List of facts to be used for grounding.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1GroundingFact" - }, - "type": "array" + "sitemap": { + "$ref": "GoogleCloudDiscoveryengineV1Sitemap", + "description": "The Sitemap." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource": { - "description": "Message to be used for grounding with Vertex AI Search.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource", + "GoogleCloudDiscoveryengineV1FhirStoreSource": { + "description": "Cloud FhirStore source import data from.", + "id": "GoogleCloudDiscoveryengineV1FhirStoreSource", "properties": { - "filter": { - "description": "Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter.", + "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" }, - "maxResultCount": { - "description": "Number of search results to return. The default value is 10. The maximumm allowed value is 10.", - "format": "int32", - "type": "integer" - }, - "safeSearch": { - "description": "If set, safe search is enabled in Vertex AI Search requests.", - "type": "boolean" - }, - "servingConfig": { - "description": "The resource name of the Engine to use. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec": { - "description": "Grounding specification.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec", - "properties": { - "groundingSources": { - "description": "Grounding sources.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse": { - "description": "Response for the `GenerateGroundedContent` method.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse", - "properties": { - "candidates": { - "description": "Generated candidates.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate": { - "description": "A response candidate generated from the model.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate", - "properties": { - "content": { - "$ref": "GoogleCloudDiscoveryengineV1GroundedGenerationContent", - "description": "Content of the candidate." - }, - "groundingMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata", - "description": "Grounding metadata for the generated content." - }, - "groundingScore": { - "description": "The overall grounding score for the candidate, in the range of [0, 1].", - "format": "float", - "type": "number" - }, - "index": { - "description": "Index of the candidate.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata": { - "description": "Citation for the generated content.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata", - "properties": { - "groundingSupport": { - "description": "GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport" - }, - "type": "array" - }, - "retrievalMetadata": { - "description": "Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata" - }, - "type": "array" - }, - "searchEntryPoint": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint", - "description": "Google search entry for the following-up web searches." - }, - "supportChunks": { - "description": "List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1FactChunk" - }, - "type": "array" }, - "webSearchQueries": { - "description": "Web search queries for the following-up web search.", + "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" - }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata": { - "description": "Describes the metadata about dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata", - "properties": { - "predictorMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata", - "description": "Metadata for the dynamic retrieval predictor." + }, + "type": "array" + }, + "updateFromLatestPredefinedSchema": { + "description": "Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata": { - "description": "Describes the metadata about the dynamic retrieval predictor.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata", + "GoogleCloudDiscoveryengineV1FirestoreSource": { + "description": "Firestore source import data from.", + "id": "GoogleCloudDiscoveryengineV1FirestoreSource", "properties": { - "prediction": { - "description": "The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding.", - "format": "float", - "type": "number" + "collectionId": { + "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", + "type": "string" }, - "version": { - "description": "The version of the predictor which was used in dynamic retrieval.", - "enum": [ - "VERSION_UNSPECIFIED", - "V1_INDEPENDENT" - ], - "enumDescriptions": [ - "Unspecified version, should never be used.", - "The V1 model which is evaluating each source independently." - ], + "databaseId": { + "description": "Required. The Firestore 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 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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport": { - "description": "Grounding info for a claim in the candidate and its support.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport", + "GoogleCloudDiscoveryengineV1GcsSource": { + "description": "Cloud Storage location for input content.", + "id": "GoogleCloudDiscoveryengineV1GcsSource", "properties": { - "claimText": { - "description": "Text for the claim in the candidate. Always provided when a support is found.", + "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" }, - "supportChunkIndices": { - "description": "A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim.", + "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": { - "format": "int32", - "type": "integer" + "type": "string" }, "type": "array" - }, - "supportScore": { - "description": "A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata": { - "description": "Describes the metadata associated with a retrieval step.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata", + "GoogleCloudDiscoveryengineV1GroundingFact": { + "description": "Grounding Fact.", + "id": "GoogleCloudDiscoveryengineV1GroundingFact", "properties": { - "dynamicRetrievalMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata", - "description": "Metadata for dynamic retrieval." + "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" }, - "source": { - "description": "Describes the source to which the metadata is referring to.", - "enum": [ - "SOURCE_UNSPECIFIED", - "VERTEX_AI_SEARCH", - "GOOGLE_SEARCH", - "INLINE_CONTENT", - "GOOGLE_MAPS" - ], - "enumDescriptions": [ - "Unspecified source.", - "Vertex AI search.", - "Google Search.", - "User inline provided content.", - "Google Maps." - ], + "factText": { + "description": "Text content of the fact. Can be at most 10K characters long.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint": { - "description": "Google search entry point.", - "id": "GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint", + "GoogleCloudDiscoveryengineV1HealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "properties": { - "renderedContent": { - "description": "Web content snippet that can be embedded in a web page or an app webview.", - "type": "string" + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", + "type": "boolean" }, - "sdkBlob": { - "description": "Base64 encoded JSON representing array of tuple.", - "format": "byte", - "type": "string" + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GroundedGenerationContent": { - "description": "Base structured datatype containing multi-part content of a message.", - "id": "GoogleCloudDiscoveryengineV1GroundedGenerationContent", + "GoogleCloudDiscoveryengineV1IdentityMappingEntry": { + "description": "Identity Mapping Entry that maps an external identity to an internal identity.", + "id": "GoogleCloudDiscoveryengineV1IdentityMappingEntry", "properties": { - "parts": { - "description": "Ordered `Parts` that constitute a single message.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1GroundedGenerationContentPart" - }, - "type": "array" + "externalIdentity": { + "description": "Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.", + "type": "string" + }, + "groupId": { + "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.", + "type": "string" }, - "role": { - "description": "Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset.", + "userId": { + "description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GroundedGenerationContentPart": { - "description": "Single part of content.", - "id": "GoogleCloudDiscoveryengineV1GroundedGenerationContentPart", + "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata", "properties": { - "text": { - "description": "Inline text.", + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1GroundingFact": { - "description": "Grounding Fact.", - "id": "GoogleCloudDiscoveryengineV1GroundingFact", + "GoogleCloudDiscoveryengineV1IdentityMappingStore": { + "description": "Identity Mapping Store which contains Identity Mapping Entries.", + "id": "GoogleCloudDiscoveryengineV1IdentityMappingStore", "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" + "cmekConfig": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig", + "description": "Output only. CMEK-related information for the Identity Mapping Store.", + "readOnly": true }, - "factText": { - "description": "Text content of the fact. Can be at most 10K characters long.", + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, @@ -10697,6 +10948,45 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest": { + "description": "Request message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest", + "properties": { + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource", + "description": "The inline source to import identity mapping entries from." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource": { + "description": "The inline source to import identity mapping entries from.", + "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource", + "properties": { + "identityMappingEntries": { + "description": "A maximum of 10000 entries can be imported at one time", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "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", @@ -10990,6 +11280,42 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse": { + "description": "Response message for IdentityMappingStoreService.ListIdentityMappingStores", + "id": "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse", + "properties": { + "identityMappingStores": { + "description": "The Identity Mapping Stores.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ListIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse", + "properties": { + "identityMappingEntries": { + "description": "The Identity Mapping Entries.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ListSchemasResponse": { "description": "Response message for SchemaService.ListSchemas method.", "id": "GoogleCloudDiscoveryengineV1ListSchemasResponse", @@ -11359,6 +11685,39 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest": { + "description": "Request message for IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest", + "properties": { + "filter": { + "description": "Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 \"zulu\" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time > \"2012-04-23T18:25:43.511Z\" AND update_time < \"2012-04-23T18:30:43.511Z\"` * Deleting all identity mappings for a given external_id: `external_id = \"id1\"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided.", + "type": "string" + }, + "force": { + "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.", + "type": "boolean" + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource", + "description": "The inline source to purge identity mapping entries from." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource": { + "description": "The inline source to purge identity mapping entries from.", + "id": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource", + "properties": { + "identityMappingEntries": { + "description": "A maximum of 10000 entries can be purged at one time", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry" + }, + "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", @@ -11440,7 +11799,7 @@ "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.", + "description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.", "type": "string" }, "query": { @@ -11601,7 +11960,7 @@ "id": "GoogleCloudDiscoveryengineV1RecrawlUrisRequest", "properties": { "siteCredential": { - "description": "Optional. Full resource name of the `SiteCredential`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.", + "description": "Optional. Credential id to use for crawling.", "type": "string" }, "uris": { @@ -11772,7 +12131,7 @@ "type": "string" }, "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, @@ -11799,12 +12158,16 @@ "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 data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", + "description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" }, "type": "array" }, + "displaySpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec", + "description": "Optional. Config for display feature, like match highlighting on search results." + }, "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": { @@ -11862,6 +12225,28 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec", "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, + "relevanceScoreSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec", + "description": "Optional. The specification for returning the relevance score." + }, + "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. This feature is not supported for healthcare search.", + "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" @@ -11884,7 +12269,7 @@ }, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1UserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." }, "userLabels": { "additionalProperties": { @@ -12190,6 +12575,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec": { + "description": "Specifies features for display, like match highlighting.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec", + "properties": { + "matchHighlightingCondition": { + "description": "The condition under which match highlighting should occur.", + "enum": [ + "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", + "MATCH_HIGHLIGHTING_DISABLED", + "MATCH_HIGHLIGHTING_ENABLED" + ], + "enumDescriptions": [ + "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", + "Disables match highlighting on all documents.", + "Enables match highlighting on all documents." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec": { "description": "A facet specification to perform faceted search.", "id": "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec", @@ -12300,6 +12706,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec": { + "description": "The specification for returning the document relevance score.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec", + "properties": { + "returnRelevanceScore": { + "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec", @@ -12309,12 +12726,14 @@ "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", - "ENABLED" + "ENABLED", + "AUTO" ], "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", - "Enables Search As You Type." + "Enables Search As You Type.", + "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ], "type": "string" } @@ -12330,7 +12749,7 @@ "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.", + "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 similar 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" } @@ -12492,6 +12911,14 @@ "id": { "description": "Document.id of the searched Document.", "type": "string" + }, + "modelScores": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1DoubleList" + }, + "description": "Output only. Google provided available scores.", + "readOnly": true, + "type": "object" } }, "type": "object" @@ -12532,7 +12959,8 @@ "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", - "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" + "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2", + "TIME_OUT" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", @@ -12544,7 +12972,8 @@ "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.", - "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." + "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`.", + "The time out case. Google skips the summary if the time out." ], "type": "string" }, @@ -12990,6 +13419,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Sitemap": { + "description": "A sitemap for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1Sitemap", + "properties": { + "createTime": { + "description": "Output only. The sitemap's creation time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SpannerSource": { "description": "The Spanner source for importing data", "id": "GoogleCloudDiscoveryengineV1SpannerSource", @@ -13548,17 +13999,60 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { - "description": "Configuration data for advance site search.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", + "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { + "description": "Configuration data for advance site search.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", + "properties": { + "disableAutomaticRefresh": { + "description": "If set true, automatic refresh is disabled for the DataStore.", + "type": "boolean" + }, + "disableInitialIndex": { + "description": "If set true, initial indexing is disabled for the DataStore.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { + "description": "The connector level alert config.", + "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", + "properties": { + "alertEnrollments": { + "description": "Optional. The enrollment states of each alert.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment" + }, + "type": "array" + }, + "alertPolicyName": { + "description": "Immutable. The fully qualified resource name of the AlertPolicy.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": { + "description": "The alert enrollment status.", + "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment", "properties": { - "disableAutomaticRefresh": { - "description": "If set true, automatic refresh is disabled for the DataStore.", - "type": "boolean" + "alertId": { + "description": "Immutable. The id of an alert.", + "type": "string" }, - "disableInitialIndex": { - "description": "If set true, initial indexing is disabled for the DataStore.", - "type": "boolean" + "enrollState": { + "description": "Required. The enrollment status of a customer.", + "enum": [ + "ENROLL_STATES_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" } }, "type": "object" @@ -13695,7 +14189,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { "endIndex": { - "description": "End of the attributed segment, exclusive.", + "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -13707,7 +14201,7 @@ "type": "array" }, "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -13890,6 +14384,16 @@ }, "description": "Structured search data.", "type": "object" + }, + "title": { + "description": "Output only. The title of the document.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. The URI of the document.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -14101,6 +14605,30 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaBAPConfig": { + "description": "The configuration for the BAP connector.", + "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", + "properties": { + "supportedConnectorModes": { + "description": "Required. The supported connector modes for the associated BAP connection.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for Actions" + ], + "type": "string" + }, + "type": "array" + } + }, + "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", @@ -14142,11 +14670,11 @@ "type": "boolean" }, "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "type": "string" }, "lastRotationTimestampMicros": { @@ -14156,7 +14684,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "type": "string" }, "singleRegionKeys": { @@ -14167,13 +14695,14 @@ "type": "array" }, "state": { - "description": "Output only. State of the CmekConfig.", + "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", + "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING" ], @@ -14183,6 +14712,7 @@ "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated." ], @@ -14327,7 +14857,8 @@ "OVERRUN", "CANCELLED", "PENDING", - "WARNING" + "WARNING", + "SKIPPED" ], "enumDescriptions": [ "Default value.", @@ -14337,7 +14868,8 @@ "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", "Data sync was scheduled but has been cancelled.", "Data sync is about to start.", - "The data sync completed with non-fatal errors." + "The data sync completed with non-fatal errors.", + "An ongoing connector run has been running longer than expected, causing this run to be skipped." ], "readOnly": true, "type": "string" @@ -14373,6 +14905,11 @@ "description": "Represents an entity that was synced in this ConnectorRun.", "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun", "properties": { + "deletedRecordCount": { + "description": "The number of documents deleted.", + "format": "int64", + "type": "string" + }, "entityName": { "description": "The name of the source entity.", "type": "string" @@ -14399,6 +14936,10 @@ "format": "int64", "type": "string" }, + "progress": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", + "description": "Metadata to generate the progress bar." + }, "sourceApiRequestCount": { "description": "The number of requests sent to 3p API.", "format": "int64", @@ -14414,7 +14955,8 @@ "OVERRUN", "CANCELLED", "PENDING", - "WARNING" + "WARNING", + "SKIPPED" ], "enumDescriptions": [ "Default value.", @@ -14424,7 +14966,8 @@ "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", "Data sync was scheduled but has been cancelled.", "Data sync is about to start.", - "The data sync completed with non-fatal errors." + "The data sync completed with non-fatal errors.", + "An ongoing connector run has been running longer than expected, causing this run to be skipped." ], "type": "string" }, @@ -14443,18 +14986,42 @@ "enum": [ "SYNC_TYPE_UNSPECIFIED", "FULL", - "INCREMENTAL" + "INCREMENTAL", + "REALTIME" ], "enumDescriptions": [ "Sync type unspecified.", "Sync triggers full sync of all documents.", - "Incremental sync of updated documents." + "Incremental sync of updated documents.", + "Realtime sync." ], "type": "string" } }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress": { + "description": "Represents the progress of a sync run.", + "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", + "properties": { + "currentCount": { + "description": "The current progress.", + "format": "int64", + "type": "string" + }, + "percentile": { + "description": "Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.", + "format": "float", + "type": "number" + }, + "totalCount": { + "description": "The total.", + "format": "int64", + "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", @@ -14562,6 +15129,70 @@ "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" + }, + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec", + "properties": { + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "Optional. The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "Optional. 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" + }, + "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" + }, + "boostAmount": { + "description": "Optional. 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" @@ -14742,10 +15373,21 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig", "description": "Optional. Action configurations to make the connector support actions." }, + "alertPolicyConfigs": { + "description": "Optional. The connector level alert config.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig" + }, + "type": "array" + }, "autoRunDisabled": { "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.", "type": "boolean" }, + "bapConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig", + "description": "Optional. The configuration for establishing a BAP connection." + }, "blockingReasons": { "description": "Output only. User actions that must be completed before the connector can start syncing data.", "items": { @@ -14764,6 +15406,35 @@ "readOnly": true, "type": "array" }, + "connectorType": { + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system.", + "enum": [ + "CONNECTOR_TYPE_UNSPECIFIED", + "THIRD_PARTY", + "GCP_FHIR", + "BIG_QUERY", + "GCS", + "GOOGLE_MAIL", + "GOOGLE_CALENDAR", + "GOOGLE_DRIVE", + "NATIVE_CLOUD_IDENTITY", + "THIRD_PARTY_FEDERATED" + ], + "enumDescriptions": [ + "Default value.", + "Third party connector to connector to third party application.", + "Data connector connects between FHIR store and VAIS datastore.", + "Big query connector.", + "Google Cloud Storage connector.", + "Gmail connector.", + "Google Calendar connector.", + "Google Drive connector.", + "Native Cloud Identity connector for people search powered by People API.", + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API." + ], + "readOnly": true, + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the DataConnector was created at.", "format": "google-datetime", @@ -14844,6 +15515,29 @@ "readOnly": true, "type": "string" }, + "realtimeState": { + "description": "Output only. real-time sync state", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)." + ], + "readOnly": true, + "type": "string" + }, "refreshInterval": { "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.", "format": "google-duration", @@ -14857,7 +15551,8 @@ "ACTIVE", "FAILED", "RUNNING", - "WARNING" + "WARNING", + "INITIALIZATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -14865,7 +15560,8 @@ "The connector is successfully set up and awaiting next sync run.", "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", "The connector is actively syncing records from the data source.", - "The connector has completed a sync run, but encountered non-fatal errors." + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)." ], "readOnly": true, "type": "string" @@ -14885,10 +15581,14 @@ "syncMode": { "description": "The data synchronization mode supported by the data connector.", "enum": [ - "PERIODIC" + "PERIODIC", + "STREAMING", + "UNSPECIFIED" ], "enumDescriptions": [ - "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync." + "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", + "The data will be synced in real time.", + "Connector that doesn't ingest data will have this value" ], "type": "string" }, @@ -14914,6 +15614,10 @@ "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", "type": "string" }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, "keyPropertyMappings": { "additionalProperties": { "type": "string" @@ -14928,6 +15632,10 @@ }, "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.", "type": "object" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", + "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector 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" @@ -14979,7 +15687,7 @@ "type": "string" }, "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -14991,6 +15699,14 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", + "type": "string" + }, "idpConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "description": "Output only. Data store level identity provider config.", @@ -15120,10 +15836,18 @@ "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", "id": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries", "properties": { + "autoRefreshCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl." + }, "autoRefreshCrawlRate": { "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." }, + "userTriggeredCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of user triggered dedicated crawl." + }, "userTriggeredCrawlRate": { "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." @@ -15131,6 +15855,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { + "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", + "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" + }, "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": { "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata", @@ -15562,6 +16303,10 @@ "$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." }, + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" @@ -15874,31 +16619,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": { - "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse", - "properties": { - "sitemapsMetadata": { - "description": "List of Sitemaps fetched.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": { - "description": "Contains a Sitemap and its metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata", - "properties": { - "sitemap": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSitemap", - "description": "The Sitemap." - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -16089,6 +16809,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", + "properties": { + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", + "type": "boolean" + }, + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata", + "properties": { + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": { "description": "The configuration for the identity data synchronization runs.", "id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", @@ -16247,6 +17004,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", @@ -16892,6 +17663,18 @@ "format": "int32", "type": "integer" }, + "noindexUris": { + "description": "URIs that have no index meta tag. Sample limited to 1000.", + "items": { + "type": "string" + }, + "type": "array" + }, + "noindexUrisCount": { + "description": "Total number of URIs that have no index meta tag.", + "format": "int32", + "type": "integer" + }, "pendingCount": { "description": "Total number of URIs that have yet to be crawled.", "format": "int32", @@ -17174,7 +17957,7 @@ "type": "string" }, "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, @@ -17205,12 +17988,16 @@ "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 data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", + "description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, + "displaySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", + "description": "Optional. Config for display feature, like match highlighting on search results." + }, "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." @@ -17281,15 +18068,33 @@ "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)`.", + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result", + "type": "string" + }, + "rankingExpressionBackend": { + "description": "Optional. The backend to use for the ranking expression evaluation.", + "enum": [ + "UNKNOWN", + "BYOE", + "CLEARBOX" + ], + "enumDescriptions": [ + "Default option for unspecified/unknown values.", + "Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", + "The expression is compiled into a Clearbox formula." + ], "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" }, + "relevanceScoreSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", + "description": "Optional. The specification for returning the relevance score." + }, "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.", + "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. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -17332,7 +18137,7 @@ }, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." }, "userLabels": { "additionalProperties": { @@ -17638,6 +18443,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": { + "description": "Specifies features for display, like match highlighting.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", + "properties": { + "matchHighlightingCondition": { + "description": "The condition under which match highlighting should occur.", + "enum": [ + "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", + "MATCH_HIGHLIGHTING_DISABLED", + "MATCH_HIGHLIGHTING_ENABLED" + ], + "enumDescriptions": [ + "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", + "Disables match highlighting on all documents.", + "Enables match highlighting on all documents." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", @@ -17830,6 +18656,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": { + "description": "The specification for returning the document relevance score.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", + "properties": { + "returnRelevanceScore": { + "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", @@ -17839,12 +18676,14 @@ "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", - "ENABLED" + "ENABLED", + "AUTO" ], "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", - "Enables Search As You Type." + "Enables Search As You Type.", + "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ], "type": "string" } @@ -17860,7 +18699,7 @@ "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.", + "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 similar 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" } @@ -18465,11 +19304,11 @@ "type": "boolean" }, "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "type": "string" }, "lastRotationTimestampMicros": { @@ -18479,7 +19318,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "type": "string" }, "singleRegionKeys": { @@ -18490,13 +19329,14 @@ "type": "array" }, "state": { - "description": "Output only. State of the CmekConfig.", + "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", + "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING" ], @@ -18506,6 +19346,7 @@ "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated." ], @@ -18679,6 +19520,70 @@ "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" + }, + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", + "properties": { + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "Optional. The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "Optional. 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" + }, + "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" + }, + "boostAmount": { + "description": "Optional. 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" @@ -18738,6 +19643,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": { + "description": "The historical crawl rate timeseries data, used for monitoring.", + "id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "properties": { + "qpsTimeSeries": { + "$ref": "GoogleMonitoringV3TimeSeries", + "description": "The QPS of the crawl rate." + } + }, + "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", @@ -18872,7 +19788,7 @@ "type": "string" }, "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -18884,6 +19800,14 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", + "type": "string" + }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -19004,6 +19928,29 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": { + "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", + "id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", + "properties": { + "autoRefreshCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl." + }, + "autoRefreshCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." + }, + "userTriggeredCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of user triggered dedicated crawl." + }, + "userTriggeredCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." + } + }, + "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", @@ -19352,6 +20299,10 @@ "$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." }, + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" @@ -19530,27 +20481,39 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse": { - "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", - "id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse", + "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "properties": { - "sitemapsMetadata": { - "description": "List of Sitemaps fetched.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata" - }, - "type": "array" + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", + "type": "boolean" + }, + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata": { - "description": "Contains a Sitemap and its metadata.", - "id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata", + "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata", "properties": { - "sitemap": { - "$ref": "GoogleCloudDiscoveryengineV1betaSitemap", - "description": "The Sitemap." + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", + "type": "string" } }, "type": "object" @@ -19661,6 +20624,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "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", @@ -19881,6 +20858,55 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", + "id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse", + "properties": { + "dedicatedCrawlRateTimeSeries": { + "$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", + "description": "The historical dedicated crawl rate timeseries data, used for monitoring." + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "organicCrawlRateTimeSeries": { + "$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", + "description": "The historical organic crawl rate timeseries data, used for monitoring." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": { + "description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.", + "id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", + "properties": { + "googleOrganicCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." + }, + "vertexAiOrganicCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", @@ -20101,6 +21127,49 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": { + "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata", + "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" + }, + "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -20145,7 +21214,7 @@ "type": "string" }, "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, @@ -20172,12 +21241,16 @@ "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 data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", + "description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, "type": "array" }, + "displaySpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", + "description": "Optional. Config for display feature, like match highlighting on search results." + }, "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." @@ -20248,15 +21321,33 @@ "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)`.", + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result", + "type": "string" + }, + "rankingExpressionBackend": { + "description": "Optional. The backend to use for the ranking expression evaluation.", + "enum": [ + "UNKNOWN", + "BYOE", + "CLEARBOX" + ], + "enumDescriptions": [ + "Default option for unspecified/unknown values.", + "Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", + "The expression is compiled into a Clearbox formula." + ], "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" }, + "relevanceScoreSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", + "description": "Optional. The specification for returning the relevance score." + }, "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.", + "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. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -20299,7 +21390,7 @@ }, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." }, "userLabels": { "additionalProperties": { @@ -20605,6 +21696,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": { + "description": "Specifies features for display, like match highlighting.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", + "properties": { + "matchHighlightingCondition": { + "description": "The condition under which match highlighting should occur.", + "enum": [ + "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", + "MATCH_HIGHLIGHTING_DISABLED", + "MATCH_HIGHLIGHTING_ENABLED" + ], + "enumDescriptions": [ + "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", + "Disables match highlighting on all documents.", + "Enables match highlighting on all documents." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", @@ -20797,6 +21909,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": { + "description": "The specification for returning the document relevance score.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", + "properties": { + "returnRelevanceScore": { + "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -20806,12 +21929,14 @@ "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", - "ENABLED" + "ENABLED", + "AUTO" ], "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", - "Enables Search As You Type." + "Enables Search As You Type.", + "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ], "type": "string" } @@ -20827,7 +21952,7 @@ "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.", + "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 similar 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" } @@ -20855,6 +21980,49 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { + "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", + "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" + }, + "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", + "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey", diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index b1ddd359168..b91dec45133 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -4,6 +4,9 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + }, + "https://www.googleapis.com/auth/cloud_search.query": { + "description": "Search your organization's data in the Cloud Search index" } } } @@ -127,6 +130,50 @@ }, "protocol": "rest", "resources": { + "media": { + "methods": { + "upload": { + "description": "Uploads a file for Notebook LM to use. Creates a Source.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources:uploadFile", + "httpMethod": "POST", + "id": "discoveryengine.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v1alpha/{+parent}/sources:uploadFile" + } + } + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sources:uploadFile", + "request": { + "$ref": "GoogleCloudNotebooklmV1alphaUploadSourceFileRequest" + }, + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaUploadSourceFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaUpload": true + } + } + }, "projects": { "methods": { "get": { @@ -242,34 +289,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateGroundedContent": { - "description": "Generates grounded content.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:generateGroundedContent", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.generateGroundedContent", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. Location resource. Format: `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+location}:generateGroundedContent", - "request": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest" - }, - "response": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "getAclConfig": { "description": "Gets the AclConfig.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", @@ -470,7 +489,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", "required": true, @@ -497,6 +516,31 @@ "resources": { "cmekConfigs": { "methods": { + "delete": { + "description": "De-provisions a CmekConfig.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.cmekConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the CmekConfig to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the CmekConfig.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", @@ -557,7 +601,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", "required": true, @@ -1761,7 +1805,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_search.query" ] } } @@ -3345,6 +3390,37 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "fetch": { + "description": "Fetch Sitemaps in a DataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The Sitemap uris.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent 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/{+parent}/sitemaps:fetch", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -3789,6 +3865,40 @@ ] } } + }, + "widgetConfigs": { + "methods": { + "get": { + "description": "Gets a WidgetConfig.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "acceptCache": { + "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -4064,6 +4174,35 @@ "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_search.query" + ] + }, + "removeSuggestion": { + "description": "Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion", + "parameterOrder": [ + "completionConfig" + ], + "parameters": { + "completionConfig": { + "description": "Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+completionConfig}:removeSuggestion", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] @@ -4928,6 +5067,40 @@ } } } + }, + "widgetConfigs": { + "methods": { + "get": { + "description": "Gets a WidgetConfig.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "acceptCache": { + "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -5822,7 +5995,8 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_search.query" ] } } @@ -7521,6 +7695,40 @@ ] } } + }, + "widgetConfigs": { + "methods": { + "get": { + "description": "Gets a WidgetConfig.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.widgetConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "acceptCache": { + "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -7717,68 +7925,291 @@ } }, "identityMappingStores": { - "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}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "methods": { + "create": { + "description": "Creates a new Identity Mapping Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "cmekConfigName": { + "description": "Resource name of the CmekConfig to use for protecting this Identity Mapping Store.", + "location": "query", + "type": "string" }, - "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}/identityMappingStores/{identityMappingStoresId}/operations", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.identityMappingStores.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/[^/]+/identityMappingStores/[^/]+$", - "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", + "disableCmek": { + "description": "Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", + "location": "query", + "type": "boolean" + }, + "identityMappingStoreId": { + "description": "Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/identityMappingStores", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the Identity Mapping Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.identityMappingStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the Identity Mapping Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "importIdentityMappings": { + "description": "Imports a list of Identity Mapping Entries to an Identity Mapping Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:importIdentityMappings", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.importIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+identityMappingStore}:importIdentityMappings", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Identity Mapping Stores.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed 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 `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/identityMappingStores", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listIdentityMappings": { + "description": "Lists Identity Mappings in an Identity Mapping Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.listIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed 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 `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+identityMappingStore}:listIdentityMappings", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purgeIdentityMappings": { + "description": "Purges specified or all Identity Mapping Entries from an Identity Mapping Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+identityMappingStore}:purgeIdentityMappings", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/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}/identityMappingStores/{identityMappingStoresId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.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/[^/]+/identityMappingStores/[^/]+$", + "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" }, @@ -8552,982 +8983,1022 @@ } } }, - "revision": "20250121", + "revision": "20250312", "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", + "ApiservingMediaRequestInfo": { + "description": "Extra information added to operations that support Scotty media requests.", + "id": "ApiservingMediaRequestInfo", "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" + "currentBytes": { + "description": "The number of current bytes uploaded or downloaded.", + "format": "int64", + "type": "string" }, - "bucketOptions": { - "$ref": "GoogleApiDistributionBucketOptions", - "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." + "customData": { + "description": "Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.", + "type": "string" }, - "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", + "diffObjectVersion": { + "description": "Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.", "type": "string" }, - "exemplars": { - "description": "Must be in increasing order of `value` field.", - "items": { - "$ref": "GoogleApiDistributionExemplar" - }, - "type": "array" + "finalStatus": { + "description": "The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929", + "format": "int32", + "type": "integer" }, - "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" + "notificationType": { + "description": "The type of notification received from Scotty.", + "enum": [ + "START", + "PROGRESS", + "END", + "RESPONSE_SENT", + "ERROR" + ], + "enumDescriptions": [ + "Such requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.", + "Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.", + "Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.", + "Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.", + "Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything." + ], + "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." + "requestId": { + "description": "The Scotty request ID.", + "type": "string" }, - "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" + "requestReceivedParamsServingInfo": { + "description": "The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()", + "format": "byte", + "type": "string" + }, + "totalBytes": { + "description": "The total size of the file.", + "format": "int64", + "type": "string" + }, + "totalBytesIsEstimated": { + "description": "Whether the total bytes field contains an estimated data.", + "type": "boolean" } }, "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", + "ApiservingMediaResponseInfo": { + "description": "This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }", + "id": "ApiservingMediaResponseInfo", "properties": { - "explicitBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsExplicit", - "description": "The explicit buckets." + "customData": { + "description": "Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.", + "type": "string" }, - "exponentialBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsExponential", - "description": "The exponential buckets." + "dataStorageTransform": { + "description": "Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.", + "format": "byte", + "type": "string" }, - "linearBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsLinear", - "description": "The linear bucket." + "dynamicDropTarget": { + "description": "Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.", + "format": "byte", + "type": "string" + }, + "dynamicDropzone": { + "description": "Specifies the Scotty dropzone to use for uploads.", + "type": "string" + }, + "mediaForDiff": { + "$ref": "GdataMedia", + "description": "Diff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information." + }, + "requestClass": { + "description": "Request class to use for all Blobstore operations for this request.", + "enum": [ + "UNKNOWN_REQUEST_CLASS", + "LATENCY_SENSITIVE", + "PRODUCTION_BATCH", + "BEST_EFFORT" + ], + "enumDescriptions": [ + "Unpopulated request_class in log files will be taken as 0 in dremel query. GoogleSQL will try to cast it to enum by default. An unused 0 value is added to avoid GoogleSQL casting error. Please refer to b/69677280.", + "A latency-sensitive request.", + "A request generated by a batch process.", + "A best-effort request." + ], + "type": "string" + }, + "scottyAgentUserId": { + "description": "Requester ID passed along to be recorded in the Scotty logs", + "format": "int64", + "type": "string" + }, + "scottyCustomerLog": { + "description": "Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog", + "format": "byte", + "type": "string" + }, + "trafficClassField": { + "description": "Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.", + "enum": [ + "BE1", + "AF1", + "AF2", + "AF3", + "AF4", + "NC1", + "NC0", + "BE0", + "LLQ", + "LLQ1", + "LLQ2", + "LLQ3" + ], + "enumDescriptions": [ + "Application-selectable traffic classes Best effort", + "Assured forwarding priority 1", + "Assured forwarding priority 2", + "Assured forwarding priority 3", + "Assured forwarding priority 4", + "Network control", + "Network control", + "Best effort at high packet loss", + "Low-latency queue (LLQ) best effort (go/llq)", + "LLQ assured forwarding priority 1 (go/llq2)", + "LLQ assured forwarding priority 2 (go/llq2)", + "LLQ assured forwarding priority 3 (go/llq3)" + ], + "type": "string" + }, + "verifyHashFromHeader": { + "description": "Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.", + "type": "boolean" } }, "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", + "GdataBlobstore2Info": { + "description": "Information to read/write to blobstore2.", + "id": "GdataBlobstore2Info", "properties": { - "bounds": { - "description": "The values must be monotonically increasing.", - "items": { - "format": "double", - "type": "number" - }, - "type": "array" + "blobGeneration": { + "description": "The blob generation id.", + "format": "int64", + "type": "string" + }, + "blobId": { + "description": "The blob id, e.g., /blobstore/prod/playground/scotty", + "type": "string" + }, + "downloadReadHandle": { + "description": "Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.", + "format": "byte", + "type": "string" + }, + "readToken": { + "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.", + "type": "string" + }, + "uploadMetadataContainer": { + "description": "Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", + "format": "byte", + "type": "string" } }, "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", + "GdataCompositeMedia": { + "description": "A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.", + "id": "GdataCompositeMedia", "properties": { - "growthFactor": { - "description": "Must be greater than 1.", - "format": "double", - "type": "number" + "blobRef": { + "deprecated": true, + "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.", + "format": "byte", + "type": "string" }, - "numFiniteBuckets": { - "description": "Must be greater than 0.", - "format": "int32", + "blobstore2Info": { + "$ref": "GdataBlobstore2Info", + "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob." + }, + "cosmoBinaryReference": { + "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.", + "format": "byte", + "type": "string" + }, + "crc32cHash": { + "description": "crc32.c hash for the payload.", + "format": "uint32", "type": "integer" }, - "scale": { - "description": "Must be greater than 0.", - "format": "double", - "type": "number" + "inline": { + "description": "Media data, set if reference_type is INLINE", + "format": "byte", + "type": "string" + }, + "length": { + "description": "Size of the data, in bytes", + "format": "int64", + "type": "string" + }, + "md5Hash": { + "description": "MD5 hash for the payload.", + "format": "byte", + "type": "string" + }, + "objectId": { + "$ref": "GdataObjectId", + "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF." + }, + "path": { + "description": "Path to the data, set if reference_type is PATH", + "type": "string" + }, + "referenceType": { + "description": "Describes what the field reference contains.", + "enum": [ + "PATH", + "BLOB_REF", + "INLINE", + "BIGSTORE_REF", + "COSMO_BINARY_REFERENCE" + ], + "enumDescriptions": [ + "Reference contains a GFS path or a local path.", + "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.", + "Data is included into this proto buffer", + "Reference points to a bigstore object", + "Indicates the data is stored in cosmo_binary_reference." + ], + "type": "string" + }, + "sha1Hash": { + "description": "SHA-1 hash for the payload.", + "format": "byte", + "type": "string" } }, "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", + "GdataContentTypeInfo": { + "description": "Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.", + "id": "GdataContentTypeInfo", "properties": { - "numFiniteBuckets": { - "description": "Must be greater than 0.", - "format": "int32", - "type": "integer" + "bestGuess": { + "description": "Scotty's best guess of what the content type of the file is.", + "type": "string" }, - "offset": { - "description": "Lower bound of the first bucket.", - "format": "double", - "type": "number" + "fromBytes": { + "description": "The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.", + "type": "string" }, - "width": { - "description": "Must be greater than 0.", - "format": "double", - "type": "number" + "fromFileName": { + "description": "The content type of the file derived from the file extension of the original file name used by the client.", + "type": "string" + }, + "fromHeader": { + "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.", + "type": "string" + }, + "fromUrlPath": { + "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).", + "type": "string" } }, "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", + "GdataDiffChecksumsResponse": { + "description": "Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", + "id": "GdataDiffChecksumsResponse", "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" + "checksumsLocation": { + "$ref": "GdataCompositeMedia", + "description": "Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol." }, - "timestamp": { - "description": "The observation (sampling) time of the above value.", - "format": "google-datetime", + "chunkSizeBytes": { + "description": "The chunk size of checksums. Must be a multiple of 256KB.", + "format": "int64", "type": "string" }, - "value": { - "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", - "format": "double", - "type": "number" + "objectLocation": { + "$ref": "GdataCompositeMedia", + "description": "If set, calculate the checksums based on the contents and return them to the caller." + }, + "objectSizeBytes": { + "description": "The total size of the server object.", + "format": "int64", + "type": "string" + }, + "objectVersion": { + "description": "The object version of the object the checksums are being returned for.", + "type": "string" } }, "type": "object" }, - "GoogleApiDistributionRange": { - "description": "The range of the population values.", - "id": "GoogleApiDistributionRange", + "GdataDiffDownloadResponse": { + "description": "Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", + "id": "GdataDiffDownloadResponse", "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" + "objectLocation": { + "$ref": "GdataCompositeMedia", + "description": "The original object location." } }, "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", + "GdataDiffUploadRequest": { + "description": "A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", + "id": "GdataDiffUploadRequest", "properties": { - "contentType": { - "description": "The HTTP Content-Type header value specifying the content type of the body.", - "type": "string" + "checksumsInfo": { + "$ref": "GdataCompositeMedia", + "description": "The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol." }, - "data": { - "description": "The HTTP request/response body as raw binary.", - "format": "byte", - "type": "string" + "objectInfo": { + "$ref": "GdataCompositeMedia", + "description": "The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received." }, - "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" + "objectVersion": { + "description": "The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.", + "type": "string" } }, "type": "object" }, - "GoogleApiMetric": { - "description": "A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`.", - "id": "GoogleApiMetric", + "GdataDiffUploadResponse": { + "description": "Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", + "id": "GdataDiffUploadResponse", "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.", - "type": "object" - }, - "type": { - "description": "An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.", + "objectVersion": { + "description": "The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.", "type": "string" + }, + "originalObject": { + "$ref": "GdataCompositeMedia", + "description": "The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification." } }, "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", + "GdataDiffVersionResponse": { + "description": "Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", + "id": "GdataDiffVersionResponse", "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" + "objectSizeBytes": { + "description": "The total size of the server object.", + "format": "int64", + "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`.", + "objectVersion": { + "description": "The version of the object stored at the server.", "type": "string" } }, "type": "object" }, - "GoogleApiMonitoredResourceMetadata": { - "description": "Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.", - "id": "GoogleApiMonitoredResourceMetadata", + "GdataDownloadParameters": { + "description": "Parameters specific to media downloads.", + "id": "GdataDownloadParameters", "properties": { - "systemLabels": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { \"name\": \"my-test-instance\", \"security_group\": [\"a\", \"b\", \"c\"], \"spot_instance\": false }", - "type": "object" + "allowGzipCompression": { + "description": "A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.", + "type": "boolean" }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "Output only. A map of user-defined metadata labels.", - "type": "object" + "ignoreRange": { + "description": "Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorContext": { - "description": "A description of the context in which an error occurred.", - "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "GdataMedia": { + "description": "A reference to data stored on the filesystem, on GFS or in blobstore.", + "id": "GdataMedia", "properties": { - "httpRequest": { - "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", - "description": "The HTTP request which was processed when the error was triggered." + "algorithm": { + "deprecated": true, + "description": "Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, \"MD5\" is the only possible value for this field. New values may be added at any time.", + "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." - } - }, - "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." + "bigstoreObjectRef": { + "deprecated": true, + "description": "Use object_id instead.", + "format": "byte", + "type": "string" }, - "message": { - "description": "A message describing the error.", + "blobRef": { + "deprecated": true, + "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.", + "format": "byte", "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" + "blobstore2Info": { + "$ref": "GdataBlobstore2Info", + "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob." }, - "responsePayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "compositeMedia": { + "description": "A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.", + "items": { + "$ref": "GdataCompositeMedia" }, - "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." + "type": "array" }, - "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.", + "contentType": { + "description": "MIME type of the data", "type": "string" }, - "gcsPath": { - "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", - "type": "string" + "contentTypeInfo": { + "$ref": "GdataContentTypeInfo", + "description": "Extended content type information provided for Scotty uploads." }, - "lineNumber": { - "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "cosmoBinaryReference": { + "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.", + "format": "byte", "type": "string" }, - "operation": { - "description": "The operation resource name of the LRO.", - "type": "string" + "crc32cHash": { + "description": "For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.", + "format": "uint32", + "type": "integer" }, - "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`.", + "diffChecksumsResponse": { + "$ref": "GdataDiffChecksumsResponse", + "description": "Set if reference_type is DIFF_CHECKSUMS_RESPONSE." + }, + "diffDownloadResponse": { + "$ref": "GdataDiffDownloadResponse", + "description": "Set if reference_type is DIFF_DOWNLOAD_RESPONSE." + }, + "diffUploadRequest": { + "$ref": "GdataDiffUploadRequest", + "description": "Set if reference_type is DIFF_UPLOAD_REQUEST." + }, + "diffUploadResponse": { + "$ref": "GdataDiffUploadResponse", + "description": "Set if reference_type is DIFF_UPLOAD_RESPONSE." + }, + "diffVersionResponse": { + "$ref": "GdataDiffVersionResponse", + "description": "Set if reference_type is DIFF_VERSION_RESPONSE." + }, + "downloadParameters": { + "$ref": "GdataDownloadParameters", + "description": "Parameters for a media download." + }, + "filename": { + "description": "Original file name", "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`.", + }, + "hash": { + "deprecated": true, + "description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { - "description": "Configuration data for advance site search.", - "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", - "properties": { - "disableAutomaticRefresh": { - "description": "If set true, automatic refresh is disabled for the DataStore.", - "type": "boolean" }, - "disableInitialIndex": { - "description": "If set true, initial indexing is disabled for the DataStore.", + "hashVerified": { + "description": "For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.", "type": "boolean" - } - }, - "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", + "inline": { + "description": "Media data, set if reference_type is INLINE", + "format": "byte", "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" - }, - "GoogleCloudDiscoveryengineV1CmekConfig": { - "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", - "id": "GoogleCloudDiscoveryengineV1CmekConfig", - "properties": { - "isDefault": { - "description": "Output only. The default CmekConfig for the Customer.", - "readOnly": true, + }, + "isPotentialRetry": { + "description": "|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.", "type": "boolean" }, - "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "length": { + "description": "Size of the data, in bytes", + "format": "int64", "type": "string" }, - "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", + "md5Hash": { + "description": "Scotty-provided MD5 hash for an upload.", + "format": "byte", "type": "string" }, - "lastRotationTimestampMicros": { - "description": "Output only. The timestamp of the last key rotation.", - "format": "int64", - "readOnly": true, + "mediaId": { + "description": "Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.", + "format": "byte", "type": "string" }, - "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", - "type": "string" + "objectId": { + "$ref": "GdataObjectId", + "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF." }, - "singleRegionKeys": { - "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1SingleRegionKey" - }, - "type": "array" + "path": { + "description": "Path to the data, set if reference_type is PATH", + "type": "string" }, - "state": { - "description": "Output only. State of the CmekConfig.", + "referenceType": { + "description": "Describes what the field reference contains.", "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "ACTIVE", - "KEY_ISSUE", - "DELETING", - "UNUSABLE", - "ACTIVE_ROTATING" + "PATH", + "BLOB_REF", + "INLINE", + "GET_MEDIA", + "COMPOSITE_MEDIA", + "BIGSTORE_REF", + "DIFF_VERSION_RESPONSE", + "DIFF_CHECKSUMS_RESPONSE", + "DIFF_DOWNLOAD_RESPONSE", + "DIFF_UPLOAD_REQUEST", + "DIFF_UPLOAD_RESPONSE", + "COSMO_BINARY_REFERENCE", + "ARBITRARY_BYTES" ], "enumDescriptions": [ - "The CmekConfig state is unknown.", - "The CmekConfig is creating.", - "The CmekConfig can be used with DataStores.", - "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", - "The CmekConfig is deleting.", - "The CmekConfig is not usable, most likely due to some internal issue.", - "The KMS key version is being rotated." + "Reference contains a GFS path or a local path.", + "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.", + "Data is included into this proto buffer", + "Data should be accessed from the current service using the operation GetMedia.", + "The content for this media object is stored across multiple partial media objects under the composite_media field.", + "Reference points to a bigstore object", + "Indicates the data is stored in diff_version_response.", + "Indicates the data is stored in diff_checksums_response.", + "Indicates the data is stored in diff_download_response.", + "Indicates the data is stored in diff_upload_request.", + "Indicates the data is stored in diff_upload_response.", + "Indicates the data is stored in cosmo_binary_reference.", + "Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes." ], - "readOnly": true, "type": "string" - } - }, - "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" }, - "queryRegex": { - "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", + "sha1Hash": { + "description": "Scotty-provided SHA1 hash for an upload.", + "format": "byte", "type": "string" }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. 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" + "sha256Hash": { + "description": "Scotty-provided SHA256 hash for an upload.", + "format": "byte", + "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.", + "timestamp": { + "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch", + "format": "uint64", + "type": "string" + }, + "token": { + "description": "A unique fingerprint/version id for the media data", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "GdataObjectId": { + "description": "This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.", + "id": "GdataObjectId", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", + "bucketName": { + "description": "The name of the bucket to which this object belongs.", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", - "format": "google-datetime", + "generation": { + "description": "Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions", + "format": "int64", + "type": "string" + }, + "objectName": { + "description": "The name of the object.", "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", + "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": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", + "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" }, - "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" + "bucketOptions": { + "$ref": "GoogleApiDistributionBucketOptions", + "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." }, - "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.", + "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" }, - "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" + "exemplars": { + "description": "Must be in increasing order of `value` field.", + "items": { + "$ref": "GoogleApiDistributionExemplar" + }, + "type": "array" }, - "promoteAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "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" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", - "description": "Defines a redirect-type control." + "range": { + "$ref": "GoogleApiDistributionRange", + "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero." }, - "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" + "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." }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." + "exponentialBuckets": { + "$ref": "GoogleApiDistributionBucketOptionsExponential", + "description": "The exponential buckets." }, - "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.", + "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": { - "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" + "format": "double", + "type": "number" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "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": { - "boost": { - "deprecated": true, - "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", + "growthFactor": { + "description": "Must be greater than 1.", + "format": "double", "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" + "numFiniteBuckets": { + "description": "Must be greater than 0.", + "format": "int32", + "type": "integer" }, - "fixedBoost": { - "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", + "scale": { + "description": "Must be greater than 0.", + "format": "double", "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "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": { - "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" + "numFiniteBuckets": { + "description": "Must be greater than 0.", + "format": "int32", + "type": "integer" }, - "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" + "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" }, - "GoogleCloudDiscoveryengineV1ControlPromoteAction": { - "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.", - "id": "GoogleCloudDiscoveryengineV1ControlPromoteAction", + "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": { - "dataStore": { - "description": "Required. Data store with which this promotion is attached to.", + "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" }, - "searchLinkPromotion": { - "$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion", - "description": "Required. Promotion attached to this action." + "value": { + "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "GoogleApiDistributionRange": { + "description": "The range of the population values.", + "id": "GoogleApiDistributionRange", "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" + "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" }, - "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", + "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": { - "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.", + "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": { - "type": "string" + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" }, "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", + "GoogleApiMetric": { + "description": "A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`.", + "id": "GoogleApiMetric", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.", + "type": "object" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "type": { + "description": "An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.", "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", + "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": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" }, - "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "GoogleApiMonitoredResourceMetadata": { + "description": "Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.", + "id": "GoogleApiMonitoredResourceMetadata", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "systemLabels": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { \"name\": \"my-test-instance\", \"security_group\": [\"a\", \"b\", \"c\"], \"spot_instance\": false }", + "type": "object" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. A map of user-defined metadata labels.", + "type": "object" } }, "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", + "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": { + "description": "The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`", + "id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext", "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", + "connectorRun": { + "description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1DataStore", - "properties": { - "advancedSiteSearchConfig": { - "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", - "description": "Optional. Configuration for advanced site search." - }, - "billingEstimation": { - "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", - "description": "Output only. Data size estimation for billing.", - "readOnly": true - }, - "cmekConfig": { - "$ref": "GoogleCloudDiscoveryengineV1CmekConfig", - "description": "Output only. CMEK-related information for the DataStore.", - "readOnly": true }, - "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." - ], + "dataConnector": { + "description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", + "endTime": { + "description": "The time when the connector run ended.", "format": "google-datetime", - "readOnly": true, "type": "string" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, + "entity": { + "description": "The entity to sync for the connector run.", "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.", + "operation": { + "description": "The operation resource name of the LRO to sync the connector.", "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." + "startTime": { + "description": "The time when the connector run started.", + "format": "google-datetime", + "type": "string" }, - "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." - ], + "syncType": { + "description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`", "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." }, - "isInfobotFaqDataStore": { - "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", - "type": "boolean" + "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": { + "connectorRunPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext", + "description": "The error payload that is populated on LRO connector sync APIs." }, - "kmsKeyName": { - "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", - "type": "string" + "context": { + "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", + "description": "A description of the context in which the error occurred." }, - "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.", + "importPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "description": "The error payload that is populated on LRO import APIs." + }, + "message": { + "description": "A message describing the error.", "type": "string" }, - "servingConfigDataStore": { - "$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", - "description": "Optional. Stores serving config at DataStore level." + "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" }, - "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" + "responsePayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" + "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" }, - "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)." + "serviceContext": { + "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", + "description": "The service context in which this error has occurred." }, - "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." + "status": { + "$ref": "GoogleRpcStatus", + "description": "The RPC status associated with the error log." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": { - "description": "Estimation of data size per data store.", - "id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { + "description": "HTTP request data that is related to a reported error.", + "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", "properties": { - "structuredDataSize": { - "description": "Data size for structured data in terms of bytes.", - "format": "int64", + "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" }, - "structuredDataUpdateTime": { - "description": "Last updated timestamp for structured data.", - "format": "google-datetime", + "gcsPath": { + "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", "type": "string" }, - "unstructuredDataSize": { - "description": "Data size for unstructured data in terms of bytes.", - "format": "int64", + "lineNumber": { + "description": "Line number of the content in file. Should be empty for permission or batch operation error.", "type": "string" }, - "unstructuredDataUpdateTime": { - "description": "Last updated timestamp for unstructured data.", - "format": "google-datetime", + "operation": { + "description": "The operation resource name of the LRO.", "type": "string" }, - "websiteDataSize": { - "description": "Data size for websites in terms of bytes.", - "format": "int64", - "type": "string" - }, - "websiteDataUpdateTime": { - "description": "Last updated timestamp for websites.", - "format": "google-datetime", + "userEvent": { + "description": "The detailed content which caused the error on importing a user event.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { - "description": "Stores information regarding the serving configurations at DataStore level.", - "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", + "GoogleCloudDiscoveryengineLoggingServiceContext": { + "description": "Describes a running service that sends errors.", + "id": "GoogleCloudDiscoveryengineLoggingServiceContext", "properties": { - "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", - "type": "boolean" + "service": { + "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", + "type": "string" } }, "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", + "GoogleCloudDiscoveryengineLoggingSourceLocation": { + "description": "Indicates a location in the source code of the service for which errors are reported.", + "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", "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", + "functionName": { + "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", "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", + "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { + "description": "Configuration data for advance site search.", + "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "disableAutomaticRefresh": { + "description": "If set true, automatic refresh is disabled for the DataStore.", + "type": "boolean" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "disableInitialIndex": { + "description": "If set true, initial indexing is disabled for the DataStore.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata": { - "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata", + "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.", @@ -9542,253 +10013,184 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", "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": "GoogleCloudDiscoveryengineV1TargetSite" + }, + "type": "array" } }, "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", + "GoogleCloudDiscoveryengineV1CmekConfig": { + "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", + "id": "GoogleCloudDiscoveryengineV1CmekConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "isDefault": { + "description": "Output only. The default CmekConfig for the Customer.", + "readOnly": true, + "type": "boolean" + }, + "kmsKey": { + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "kmsKeyVersion": { + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "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", + }, + "lastRotationTimestampMicros": { + "description": "Output only. The timestamp of the last key rotation.", + "format": "int64", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "name": { + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "type": "string" + }, + "singleRegionKeys": { + "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1SingleRegionKey" + }, + "type": "array" + }, + "state": { + "description": "Output only. The states of the CmekConfig.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "KEY_ISSUE", + "DELETING", + "DELETE_FAILED", + "UNUSABLE", + "ACTIVE_ROTATING" + ], + "enumDescriptions": [ + "The CmekConfig state is unknown.", + "The CmekConfig is creating.", + "The CmekConfig can be used with DataStores.", + "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", + "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", + "The CmekConfig is not usable, most likely due to some internal issue.", + "The KMS key version is being rotated." + ], + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { - "description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1Condition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1Condition", "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." + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" + }, + "type": "array" }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "queryRegex": { + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", "type": "string" }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" + "queryTerms": { + "description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" }, - "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. * `xlsm`: Override parsing config for XLSM 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": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "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" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1ConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", + "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" + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "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": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." + "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" }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "description": "Defines a boost-type control" }, - "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.", + "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": "GoogleCloudDiscoveryengineV1Condition" }, "type": "array" }, - "disableAnalytics": { - "description": "Optional. Whether to disable analytics for searches performed on this engine.", - "type": "boolean" - }, "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: 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": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "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}/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": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "promoteAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction", + "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + }, + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "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", @@ -9805,180 +10207,184 @@ ], "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "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" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "GoogleCloudDiscoveryengineV1ControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", "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." + "boost": { + "deprecated": true, + "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "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.", + "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" + }, + "fixedBoost": { + "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" + }, + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." } }, "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", + "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", "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.", + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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" }, - "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" + "controlPoints": { + "description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" }, - "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.", + "fieldName": { + "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "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.", + "interpolationType": { + "description": "Optional. 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" }, - "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" + }, + "boostAmount": { + "description": "Optional. 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" }, - "GoogleCloudDiscoveryengineV1EngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "GoogleCloudDiscoveryengineV1ControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", "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.", + "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" }, - "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1ControlPromoteAction": { + "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.", + "id": "GoogleCloudDiscoveryengineV1ControlPromoteAction", "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" + "dataStore": { + "description": "Required. Data store with which this promotion is attached to.", + "type": "string" }, - "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" + "searchLinkPromotion": { + "$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion", + "description": "Required. Promotion attached to this action." } }, "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", + "GoogleCloudDiscoveryengineV1ControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", "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", + "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" }, - "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", + "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": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "The desired location of errors incurred during the Import." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "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": "GoogleRpcStatus" + "type": "string" }, "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", + "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" }, - "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", @@ -9987,38 +10393,26 @@ }, "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", + "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": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "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" - } - }, - "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "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", + "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -10033,49 +10427,32 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1CreateSitemapMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata", "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" }, - "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", + "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" }, - "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", @@ -10084,172 +10461,190 @@ }, "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", + "GoogleCloudDiscoveryengineV1DataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1DataStore", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." + "advancedSiteSearchConfig": { + "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", + "description": "Optional. Configuration for advanced site search." }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", - "type": "string" + "cmekConfig": { + "$ref": "GoogleCloudDiscoveryengineV1CmekConfig", + "description": "Output only. CMEK-related information for the DataStore.", + "readOnly": true }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", + "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" - } - }, - "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.", + "description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "defaultSchemaId": { + "description": "Output only. The id of the default Schema associated to this data store.", "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, + "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" }, - "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" + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "type": "string" + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, - "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`.", + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", "type": "string" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" ], "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." + "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" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "isInfobotFaqDataStore": { + "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", + "type": "boolean" + }, + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", "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" + }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, + "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" }, - "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", + "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", "properties": { - "createTime": { - "description": "Operation create time.", + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "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.", + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", "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", + "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata": { + "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata", "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", @@ -10258,28 +10653,26 @@ }, "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", + "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": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "createTime": { + "description": "Operation create 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" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "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", + "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.", @@ -10294,348 +10687,287 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata": { + "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "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" }, - "GoogleCloudDiscoveryengineV1Schema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1Schema", + "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SearchLinkPromotion": { - "description": "Promotion proto includes uri and other helping information to display the promotion.", - "id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion", + "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata", "properties": { - "description": { - "description": "Optional. The Promotion description. Maximum length: 200 characters.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "enabled": { - "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.", - "type": "boolean" - }, - "imageUri": { - "description": "Optional. The promotion thumbnail image url.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "title": { - "description": "Required. The title of the promotion. Maximum length: 160 characters.", + } + }, + "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" }, - "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": { - "description": "A specification for configuring the behavior of content search.", - "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", + "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": { - "chunkSpec": { - "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec", - "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": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec", - "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 DocumentProcessingConfig.chunking_config is specified." - ], + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "snippetSpec": { - "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec", - "description": "If `snippetSpec` is not specified, snippets are not included in the search response." - }, - "summarySpec": { - "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec", - "description": "If `summarySpec` is not specified, summaries 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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": { - "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": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec", + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { + "description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "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" + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." }, - "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" + "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. * `xlsm`: Override parsing config for XLSM 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" }, - "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": { - "description": "A specification for configuring the extractive content in a search response.", - "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec", + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", "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" + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": { - "description": "A specification for configuring snippets in a search response.", - "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec", + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "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.", + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "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.", + "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" }, - "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": { - "description": "A specification for configuring a summary returned in a search response.", - "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec", + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "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" - }, - "ignoreJailBreakingQuery": { - "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking 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": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec", - "description": "If specified, the spec will be used to modify the prompt provided to the LLM." - }, - "modelSpec": { - "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec", - "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." }, - "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" + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." }, - "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" + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": { - "description": "Specification of the prompt to use with the model.", - "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "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": { - "preamble": { - "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", - "type": "string" + "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" }, - "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": { - "description": "Specification of the model.", - "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec", + "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": { - "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).", + "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" }, - "GoogleCloudDiscoveryengineV1ServingConfig": { - "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": "GoogleCloudDiscoveryengineV1ServingConfig", + "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": { - "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" + "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. ServingConfig created timestamp.", + "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "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" - }, - "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": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig", - "description": "The GenericConfig of the serving configuration." - }, - "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.", + "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" }, - "mediaConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig", - "description": "The MediaConfig of the serving configuration." + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" }, - "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.", + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "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" }, - "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" - }, - "promoteControlIds": { - "description": "Condition promote specifications. Maximum number of specifications is 100.", - "items": { - "type": "string" - }, - "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)`.", + "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}/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" }, - "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" + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, "solutionType": { - "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", + "description": "Required. The solutions of the engine.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -10652,15 +10984,8 @@ ], "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.", - "items": { - "type": "string" - }, - "type": "array" - }, "updateTime": { - "description": "Output only. ServingConfig updated timestamp.", + "description": "Output only. Timestamp the Recommendation Engine was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -10668,198 +10993,212 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": { - "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", - "id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig", + "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "properties": { - "contentSearchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", - "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." + "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." + }, + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" }, - "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": { - "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": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig", + "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": { - "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.", - "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" }, - "contentWatchedSecondsThreshold": { - "description": "Specifies the content watched minutes threshold for demotion.", - "format": "float", - "type": "number" + "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" }, - "demoteContentWatchedPastDays": { - "description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.", - "format": "int32", - "type": "integer" + "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" }, - "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.", + "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" }, - "GoogleCloudDiscoveryengineV1SingleRegionKey": { - "description": "Metadata for single-regional CMEKs.", - "id": "GoogleCloudDiscoveryengineV1SingleRegionKey", + "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", "properties": { - "kmsKey": { - "description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "GoogleCloudDiscoveryengineV1EngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", + "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": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" ], "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." + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." ], "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", + "GoogleCloudDiscoveryengineV1HealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "properties": { - "exactMatch": { - "description": "Immutable. 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.", + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", "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, + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata", + "properties": { + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", "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, + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", "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, + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", "type": "string" - }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + } + }, + "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" }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", "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." - ], + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", "type": "string" }, "updateTime": { - "description": "Output only. The target site's last updated time.", + "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" }, - "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", + "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": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", - "type": "string" + "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" }, - "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { - "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", + "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", @@ -10868,43 +11207,52 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { - "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", + "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 data.", + "description": "A sample of errors encountered while processing the request.", "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": "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" }, - "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata": { - "description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata", + "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "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.", @@ -10919,32 +11267,49 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "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" + }, + "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" }, - "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", + "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", @@ -10953,5399 +11318,5256 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1WorkspaceConfig": { - "description": "Config to store data store type configuration for workspace data", - "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", + "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": { - "dasherCustomerId": { - "description": "Obfuscated Dasher customer ID.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." }, - "superAdminEmailAddress": { - "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "superAdminServiceAccount": { - "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", "type": "string" }, - "type": { - "description": "The Google Workspace data source.", - "enum": [ - "TYPE_UNSPECIFIED", - "GOOGLE_DRIVE", - "GOOGLE_MAIL", - "GOOGLE_SITES", - "GOOGLE_CALENDAR", - "GOOGLE_CHAT", - "GOOGLE_GROUPS", - "GOOGLE_KEEP", - "GOOGLE_PEOPLE" - ], - "enumDescriptions": [ - "Defaults to an unspecified Workspace type.", - "Workspace Data Store contains Drive data", - "Workspace Data Store contains Mail data", - "Workspace Data Store contains Sites data", - "Workspace Data Store contains Calendar data", - "Workspace Data Store contains Chat data", - "Workspace Data Store contains Groups data", - "Workspace Data Store contains Keep data", - "Workspace Data Store contains People data" - ], + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAclConfig": { - "description": "Access Control Configuration.", - "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", + "GoogleCloudDiscoveryengineV1Project": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1Project", "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.", + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaActionConfig": { - "description": "Informations to support actions on the connector.", - "id": "GoogleCloudDiscoveryengineV1alphaActionConfig", - "properties": { - "actionParams": { + }, + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project}`. 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": { - "description": "Properties of the object.", - "type": "any" + "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" }, - "description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", - "type": "object" - }, - "isActionConfigured": { - "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", "readOnly": true, - "type": "boolean" + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest": { - "description": "Request message for CompletionService.AdvancedCompleteQuery method. .", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest", + "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", "properties": { - "boostSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec", - "description": "Optional. Specification to boost suggestions matching the condition." + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", + "type": "string" }, - "includeTailSuggestions": { - "description": "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.", - "type": "boolean" + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", + "type": "string" }, - "query": { - "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called \"zero prefix\" feature, which returns user's recently searched queries given the empty query.", + "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" }, - "queryModel": { - "description": "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.", + "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" }, - "suggestionTypeSpecs": { - "description": "Optional. Specification of each suggestion type.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec" - }, - "type": "array" + "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" }, - "suggestionTypes": { - "description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.", + "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": { - "enum": [ - "SUGGESTION_TYPE_UNSPECIFIED", - "QUERY", - "PEOPLE", - "CONTENT", - "RECENT_SEARCH", - "GOOGLE_WORKSPACE" - ], - "enumDescriptions": [ - "Default value.", - "Returns query suggestions.", - "Returns people suggestions.", - "Returns content suggestions.", - "Returns recent search suggestions.", - "Returns Google Workspace suggestions." - ], - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "userInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." + "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" }, - "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 SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", + "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" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec": { - "description": "Specification to boost suggestions based on the condtion of the suggestion.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec", + "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": { - "conditionBoostSpecs": { - "description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifictions, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec": { - "description": "Boost applies to suggestions which match a condition.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec", + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", "properties": { - "boost": { - "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.", - "format": "float", - "type": "number" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "condition": { - "description": "An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY(\"en\", \"fr\"))`", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec": { - "description": "Specification of each suggestion type.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec", + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", "properties": { - "maxSuggestions": { - "description": "Optional. Maximum number of suggestions to return for each suggestion type.", - "format": "int32", - "type": "integer" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "suggestionType": { - "description": "Optional. Suggestion type.", - "enum": [ - "SUGGESTION_TYPE_UNSPECIFIED", - "QUERY", - "PEOPLE", - "CONTENT", - "RECENT_SEARCH", - "GOOGLE_WORKSPACE" - ], - "enumDescriptions": [ - "Default value.", - "Returns query suggestions.", - "Returns people suggestions.", - "Returns content suggestions.", - "Returns recent search suggestions.", - "Returns Google Workspace suggestions." - ], + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse": { - "description": "Response message for CompletionService.AdvancedCompleteQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse", + "GoogleCloudDiscoveryengineV1Schema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1Schema", "properties": { - "contentSuggestions": { - "description": "Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion" - }, - "type": "array" - }, - "peopleSuggestions": { - "description": "Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion" - }, - "type": "array" + "jsonSchema": { + "description": "The JSON representation of the schema.", + "type": "string" }, - "querySuggestions": { - "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion" - }, - "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.", + "type": "string" }, - "recentSearchSuggestions": { - "description": "Results of the matched \"recent search\" suggestions. The result list is ordered and the first result is the top suggestion.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion" + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "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" + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion": { - "description": "Suggestions as content.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion", + "GoogleCloudDiscoveryengineV1SearchLinkPromotion": { + "description": "Promotion proto includes uri and other helping information to display the promotion.", + "id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion", "properties": { - "contentType": { - "description": "The type of the content suggestion.", - "enum": [ - "CONTENT_TYPE_UNSPECIFIED", - "GOOGLE_WORKSPACE", - "THIRD_PARTY" - ], - "enumDescriptions": [ - "Default value.", - "The suggestion is from a Google Workspace source.", - "The suggestion is from a third party source." - ], + "description": { + "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, - "dataStore": { - "description": "The name of the dataStore that this suggestion belongs to.", + "enabled": { + "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.", + "type": "boolean" + }, + "imageUri": { + "description": "Optional. The promotion thumbnail image url.", "type": "string" }, - "document": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "The document data snippet in the suggestion. Only a subset of fields will be populated." + "title": { + "description": "Required. The title of the promotion. Maximum length: 160 characters.", + "type": "string" }, - "suggestion": { - "description": "The suggestion for the query.", + "uri": { + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion": { - "description": "Suggestions as people.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion", + "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", "properties": { - "dataStore": { - "description": "The name of the dataStore that this suggestion belongs to.", - "type": "string" + "chunkSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec", + "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" }, - "document": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "The document data snippet in the suggestion. Only a subset of fields is populated." + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, - "personType": { - "description": "The type of the person.", + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ - "PERSON_TYPE_UNSPECIFIED", - "CLOUD_IDENTITY", - "THIRD_PARTY_IDENTITY" + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" ], "enumDescriptions": [ "Default value.", - "The suggestion is from a GOOGLE_IDENTITY source.", - "The suggestion is from a THIRD_PARTY_IDENTITY source." + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, - "suggestion": { - "description": "The suggestion for the query.", - "type": "string" + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion": { - "description": "Suggestions as search queries.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion", + "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": { + "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": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec", "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" - }, - "dataStore": { - "description": "The name of the dataStore that this suggestion belongs to.", - "items": { - "type": "string" - }, - "type": "array" + "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" }, - "suggestion": { - "description": "The suggestion for the query.", - "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" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion": { - "description": "Suggestions from recent search history.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion", + "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "recentSearchTime": { - "description": "The time when this recent rearch happened.", - "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" }, - "suggestion": { - "description": "The suggestion for the query.", - "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" }, - "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { - "description": "Configuration data for advance site search.", - "id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", + "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec", "properties": { - "disableAutomaticRefresh": { - "description": "If set true, automatic refresh is disabled for the DataStore.", + "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" }, - "disableInitialIndex": { - "description": "If set true, initial indexing is disabled for the DataStore.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { - "description": "AlloyDB source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec", "properties": { - "clusterId": { - "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", - "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" }, - "databaseId": { - "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", - "type": "string" + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" }, - "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" + "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" }, - "locationId": { - "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", - "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" }, - "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" + "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" }, - "tableId": { - "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "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" - }, - "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", - "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", - "LOW_GROUNDED_ANSWER" - ], - "enumDescriptions": [ - "Default value. The answer skipped reason is not specified.", - "The adversarial query ignored case.", - "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", - "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.", - "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", - "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated." - ], + }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec", + "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" + }, + "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "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" + }, + "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec", + "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" + }, + "GoogleCloudDiscoveryengineV1ServingConfig": { + "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": "GoogleCloudDiscoveryengineV1ServingConfig", + "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" }, - "answerText": { - "description": "The textual answer.", + "createTime": { + "description": "Output only. ServingConfig created timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "citations": { - "description": "Citations.", + "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": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" + "type": "string" }, "type": "array" }, - "completeTime": { - "description": "Output only. Answer completed timestamp.", - "format": "google-datetime", - "readOnly": true, + "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" }, - "createTime": { - "description": "Output only. Answer creation timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "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" }, - "groundingScore": { - "description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.", - "format": "double", - "type": "number" + "genericConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig", + "description": "The GenericConfig of the serving configuration." }, - "groundingSupports": { - "description": "Optional. Grounding supports.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport" + "type": "string" }, "type": "array" }, + "mediaConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig", + "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" + }, "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "type": "string" }, - "queryUnderstandingInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", - "description": "Query understanding information." + "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" }, - "references": { - "description": "References.", + "promoteControlIds": { + "description": "Condition promote specifications. Maximum number of specifications is 100.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" + "type": "string" }, "type": "array" }, - "relatedQuestions": { - "description": "Suggested related questions.", + "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" + }, + "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" }, - "safetyRatings": { - "description": "Optional. Safety ratings.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSafetyRating" + "type": "string" }, "type": "array" }, - "state": { - "description": "The state of the answer generation.", + "solutionType": { + "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED", - "STREAMING" + "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.", - "Answer generation is currently in progress." + "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.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" + "type": "string" }, "type": "array" + }, + "updateTime": { + "description": "Output only. ServingConfig updated timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { - "description": "Citation info for a segment.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", + "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": { + "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", + "id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig", "properties": { - "endIndex": { - "description": "End of the attributed segment, exclusive.", - "format": "int64", - "type": "string" + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", + "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": { + "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": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig", + "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" }, - "sources": { - "description": "Citation sources for the attributed segment.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" - }, - "type": "array" + "contentWatchedPercentageThreshold": { + "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", + "format": "float", + "type": "number" }, - "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", - "format": "int64", + "contentWatchedSecondsThreshold": { + "description": "Specifies the content watched minutes threshold for demotion.", + "format": "float", + "type": "number" + }, + "demoteContentWatchedPastDays": { + "description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.", + "format": "int32", + "type": "integer" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { - "description": "Citation source.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", + "GoogleCloudDiscoveryengineV1SingleRegionKey": { + "description": "Metadata for single-regional CMEKs.", + "id": "GoogleCloudDiscoveryengineV1SingleRegionKey", "properties": { - "referenceId": { - "description": "ID of the citation source.", + "kmsKey": { + "description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": { - "description": "Grounding support for a claim in `answer_text`.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport", - "properties": { - "endIndex": { - "description": "Required. End of the claim, exclusive.", - "format": "int64", + "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" }, - "groundingCheckRequired": { - "description": "Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.", - "type": "boolean" - }, - "groundingScore": { - "description": "A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.", - "format": "double", - "type": "number" + "verifyTime": { + "description": "Latest site verification time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Sitemap": { + "description": "A sitemap for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1Sitemap", + "properties": { + "createTime": { + "description": "Output only. The sitemap's creation time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "sources": { - "description": "Optional. Citation sources for the claim.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" - }, - "type": "array" + "name": { + "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", + "readOnly": true, + "type": "string" }, - "startIndex": { - "description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).", - "format": "int64", + "uri": { + "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": { - "description": "Request message for ConversationalSearchService.AnswerQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest", + "GoogleCloudDiscoveryengineV1TargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1TargetSite", "properties": { - "answerGenerationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", - "description": "Answer generation specification." - }, - "asynchronousMode": { - "deprecated": true, - "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. 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.", + "exactMatch": { + "description": "Immutable. 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" }, - "endUserSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec", - "description": "Optional. End user specification." + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true }, - "groundingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec", - "description": "Optional. Grounding specification." + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, + "type": "string" }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", - "description": "Required. Current user query." + "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" }, - "queryUnderstandingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", - "description": "Query understanding specification." + "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" }, - "relatedQuestionsSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", - "description": "Related questions specification." + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "type": "string" }, - "safetySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", - "description": "Model specification." + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, + "type": "string" }, - "searchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", - "description": "Search specification." + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true }, - "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": { + "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" }, - "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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "updateTime": { + "description": "Output only. The target site's last updated time.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": { - "description": "Answer generation specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", + "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", "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" - }, - "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" - }, - "ignoreJailBreakingQuery": { - "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", - "type": "boolean" - }, - "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." + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": { - "description": "Answer Generation Model specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", + "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", "properties": { - "modelVersion": { - "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { - "description": "Answer generation prompt specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", + "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", "properties": { - "preamble": { - "description": "Customized preamble.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec": { - "description": "End user specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec", + "GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", "properties": { - "endUserMetadata": { - "description": "Optional. End user metadata.", + "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": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData" + "$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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData": { - "description": "End user metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData", - "properties": { - "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", - "description": "Chunk information." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", + "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata": { + "description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata", "properties": { - "content": { - "description": "Chunk textual content. It is limited to 8000 characters.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "documentMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", - "description": "Metadata of the document from the current chunk." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": { - "description": "Document metadata contains the information of the document of the current chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", + "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", "properties": { - "title": { - "description": "Title of the document.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec": { - "description": "Grounding specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec", + "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": { - "filteringLevel": { - "description": "Optional. Specifies whether to enable the filtering based on grounding score and at what level.", + "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" + }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", "enum": [ - "FILTERING_LEVEL_UNSPECIFIED", - "FILTERING_LEVEL_LOW", - "FILTERING_LEVEL_HIGH" + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" ], "enumDescriptions": [ - "Default is no filter", - "Filter answers based on a low threshold.", - "Filter answers based on a high threshold." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" ], "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", + "properties": { + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Identity provider config." }, - "includeGroundingSupports": { - "description": "Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.", - "type": "boolean" + "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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": { - "description": "Query understanding specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", + "GoogleCloudDiscoveryengineV1alphaActionConfig": { + "description": "Informations to support actions on the connector.", + "id": "GoogleCloudDiscoveryengineV1alphaActionConfig", "properties": { - "queryClassificationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", - "description": "Query classification specification." + "actionParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", + "type": "object" }, - "queryRephraserSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", - "description": "Query rephraser specification." + "isActionConfigured": { + "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", + "readOnly": true, + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { - "description": "Query classification specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest": { + "description": "Request message for CompletionService.AdvancedCompleteQuery method. .", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest", "properties": { - "types": { - "description": "Enabled query classification types.", + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec", + "description": "Optional. Specification to boost suggestions matching the condition." + }, + "includeTailSuggestions": { + "description": "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.", + "type": "boolean" + }, + "query": { + "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called \"zero prefix\" feature, which returns user's recently searched queries given the empty query.", + "type": "string" + }, + "queryModel": { + "description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. 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.", + "type": "string" + }, + "suggestionTypeSpecs": { + "description": "Optional. Specification of each suggestion type.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec" + }, + "type": "array" + }, + "suggestionTypes": { + "description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.", "items": { "enum": [ - "TYPE_UNSPECIFIED", - "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" + "SUGGESTION_TYPE_UNSPECIFIED", + "QUERY", + "PEOPLE", + "CONTENT", + "RECENT_SEARCH", + "GOOGLE_WORKSPACE" ], "enumDescriptions": [ - "Unspecified query classification type.", - "Adversarial query classification type.", - "Non-answer-seeking query classification type, for chit chat.", - "Jail-breaking query classification type.", - "Non-answer-seeking query classification type, for no clear intent." + "Default value.", + "Returns query suggestions.", + "Returns people suggestions.", + "Returns content suggestions.", + "Returns recent search suggestions.", + "Returns Google Workspace suggestions." ], "type": "string" }, "type": "array" + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." + }, + "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 SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { - "description": "Query rephraser specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec": { + "description": "Specification to boost suggestions based on the condtion of the suggestion.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec", "properties": { - "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" - }, - "modelSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec", - "description": "Optional. Query Rephraser Model specification." + "conditionBoostSpecs": { + "description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifictions, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": { - "description": "Query Rephraser Model specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to suggestions which match a condition.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec", "properties": { - "modelType": { - "description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.", - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "SMALL", - "LARGE" - ], - "enumDescriptions": [ - "Unspecified model type.", - "Small query rephraser model. Gemini 1.0 XS model.", - "Large query rephraser model. Gemini 1.0 Pro model." - ], + "boost": { + "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.", + "format": "float", + "type": "number" + }, + "condition": { + "description": "An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY(\"en\", \"fr\"))`", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": { - "description": "Related questions specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec": { + "description": "Specification of each suggestion type.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec", "properties": { - "enable": { - "description": "Enable related questions feature if true.", - "type": "boolean" + "maxSuggestions": { + "description": "Optional. Maximum number of suggestions to return for each suggestion type.", + "format": "int32", + "type": "integer" + }, + "suggestionType": { + "description": "Optional. Suggestion type.", + "enum": [ + "SUGGESTION_TYPE_UNSPECIFIED", + "QUERY", + "PEOPLE", + "CONTENT", + "RECENT_SEARCH", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Returns query suggestions.", + "Returns people suggestions.", + "Returns content suggestions.", + "Returns recent search suggestions.", + "Returns Google Workspace suggestions." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": { - "description": "Safety specification. There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories. 2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse": { + "description": "Response message for CompletionService.AdvancedCompleteQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse", "properties": { - "enable": { - "description": "Enable the safety filtering on the answer response. It is false by default.", - "type": "boolean" + "contentSuggestions": { + "description": "Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion" + }, + "type": "array" }, - "safetySettings": { - "description": "Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.", + "peopleSuggestions": { + "description": "Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting" + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion" + }, + "type": "array" + }, + "querySuggestions": { + "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion" + }, + "type": "array" + }, + "recentSearchSuggestions": { + "description": "Results of the matched \"recent search\" suggestions. The result list is ordered and the first result is the top suggestion.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion" }, "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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting": { - "description": "Safety settings.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion": { + "description": "Suggestions as content.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion", "properties": { - "category": { - "description": "Required. Harm category.", + "contentType": { + "description": "The type of the content suggestion.", "enum": [ - "HARM_CATEGORY_UNSPECIFIED", - "HARM_CATEGORY_HATE_SPEECH", - "HARM_CATEGORY_DANGEROUS_CONTENT", - "HARM_CATEGORY_HARASSMENT", - "HARM_CATEGORY_SEXUALLY_EXPLICIT", - "HARM_CATEGORY_CIVIC_INTEGRITY" + "CONTENT_TYPE_UNSPECIFIED", + "GOOGLE_WORKSPACE", + "THIRD_PARTY" ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", - "The harm category is civic integrity." + "Default value.", + "The suggestion is from a Google Workspace source.", + "The suggestion is from a third party source." ], "type": "string" }, - "threshold": { - "description": "Required. The harm block threshold.", - "enum": [ - "HARM_BLOCK_THRESHOLD_UNSPECIFIED", - "BLOCK_LOW_AND_ABOVE", - "BLOCK_MEDIUM_AND_ABOVE", - "BLOCK_ONLY_HIGH", - "BLOCK_NONE", - "OFF" - ], - "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." - ], + "dataStore": { + "description": "The name of the dataStore that this suggestion belongs to.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": { - "description": "Search specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", - "properties": { - "searchParams": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", - "description": "Search parameters." }, - "searchResultList": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", - "description": "Search result list." + "destinationUri": { + "description": "The destination uri of the content suggestion.", + "type": "string" + }, + "document": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", + "description": "The document data snippet in the suggestion. Only a subset of fields will be populated." + }, + "iconUri": { + "description": "The icon uri of the content suggestion.", + "type": "string" + }, + "score": { + "description": "The score of each suggestion. The score is in the range of [0, 1].", + "format": "double", + "type": "number" + }, + "suggestion": { + "description": "The suggestion for the query.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": { - "description": "Search parameters.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion": { + "description": "Suggestions as people.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion", "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)" - }, - "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)", + "dataStore": { + "description": "The name of the dataStore that this suggestion belongs to.", "type": "string" }, - "maxReturnResults": { - "description": "Number of search results to return. The default value is 10.", - "format": "int32", - "type": "integer" - }, - "naturalLanguageQueryUnderstandingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", - "description": "Optional. Specification to enable natural language understanding capabilities for search requests." + "destinationUri": { + "description": "The destination uri of the person suggestion.", + "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.", + "displayPhotoUri": { + "description": "The photo uri of the person suggestion.", "type": "string" }, - "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)", + "document": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", + "description": "The document data snippet in the suggestion. Only a subset of fields is populated." + }, + "personType": { + "description": "The type of the person.", "enum": [ - "SEARCH_RESULT_MODE_UNSPECIFIED", - "DOCUMENTS", - "CHUNKS" + "PERSON_TYPE_UNSPECIFIED", + "CLOUD_IDENTITY", + "THIRD_PARTY_IDENTITY" ], "enumDescriptions": [ "Default value.", - "Returns documents in the search result.", - "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified." + "The suggestion is from a GOOGLE_IDENTITY source.", + "The suggestion is from a THIRD_PARTY_IDENTITY source." ], "type": "string" + }, + "score": { + "description": "The score of each suggestion. The score is in the range of [0, 1].", + "format": "double", + "type": "number" + }, + "suggestion": { + "description": "The suggestion for the query.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": { - "description": "Search result list.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion": { + "description": "Suggestions as search queries.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion", "properties": { - "searchResults": { - "description": "Search results.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult" + "type": "string" }, "type": "array" + }, + "dataStore": { + "description": "The name of the dataStore that this suggestion belongs to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "score": { + "description": "The score of each suggestion. The score is in the range of [0, 1].", + "format": "double", + "type": "number" + }, + "suggestion": { + "description": "The suggestion for the query.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { - "description": "Search result.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult", + "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion": { + "description": "Suggestions from recent search history.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion", "properties": { - "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", - "description": "Chunk information." + "recentSearchTime": { + "description": "The time when this recent rearch happened.", + "format": "google-datetime", + "type": "string" }, - "unstructuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", - "description": "Unstructured document information." + "score": { + "description": "The score of each suggestion. The score is in the range of [0, 1].", + "format": "double", + "type": "number" + }, + "suggestion": { + "description": "The suggestion for the query.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", + "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { + "description": "Configuration data for advance site search.", + "id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", "properties": { - "chunk": { - "description": "Chunk resource name.", - "type": "string" + "disableAutomaticRefresh": { + "description": "If set true, automatic refresh is disabled for the DataStore.", + "type": "boolean" }, - "content": { - "description": "Chunk textual content.", - "type": "string" + "disableInitialIndex": { + "description": "If set true, initial indexing is disabled for the DataStore.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { + "description": "The connector level alert config.", + "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", + "properties": { + "alertEnrollments": { + "description": "Optional. The enrollment states of each alert.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment" + }, + "type": "array" }, - "documentMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", - "description": "Metadata of the document from the current chunk." + "alertPolicyName": { + "description": "Immutable. The fully qualified resource name of the AlertPolicy.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata": { - "description": "Document metadata contains the information of the document of the current chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": { + "description": "The alert enrollment status.", + "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment", "properties": { - "title": { - "description": "Title of the document.", + "alertId": { + "description": "Immutable. The id of an alert.", "type": "string" }, - "uri": { - "description": "Uri of the document.", + "enrollState": { + "description": "Required. The enrollment status of a customer.", + "enum": [ + "ENROLL_STATES_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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { - "description": "Unstructured document information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", "properties": { - "document": { - "description": "Document resource name.", + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", "type": "string" }, - "documentContexts": { - "description": "List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" + "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", + "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", + "LOW_GROUNDED_ANSWER" + ], + "enumDescriptions": [ + "Default value. The answer skipped reason is not specified.", + "The adversarial query ignored case.", + "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", + "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.", + "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", + "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated." + ], + "type": "string" }, "type": "array" }, - "extractiveAnswers": { - "deprecated": true, - "description": "Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.", + "answerText": { + "description": "The textual answer.", + "type": "string" + }, + "citations": { + "description": "Citations.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" }, "type": "array" }, - "extractiveSegments": { - "description": "List of extractive segments.", + "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" + }, + "groundingScore": { + "description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.", + "format": "double", + "type": "number" + }, + "groundingSupports": { + "description": "Optional. Grounding supports.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport" }, "type": "array" }, - "title": { - "description": "Title.", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "type": "string" }, - "uri": { - "description": "URI for the document.", + "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" + }, + "safetyRatings": { + "description": "Optional. Safety ratings.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSafetyRating" + }, + "type": "array" + }, + "state": { + "description": "The state of the answer generation.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED", + "STREAMING" + ], + "enumDescriptions": [ + "Unknown.", + "Answer generation is currently in progress.", + "Answer generation currently failed.", + "Answer generation has succeeded.", + "Answer generation is currently in progress." + ], "type": "string" + }, + "steps": { + "description": "Answer generation steps.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { - "description": "Document context.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", + "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { - "content": { - "description": "Document content to be used for answer generation.", + "endIndex": { + "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", + "format": "int64", "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", + "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). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { - "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", + "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", "properties": { - "content": { - "description": "Extractive answer content.", - "type": "string" - }, - "pageIdentifier": { - "description": "Page identifier.", + "referenceId": { + "description": "ID of the citation source.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { - "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", + "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": { + "description": "Grounding support for a claim in `answer_text`.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport", "properties": { - "content": { - "description": "Extractive segment content.", + "endIndex": { + "description": "Required. End of the claim, exclusive.", + "format": "int64", "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", + "groundingCheckRequired": { + "description": "Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.", + "type": "boolean" + }, + "groundingScore": { + "description": "A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.", + "format": "double", + "type": "number" + }, + "sources": { + "description": "Optional. Citation sources for the claim.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" + }, + "type": "array" + }, + "startIndex": { + "description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse": { - "description": "Response message for ConversationalSearchService.AnswerQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": { + "description": "Request message for ConversationalSearchService.AnswerQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest", "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." + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", + "description": "Answer generation specification." }, - "answerQueryToken": { - "description": "A global unique ID used for logging.", - "type": "string" + "asynchronousMode": { + "deprecated": true, + "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. 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" + }, + "endUserSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec", + "description": "Optional. End user specification." + }, + "groundingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec", + "description": "Optional. Grounding specification." + }, + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSession", - "description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request." + "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" + }, + "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`. 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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { - "description": "Query understanding information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": { + "description": "Answer generation specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", "properties": { - "queryClassificationInfo": { - "description": "Query classification information.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" - }, - "type": "array" + "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" + }, + "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" + }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { - "description": "Query classification information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": { + "description": "Answer Generation Model specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", "properties": { - "positive": { - "description": "Classification output.", - "type": "boolean" - }, - "type": { - "description": "Query classification type.", - "enum": [ - "TYPE_UNSPECIFIED", - "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY", - "NON_ANSWER_SEEKING_QUERY_V2" - ], - "enumDescriptions": [ - "Unspecified query classification type.", - "Adversarial query classification type.", - "Non-answer-seeking query classification type, for chit chat.", - "Jail-breaking query classification type.", - "Non-answer-seeking query classification type, for no clear intent." - ], + "modelVersion": { + "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReference": { - "description": "Reference.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { + "description": "Answer generation prompt specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", + "properties": { + "preamble": { + "description": "Customized preamble.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec": { + "description": "End user specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec", + "properties": { + "endUserMetadata": { + "description": "Optional. End user metadata.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData": { + "description": "End user metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData", "properties": { "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", "description": "Chunk information." - }, - "structuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", - "description": "Structured document information." - }, - "unstructuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", - "description": "Unstructured document information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": { "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", "properties": { - "chunk": { - "description": "Chunk resource name.", - "type": "string" - }, "content": { - "description": "Chunk textual content.", + "description": "Chunk textual content. It is limited to 8000 characters.", "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" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", + "description": "Metadata of the document from the current chunk." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { - "description": "Document metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", "properties": { - "document": { - "description": "Document resource name.", - "type": "string" - }, - "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.", + "description": "Title of the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { - "description": "Structured search information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec": { + "description": "Grounding specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec", "properties": { - "document": { - "description": "Document resource name.", - "type": "string" - }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Structured search data.", - "type": "object" + "filteringLevel": { + "description": "Optional. Specifies whether to enable the filtering based on grounding score and at what level.", + "enum": [ + "FILTERING_LEVEL_UNSPECIFIED", + "FILTERING_LEVEL_LOW", + "FILTERING_LEVEL_HIGH" + ], + "enumDescriptions": [ + "Default is no filter", + "Filter answers based on a low threshold.", + "Filter answers based on a high threshold." + ], + "type": "string" + }, + "includeGroundingSupports": { + "description": "Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { - "description": "Unstructured document information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": { + "description": "Query understanding specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", "properties": { - "chunkContents": { - "description": "List of cited chunk contents derived from document content.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" - }, - "type": "array" + "disableSpellCorrection": { + "description": "Optional. Whether to disable spell correction. The default value is `false`.", + "type": "boolean" }, - "document": { - "description": "Document resource name.", - "type": "string" + "queryClassificationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "description": "Query classification specification." }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "queryRephraserSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", + "description": "Query rephraser specification." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { + "description": "Query classification specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "properties": { + "types": { + "description": "Enabled query classification types.", + "items": { + "enum": [ + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" + ], + "enumDescriptions": [ + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." + ], + "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" - }, - "title": { - "description": "Title.", - "type": "string" - }, - "uri": { - "description": "URI for the document.", - "type": "string" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { - "description": "Chunk content.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { + "description": "Query rephraser specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", "properties": { - "content": { - "description": "Chunk textual content.", - "type": "string" + "disable": { + "description": "Disable query rephraser.", + "type": "boolean" }, - "pageIdentifier": { - "description": "Page identifier.", - "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" }, - "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" + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec", + "description": "Optional. Query Rephraser Model specification." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStep": { - "description": "Step information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": { + "description": "Query Rephraser Model specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec", "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.", + "modelType": { + "description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.", "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" + "MODEL_TYPE_UNSPECIFIED", + "SMALL", + "LARGE" ], "enumDescriptions": [ - "Unknown.", - "Step is currently in progress.", - "Step currently failed.", - "Step has succeeded." + "Unspecified model type.", + "Small query rephraser model. Gemini 1.0 XS model.", + "Large query rephraser model. Gemini 1.0 Pro model." ], "type": "string" - }, - "thought": { - "description": "The thought of the step.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { - "description": "Action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": { + "description": "Related questions specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", "properties": { - "observation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", - "description": "Observation." - }, - "searchAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", - "description": "Search action." + "enable": { + "description": "Enable related questions feature if true.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { - "description": "Observation.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": { + "description": "Safety specification. There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories. 2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", "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.", + "enable": { + "description": "Enable the safety filtering on the answer response. It is false by default.", + "type": "boolean" + }, + "safetySettings": { + "description": "Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting": { + "description": "Safety settings.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting", "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" - }, - "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.", + "category": { + "description": "Required. Harm category.", + "enum": [ + "HARM_CATEGORY_UNSPECIFIED", + "HARM_CATEGORY_HATE_SPEECH", + "HARM_CATEGORY_DANGEROUS_CONTENT", + "HARM_CATEGORY_HARASSMENT", + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" + ], + "enumDescriptions": [ + "The harm category is unspecified.", + "The harm category is hate speech.", + "The harm category is dangerous content.", + "The harm category is harassment.", + "The harm category is sexually explicit content.", + "The harm category is civic integrity." + ], "type": "string" }, - "uri": { - "description": "URI for the document.", + "threshold": { + "description": "Required. The harm block threshold.", + "enum": [ + "HARM_BLOCK_THRESHOLD_UNSPECIFIED", + "BLOCK_LOW_AND_ABOVE", + "BLOCK_MEDIUM_AND_ABOVE", + "BLOCK_ONLY_HIGH", + "BLOCK_NONE", + "OFF" + ], + "enumDescriptions": [ + "Unspecified harm block threshold.", + "Block low threshold and above (i.e. block more).", + "Block medium threshold and above.", + "Block only high threshold (i.e. block less).", + "Block none.", + "Turn off the safety filter." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", - "properties": { - "chunk": { - "description": "Chunk resource name.", - "type": "string" - }, - "content": { - "description": "Chunk textual content.", - "type": "string" + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": { + "description": "Search specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", + "properties": { + "searchParams": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", + "description": "Search parameters." }, - "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" + "searchResultList": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", + "description": "Search result list." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { - "description": "Snippet information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": { + "description": "Search parameters.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", "properties": { - "snippet": { - "description": "Snippet content.", + "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" }, - "snippetStatus": { - "description": "Status of the snippet defined by the search team.", + "maxReturnResults": { + "description": "Number of search results to return. The default value is 10.", + "format": "int32", + "type": "integer" + }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "Optional. Specification to enable natural language understanding capabilities for search requests." + }, + "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" + }, + "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 DocumentProcessingConfig.chunking_config is specified." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { - "description": "Search action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": { + "description": "Search result list.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", "properties": { - "query": { - "description": "The query to search.", - "type": "string" + "searchResults": { + "description": "Search results.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult" + }, + "type": "array" } }, "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", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { + "description": "Search result.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", + "description": "Chunk information." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "description": "Unstructured document information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest": { - "description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", "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" + "chunk": { + "description": "Chunk resource name.", + "type": "string" + }, + "content": { + "description": "Chunk textual content.", + "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", + "description": "Metadata of the document from the current chunk." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", "properties": { - "targetSites": { - "description": "TargetSites created.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" - }, - "type": "array" + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "Uri of the document.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse": { - "description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", "properties": { - "documentsMetadata": { - "description": "The metadata of the Documents.", + "document": { + "description": "Document resource name.", + "type": "string" + }, + "documentContexts": { + "description": "List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" + }, + "type": "array" + }, + "extractiveAnswers": { + "deprecated": true, + "description": "Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. 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" }, - "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata": { - "description": "The metadata of a Document.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { + "description": "Document context.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "properties": { - "dataIngestionSource": { - "description": "The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.", - "type": "string" - }, - "lastRefreshedTime": { - "description": "The timestamp of the last time the Document was last indexed.", - "format": "google-datetime", + "content": { + "description": "Document content to be used for answer generation.", "type": "string" }, - "matcherValue": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", - "description": "The value of the matcher that was used to match the Document." - }, - "state": { - "description": "The state of the document.", - "enum": [ - "STATE_UNSPECIFIED", - "INDEXED", - "NOT_IN_TARGET_SITE", - "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." - ], + "pageIdentifier": { + "description": "Page identifier.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { - "description": "The value of the matcher that was used to match the Document.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { + "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", "properties": { - "fhirResource": { - "description": "Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", + "content": { + "description": "Extractive answer content.", "type": "string" }, - "uri": { - "description": "If match by URI, the URI of the Document.", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { - "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaBigQuerySource": { - "description": "BigQuery source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { + "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", "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.", + "content": { + "description": "Extractive segment content.", "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.", + "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." }, - "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.", + "answerQueryToken": { + "description": "A global unique ID used for logging.", "type": "string" }, - "tableId": { - "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.", - "type": "string" + "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" }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptions": { - "description": "The Bigtable Options object that contains information to support the import.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { + "description": "Query understanding information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", "properties": { - "families": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily" + "queryClassificationInfo": { + "description": "Query classification information.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" }, - "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" - }, - "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": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": { - "description": "The column of the Bigtable.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { + "description": "Query classification information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", "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" + "positive": { + "description": "Classification output.", + "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`.", + "description": "Query classification type.", "enum": [ "TYPE_UNSPECIFIED", - "STRING", - "NUMBER", - "INTEGER", - "VAR_INTEGER", - "BIG_NUMERIC", - "BOOLEAN", - "JSON" + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ - "The type is unspecified.", - "String type.", - "Numerical type.", - "Integer type.", - "Variable length integer type.", - "BigDecimal type.", - "Boolean type.", - "JSON type." + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": { - "description": "The column family of the Bigtable.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily", + "GoogleCloudDiscoveryengineV1alphaAnswerReference": { + "description": "Reference.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", "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.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn" - }, - "type": "array" + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "description": "Chunk information." }, - "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" + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." }, - "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.", + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "description": "Unstructured document information." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "properties": { + "chunk": { + "description": "Chunk resource name.", "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." - ], + "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" }, - "GoogleCloudDiscoveryengineV1alphaBigtableSource": { - "description": "The Cloud Bigtable source for importing data.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableSource", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { + "description": "Document metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { - "bigtableOptions": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", - "description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations." + "document": { + "description": "Document resource name.", + "type": "string" }, - "instanceId": { - "description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" }, - "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.", + "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" }, - "tableId": { - "description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { - "description": "Request message for GroundedGenerationService.CheckGrounding method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", "properties": { - "answerCandidate": { - "description": "Answer candidate to check. It can have a maximum length of 4096 tokens.", + "document": { + "description": "Document resource name.", "type": "string" }, - "facts": { - "description": "List of facts for the grounding check. We support up to 200 facts.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact" - }, - "type": "array" - }, - "groundingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", - "description": "Configuration of the grounding check." - }, - "userLabels": { + "structData": { "additionalProperties": { - "type": "string" + "description": "Properties of the object.", + "type": "any" }, - "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.", + "description": "Structured search data.", "type": "object" + }, + "title": { + "description": "Output only. The title of the document.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. The URI of the document.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": { - "description": "Response message for the GroundedGenerationService.CheckGrounding method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { - "citedChunks": { - "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", + "chunkContents": { + "description": "List of cited chunk contents derived from document content.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, "type": "array" }, - "citedFacts": { - "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk" - }, - "type": "array" + "document": { + "description": "Document resource name.", + "type": "string" }, - "claims": { - "description": "Claim texts and citation info across all claims in the answer candidate.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim" + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" }, - "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" + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk": { - "description": "Fact chunk for grounding check.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { - "chunkText": { - "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "content": { + "description": "Chunk textual content.", + "type": "string" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { - "description": "Text and citation info for a claim in the answer candidate.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", + "GoogleCloudDiscoveryengineV1alphaAnswerStep": { + "description": "Step information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "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.", + "actions": { + "description": "Actions.", "items": { - "format": "int32", - "type": "integer" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" }, "type": "array" }, - "claimText": { - "description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.", + "description": { + "description": "The description of the step.", "type": "string" }, - "endPos": { - "description": "Position indicating the end of the claim in the answer candidate, exclusive.", - "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 should not be returned.", - "type": "boolean" + "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" }, - "startPos": { - "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", - "format": "int32", - "type": "integer" + "thought": { + "description": "The thought of the step.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { - "description": "Specification for the grounding check.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", + "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { + "description": "Action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "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" + "observation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "description": "Observation." + }, + "searchAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "description": "Search action." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest": { - "description": "Request for CheckRequirement method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { + "description": "Observation.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "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`", - "type": "string" - }, - "resources": { - "description": "The resources to be checked for this requirement. 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`", + "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": "GoogleApiMonitoredResource" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse": { - "description": "Response for the CheckRequirement method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { - "metricResults": { - "description": "Metric results.", + "chunkInfo": { + "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" }, "type": "array" }, - "oldestMetricTimestamp": { - "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `result` may not accurately reflect any Event and Product Catalog updates performed after this time.", - "format": "google-datetime", + "document": { + "description": "Document resource name.", "type": "string" }, - "requirement": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirement", - "description": "Requirement definition." + "snippetInfo": { + "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" + }, + "type": "array" }, - "requirementCondition": { - "$ref": "GoogleTypeExpr", - "description": "The condition for evaluating the requirement result." + "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" }, - "result": { - "description": "The result of the requirement. It should be one of the `severity` fields in the requirement definition. If any error happens during the evaluation, it will be `UNKNOWN`.", + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult": { - "description": "Metric result. The metric are in the requirement_condition.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { - "metricType": { - "description": "Type identifier of the metric corresponding to this query result.", + "chunk": { + "description": "Chunk resource name.", "type": "string" }, - "name": { - "description": "This metric query name is mapping to variables in the requirement_condition.", + "content": { + "description": "Chunk textual content.", "type": "string" }, - "timestamp": { - "description": "Time corresponding to when this metric value was calculated.", - "format": "google-datetime", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { + "description": "Snippet information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", + "properties": { + "snippet": { + "description": "Snippet content.", "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.", + "snippetStatus": { + "description": "Status of the snippet defined by the search team.", "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", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { + "description": "Search action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", "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).", + "query": { + "description": "The query to search.", "type": "string" - }, - "derivedStructData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBAPConfig": { + "description": "The configuration for the BAP connector.", + "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", + "properties": { + "supportedConnectorModes": { + "description": "Required. The supported connector modes for the associated BAP connection.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for Actions" + ], + "type": "string" }, - "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": "array" + } + }, + "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.", + "format": "google-datetime", "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "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 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", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest": { + "description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest", "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.", + "requests": { + "description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + "$ref": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest" }, "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.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", + "properties": { + "targetSites": { + "description": "TargetSites created.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata": { - "description": "Document metadata contains the information of the document of the current chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse": { + "description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse", "properties": { - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "documentsMetadata": { + "description": "The metadata of the Documents.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata" }, - "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" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata": { + "description": "The metadata of a Document.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata", + "properties": { + "dataIngestionSource": { + "description": "The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.", + "type": "string" }, - "title": { - "description": "Title of the document.", + "lastRefreshedTime": { + "description": "The timestamp of the last time the Document was last indexed.", + "format": "google-datetime", "type": "string" }, - "uri": { - "description": "Uri of the document.", + "matcherValue": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", + "description": "The value of the matcher that was used to match the Document." + }, + "state": { + "description": "The state of the document.", + "enum": [ + "STATE_UNSPECIFIED", + "INDEXED", + "NOT_IN_TARGET_SITE", + "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" }, - "GoogleCloudDiscoveryengineV1alphaChunkPageSpan": { - "description": "Page span of the chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", + "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { + "description": "The value of the matcher that was used to match the Document.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "properties": { - "pageEnd": { - "description": "The end page of the chunk.", - "format": "int32", - "type": "integer" + "fhirResource": { + "description": "Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", + "type": "string" }, - "pageStart": { - "description": "The start page of the chunk.", - "format": "int32", - "type": "integer" + "uri": { + "description": "If match by URI, the URI of the Document.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { - "description": "Cloud SQL source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", + "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { + "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBigQuerySource": { + "description": "BigQuery source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", "properties": { - "databaseId": { - "description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.", + "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" }, - "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.", + "datasetId": { + "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.", "type": "string" }, - "instanceId": { - "description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.", + "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" }, - "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" + "partitionDate": { + "$ref": "GoogleTypeDate", + "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "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.", + "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 Cloud SQL table to copy the data from with a length limit of 256 characters.", + "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCmekConfig": { - "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", - "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", + "GoogleCloudDiscoveryengineV1alphaBigtableOptions": { + "description": "The Bigtable Options object that contains information to support the import.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", "properties": { - "isDefault": { - "description": "Output only. The default CmekConfig for the Customer.", - "readOnly": true, - "type": "boolean" - }, - "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", - "type": "string" - }, - "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", - "type": "string" - }, - "lastRotationTimestampMicros": { - "description": "Output only. The timestamp of the last key rotation.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", - "type": "string" - }, - "singleRegionKeys": { - "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey" + "families": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily" }, - "type": "array" + "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" }, - "state": { - "description": "Output only. State of the CmekConfig.", - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "ACTIVE", - "KEY_ISSUE", - "DELETING", - "UNUSABLE", - "ACTIVE_ROTATING" - ], - "enumDescriptions": [ - "The CmekConfig state is unknown.", - "The CmekConfig is creating.", - "The CmekConfig can be used with DataStores.", - "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", - "The CmekConfig is deleting.", - "The CmekConfig is not usable, most likely due to some internal issue.", - "The KMS key version is being rotated." - ], - "readOnly": true, + "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" }, - "GoogleCloudDiscoveryengineV1alphaCollection": { - "description": "Collection is a container for configuring resources and access to a set of DataStores.", - "id": "GoogleCloudDiscoveryengineV1alphaCollection", + "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": { + "description": "The column of the Bigtable.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn", "properties": { - "createTime": { - "description": "Output only. Timestamp the Collection was created at.", - "format": "google-datetime", - "readOnly": true, + "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" }, - "dataConnector": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector", - "description": "Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method.", - "readOnly": true - }, - "displayName": { - "description": "Required. The Collection 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.", + "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" }, - "name": { - "description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "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": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": { - "description": "Response message for CompletionService.CompleteQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse", - "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" }, - "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": { + "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" }, - "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion": { - "description": "Suggestions as search queries.", - "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion", + "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": { + "description": "The column family of the Bigtable.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily", "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.", + "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": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn" }, "type": "array" }, - "suggestion": { - "description": "The suggestion for the query.", + "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" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaCompletionInfo": { - "description": "Detailed completion information including completion attribution token and clicked completion info.", - "id": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", + "GoogleCloudDiscoveryengineV1alphaBigtableSource": { + "description": "The Cloud Bigtable source for importing data.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableSource", "properties": { - "selectedPosition": { - "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", - "format": "int32", - "type": "integer" + "bigtableOptions": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", + "description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations." }, - "selectedSuggestion": { - "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", + "instanceId": { + "description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", + "type": "string" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion": { - "description": "Autocomplete suggestions that are imported from Customer.", - "id": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { + "description": "Request message for GroundedGenerationService.CheckGrounding method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", "properties": { - "alternativePhrases": { - "description": "Alternative matching phrases for this suggestion.", + "answerCandidate": { + "description": "Answer candidate to check. It can have a maximum length of 4096 tokens.", + "type": "string" + }, + "facts": { + "description": "List of facts for the grounding check. We support up to 200 facts.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact" }, "type": "array" }, - "frequency": { - "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.", - "format": "int64", - "type": "string" - }, - "globalScore": { - "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked.", - "format": "double", - "type": "number" - }, - "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" - }, - "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" + "groundingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", + "description": "Configuration of the grounding check." }, - "suggestion": { - "description": "Required. The suggestion text.", - "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" }, - "GoogleCloudDiscoveryengineV1alphaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1alphaCondition", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": { + "description": "Response message for the GroundedGenerationService.CheckGrounding method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "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": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" + "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" }, "type": "array" }, - "queryRegex": { - "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", - "type": "string" + "citedFacts": { + "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk" + }, + "type": "array" }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", + "claims": { + "description": "Claim texts and citation info across all claims in the answer candidate.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" + "$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" }, - "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk": { + "description": "Fact chunk for grounding check.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk", "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.", + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { + "description": "Text and citation info for a claim in the answer candidate.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", - "type": "string" + "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" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", - "format": "google-datetime", + "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, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).", + "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 should not be returned.", + "type": "boolean" + }, + "startPos": { + "description": "Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConnectorRun": { - "description": "A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //", - "id": "GoogleCloudDiscoveryengineV1alphaConnectorRun", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { + "description": "Specification for the grounding check.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", "properties": { - "endTime": { - "description": "Output only. The time when the connector run ended.", - "format": "google-datetime", - "readOnly": true, + "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" + }, + "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest": { + "description": "Request for CheckRequirement method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest", + "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`", "type": "string" }, - "entityRuns": { - "description": "Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.", + "resources": { + "description": "The resources to be checked for this requirement. 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": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun" + "$ref": "GoogleApiMonitoredResource" }, - "readOnly": true, "type": "array" - }, - "errors": { - "description": "Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse": { + "description": "Response for the CheckRequirement method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse", + "properties": { + "metricResults": { + "description": "Metric results.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult" }, "type": "array" }, - "latestPauseTime": { - "description": "Output only. The time when the connector run was most recently paused.", + "oldestMetricTimestamp": { + "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `result` may not accurately reflect any Event and Product Catalog updates performed after this time.", "format": "google-datetime", - "readOnly": true, "type": "string" }, - "name": { - "description": "Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.", - "readOnly": true, - "type": "string" + "requirement": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirement", + "description": "Requirement definition." }, - "startTime": { - "description": "Output only. The time when the connector run started.", - "format": "google-datetime", - "readOnly": true, + "requirementCondition": { + "$ref": "GoogleTypeExpr", + "description": "The condition for evaluating the requirement result." + }, + "result": { + "description": "The result of the requirement. It should be one of the `severity` fields in the requirement definition. If any error happens during the evaluation, it will be `UNKNOWN`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult": { + "description": "Metric result. The metric are in the requirement_condition.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult", + "properties": { + "metricType": { + "description": "Type identifier of the metric corresponding to this query result.", "type": "string" }, - "state": { - "description": "Output only. The state of the sync run.", - "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "SUCCEEDED", - "FAILED", - "OVERRUN", - "CANCELLED", - "PENDING", - "WARNING" - ], - "enumDescriptions": [ - "Default value.", - "The data sync is ongoing.", - "The data sync is finished.", - "The data sync is failed.", - "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", - "Data sync was scheduled but has been cancelled.", - "Data sync is about to start.", - "The data sync completed with non-fatal errors." - ], - "readOnly": true, + "name": { + "description": "This metric query name is mapping to variables in the requirement_condition.", "type": "string" }, - "stateUpdateTime": { - "description": "Timestamp at which the connector run sync state was last updated.", + "timestamp": { + "description": "Time corresponding to when this metric value was calculated.", "format": "google-datetime", "type": "string" }, - "trigger": { - "description": "Output only. The trigger for this ConnectorRun.", - "enum": [ - "TRIGGER_UNSPECIFIED", - "SCHEDULER", - "INITIALIZATION", - "RESUME", - "MANUAL" - ], - "enumDescriptions": [ - "Default value.", - "ConnectorRun triggered by scheduler if connector has PERIODIC sync mode.", - "ConnectorRun auto triggered by connector initialization.", - "ConnectorRun auto triggered by resuming connector.", - "ConnectorRun triggered by user manually." - ], - "readOnly": true, + "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" }, - "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun": { - "description": "Represents an entity that was synced in this ConnectorRun.", - "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun", + "GoogleCloudDiscoveryengineV1alphaChunk": { + "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", + "id": "GoogleCloudDiscoveryengineV1alphaChunk", "properties": { - "entityName": { - "description": "The name of the source entity.", - "type": "string" + "chunkMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", + "description": "Output only. Metadata of the current chunk.", + "readOnly": true }, - "errorRecordCount": { - "description": "The total number of documents failed at sync at any stage (extraction, indexing, etc).", - "format": "int64", + "content": { + "description": "Content is a string from a document (parsed content).", "type": "string" }, - "errors": { - "description": "The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message.", - "items": { - "$ref": "GoogleRpcStatus" + "derivedStructData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" - }, - "extractedRecordCount": { - "description": "The number of documents extracted from connector source, ready to be ingested to UCS.", - "format": "int64", - "type": "string" - }, - "indexedRecordCount": { - "description": "The number of documents indexed.", - "format": "int64", - "type": "string" + "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", + "readOnly": true, + "type": "object" }, - "sourceApiRequestCount": { - "description": "The number of requests sent to 3p API.", - "format": "int64", - "type": "string" + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", + "description": "Metadata of the document from the current chunk." }, - "state": { - "description": "The state of the entity's sync run.", - "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "SUCCEEDED", - "FAILED", - "OVERRUN", - "CANCELLED", - "PENDING", - "WARNING" - ], - "enumDescriptions": [ - "Default value.", - "The data sync is ongoing.", - "The data sync is finished.", - "The data sync is failed.", - "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", - "Data sync was scheduled but has been cancelled.", - "Data sync is about to start.", - "The data sync completed with non-fatal errors." - ], + "id": { + "description": "Unique chunk ID of the current chunk.", "type": "string" }, - "stateUpdateTime": { - "description": "Timestamp at which the entity sync state was last updated.", - "format": "google-datetime", + "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" }, - "statsUpdateTime": { - "description": "The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.", - "format": "google-datetime", - "type": "string" + "pageSpan": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", + "description": "Page span of the chunk." }, - "syncType": { - "description": "Sync type of this run.", - "enum": [ - "SYNC_TYPE_UNSPECIFIED", - "FULL", - "INCREMENTAL" - ], - "enumDescriptions": [ - "Sync type unspecified.", - "Sync triggers full sync of all documents.", - "Incremental sync of updated documents." - ], - "type": "string" + "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 SearchResponse.", + "format": "double", + "readOnly": true, + "type": "number" } }, "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", + "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": { + "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", "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.", + "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": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, - "readOnly": true, "type": "array" }, - "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.", + "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": "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" - }, - "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" - }, - "promoteAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." - }, - "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": [ - "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": "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" + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", + "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", "properties": { - "boost": { - "deprecated": true, - "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" + "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" }, - "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", + "title": { + "description": "Title of the document.", "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.", + "uri": { + "description": "Uri of the document.", "type": "string" - }, - "fixedBoost": { - "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "GoogleCloudDiscoveryengineV1alphaChunkPageSpan": { + "description": "Page span of the chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", "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" + "pageEnd": { + "description": "The end page of the chunk.", + "format": "int32", + "type": "integer" }, - "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" + "pageStart": { + "description": "The start page of the chunk.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlPromoteAction": { - "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.", - "id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", + "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { + "description": "Cloud SQL source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", "properties": { - "dataStore": { - "description": "Required. Data store with which this promotion is attached to.", + "databaseId": { + "description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.", "type": "string" }, - "searchLinkPromotion": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion", - "description": "Required. Promotion attached to this action." - } - }, - "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.", + "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 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": { + "description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.", "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": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaConversation": { - "description": "External conversation proto definition.", - "id": "GoogleCloudDiscoveryengineV1alphaConversation", + "GoogleCloudDiscoveryengineV1alphaCmekConfig": { + "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", + "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", "properties": { - "endTime": { - "description": "Output only. The time the conversation finished.", - "format": "google-datetime", + "isDefault": { + "description": "Output only. The default CmekConfig for the Customer.", "readOnly": true, - "type": "string" + "type": "boolean" }, - "messages": { - "description": "Conversation messages.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversationMessage" - }, - "type": "array" + "kmsKey": { + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "type": "string" }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", + "kmsKeyVersion": { + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "type": "string" }, - "startTime": { - "description": "Output only. The time the conversation started.", - "format": "google-datetime", + "lastRotationTimestampMicros": { + "description": "Output only. The timestamp of the last key rotation.", + "format": "int64", "readOnly": true, "type": "string" }, + "name": { + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "type": "string" + }, + "singleRegionKeys": { + "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey" + }, + "type": "array" + }, "state": { - "description": "The state of the Conversation.", + "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", - "IN_PROGRESS", - "COMPLETED" + "CREATING", + "ACTIVE", + "KEY_ISSUE", + "DELETING", + "DELETE_FAILED", + "UNUSABLE", + "ACTIVE_ROTATING" ], "enumDescriptions": [ - "Unknown.", - "Conversation is currently open.", - "Conversation has been completed." + "The CmekConfig state is unknown.", + "The CmekConfig is creating.", + "The CmekConfig can be used with DataStores.", + "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", + "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", + "The CmekConfig is not usable, most likely due to some internal issue.", + "The KMS key version is being rotated." ], - "type": "string" - }, - "userPseudoId": { - "description": "A unique identifier for tracking users.", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConversationContext": { - "description": "Defines context of the conversation", - "id": "GoogleCloudDiscoveryengineV1alphaConversationContext", + "GoogleCloudDiscoveryengineV1alphaCollection": { + "description": "Collection is a container for configuring resources and access to a set of DataStores.", + "id": "GoogleCloudDiscoveryengineV1alphaCollection", "properties": { - "activeDocument": { - "description": "The current active document the user opened. It contains the document resource reference.", + "createTime": { + "description": "Output only. Timestamp the Collection was created at.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "contextDocuments": { - "description": "The current list of documents the user is seeing. It contains the document resource references.", - "items": { - "type": "string" - }, - "type": "array" + "dataConnector": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector", + "description": "Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method.", + "readOnly": true + }, + "displayName": { + "description": "Required. The Collection 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" + }, + "name": { + "description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConversationMessage": { - "description": "Defines a conversation message.", - "id": "GoogleCloudDiscoveryengineV1alphaConversationMessage", + "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": { + "description": "Response message for CompletionService.CompleteQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse", "properties": { - "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" - }, - "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest": { - "description": "Request message for ConversationalSearchService.ConverseConversation method.", - "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest", - "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." + "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" }, - "safeSearch": { - "description": "Whether to turn on safe search.", + "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" - }, - "servingConfig": { - "description": "The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", - "type": "string" - }, - "summarySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", - "description": "A specification for configuring the summary returned in the response." - }, - "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" }, - "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse": { - "description": "Response message for ConversationalSearchService.ConverseConversation method.", - "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse", + "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion": { + "description": "Suggestions as search queries.", + "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion", "properties": { - "conversation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", - "description": "Updated conversation including the answer." - }, - "relatedQuestions": { - "description": "Suggested related questions.", + "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" }, - "reply": { - "$ref": "GoogleCloudDiscoveryengineV1alphaReply", - "description": "Answer to the current query." - }, - "searchResults": { - "description": "Search Results.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" - }, - "type": "array" + "suggestion": { + "description": "The suggestion for the query.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries": { - "description": "The historical crawl rate timeseries data, used for monitoring.", - "id": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "GoogleCloudDiscoveryengineV1alphaCompletionInfo": { + "description": "Detailed completion information including completion attribution token and clicked completion info.", + "id": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", "properties": { - "qpsTimeSeries": { - "$ref": "GoogleMonitoringV3TimeSeries", - "description": "The QPS of the crawl rate." + "selectedPosition": { + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", + "format": "int32", + "type": "integer" + }, + "selectedSuggestion": { + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", + "type": "string" } }, "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", + "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion": { + "description": "Autocomplete suggestions that are imported from Customer.", + "id": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "alternativePhrases": { + "description": "Alternative matching phrases for this suggestion.", + "items": { + "type": "string" + }, + "type": "array" + }, + "frequency": { + "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "globalScore": { + "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked.", + "format": "double", + "type": "number" + }, + "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" - } - }, - "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", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { - "description": "Metadata for EvaluationService.CreateEvaluation method.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1alphaCondition", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "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", + "queryRegex": { + "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.", "type": "string" + }, + "queryTerms": { + "description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata", + "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" }, - "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", + "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", "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" }, - "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest": { - "description": "Request message for SiteSearchEngineService.CreateTargetSite method.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest", + "GoogleCloudDiscoveryengineV1alphaConnectorRun": { + "description": "A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //", + "id": "GoogleCloudDiscoveryengineV1alphaConnectorRun", "properties": { - "parent": { - "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", + "endTime": { + "description": "Output only. The time when the connector run ended.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "targetSite": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite", - "description": "Required. The TargetSite to create." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCustomAttribute": { - "description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomAttribute", - "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.", + "entityRuns": { + "description": "Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.", "items": { - "format": "double", - "type": "number" + "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun" }, + "readOnly": true, "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.", + "errors": { + "description": "Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "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", - "properties": { - "createTime": { - "deprecated": true, - "description": "Deprecated: Timestamp the Model was created at.", + }, + "latestPauseTime": { + "description": "Output only. The time when the connector run was most recently paused.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "displayName": { - "description": "The display name of the model.", + "name": { + "description": "Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.", + "readOnly": true, "type": "string" }, - "errorMessage": { - "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "startTime": { + "description": "Output only. The time when the connector run started.", + "format": "google-datetime", + "readOnly": true, "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`).", + "state": { + "description": "Output only. The state of the sync run.", "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED", - "NO_IMPROVEMENT", - "INPUT_VALIDATION_FAILED" + "STATE_UNSPECIFIED", + "RUNNING", + "SUCCEEDED", + "FAILED", + "OVERRUN", + "CANCELLED", + "PENDING", + "WARNING", + "SKIPPED" ], "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.", - "Input data validation failed. Model training didn't start." + "The data sync is ongoing.", + "The data sync is finished.", + "The data sync is failed.", + "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", + "Data sync was scheduled but has been cancelled.", + "Data sync is about to start.", + "The data sync completed with non-fatal errors.", + "An ongoing connector run has been running longer than expected, causing this run to be skipped." ], + "readOnly": true, "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}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", + "stateUpdateTime": { + "description": "Timestamp at which the connector run sync state was last updated.", + "format": "google-datetime", "type": "string" }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", - "format": "google-datetime", + "trigger": { + "description": "Output only. The trigger for this ConnectorRun.", + "enum": [ + "TRIGGER_UNSPECIFIED", + "SCHEDULER", + "INITIALIZATION", + "RESUME", + "MANUAL" + ], + "enumDescriptions": [ + "Default value.", + "ConnectorRun triggered by scheduler if connector has PERIODIC sync mode.", + "ConnectorRun auto triggered by connector initialization.", + "ConnectorRun auto triggered by resuming connector.", + "ConnectorRun triggered by user manually." + ], + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDataConnector": { - "description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.", - "id": "GoogleCloudDiscoveryengineV1alphaDataConnector", + "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun": { + "description": "Represents an entity that was synced in this ConnectorRun.", + "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun", "properties": { - "actionConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig", - "description": "Optional. Action configurations to make the connector support actions." - }, - "autoRunDisabled": { - "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.", - "type": "boolean" - }, - "blockingReasons": { - "description": "Output only. User actions that must be completed before the connector can start syncing data.", - "items": { - "enum": [ - "BLOCKING_REASON_UNSPECIFIED", - "ALLOWLIST_STATIC_IP", - "ALLOWLIST_IN_SERVICE_ATTACHMENT" - ], - "enumDescriptions": [ - "Default value.", - "Connector requires customer to allowlist static IPs.", - "Connector requires customer to allowlist our project in their service attachment." - ], - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "createTime": { - "description": "Output only. Timestamp the DataConnector was created at.", - "format": "google-datetime", - "readOnly": true, + "deletedRecordCount": { + "description": "The number of documents deleted.", + "format": "int64", "type": "string" }, - "dataSource": { - "description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", + "entityName": { + "description": "The name of the source entity.", "type": "string" }, - "destinationConfigs": { - "description": "Optional. Any target destinations used to connect to third-party services.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfig" - }, - "type": "array" - }, - "entities": { - "description": "List of entities from the connected data source to ingest.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity" - }, - "type": "array" + "errorRecordCount": { + "description": "The total number of documents failed at sync at any stage (extraction, indexing, etc).", + "format": "int64", + "type": "string" }, "errors": { - "description": "Output only. The errors from initialization or from the latest connector run.", + "description": "The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message.", "items": { "$ref": "GoogleRpcStatus" }, - "readOnly": true, "type": "array" }, - "identityRefreshInterval": { - "deprecated": true, - "description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", - "format": "google-duration", - "type": "string" - }, - "identityScheduleConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", - "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." - }, - "kmsKeyName": { - "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", - "type": "string" - }, - "lastSyncTime": { - "description": "Output only. For periodic connectors only, the last time a data sync was completed.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "latestPauseTime": { - "description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.", - "format": "google-datetime", - "readOnly": true, + "extractedRecordCount": { + "description": "The number of documents extracted from connector source, ready to be ingested to UCS.", + "format": "int64", "type": "string" }, - "name": { - "description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", - "readOnly": true, + "indexedRecordCount": { + "description": "The number of documents indexed.", + "format": "int64", "type": "string" }, - "nextSyncTime": { - "$ref": "GoogleTypeDateTime", - "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." - }, - "params": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.", - "type": "object" - }, - "privateConnectivityProjectId": { - "description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.", - "readOnly": true, - "type": "string" + "progress": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", + "description": "Metadata to generate the progress bar." }, - "refreshInterval": { - "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.", - "format": "google-duration", + "sourceApiRequestCount": { + "description": "The number of requests sent to 3p API.", + "format": "int64", "type": "string" }, "state": { - "description": "Output only. State of the connector.", + "description": "The state of the entity's sync run.", "enum": [ "STATE_UNSPECIFIED", - "CREATING", - "ACTIVE", - "FAILED", "RUNNING", - "WARNING" + "SUCCEEDED", + "FAILED", + "OVERRUN", + "CANCELLED", + "PENDING", + "WARNING", + "SKIPPED" ], "enumDescriptions": [ "Default value.", - "The connector is being set up.", - "The connector is successfully set up and awaiting next sync run.", - "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", - "The connector is actively syncing records from the data source.", - "The connector has completed a sync run, but encountered non-fatal errors." + "The data sync is ongoing.", + "The data sync is finished.", + "The data sync is failed.", + "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", + "Data sync was scheduled but has been cancelled.", + "Data sync is about to start.", + "The data sync completed with non-fatal errors.", + "An ongoing connector run has been running longer than expected, causing this run to be skipped." ], - "readOnly": true, "type": "string" }, - "staticIpAddresses": { - "description": "Output only. The static IP addresses used by this connector.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "stateUpdateTime": { + "description": "Timestamp at which the entity sync state was last updated.", + "format": "google-datetime", + "type": "string" }, - "staticIpEnabled": { - "description": "Optional. Whether customer has enabled static IP addresses for this connector.", - "type": "boolean" + "statsUpdateTime": { + "description": "The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.", + "format": "google-datetime", + "type": "string" }, - "syncMode": { - "description": "The data synchronization mode supported by the data connector.", + "syncType": { + "description": "Sync type of this run.", "enum": [ - "PERIODIC" + "SYNC_TYPE_UNSPECIFIED", + "FULL", + "INCREMENTAL", + "REALTIME" ], "enumDescriptions": [ - "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync." + "Sync type unspecified.", + "Sync triggers full sync of all documents.", + "Incremental sync of updated documents.", + "Realtime sync." ], "type": "string" - }, - "updateTime": { - "description": "Output only. Timestamp the DataConnector was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": { - "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", - "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity", + "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress": { + "description": "Represents the progress of a sync run.", + "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", "properties": { - "dataStore": { - "description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.", - "readOnly": true, - "type": "string" - }, - "entityName": { - "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", + "currentCount": { + "description": "The current progress.", + "format": "int64", "type": "string" }, - "keyPropertyMappings": { - "additionalProperties": { - "type": "string" - }, - "description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.", - "type": "object" + "percentile": { + "description": "Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.", + "format": "float", + "type": "number" }, - "params": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.", - "type": "object" + "totalCount": { + "description": "The total.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1alphaDataStore", + "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": { - "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" - }, - "advancedSiteSearchConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", - "description": "Optional. Configuration for advanced site search." - }, - "billingEstimation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", - "description": "Output only. Data size estimation for billing.", - "readOnly": true + "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" }, - "cmekConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig", - "description": "Output only. CMEK-related information for the DataStore.", - "readOnly": true + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", + "description": "Defines a boost-type control" }, - "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" + "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" }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "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" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, - "type": "string" + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" }, - "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.", + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." + "promoteAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", + "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." }, - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Output only. Data store level identity provider config.", - "readOnly": true + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "description": "Defines a redirect-type control." }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "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": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], "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." + "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" }, - "isInfobotFaqDataStore": { - "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", - "type": "boolean" - }, - "kmsKeyName": { - "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config 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.", - "type": "string" - }, - "naturalLanguageQueryUnderstandingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", - "description": "Optional. Configuration for Natural Language Query Understanding." - }, - "servingConfigDataStore": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", - "description": "Optional. Stores serving config at DataStore level." + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." }, - "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.", + "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": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" ], "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." + "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" - }, - "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" }, - "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": { - "description": "Estimation of data size per data store.", - "id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", + "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "properties": { - "structuredDataSize": { - "description": "Data size for structured data in terms of bytes.", - "format": "int64", - "type": "string" - }, - "structuredDataUpdateTime": { - "description": "Last updated timestamp for structured data.", - "format": "google-datetime", - "type": "string" + "boost": { + "deprecated": true, + "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" }, - "unstructuredDataSize": { - "description": "Data size for unstructured data in terms of bytes.", - "format": "int64", + "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" }, - "unstructuredDataUpdateTime": { - "description": "Last updated timestamp for unstructured data.", - "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" }, - "websiteDataSize": { - "description": "Data size for websites in terms of bytes.", - "format": "int64", - "type": "string" + "fixedBoost": { + "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" }, - "websiteDataUpdateTime": { - "description": "Last updated timestamp for websites.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { - "description": "Stores information regarding the serving configurations at DataStore level.", - "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", - "properties": { - "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", - "type": "boolean" + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries": { - "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", - "id": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries", + "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec", "properties": { - "autoRefreshCrawlRate": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", - "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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" }, - "userTriggeredCrawlRate": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", - "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": { - "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "controlPoints": { + "description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "Optional. 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": "Optional. 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" }, - "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", + "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "boostAmount": { + "description": "Optional. 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" }, - "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", + "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" }, - "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata": { - "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaControlPromoteAction": { + "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.", + "id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "dataStore": { + "description": "Required. Data store with which this promotion is attached to.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "searchLinkPromotion": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion", + "description": "Required. Promotion attached to this action." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", "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", + "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" }, - "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": { - "description": "Request for DeleteSession method.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest", + "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": { - "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", - "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" }, - "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata", + "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", + "messages": { + "description": "Conversation messages.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversationMessage" + }, + "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" - } - }, - "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", - "properties": { - "createTime": { - "description": "Operation create time.", + }, + "startTime": { + "description": "Output only. The time the conversation started.", "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", + "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" }, - "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { - "description": "Defines target endpoints used to connect to third-party sources.", - "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", + "GoogleCloudDiscoveryengineV1alphaConversationContext": { + "description": "Defines context of the conversation", + "id": "GoogleCloudDiscoveryengineV1alphaConversationContext", "properties": { - "destinations": { - "description": "Optional. The destinations for the corresponding key.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination" - }, - "type": "array" - }, - "key": { - "description": "Optional. Unique destination identifier that is supported by the connector.", + "activeDocument": { + "description": "The current active document the user opened. It contains the document resource reference.", "type": "string" }, - "params": { - "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": "Optional. Additional parameters for this destination config.", - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination": { - "description": "Defines a target endpoint", - "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination", + "GoogleCloudDiscoveryengineV1alphaConversationMessage": { + "description": "Defines a conversation message.", + "id": "GoogleCloudDiscoveryengineV1alphaConversationMessage", "properties": { - "host": { - "description": "Publicly routable host.", + "createTime": { + "description": "Output only. Message creation timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "port": { - "description": "Optional. Target port number accepted by the destination.", - "format": "int32", - "type": "integer" + "reply": { + "$ref": "GoogleCloudDiscoveryengineV1alphaReply", + "description": "Search reply." + }, + "userInput": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", + "description": "User text input." } }, "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", + "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest": { + "description": "Request message for ConversationalSearchService.ConverseConversation method.", + "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest", "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" - }, - "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", - "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" - }, - "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 128 characters.", - "type": "string" + "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)" }, - "indexStatus": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", - "description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated.", - "readOnly": true + "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." }, - "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, + "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" }, - "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" + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", + "description": "Required. Current user input." }, - "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" + "safeSearch": { + "description": "Whether to turn on safe search.", + "type": "boolean" }, - "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.", + "servingConfig": { + "description": "The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", "type": "string" }, - "schemaId": { - "description": "The identifier of the schema located in the same data store.", - "type": "string" + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "A specification for configuring the summary returned in the response." }, - "structData": { + "userLabels": { "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "type": "string" }, - "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo": { - "description": "ACL Information of the Document.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", + "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse": { + "description": "Response message for ConversationalSearchService.ConverseConversation method.", + "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse", "properties": { - "readers": { - "description": "Readers of the document.", + "conversation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", + "description": "Updated conversation including the answer." + }, + "relatedQuestions": { + "description": "Suggested related questions.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" + "type": "string" }, "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", - "properties": { - "idpWide": { - "description": "All users within the Identity Provider.", - "type": "boolean" }, - "principals": { - "description": "List of principals.", + "reply": { + "$ref": "GoogleCloudDiscoveryengineV1alphaReply", + "description": "Answer to the current query." + }, + "searchResults": { + "description": "Search Results.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPrincipal" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentContent": { - "description": "Unstructured data linked to this document.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", + "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries": { + "description": "The historical crawl rate timeseries data, used for monitoring.", + "id": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "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.", - "type": "string" + "qpsTimeSeries": { + "$ref": "GoogleMonitoringV3TimeSeries", + "description": "The QPS of the crawl rate." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus": { - "description": "Index status of the document.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", + "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": { - "errorSamples": { - "description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "indexTime": { - "description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.", + "createTime": { + "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "pendingMessage": { - "description": "Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { - "description": "Detailed document information associated with a user event.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", + "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": { - "conversionValue": { - "description": "Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is \"conversion\". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.", - "format": "float", - "type": "number" - }, - "id": { - "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}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "promotionIds": { - "description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.", - "items": { - "type": "string" - }, - "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "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`.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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. * `xlsm`: Override parsing config for XLSM 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" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", - "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata", "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" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", + "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": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." - }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "updateTime": { + "description": "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", + "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest": { + "description": "Request message for SiteSearchEngineService.CreateTargetSite method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest", "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" + "parent": { + "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", + "type": "string" }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" + "targetSite": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite", + "description": "Required. The TargetSite to create." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDoubleList": { - "description": "Double list.", - "id": "GoogleCloudDiscoveryengineV1alphaDoubleList", + "GoogleCloudDiscoveryengineV1alphaCustomAttribute": { + "description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomAttribute", "properties": { - "values": { - "description": "Double values.", + "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.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig": { - "description": "Defines embedding config, used for bring your own embeddings feature.", - "id": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", + "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { + "description": "Defines custom fine tuning spec.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "properties": { - "fieldPath": { - "description": "Full field path in the schema mapped as embedding field.", - "type": "string" + "enableSearchAdaptor": { + "description": "Whether or not to enable and include custom fine tuned search adaptor model.", + "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", + "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", "properties": { "createTime": { - "description": "Operation create time.", + "deprecated": true, + "description": "Deprecated: Timestamp the Model was created at.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "displayName": { + "description": "The display name of the model.", + "type": "string" + }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "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", + "INPUT_VALIDATION_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 model training finished successfully but metrics did not improve.", + "Input data validation failed. Model training didn't start." + ], + "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}/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" }, - "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", + "GoogleCloudDiscoveryengineV1alphaDataConnector": { + "description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnector", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." + "actionConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig", + "description": "Optional. Action configurations to make the connector support actions." }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true + "alertPolicyConfigs": { + "description": "Optional. The connector level alert config.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig" + }, + "type": "array" }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." + "autoRunDisabled": { + "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.", + "type": "boolean" }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "bapConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig", + "description": "Optional. The configuration for establishing a BAP connection." }, - "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.", + "blockingReasons": { + "description": "Output only. User actions that must be completed before the connector can start syncing data.", "items": { + "enum": [ + "BLOCKING_REASON_UNSPECIFIED", + "ALLOWLIST_STATIC_IP", + "ALLOWLIST_IN_SERVICE_ATTACHMENT" + ], + "enumDescriptions": [ + "Default value.", + "Connector requires customer to allowlist static IPs.", + "Connector requires customer to allowlist our project in their service attachment." + ], "type": "string" }, + "readOnly": true, "type": "array" }, - "disableAnalytics": { - "description": "Optional. Whether to disable analytics for searches performed on this engine.", - "type": "boolean" - }, - "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: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "connectorType": { + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "CONNECTOR_TYPE_UNSPECIFIED", + "THIRD_PARTY", + "GCP_FHIR", + "BIG_QUERY", + "GCS", + "GOOGLE_MAIL", + "GOOGLE_CALENDAR", + "GOOGLE_DRIVE", + "NATIVE_CLOUD_IDENTITY", + "THIRD_PARTY_FEDERATED" ], "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." + "Default value.", + "Third party connector to connector to third party application.", + "Data connector connects between FHIR store and VAIS datastore.", + "Big query connector.", + "Google Cloud Storage connector.", + "Gmail connector.", + "Google Calendar connector.", + "Google Drive connector.", + "Native Cloud Identity connector for people search powered by People API.", + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API." ], + "readOnly": true, "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." + "createTime": { + "description": "Output only. Timestamp the DataConnector was created at.", + "format": "google-datetime", + "readOnly": true, + "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}/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.", + "dataSource": { + "description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", "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 + "destinationConfigs": { + "description": "Optional. Any target destinations used to connect to third-party services.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfig" + }, + "type": "array" }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "entities": { + "description": "List of entities from the connected data source to ingest.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity" + }, + "type": "array" }, - "similarDocumentsConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "description": "Additional config specs for a `similar-items` engine." + "errors": { + "description": "Output only. The errors from initialization or from the latest connector run.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" }, - "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." - ], + "identityRefreshInterval": { + "deprecated": true, + "description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", + "format": "google-duration", "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "identityScheduleConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", + "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." + }, + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", + "type": "string" + }, + "lastSyncTime": { + "description": "Output only. For periodic connectors only, the last time a data sync was completed.", "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." }, - "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" - }, - "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": { - "business": { - "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "latestPauseTime": { + "description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.", + "format": "google-datetime", + "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.", + "name": { + "description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", + "readOnly": true, "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" + "nextSyncTime": { + "$ref": "GoogleTypeDateTime", + "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, - "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" + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.", + "type": "object" }, - "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)." + "privateConnectivityProjectId": { + "description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.", + "readOnly": true, + "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.", + "realtimeState": { + "description": "Output only. real-time sync state", "enum": [ - "TRAINING_STATE_UNSPECIFIED", - "PAUSED", - "TRAINING" + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED" ], "enumDescriptions": [ - "Unspecified training state.", - "The engine training is paused.", - "The engine is training." + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)." ], + "readOnly": true, "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" - }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { - "description": "Custom threshold for `cvr` optimization_objective.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", - "properties": { - "targetField": { - "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "refreshInterval": { + "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.", + "format": "google-duration", "type": "string" }, - "targetFieldValueFloat": { - "description": "Required. The threshold to be applied to the target (e.g., 0.5).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { - "description": "Additional information of a recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", - "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.", + "state": { + "description": "Output only. State of the connector.", "enum": [ - "DATA_STATE_UNSPECIFIED", - "DATA_OK", - "DATA_ERROR" + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED" ], "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." + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)." ], "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", + "staticIpAddresses": { + "description": "Output only. The static IP addresses used by this connector.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "servingState": { - "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", + "staticIpEnabled": { + "description": "Optional. Whether customer has enabled static IP addresses for this connector.", + "type": "boolean" + }, + "syncMode": { + "description": "The data synchronization mode supported by the data connector.", "enum": [ - "SERVING_STATE_UNSPECIFIED", - "INACTIVE", - "ACTIVE", - "TUNED" + "PERIODIC", + "STREAMING", + "UNSPECIFIED" ], "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." + "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", + "The data will be synced in real time.", + "Connector that doesn't ingest data will have this value" ], - "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.", + "updateTime": { + "description": "Output only. Timestamp the DataConnector was last updated.", + "format": "google-datetime", "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": { + "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", + "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity", "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." - ], + "dataStore": { + "description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.", + "readOnly": true, "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.", - "format": "google-datetime", + }, + "entityName": { + "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", "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." + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." - } - }, - "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" + "keyPropertyMappings": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.", + "type": "object" + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.", + "type": "object" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", + "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector 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" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern": { - "description": "URI patterns that we use to crawl.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern", + "GoogleCloudDiscoveryengineV1alphaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { - "exactMatch": { - "description": "Whether we infer the generated URI or use the exact provided one.", + "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" }, - "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" + "advancedSiteSearchConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", + "description": "Optional. Configuration for advanced site search." }, - "providedUriPattern": { - "description": "User provided URI pattern. For example, `foo.com/bar/*`.", - "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", - "properties": { - "dataSizeBytes": { - "description": "Data size in terms of bytes.", - "format": "int64", - "type": "string" + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true }, - "documentCount": { - "description": "Total number of documents.", - "format": "int64", + "cmekConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig", + "description": "Output only. CMEK-related information for the DataStore.", + "readOnly": true + }, + "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" - } - }, - "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.", + "description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "endTime": { - "description": "Output only. Timestamp the Evaluation was completed at.", - "format": "google-datetime", + "defaultSchemaId": { + "description": "Output only. The id of the default Schema associated to this data store.", "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 + "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" }, - "errorSamples": { - "description": "Output only. A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "readOnly": true, - "type": "array" + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." }, - "evaluationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", - "description": "Required. The specification of the evaluation." + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, - "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.", + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", "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.", + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Output only. Data store level identity provider config.", "readOnly": true }, - "state": { - "description": "Output only. The state of the evaluation.", + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "FAILED" + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" ], "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." + "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." ], - "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" + "isInfobotFaqDataStore": { + "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", + "type": "boolean" + }, + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config 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.", + "type": "string" + }, + "naturalLanguageQueryUnderstandingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", + "description": "Optional. Configuration for Natural Language Query Understanding." + }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { - "description": "Describes the specification of the query set.", - "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", "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}`.", + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFactChunk": { - "description": "Fact Chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", + "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "properties": { - "chunkText": { - "description": "Text content of the fact chunk. Can be at most 10K characters long.", - "type": "string" + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries": { + "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", + "id": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries", + "properties": { + "autoRefreshCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl." }, - "index": { - "description": "The index of this chunk. Currently, only used for the streaming mode.", - "format": "int32", - "type": "integer" + "autoRefreshCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." }, - "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" + "userTriggeredCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of user triggered dedicated crawl." }, - "sourceMetadata": { - "additionalProperties": { - "type": "string" - }, - "description": "More fine-grained information for the source reference.", - "type": "object" + "userTriggeredCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { - "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", + "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { + "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", "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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": { - "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse", + "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": { + "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata", "properties": { - "sitemapsMetadata": { - "description": "List of Sitemaps fetched.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata" - }, - "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" }, - "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": { - "description": "Contains a Sitemap and its metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata", + "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": { - "sitemap": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSitemap", - "description": "The Sitemap." + "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" }, - "GoogleCloudDiscoveryengineV1alphaFhirStoreSource": { - "description": "Cloud FhirStore source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", + "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": { - "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata": { + "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "updateFromLatestPredefinedSchema": { - "description": "Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import.", - "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" }, - "GoogleCloudDiscoveryengineV1alphaFieldConfig": { - "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", - "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", + "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": { + "description": "Request for DeleteSession method.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest", "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", - "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" - }, - "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" - }, - "fieldPath": { - "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", - "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, - "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" - }, - "metatagName": { - "description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.", - "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": [ - "Value used when unset.", - "Searchable option enabled for a schema field.", - "Searchable option disabled for a schema field." - ], + "name": { + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFirestoreSource": { - "description": "Firestore source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", + "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata", "properties": { - "collectionId": { - "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", - "type": "string" - }, - "databaseId": { - "description": "Required. The Firestore 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 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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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", + "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": { - "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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest": { - "description": "Top-level message sent by the client for the `GenerateGroundedContent` method.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest", + "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { + "description": "Defines target endpoints used to connect to third-party sources.", + "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", "properties": { - "contents": { - "description": "Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", + "destinations": { + "description": "Optional. The destinations for the corresponding key.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent" + "$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination" }, "type": "array" }, - "generationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec", - "description": "Content generation specification." - }, - "groundingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec", - "description": "Grounding specification." - }, - "systemInstruction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent", - "description": "Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them." + "key": { + "description": "Optional. Unique destination identifier that is supported by the connector.", + "type": "string" }, - "userLabels": { + "params": { "additionalProperties": { - "type": "string" + "description": "Properties of the object.", + "type": "any" }, - "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.", + "description": "Optional. Additional parameters for this destination config.", "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration": { - "description": "Describes the options to customize dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration", + "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination": { + "description": "Defines a target endpoint", + "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination", "properties": { - "predictor": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor", - "description": "Specification for the predictor for dynamic retrieval." + "host": { + "description": "Publicly routable host.", + "type": "string" + }, + "port": { + "description": "Optional. Target port number accepted by the destination.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor": { - "description": "Describes the predictor settings for dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor", + "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": { - "threshold": { - "description": "The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source.", - "format": "float", - "type": "number" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "version": { - "description": "The version of the predictor to be used in dynamic retrieval.", - "enum": [ - "VERSION_UNSPECIFIED", - "V1_INDEPENDENT" - ], - "enumDescriptions": [ - "Automatically choose the best version of the retrieval predictor.", - "The V1 model which is evaluating each source independently." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec": { - "description": "Content generation specification.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec", - "properties": { - "frequencyPenalty": { - "description": "If specified, custom value for frequency penalty will be used.", - "format": "float", - "type": "number" - }, - "languageCode": { - "description": "Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).", - "type": "string" - }, - "maxOutputTokens": { - "description": "If specified, custom value for max output tokens will be used.", - "format": "int32", - "type": "integer" - }, - "modelId": { - "description": "Specifies which Vertex model id to use for generation.", - "type": "string" - }, - "presencePenalty": { - "description": "If specified, custom value for presence penalty will be used.", - "format": "float", - "type": "number" - }, - "seed": { - "description": "If specified, custom value for the seed will be used.", - "format": "int32", - "type": "integer" - }, - "temperature": { - "description": "If specified, custom value for the temperature will be used.", - "format": "float", - "type": "number" - }, - "topK": { - "description": "If specified, custom value for top-k sampling will be used.", - "format": "int32", - "type": "integer" - }, - "topP": { - "description": "If specified, custom value for nucleus sampling will be used.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource": { - "description": "Grounding source.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource", - "properties": { - "googleSearchSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource", - "description": "If set, grounding is performed with Google Search." - }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource", - "description": "If set, grounding is performed with inline content." - }, - "searchSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource", - "description": "If set, grounding is performed with Vertex AI Search." - } - }, + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest": { + "description": "Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource": { - "description": "Google Search config parameters.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource", - "properties": { - "dynamicRetrievalConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration", - "description": "Optional. Specifies the dynamic retrieval configuration for the given source." - } - }, + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource": { - "description": "Message to be used for grounding based on inline content.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource", + "GoogleCloudDiscoveryengineV1alphaDocument": { + "description": "Document captures all raw metadata information of items to be recommended or searched.", + "id": "GoogleCloudDiscoveryengineV1alphaDocument", "properties": { - "attributes": { + "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": { - "type": "string" + "description": "Properties of the object.", + "type": "any" }, - "description": "Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content).", + "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", + "readOnly": true, "type": "object" }, - "groundingFacts": { - "description": "List of facts to be used for grounding.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource": { - "description": "Message to be used for grounding with Vertex AI Search.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource", - "properties": { - "filter": { - "description": "Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter.", + "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 128 characters.", "type": "string" }, - "maxResultCount": { - "description": "Number of search results to return. The default value is 10. The maximumm allowed value is 10.", - "format": "int32", - "type": "integer" + "indexStatus": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", + "description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated.", + "readOnly": true }, - "safeSearch": { - "description": "If set, safe search is enabled in Vertex AI Search requests.", - "type": "boolean" + "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" }, - "servingConfig": { - "description": "The resource name of the Engine to use. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", + "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" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec": { - "description": "Grounding specification.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec", + "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo": { + "description": "ACL Information of the Document.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", "properties": { - "groundingSources": { - "description": "Grounding sources.", + "readers": { + "description": "Readers of the document.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse": { - "description": "Response for the `GenerateGroundedContent` method.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse", + "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": { - "candidates": { - "description": "Generated candidates.", + "idpWide": { + "description": "All users within the Identity Provider.", + "type": "boolean" + }, + "principals": { + "description": "List of principals.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate" + "$ref": "GoogleCloudDiscoveryengineV1alphaPrincipal" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate": { - "description": "A response candidate generated from the model.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate", + "GoogleCloudDiscoveryengineV1alphaDocumentContent": { + "description": "Unstructured data linked to this document.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", "properties": { - "content": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent", - "description": "Content of the candidate." - }, - "groundingMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata", - "description": "Grounding metadata for the generated content." + "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" }, - "groundingScore": { - "description": "The overall grounding score for the candidate, in the range of [0, 1].", - "format": "float", - "type": "number" + "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" }, - "index": { - "description": "Index of the candidate.", - "format": "int32", - "type": "integer" + "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" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata": { - "description": "Citation for the generated content.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata", + "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus": { + "description": "Index status of the document.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", "properties": { - "groundingSupport": { - "description": "GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport" - }, - "type": "array" - }, - "retrievalMetadata": { - "description": "Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.", + "errorSamples": { + "description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "searchEntryPoint": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint", - "description": "Google search entry for the following-up web searches." - }, - "supportChunks": { - "description": "List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" - }, - "type": "array" + "indexTime": { + "description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.", + "format": "google-datetime", + "type": "string" }, - "webSearchQueries": { - "description": "Web search queries for the following-up web search.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata": { - "description": "Describes the metadata about dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata", - "properties": { - "predictorMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata", - "description": "Metadata for the dynamic retrieval predictor." + "pendingMessage": { + "description": "Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata": { - "description": "Describes the metadata about the dynamic retrieval predictor.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata", + "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { + "description": "Detailed document information associated with a user event.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", "properties": { - "prediction": { - "description": "The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding.", + "conversionValue": { + "description": "Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is \"conversion\". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.", "format": "float", "type": "number" }, - "version": { - "description": "The version of the predictor which was used in dynamic retrieval.", - "enum": [ - "VERSION_UNSPECIFIED", - "V1_INDEPENDENT" - ], - "enumDescriptions": [ - "Unspecified version, should never be used.", - "The V1 model which is evaluating each source independently." - ], + "id": { + "description": "The Document resource ID.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport": { - "description": "Grounding info for a claim in the candidate and its support.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport", - "properties": { - "claimText": { - "description": "Text for the claim in the candidate. Always provided when a support is found.", + }, + "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}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" }, - "supportChunkIndices": { - "description": "A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim.", + "promotionIds": { + "description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.", "items": { - "format": "int32", - "type": "integer" + "type": "string" }, "type": "array" }, - "supportScore": { - "description": "A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata": { - "description": "Describes the metadata associated with a retrieval step.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata", - "properties": { - "dynamicRetrievalMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata", - "description": "Metadata for dynamic retrieval." + "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" }, - "source": { - "description": "Describes the source to which the metadata is referring to.", - "enum": [ - "SOURCE_UNSPECIFIED", - "VERTEX_AI_SEARCH", - "GOOGLE_SEARCH", - "INLINE_CONTENT", - "GOOGLE_MAPS" - ], - "enumDescriptions": [ - "Unspecified source.", - "Vertex AI search.", - "Google Search.", - "User inline provided content.", - "Google Maps." - ], + "uri": { + "description": "The Document URI - only allowed for website data stores.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint": { - "description": "Google search entry point.", - "id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { - "renderedContent": { - "description": "Web content snippet that can be embedded in a web page or an app webview.", - "type": "string" + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." }, - "sdkBlob": { - "description": "Base64 encoded JSON representing array of tuple.", - "format": "byte", + "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. * `xlsm`: Override parsing config for XLSM 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" }, - "GoogleCloudDiscoveryengineV1alphaGetSessionRequest": { - "description": "Request for GetSession method.", - "id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", "properties": { - "includeAnswerDetails": { - "description": "Optional. If set to true, the full session including all answer details will be returned.", - "type": "boolean" - }, - "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", - "type": "string" + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { - "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", - "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "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" + "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" }, - "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent": { - "description": "Base structured datatype containing multi-part content of a message.", - "id": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { - "parts": { - "description": "Ordered `Parts` that constitute a single message.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart" - }, - "type": "array" + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." }, - "role": { - "description": "Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset.", - "type": "string" + "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" }, - "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart": { - "description": "Single part of content.", - "id": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart", - "properties": { - "text": { - "description": "Inline text.", - "type": "string" - } - }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGroundingFact": { - "description": "Grounding Fact.", - "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", - "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.", - "type": "string" - } - }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": { - "description": "Defines guided search spec.", - "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { - "enableRefinementAttributes": { - "description": "Whether or not to enable and include refinement attributes in gudied search result.", - "type": "boolean" + "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" }, - "enableRelatedQuestions": { - "description": "Whether or not to enable and include related questions in search response.", + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", "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" - }, - "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": { - "description": "The configuration for the identity data synchronization runs.", - "id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", - "properties": { - "nextSyncTime": { - "$ref": "GoogleTypeDateTime", - "description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." - }, - "refreshInterval": { - "description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", - "format": "google-duration", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfig": { - "description": "Identity Provider Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "GoogleCloudDiscoveryengineV1alphaDoubleList": { + "description": "Double list.", + "id": "GoogleCloudDiscoveryengineV1alphaDoubleList", "properties": { - "externalIdpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", - "description": "External Identity provider config." - }, - "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" + "values": { + "description": "Double values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { - "description": "Third party IDP Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig": { + "description": "Defines embedding config, used for bring your own embeddings feature.", + "id": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", "properties": { - "workforcePoolName": { - "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "fieldPath": { + "description": "Full field path in the schema mapped as embedding field.", "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", + "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": { "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", @@ -16354,1312 +16576,1374 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest": { - "description": "Request message for CompletionService.ImportCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest", - "properties": { - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." - }, - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." - }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." - }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", - "description": "The Inline source for suggestion entries." - } - }, + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest": { + "description": "Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource": { - "description": "The inline source for CompletionSuggestions.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", - "properties": { - "suggestions": { - "description": "Required. A list of all denylist entries to import. Max of 1000 items.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion" - }, - "type": "array" - } - }, + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", + "properties": {}, "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", + "GoogleCloudDiscoveryengineV1alphaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "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." }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "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", - "properties": { "createTime": { - "description": "Operation create time.", + "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "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" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "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" - }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest": { - "description": "Request message for Import methods.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", - "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." + "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." }, - "forceRefreshContent": { - "description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.", - "type": "boolean" + "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}/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" }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." + "recommendationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", + "readOnly": true }, - "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" + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", - "description": "The Inline source for the input content for documents." + "similarDocumentsConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", + "description": "Additional config specs for a `similar-items` engine." }, - "reconciliationMode": { - "description": "The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.", + "solutionType": { + "description": "Required. The solutions of the engine.", "enum": [ - "RECONCILIATION_MODE_UNSPECIFIED", - "INCREMENTAL", - "FULL" + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], "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." + "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" }, - "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", + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource": { - "description": "The inline source for the input config for ImportDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", - "properties": { - "documents": { - "description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" - }, - "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", + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "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." }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "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.", + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { - "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", + "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": { - "createTime": { - "description": "ImportSampleQueries operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of SampleQuerys that failed to be imported.", - "format": "int64", + "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" }, - "successCount": { - "description": "Count of SampleQuerys successfully imported.", - "format": "int64", + "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" }, - "totalCount": { - "description": "Total count of SampleQuerys that were processed.", - "format": "int64", + "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" }, - "updateTime": { - "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" }, - "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": { - "description": "Request message for SampleQueryService.ImportSampleQueries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest", + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "properties": { - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." - }, - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." - }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." - }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", - "description": "The Inline source for sample query entries." + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": { - "description": "The inline source for SampleQuerys.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", + "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "properties": { - "sampleQueries": { - "description": "Required. A list of SampleQuerys to import. Max of 1000 items.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" - }, - "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" }, - "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", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "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" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "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", + "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" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "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" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { - "description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "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." + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "type": "string" }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", - "description": "The Inline source for the input content for suggestion deny list entries." + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { - "description": "The inline source for SuggestionDenyListEntry.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", + "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { + "description": "Additional information of a recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "properties": { - "entries": { - "description": "Required. A list of all denylist entries to import. Max of 1000 items.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" - }, - "type": "array" + "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" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "searchAddOns": { + "description": "The add-on that this search engine enables.", "items": { - "$ref": "GoogleRpcStatus" + "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" }, - "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", + "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" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest": { + "description": "Request message for EstimateBillingService.EstimateDataSize method", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest", + "properties": { + "fileDataSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", + "description": "Structured or unstructured data." }, - "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" + "websiteDataSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", + "description": "Website data." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest": { - "description": "Request message for the ImportUserEvents request.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource": { + "description": "Data source contains files either in Cloud Storage or BigQuery.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", "properties": { "bigquerySource": { "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", "description": "BigQuery input source." }, - "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" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource": { - "description": "The inline source for the input config for ImportUserEvents method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource": { + "description": "Data source is a set of website patterns that we crawl to get the total number of websites.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", "properties": { - "userEvents": { - "description": "Required. A list of user events to import. Recommended max of 10k items.", + "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": "GoogleCloudDiscoveryengineV1alphaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern" }, "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", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern": { + "description": "URI patterns that we use to crawl.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." + "exactMatch": { + "description": "Whether we infer the generated URI or use the exact provided one.", + "type": "boolean" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "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" }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", + "providedUriPattern": { + "description": "User provided URI pattern. For example, `foo.com/bar/*`.", + "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", + "properties": { + "dataSizeBytes": { + "description": "Data size in terms of bytes.", "format": "int64", "type": "string" }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "documentCount": { + "description": "Total number of documents.", "format": "int64", "type": "string" } }, "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", + "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": { - "language": { - "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "languageCode": { - "description": "The language code for the DataStore.", + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, "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`.", + "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" }, - "region": { - "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { - "description": "Response message for ChunkService.ListChunks method.", - "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", "properties": { - "chunks": { - "description": "The Chunks.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" - }, - "type": "array" + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." }, - "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" + "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" }, - "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse": { - "description": "Response message for CmekConfigService.ListCmekConfigs method.", - "id": "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse", + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "properties": { - "cmekConfigs": { - "description": "All the customer's CmekConfigs.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" - }, - "type": "array" + "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" }, - "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse": { - "description": "Response message for CollectionService.ListCollections method.", - "id": "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse", + "GoogleCloudDiscoveryengineV1alphaFactChunk": { + "description": "Fact Chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", "properties": { - "collections": { - "description": "The Collections.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCollection" - }, - "type": "array" + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "type": "string" }, - "nextPageToken": { - "description": "A token that can be sent as ListCollectionsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse": { - "description": "Response for DataConnectorService.ListConnectorRuns method.", - "id": "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse", + "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { + "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", + "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", "properties": { - "connectorRuns": { - "description": "List of ConnectorRuns.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRun" - }, - "type": "array" - }, "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaListControlsResponse": { - "description": "Response for ListControls method.", - "id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse", - "properties": { - "controls": { - "description": "All the Controls for a given data store.", + }, + "targetSites": { + "description": "List of TargetSites containing the site verification status.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControl" + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" }, - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", - "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" }, - "GoogleCloudDiscoveryengineV1alphaListConversationsResponse": { - "description": "Response for ListConversations method.", - "id": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse", + "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": { + "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", + "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse", "properties": { - "conversations": { - "description": "All the Conversations for a given data store.", + "sitemapsMetadata": { + "description": "List of Sitemaps fetched.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" + "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata" }, "type": "array" - }, - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", + "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": { + "description": "Contains a Sitemap and its metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata", "properties": { - "models": { - "description": "List of custom tuning models.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" - }, - "type": "array" + "sitemap": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSitemap", + "description": "The Sitemap." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse": { - "description": "Response message for DataStoreService.ListDataStores method.", - "id": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse", + "GoogleCloudDiscoveryengineV1alphaFhirStoreSource": { + "description": "Cloud FhirStore source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", "properties": { - "dataStores": { - "description": "All the customer's DataStores.", + "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" + }, + "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": "GoogleCloudDiscoveryengineV1alphaDataStore" + "type": "string" }, "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.", - "type": "string" + "updateFromLatestPredefinedSchema": { + "description": "Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse": { - "description": "Response message for DocumentService.ListDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaFieldConfig": { + "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", + "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", "properties": { - "documents": { - "description": "The Documents.", + "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": "GoogleCloudDiscoveryengineV1alphaDocument" + "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" }, - "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.", + "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaListEnginesResponse": { - "description": "Response message for EngineService.ListEngines method.", - "id": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse", - "properties": { - "engines": { - "description": "All the customer's Engines.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" - }, - "type": "array" }, - "nextPageToken": { - "description": "Not supported.", + "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": { - "description": "Response message for EvaluationService.ListEvaluationResults method.", - "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse", - "properties": { - "evaluationResults": { - "description": "The evaluation results for the SampleQuerys.", + }, + "fieldPath": { + "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", + "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, + "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" + }, + "metatagName": { + "description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult" + "type": "string" }, "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.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": { - "description": "Represents the results of an evaluation for a single SampleQuery.", - "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult", + "GoogleCloudDiscoveryengineV1alphaFirestoreSource": { + "description": "Firestore source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", "properties": { - "qualityMetrics": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", - "description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", - "readOnly": true + "collectionId": { + "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", + "type": "string" }, - "sampleQuery": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery", - "description": "Output only. The SampleQuery that was evaluated.", - "readOnly": true - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": { - "description": "Response message for EvaluationService.ListEvaluations method.", - "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse", - "properties": { - "evaluations": { - "description": "The Evaluations.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" - }, - "type": "array" + "databaseId": { + "description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.", + "type": "string" }, - "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.", + "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" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": { - "description": "Response message for SampleQueryService.ListSampleQueries method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse", + "GoogleCloudDiscoveryengineV1alphaGcsSource": { + "description": "Cloud Storage location for input content.", + "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", "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.", + "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" }, - "sampleQueries": { - "description": "The SampleQuerys.", + "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": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": { - "description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse", + "GoogleCloudDiscoveryengineV1alphaGetSessionRequest": { + "description": "Request for GetSession method.", + "id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest", "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" + "includeAnswerDetails": { + "description": "Optional. If set to true, the full session including all answer details will be returned.", + "type": "boolean" }, - "sampleQuerySets": { - "description": "The SampleQuerySets.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" - }, - "type": "array" + "name": { + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { - "description": "Response message for SchemaService.ListSchemas method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", + "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", "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.", - "type": "string" - }, - "schemas": { - "description": "The Schemas.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" }, - "type": "array" + "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" }, - "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse": { - "description": "Response for ListServingConfigs method.", - "id": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse", + "GoogleCloudDiscoveryengineV1alphaGroundingFact": { + "description": "Grounding Fact.", + "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", "properties": { - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", - "type": "string" - }, - "servingConfigs": { - "description": "All the ServingConfigs for a given dataStore.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + "attributes": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "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.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListSessionsRequest": { - "description": "Request for ListSessions method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest", + "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": { + "description": "Defines guided search spec.", + "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", "properties": { - "filter": { - "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", - "type": "string" + "enableRefinementAttributes": { + "description": "Whether or not to enable and include refinement attributes in gudied search result.", + "type": "boolean" }, - "orderBy": { - "description": "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` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.", - "type": "string" + "enableRelatedQuestions": { + "description": "Whether or not to enable and include related questions in search response.", + "type": "boolean" }, - "pageSize": { - "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", + "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" - }, - "pageToken": { - "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", - "type": "string" - }, - "parent": { - "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { - "description": "Response for ListSessions method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", + "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "properties": { - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", - "type": "string" + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", + "type": "boolean" }, - "sessions": { - "description": "All the Sessions for a given data store.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSession" - }, - "type": "array" + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.ListTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry": { + "description": "Identity Mapping Entry that maps an external identity to an internal identity.", + "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry", "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.", + "externalIdentity": { + "description": "Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.", "type": "string" }, - "targetSites": { - "description": "List of TargetSites.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" - }, - "type": "array" + "groupId": { + "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.", + "type": "string" }, - "totalSize": { - "description": "The total number of items matching the request. This will always be populated in the response.", - "format": "int32", - "type": "integer" + "userId": { + "description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaMediaInfo": { - "description": "Media-specific user event information.", - "id": "GoogleCloudDiscoveryengineV1alphaMediaInfo", + "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata", "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", + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", "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" + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": { - "description": "Configuration for Natural Language Query Understanding.", - "id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", + "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore": { + "description": "Identity Mapping Store which contains Identity Mapping Entries.", + "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore", "properties": { - "mode": { - "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", - "enum": [ - "MODE_UNSPECIFIED", - "DISABLED", - "ENABLED" - ], - "enumDescriptions": [ - "Default value.", - "Natural Language Query Understanding is disabled.", - "Natural Language Query Understanding is enabled." - ], + "cmekConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig", + "description": "Output only. CMEK-related information for the Identity Mapping Store.", + "readOnly": true + }, + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Output only. The identity provider configuration this is bound to translate the identity mapping entries within.", + "readOnly": true + }, + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest": { - "description": "Request message for CrawlRateManagementService.ObtainCrawlRate method.", - "id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest", + "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": { + "description": "The configuration for the identity data synchronization runs.", + "id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", "properties": { - "crawlRateScope": { - "description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "nextSyncTime": { + "$ref": "GoogleTypeDateTime", + "description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." + }, + "refreshInterval": { + "description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", + "format": "google-duration", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse": { - "description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", - "id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse", + "GoogleCloudDiscoveryengineV1alphaIdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "properties": { - "dedicatedCrawlRateTimeSeries": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries", - "description": "The historical dedicated crawl rate timeseries data, used for monitoring." - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "Errors from service when handling the request." - }, - "organicCrawlRateTimeSeries": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries", - "description": "The historical organic crawl rate timeseries data, used for monitoring." + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "description": "External Identity provider config." }, - "state": { - "description": "Output only. The state of the response.", + "idpType": { + "description": "Identity provider type configured.", "enum": [ - "STATE_UNSPECIFIED", - "SUCCEEDED", - "FAILED" + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" ], "enumDescriptions": [ - "The state is unspecified.", - "The state is successful.", - "The state is failed." + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." ], - "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries": { - "description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.", - "id": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries", + "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", "properties": { - "googleOrganicCrawlRate": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", - "description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." - }, - "vertexAiOrganicCrawlRate": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", - "description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPageInfo": { - "description": "Detailed page information.", - "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", + "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": { - "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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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.", + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", "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.", + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPanelInfo": { - "description": "Detailed panel information associated with a user event.", - "id": "GoogleCloudDiscoveryengineV1alphaPanelInfo", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest": { + "description": "Request message for CompletionService.ImportCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest", "properties": { - "displayName": { - "description": "The display name of the panel.", - "type": "string" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "documents": { - "description": "Optional. The document IDs associated with this panel.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" - }, - "type": "array" - }, - "panelId": { - "description": "Required. The panel ID.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "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" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." }, - "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" + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", + "description": "The Inline source for suggestion entries." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": { - "description": "Request for pausing training of an engine.", - "id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPrincipal": { - "description": "Principal identifier of a user or a group.", - "id": "GoogleCloudDiscoveryengineV1alphaPrincipal", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource": { + "description": "The inline source for CompletionSuggestions.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", "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" - }, - "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" + "suggestions": { + "description": "Required. A list of all denylist entries to import. Max of 1000 items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProcessedDocument": { - "description": "Document captures all raw metadata information of items to be recommended or searched.", - "id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument", + "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": { - "document": { - "description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "jsonData": { - "description": "The JSON string representation of the processed document.", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1alphaProject", + "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": "Output only. The timestamp when this project is created.", + "description": "Operation create time.", "format": "google-datetime", - "readOnly": true, "type": "string" }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", "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, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", "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" + "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" }, - "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest": { + "description": "Request message for Import methods.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "description": "AlloyDB input source." }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "type": "string" + "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" }, - "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`.", + "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." + }, + "forceRefreshContent": { + "description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.", + "type": "boolean" + }, + "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.", "type": "string" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "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": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" + "RECONCILIATION_MODE_UNSPECIFIED", + "INCREMENTAL", + "FULL" ], "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." + "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" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", - "type": "string" - } - }, - "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", - "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" + "spannerSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSpannerSource", + "description": "Spanner input source." }, - "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.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource": { + "description": "The inline source for the input config for ImportDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", "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" + "documents": { + "description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" + }, + "type": "array" } }, "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", + "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": { + "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 request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" - }, - "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", + "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest": { + "description": "Request message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest", + "properties": { + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource", + "description": "The inline source to import identity mapping entries from." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource": { + "description": "The inline source to import identity mapping entries from.", + "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource", + "properties": { + "identityMappingEntries": { + "description": "A maximum of 10000 entries can be imported at one time", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "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 entries that encountered errors while processing.", + "description": "Count of SampleQuerys that failed to be imported.", "format": "int64", "type": "string" }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", + "successCount": { + "description": "Count of SampleQuerys successfully imported.", "format": "int64", "type": "string" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest": { - "description": "Request message for DocumentService.PurgeDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": { + "description": "Request message for SampleQueryService.ImportSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest", "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" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "force": { - "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", - "type": "boolean" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, "gcsSource": { "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." + "description": "Cloud Storage location for the input content." }, "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource", - "description": "Inline source for the input content for purge." + "$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", + "description": "The Inline source for sample query entries." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource": { - "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": { + "description": "The inline source for SampleQuerys.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", "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.", + "sampleQueries": { + "description": "Required. A list of SampleQuerys to import. Max of 1000 items.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "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", + "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": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "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.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "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" - } - }, - "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", + "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.", @@ -17674,15 +17958,38 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest": { - "description": "Request message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest", - "properties": {}, + "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" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { + "description": "The inline source for SuggestionDenyListEntry.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", + "properties": { + "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.", @@ -17691,17 +17998,22 @@ }, "type": "array" }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { - "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", + "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.", @@ -17714,7 +18026,7 @@ "type": "string" }, "successCount": { - "description": "Count of entries that were deleted successfully.", + "description": "Count of entries that were processed successfully.", "format": "int64", "type": "string" }, @@ -17726,2428 +18038,4107 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest": { - "description": "Request message for PurgeUserEvents method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest", + "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest": { + "description": "Request message for the ImportUserEvents request.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest", "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. Note: This API only supports purging a max range of 30 days. 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 in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", - "type": "string" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "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" + "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" }, - "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", + "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource": { + "description": "The inline source for the input config for ImportUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", "properties": { - "purgeCount": { - "description": "The total count of events purged as a result of the operation.", - "format": "int64", - "type": "string" + "userEvents": { + "description": "Required. A list of user events to import. Recommended max of 10k items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { - "description": "Describes the metrics produced by the evaluation.", - "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "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": { - "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" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." }, - "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" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "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" + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", + "type": "string" }, - "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" + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { - "description": "Stores the metric values at specific top-k levels.", - "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "GoogleCloudDiscoveryengineV1alphaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1alphaInterval", "properties": { - "top1": { - "description": "The top-1 value.", + "exclusiveMaximum": { + "description": "Exclusive upper bound.", "format": "double", "type": "number" }, - "top10": { - "description": "The top-10 value.", + "exclusiveMinimum": { + "description": "Exclusive lower bound.", "format": "double", "type": "number" }, - "top3": { - "description": "The top-3 value.", + "maximum": { + "description": "Inclusive upper bound.", "format": "double", "type": "number" }, - "top5": { - "description": "The top-5 value.", + "minimum": { + "description": "Inclusive lower bound.", "format": "double", "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaQuery": { - "description": "Defines a user inputed query.", - "id": "GoogleCloudDiscoveryengineV1alphaQuery", + "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "properties": { - "queryId": { - "description": "Unique Id for the query.", + "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" }, - "text": { - "description": "Plain text.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaRankRequest": { - "description": "Request message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankRequest", + "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { + "description": "Response message for ChunkService.ListChunks method.", + "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", "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.", + "chunks": { + "description": "The Chunks.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "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" + "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" }, - "GoogleCloudDiscoveryengineV1alphaRankResponse": { - "description": "Response message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankResponse", + "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse": { + "description": "Response message for CmekConfigService.ListCmekConfigs method.", + "id": "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse", "properties": { - "records": { - "description": "A list of records sorted by descending score.", + "cmekConfigs": { + "description": "All the customer's CmekConfigs.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" + "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRankingRecord": { - "description": "Record message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankingRecord", + "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse": { + "description": "Response message for CollectionService.ListCollections method.", + "id": "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse", "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.", - "type": "string" - }, - "score": { - "description": "The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.", - "format": "float", - "type": "number" + "collections": { + "description": "The Collections.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCollection" + }, + "type": "array" }, - "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.", + "nextPageToken": { + "description": "A token that can be sent as ListCollectionsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecommendRequest": { - "description": "Request message for Recommend method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", + "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse": { + "description": "Response for DataConnectorService.ListConnectorRuns method.", + "id": "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse", "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: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: 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" - }, - "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" - }, - "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" - }, - "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" + "connectorRuns": { + "description": "List of ConnectorRuns.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRun" }, - "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" + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecommendResponse": { - "description": "Response message for Recommend method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponse", + "GoogleCloudDiscoveryengineV1alphaListControlsResponse": { + "description": "Response for ListControls method.", + "id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse", "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.", - "type": "string" - }, - "missingIds": { - "description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.", + "controls": { + "description": "All the Controls for a given data store.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "type": "array" }, - "results": { - "description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).", + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", + "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": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult" + "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "type": "array" }, - "validateOnly": { - "description": "True if RecommendRequest.validate_only was set.", - "type": "boolean" + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult": { - "description": "RecommendationResult represents a generic recommendation result with associated metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult", + "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "properties": { - "document": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "Set if `returnDocument` is set to true in RecommendRequest.params." - }, - "id": { - "description": "Resource ID of the recommended Document.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "type": "any" + "models": { + "description": "List of custom tuning models.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" }, - "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", + "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse": { + "description": "Response message for DataStoreService.ListDataStores method.", + "id": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "invalidUris": { - "description": "Unique URIs in the request that have invalid format. Sample limited to 1000.", + "dataStores": { + "description": "All the customer's DataStores.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "type": "array" }, - "invalidUrisCount": { - "description": "Total number of unique URIs in the request that have invalid format.", - "format": "int32", - "type": "integer" - }, - "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" - }, - "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 ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" - }, - "urisNotMatchingTargetSites": { - "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. Sample limited to 1000.", - "items": { - "type": "string" - }, - "type": "array" - }, - "urisNotMatchingTargetSitesCount": { - "description": "Total number of URIs that don't match any TargetSites.", - "format": "int32", - "type": "integer" - }, - "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", + "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse": { + "description": "Response message for DocumentService.ListDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse", "properties": { - "siteCredential": { - "description": "Optional. Full resource name of the `SiteCredential`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.", - "type": "string" - }, - "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`.", + "documents": { + "description": "The Documents.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "type": "array" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { - "description": "Response message for SiteSearchEngineService.RecrawlUris method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", + "GoogleCloudDiscoveryengineV1alphaListEnginesResponse": { + "description": "Response message for EngineService.ListEngines method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse", "properties": { - "failedUris": { - "description": "URIs that were not crawled before the LRO terminated.", + "engines": { + "description": "All the customer's Engines.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "type": "array" }, - "failureSamples": { - "description": "Details for a sample of up to 10 `failed_uris`.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" - }, - "type": "array" + "nextPageToken": { + "description": "Not supported.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { - "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", + "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": { + "description": "Response message for EvaluationService.ListEvaluationResults method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse", "properties": { - "failureReasons": { - "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "evaluationResults": { + "description": "The evaluation results for the SampleQuerys.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult" }, "type": "array" }, - "uri": { - "description": "URI that failed to be crawled.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { - "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", + "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": { + "description": "Represents the results of an evaluation for a single SampleQuery.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult", "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." - ], - "type": "string" + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", + "readOnly": true }, - "errorMessage": { - "description": "Reason why the URI was not crawled.", - "type": "string" + "sampleQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery", + "description": "Output only. The SampleQuery that was evaluated.", + "readOnly": true } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata": { - "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata", + "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": { + "description": "Response message for EvaluationService.ListEvaluations method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "evaluations": { + "description": "The Evaluations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" + }, + "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 ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest": { - "description": "Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.", - "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest", + "GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse": { + "description": "Response message for IdentityMappingStoreService.ListIdentityMappingStores", + "id": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse", "properties": { - "crawlRateScope": { - "description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "identityMappingStores": { + "description": "The Identity Mapping Stores.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" + }, + "type": "array" + }, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse": { - "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", - "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse", + "GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ListIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse", "properties": { - "error": { - "$ref": "GoogleRpcStatus", - "description": "Errors from service when handling the request." + "identityMappingEntries": { + "description": "The Identity Mapping Entries.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry" + }, + "type": "array" }, - "state": { - "description": "Output only. The state of the response.", - "enum": [ - "STATE_UNSPECIFIED", - "SUCCEEDED", - "FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The state is successful.", - "The state is failed." - ], - "readOnly": true, + "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" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReply": { - "description": "Defines a reply message to user.", - "id": "GoogleCloudDiscoveryengineV1alphaReply", + "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": { + "description": "Response message for SampleQueryService.ListSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse", "properties": { - "references": { - "deprecated": true, - "description": "References in the reply.", + "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": "GoogleCloudDiscoveryengineV1alphaReplyReference" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "type": "array" - }, - "reply": { - "deprecated": true, - "description": "DEPRECATED: use `summary` instead. Text reply.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": { + "description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse", + "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" }, - "summary": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", - "description": "Summary based on search results." + "sampleQuerySets": { + "description": "The SampleQuerySets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReplyReference": { - "deprecated": true, - "description": "Defines reference in reply.", - "id": "GoogleCloudDiscoveryengineV1alphaReplyReference", + "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { + "description": "Response message for SchemaService.ListSchemas method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", "properties": { - "anchorText": { - "description": "Anchor text.", + "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" }, - "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" + "schemas": { + "description": "The Schemas.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest": { - "description": "Request for ReportConsentChange method.", - "id": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest", + "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse": { + "description": "Response for ListServingConfigs method.", + "id": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse", "properties": { - "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" - }, - "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`.", + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" }, - "serviceTermVersion": { - "description": "Required. The version string of the terms of service to update.", - "type": "string" + "servingConfigs": { + "description": "All the ServingConfigs for a given dataStore.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirement": { - "description": "A data requirement.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirement", + "GoogleCloudDiscoveryengineV1alphaListSessionsRequest": { + "description": "Request for ListSessions method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest", "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.", + "filter": { + "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", "type": "string" }, - "displayName": { - "description": "The name of the requirement.", + "orderBy": { + "description": "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` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.", "type": "string" }, - "metricBindings": { - "description": "A list of the metric bindings to be used in `condition`.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding" - }, - "type": "array" - }, - "severity": { - "description": "The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples: * `BLOCKING` * `CRITICAL` * `WARNING` All thresholds in the requirement must have all the severity here.", - "items": { - "type": "string" - }, - "type": "array" - }, - "thresholdBindings": { - "description": "A list of threshold bindings to be used in `condition`.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding" - }, - "type": "array" + "pageSize": { + "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", + "format": "int32", + "type": "integer" }, - "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`", + "pageToken": { + "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", "type": "string" }, - "violationSamplesBindings": { - "description": "A list of the metric bindings to be used in `condition`.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding" - }, - "type": "array" + "parent": { + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding": { - "description": "Specifies a metrics query and bind its result to a variable which will be used in the `condition`.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding", + "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { + "description": "Response for ListSessions method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", "properties": { - "category": { - "description": "The category of the metric's target resource. Example: \"Events\"", - "type": "string" - }, - "description": { - "description": "Human readable description of the corresponding metric filter.", - "type": "string" - }, - "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" - }, - "resourceType": { - "description": "The resource being monitored for the metric.", + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" }, - "variableId": { - "description": "The variable id to be referenced in `condition`.", - "type": "string" + "sessions": { + "description": "All the Sessions for a given data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSession" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding": { - "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding", + "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.ListTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", "properties": { - "description": { - "description": "Human readable description of the corresponding threshold and sub-requirement.", + "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" }, - "thresholdValues": { - "description": "The values of the threshold. The values should be ordered from the most strict to the least strict.", + "targetSites": { + "description": "List of TargetSites.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue" + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" }, - "variableId": { - "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.", - "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" }, - "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue": { - "description": "Specifies a threshold value for a given severity.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue", + "GoogleCloudDiscoveryengineV1alphaMediaInfo": { + "description": "Media-specific user event information.", + "id": "GoogleCloudDiscoveryengineV1alphaMediaInfo", "properties": { - "severity": { - "description": "The severity of errors if the threshold is not met. It should be one of the `severity` fields in the requirement.", + "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" }, - "value": { - "description": "The value of the threshold.", - "format": "double", + "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" }, - "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding": { - "description": "Specifies a samples query and bind its result to a variable which will be used in the `condition`.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding", + "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": { + "description": "Configuration for Natural Language Query Understanding.", + "id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", "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.", - "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" - }, - "variableId": { - "description": "The variable id to be referenced in `condition`.", + "mode": { + "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value.", + "Natural Language Query Understanding is disabled.", + "Natural Language Query Understanding is enabled." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": { - "description": "Request for resuming training of an engine.", - "id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest": { + "description": "Request message for CrawlRateManagementService.ObtainCrawlRate method.", + "id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest", + "properties": { + "crawlRateScope": { + "description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "type": "string" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSafetyRating": { - "description": "Safety rating corresponding to the generated content.", - "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", + "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", + "id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse", "properties": { - "blocked": { - "description": "Output only. Indicates whether the content was filtered out because of this rating.", - "readOnly": true, - "type": "boolean" + "dedicatedCrawlRateTimeSeries": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries", + "description": "The historical dedicated crawl rate timeseries data, used for monitoring." }, - "category": { - "description": "Output only. Harm category.", - "enum": [ - "HARM_CATEGORY_UNSPECIFIED", - "HARM_CATEGORY_HATE_SPEECH", - "HARM_CATEGORY_DANGEROUS_CONTENT", - "HARM_CATEGORY_HARASSMENT", - "HARM_CATEGORY_SEXUALLY_EXPLICIT", - "HARM_CATEGORY_CIVIC_INTEGRITY" - ], - "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", - "The harm category is civic integrity." - ], - "readOnly": true, - "type": "string" + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." }, - "probability": { - "description": "Output only. Harm probability levels in the content.", + "organicCrawlRateTimeSeries": { + "$ref": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries", + "description": "The historical organic crawl rate timeseries data, used for monitoring." + }, + "state": { + "description": "Output only. The state of the response.", "enum": [ - "HARM_PROBABILITY_UNSPECIFIED", - "NEGLIGIBLE", - "LOW", - "MEDIUM", - "HIGH" + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" ], "enumDescriptions": [ - "Harm probability unspecified.", - "Negligible level of harm.", - "Low level of harm.", - "Medium level of harm.", - "High level of harm." - ], - "readOnly": true, - "type": "string" - }, - "probabilityScore": { - "description": "Output only. Harm probability score.", - "format": "float", - "readOnly": true, - "type": "number" - }, - "severity": { - "description": "Output only. Harm severity levels in the content.", - "enum": [ - "HARM_SEVERITY_UNSPECIFIED", - "HARM_SEVERITY_NEGLIGIBLE", - "HARM_SEVERITY_LOW", - "HARM_SEVERITY_MEDIUM", - "HARM_SEVERITY_HIGH" - ], - "enumDescriptions": [ - "Harm severity unspecified.", - "Negligible level of harm severity.", - "Low level of harm severity.", - "Medium level of harm severity.", - "High level of harm severity." + "The state is unspecified.", + "The state is successful.", + "The state is failed." ], "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries": { + "description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.", + "id": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries", + "properties": { + "googleOrganicCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." }, - "severityScore": { - "description": "Output only. Harm severity score.", - "format": "float", - "readOnly": true, - "type": "number" + "vertexAiOrganicCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSampleQuery": { - "description": "Sample Query captures metadata to be used for evaluation.", - "id": "GoogleCloudDiscoveryengineV1alphaSampleQuery", + "GoogleCloudDiscoveryengineV1alphaPageInfo": { + "description": "Detailed page information.", + "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", "properties": { - "createTime": { - "description": "Output only. Timestamp the SampleQuery was created at.", - "format": "google-datetime", - "readOnly": true, + "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" }, - "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.", + "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" }, - "queryEntry": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", - "description": "The query entry." + "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" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": { - "description": "Query Entry captures metadata to be used for search evaluation.", - "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", + "GoogleCloudDiscoveryengineV1alphaPanelInfo": { + "description": "Detailed panel information associated with a user event.", + "id": "GoogleCloudDiscoveryengineV1alphaPanelInfo", "properties": { - "query": { - "description": "Required. The query.", + "displayName": { + "description": "The display name of the panel.", "type": "string" }, - "targets": { - "description": "List of targets for the query.", + "documents": { + "description": "Optional. The document IDs associated with this panel.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" }, "type": "array" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": { - "description": "Defines the parameters of the query's expected outcome.", - "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget", + "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": { + "description": "Request for pausing training of an engine.", + "id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPrincipal": { + "description": "Principal identifier of a user or a group.", + "id": "GoogleCloudDiscoveryengineV1alphaPrincipal", "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" + "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" }, - "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`.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaSampleQuerySet": { - "description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", - "id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet", + "GoogleCloudDiscoveryengineV1alphaProcessedDocument": { + "description": "Document captures all raw metadata information of items to be recommended or searched.", + "id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument", "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.", + "document": { + "description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", "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.", + "jsonData": { + "description": "The JSON string representation of the processed document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1alphaSchema", + "GoogleCloudDiscoveryengineV1alphaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { - "fieldConfigs": { - "description": "Output only. Configurations for fields of the schema.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" - }, + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", "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.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. 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" }, - "structSchema": { + "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": { - "description": "Properties of the object.", - "type": "any" + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" }, - "description": "The structured representation of the schema.", + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchInfo": { - "description": "Detailed search information.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchInfo", + "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "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.", + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", "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.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": { - "description": "Promotion proto includes uri and other helping information to display the promotion.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion", - "properties": { - "description": { - "description": "Optional. The Promotion description. Maximum length: 200 characters.", + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", "type": "string" }, - "enabled": { - "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.", - "type": "boolean" - }, - "imageUri": { - "description": "Optional. The promotion thumbnail image url.", + "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" }, - "title": { - "description": "Required. The title of the promotion. Maximum length: 160 characters.", + "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" }, - "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequest": { - "description": "Request message for SearchService.Search method.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", - "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" + "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest": { + "description": "Request for ProjectService.ProvisionProject method.", + "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest", + "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" }, - "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.", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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 data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", - "items": { - "$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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "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", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" + "$ref": "GoogleRpcStatus" }, "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)", + "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", "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.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", "type": "string" }, - "naturalLanguageQueryUnderstandingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", - "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "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" + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" }, - "oneBoxPageSize": { - "description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", - "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" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest": { + "description": "Request message for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", + "description": "The desired location of errors incurred during the purge." }, - "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.", + "filter": { + "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all 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" + "force": { + "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", + "type": "boolean" }, - "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.", + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." + }, + "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" }, - "params": { - "additionalProperties": { - "type": "any" + "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" }, - "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" + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest": { + "description": "Request message for IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest", + "properties": { + "filter": { + "description": "Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 \"zulu\" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time > \"2012-04-23T18:25:43.511Z\" AND update_time < \"2012-04-23T18:30:43.511Z\"` * Deleting all identity mappings for a given external_id: `external_id = \"id1\"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided.", + "type": "string" }, - "personalizationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", - "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + "force": { + "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.", + "type": "boolean" }, - "query": { - "description": "Raw search query.", + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource", + "description": "The inline source to purge identity mapping entries from." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource": { + "description": "The inline source to purge identity mapping entries from.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource", + "properties": { + "identityMappingEntries": { + "description": "A maximum of 10000 entries can be purged at one time", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry" + }, + "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", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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)`.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "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", + "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" + }, + "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": { + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest", + "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. Note: This API only supports purging a max range of 30 days. 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 in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of 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" + }, + "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" + }, + "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", + "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 maximum 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" + }, + "GoogleCloudDiscoveryengineV1alphaRankResponse": { + "description": "Response message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1alphaRankResponse", + "properties": { + "records": { + "description": "A list of records sorted by descending score.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRankingRecord": { + "description": "Record message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1alphaRankingRecord", + "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.", + "type": "string" + }, + "score": { + "description": "The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.", + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecommendRequest": { + "description": "Request message for Recommend method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", + "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: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: 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" + }, + "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" + }, + "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" + }, + "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" + }, + "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.", + "type": "string" + }, + "missingIds": { + "description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.", + "items": { + "type": "string" + }, + "type": "array" + }, + "results": { + "description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult" + }, + "type": "array" + }, + "validateOnly": { + "description": "True if RecommendRequest.validate_only was set.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult": { + "description": "RecommendationResult represents a generic recommendation result with associated metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult", + "properties": { + "document": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", + "description": "Set if `returnDocument` is set to true in RecommendRequest.params." + }, + "id": { + "description": "Resource ID of the recommended Document.", + "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" + }, + "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" + }, + "invalidUris": { + "description": "Unique URIs in the request that have invalid format. Sample limited to 1000.", + "items": { + "type": "string" + }, + "type": "array" + }, + "invalidUrisCount": { + "description": "Total number of unique URIs in the request that have invalid format.", + "format": "int32", + "type": "integer" + }, + "noindexUris": { + "description": "URIs that have no index meta tag. Sample limited to 1000.", + "items": { + "type": "string" + }, + "type": "array" + }, + "noindexUrisCount": { + "description": "Total number of URIs that have no index meta tag.", + "format": "int32", + "type": "integer" + }, + "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" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + }, + "urisNotMatchingTargetSites": { + "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. Sample limited to 1000.", + "items": { + "type": "string" + }, + "type": "array" + }, + "urisNotMatchingTargetSitesCount": { + "description": "Total number of URIs that don't match any TargetSites.", + "format": "int32", + "type": "integer" + }, + "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", + "properties": { + "siteCredential": { + "description": "Optional. Credential id to use for crawling.", + "type": "string" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { + "description": "Response message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", + "properties": { + "failedUris": { + "description": "URIs that were not crawled before the LRO terminated.", + "items": { + "type": "string" + }, + "type": "array" + }, + "failureSamples": { + "description": "Details for a sample of up to 10 `failed_uris`.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" + }, + "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", + "properties": { + "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" + }, + "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": { + "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" + }, + "errorMessage": { + "description": "Reason why the URI was not crawled.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata": { + "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest": { + "description": "Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.", + "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest", + "properties": { + "crawlRateScope": { + "description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", + "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest": { + "description": "Request message for CompletionService.RemoveSuggestion method.", + "id": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest", + "properties": { + "removeAllSearchHistorySuggestions": { + "description": "Remove all search history suggestions for the user.", + "type": "boolean" + }, + "removeTime": { + "description": "Required. Time at which the suggestion was removed. If not set, the current time will be used.", + "format": "google-datetime", + "type": "string" + }, + "searchHistorySuggestion": { + "description": "The search history suggestion to be removed.", + "type": "string" + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." + }, + "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 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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse": { + "description": "Response message for CompletionService.RemoveSuggestion method.", + "id": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaReply": { + "description": "Defines a reply message to user.", + "id": "GoogleCloudDiscoveryengineV1alphaReply", + "properties": { + "references": { + "deprecated": true, + "description": "References in the reply.", + "items": { + "$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" + }, + "GoogleCloudDiscoveryengineV1alphaReplyReference": { + "deprecated": true, + "description": "Defines reference in reply.", + "id": "GoogleCloudDiscoveryengineV1alphaReplyReference", + "properties": { + "anchorText": { + "description": "Anchor text.", + "type": "string" + }, + "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" + }, + "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest": { + "description": "Request for ReportConsentChange method.", + "id": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest", + "properties": { + "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" + }, + "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" + }, + "serviceTermVersion": { + "description": "Required. The version string of the terms of service to update.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRequirement": { + "description": "A data requirement.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirement", + "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`.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding" + }, + "type": "array" + }, + "severity": { + "description": "The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples: * `BLOCKING` * `CRITICAL` * `WARNING` All thresholds in the requirement must have all the severity here.", + "items": { + "type": "string" + }, + "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": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding" + }, + "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", + "properties": { + "category": { + "description": "The category of the metric's target resource. Example: \"Events\"", + "type": "string" + }, + "description": { + "description": "Human readable description of the corresponding metric filter.", + "type": "string" + }, + "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" + }, + "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" + }, + "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding": { + "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding", + "properties": { + "description": { + "description": "Human readable description of the corresponding threshold and sub-requirement.", + "type": "string" + }, + "thresholdValues": { + "description": "The values of the threshold. The values should be ordered from the most strict to the least strict.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue" + }, + "type": "array" + }, + "variableId": { + "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue": { + "description": "Specifies a threshold value for a given severity.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue", + "properties": { + "severity": { + "description": "The severity of errors if the threshold is not met. It should be one of the `severity` fields in the requirement.", + "type": "string" + }, + "value": { + "description": "The value of the threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding": { + "description": "Specifies a samples query and bind its result to a variable which will be used in the `condition`.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding", + "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.", + "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" + }, + "variableId": { + "description": "The variable id to be referenced in `condition`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": { + "description": "Request for resuming training of an engine.", + "id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSafetyRating": { + "description": "Safety rating corresponding to the generated content.", + "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", + "properties": { + "blocked": { + "description": "Output only. Indicates whether the content was filtered out because of this rating.", + "readOnly": true, + "type": "boolean" + }, + "category": { + "description": "Output only. Harm category.", + "enum": [ + "HARM_CATEGORY_UNSPECIFIED", + "HARM_CATEGORY_HATE_SPEECH", + "HARM_CATEGORY_DANGEROUS_CONTENT", + "HARM_CATEGORY_HARASSMENT", + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" + ], + "enumDescriptions": [ + "The harm category is unspecified.", + "The harm category is hate speech.", + "The harm category is dangerous content.", + "The harm category is harassment.", + "The harm category is sexually explicit content.", + "The harm category is civic integrity." + ], + "readOnly": true, + "type": "string" + }, + "probability": { + "description": "Output only. Harm probability levels in the content.", + "enum": [ + "HARM_PROBABILITY_UNSPECIFIED", + "NEGLIGIBLE", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Harm probability unspecified.", + "Negligible level of harm.", + "Low level of harm.", + "Medium level of harm.", + "High level of harm." + ], + "readOnly": true, + "type": "string" + }, + "probabilityScore": { + "description": "Output only. Harm probability score.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "severity": { + "description": "Output only. Harm severity levels in the content.", + "enum": [ + "HARM_SEVERITY_UNSPECIFIED", + "HARM_SEVERITY_NEGLIGIBLE", + "HARM_SEVERITY_LOW", + "HARM_SEVERITY_MEDIUM", + "HARM_SEVERITY_HIGH" + ], + "enumDescriptions": [ + "Harm severity unspecified.", + "Negligible level of harm severity.", + "Low level of harm severity.", + "Medium level of harm severity.", + "High level of harm severity." + ], + "readOnly": true, + "type": "string" + }, + "severityScore": { + "description": "Output only. Harm severity score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSampleQuery": { + "description": "Sample Query captures metadata to be used for evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQuery", + "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": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", + "description": "The query entry." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": { + "description": "Query Entry captures metadata to be used for search evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", + "properties": { + "query": { + "description": "Required. The query.", + "type": "string" + }, + "targets": { + "description": "List of targets for the query.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": { + "description": "Defines the parameters of the query's expected outcome.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaSampleQuerySet": { + "description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1alphaSchema", + "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.", + "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", + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": { + "description": "Promotion proto includes uri and other helping information to display the promotion.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion", + "properties": { + "description": { + "description": "Optional. The Promotion description. Maximum length: 200 characters.", + "type": "string" + }, + "enabled": { + "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.", + "type": "boolean" + }, + "imageUri": { + "description": "Optional. The promotion thumbnail image url.", + "type": "string" + }, + "title": { + "description": "Required. The title of the promotion. Maximum length: 160 characters.", + "type": "string" + }, + "uri": { + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "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. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." + }, + "dataStoreSpecs": { + "description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "displaySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", + "description": "Optional. Config for display feature, like match highlighting on search results." + }, + "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" + }, + "oneBoxPageSize": { + "description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", + "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" + }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, + "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 syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result", + "type": "string" + }, + "rankingExpressionBackend": { + "description": "Optional. The backend to use for the ranking expression evaluation.", + "enum": [ + "UNKNOWN", + "BYOE", + "CLEARBOX" + ], + "enumDescriptions": [ + "Default option for unspecified/unknown values.", + "Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", + "The expression is compiled into a Clearbox formula." + ], + "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" + }, + "relevanceScoreSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", + "description": "Optional. The specification for returning the relevance score." + }, + "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. This feature is not supported for healthcare search.", + "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": "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 and personalization. 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" + }, + "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" + }, + "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" + }, + "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" + }, + "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": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "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 DocumentProcessingConfig.chunking_config is specified." + ], + "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" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "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" + }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking 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": "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" + }, + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "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" + }, + "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": { + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" + }, + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", + "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": { + "description": "Specifies features for display, like match highlighting.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", + "properties": { + "matchHighlightingCondition": { + "description": "The condition under which match highlighting should occur.", + "enum": [ + "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", + "MATCH_HIGHLIGHTING_DISABLED", + "MATCH_HIGHLIGHTING_ENABLED" + ], + "enumDescriptions": [ + "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", + "Disables match highlighting on all documents.", + "Enables match highlighting on all documents." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "properties": { + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", + "properties": { + "fieldPath": { + "description": "Embedding field path in schema.", + "type": "string" + }, + "vector": { + "description": "Query embedding vector.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "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.", + "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" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "properties": { + "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. Server behavior defaults to `DISABLED`.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to `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" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": { + "description": "The specification for personalization.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "properties": { + "mode": { + "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTO", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Mode.AUTO.", + "Personalization is enabled if data quality requirements are met.", + "Disable personalization." + ], + "type": "string" + } + }, + "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" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": { + "description": "The specification for returning the document relevance score.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", + "properties": { + "returnRelevanceScore": { + "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.", + "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", + "AUTO" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type.", + "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." + ], + "type": "string" + } + }, + "type": "object" + }, + "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": { + "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 similar 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" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponse": { + "description": "Response message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponse", + "properties": { + "appliedControls": { + "description": "Controls applied as part of the Control service.", + "items": { + "type": "string" + }, + "type": "array" }, - "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.", + "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. This also helps to identify a request during the customer support scenarios.", "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." - ], + "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" }, - "safeSearch": { - "description": "Whether to turn on safe search. This is only supported for website search.", - "type": "boolean" + "facets": { + "description": "Results of facets requested by user.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet" + }, + "type": "array" }, - "searchAsYouTypeSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", - "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + "geoSearchDebugInfo": { + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo" + }, + "type": "array" }, - "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" + "guidedSearchResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", + "description": "Guided search result." }, - "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.", + "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" }, - "sessionSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", - "description": "Session specification. Can be used only when `session` is set." + "oneBoxResults": { + "description": "A list of One Box results. There can be multiple One Box results of different types.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult" + }, + "type": "array" }, - "spellCorrectionSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", - "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + "queryExpansionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", + "description": "Query expansion information for the returned results." }, - "userInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + "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" }, - "userLabels": { - "additionalProperties": { - "type": "string" + "results": { + "description": "A list of matched documents. The order represents the ranking.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" }, - "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" }, - "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.", + "searchLinkPromotions": { + "description": "Promotions for site search.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion" + }, + "type": "array" + }, + "sessionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", + "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." + }, + "suggestedQuery": { + "description": "Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).", "type": "string" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { - "description": "Boost specification to boost certain documents.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet": { + "description": "A facet result.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet", "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.", + "dynamicFacet": { + "description": "Whether the facet is dynamically generated.", + "type": "boolean" + }, + "key": { + "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", + "type": "string" + }, + "values": { + "description": "The facet values for this field.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { - "description": "Boost applies to documents which match a condition.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue": { + "description": "A facet value which contains value names and their count.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue", "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" + "count": { + "description": "Number of items that have this facet value.", + "format": "int64", + "type": "string" }, - "boostControlSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", - "description": "Complex specification for custom ranking based on customer defined attribute value." + "interval": { + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval", + "description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals." }, - "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\"))`", + "value": { + "description": "Text value of a facet, such as \"Black\" for facet \"colors\".", "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", + "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo": { + "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo", "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`." - ], + "errorMessage": { + "description": "The error produced.", "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.", + "originalAddressQuery": { + "description": "The address from which forward geocoding ingestion produced issues.", + "type": "string" + } + }, + "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", + "properties": { + "followUpQuestions": { + "description": "Suggested follow-up questions.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + "type": "string" }, "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" + "refinementAttributes": { + "description": "A list of ranked refinement attributes.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute" + }, + "type": "array" } }, "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", + "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute": { + "description": "Useful attribute for search result refinements.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute", "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]`.", + "attributeKey": { + "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", "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" + "attributeValue": { + "description": "Attribute value used to refine the results. For example, `\"drama\"`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { - "description": "A specification for configuring the behavior of content search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo": { + "description": "Information describing what natural language understanding was done on the input query.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo", "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" - }, - "extractiveContentSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", - "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." + "classifiedIntents": { + "description": "The classified intents from the input query.", + "items": { + "type": "string" + }, + "type": "array" }, - "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 DocumentProcessingConfig.chunking_config is specified." - ], + "extractedFilters": { + "description": "The filters that were extracted from the input query.", "type": "string" }, - "snippetSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", - "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + "rewrittenQuery": { + "description": "Rewritten input query minus the extracted filters.", + "type": "string" }, - "summarySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", - "description": "If `summarySpec` is not specified, summaries are not included in the search response." + "sqlRequest": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest", + "description": "Optional. The SQL request that was generated from the natural language query understanding phase." + }, + "structuredExtractedFilter": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", + "description": "The filters that were extracted from the input query represented in a structured form." } }, "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", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest": { + "description": "The SQL request that was generated from the natural language query understanding phase.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest", "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" + "sqlQuery": { + "description": "Optional. The SQL query in text format.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { - "description": "A specification for configuring the extractive content in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { + "description": "The filters that were extracted from the input query represented in a structured form.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", "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" + "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { - "description": "A specification for configuring snippets in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": { + "description": "Logical `And` operator.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", "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" + "expressions": { + "description": "The expressions that were ANDed together.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { - "description": "A specification for configuring a summary returned in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": { + "description": "The expression denoting the filter that was extracted from the input query.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", "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" - }, - "ignoreJailBreakingQuery": { - "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking 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" + "andExpr": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "description": "Logical \"And\" compound operator connecting multiple expressions." }, - "modelPromptSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", - "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + "geolocationConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "description": "Geolocation constraint expression." }, - "modelSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", - "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + "numberConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", + "description": "Numerical constraint expression." }, - "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" + "orExpr": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "description": "Logical \"Or\" compound operator connecting multiple expressions." }, - "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" + "stringConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "description": "String constraint expression." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { - "description": "Specification of the prompt to use with the model.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": { + "description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", "properties": { - "preamble": { - "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", + "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { - "description": "Specification of the model.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", - "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).", + }, + "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" }, - "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", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": { + "description": "Constraint expression of a number field. Example: price < 100.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", "properties": { - "boostSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", - "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" + "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" }, - "dataStore": { - "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", + "fieldName": { + "description": "Name of the numerical field as defined in the schema.", "type": "string" }, - "filter": { - "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "querySegment": { + "description": "Identifies the keywords within the search query that match a filter.", "type": "string" + }, + "value": { + "description": "The value specified in the numerical constraint.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { - "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": { + "description": "Logical `Or` operator.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", "properties": { - "embeddingVectors": { - "description": "The embedding vector used for retrieval. Limit to 1.", + "expressions": { + "description": "The expressions that were ORed together.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { - "description": "Embedding vector.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": { + "description": "Constraint expression of a string field.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", "properties": { - "fieldPath": { - "description": "Embedding field path in schema.", + "fieldName": { + "description": "Name of the string field as defined in the schema.", "type": "string" }, - "vector": { - "description": "Query embedding vector.", + "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": { - "format": "float", - "type": "number" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { - "description": "A facet specification to perform faceted search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult": { + "description": "OneBoxResult is a holder for all results of specific type that we want to display in UI differently.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult", "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" + "oneBoxType": { + "description": "The type of One Box result.", + "enum": [ + "ONE_BOX_TYPE_UNSPECIFIED", + "PEOPLE", + "ORGANIZATION", + "SLACK", + "KNOWLEDGE_GRAPH" + ], + "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.", + "One Box result contains Knowledge Graph search responses." + ], + "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.", + "searchResults": { + "description": "The search results for this One Box.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" }, "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { - "description": "Specifies how a facet is computed.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": { + "description": "Information describing query expansion including whether expansion has occurred.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", "properties": { - "caseInsensitive": { - "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "expandedQuery": { + "description": "Bool describing whether query expansion has occurred.", "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.", + "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." }, - "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" + "document": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", + "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." }, - "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" + "id": { + "description": "Document.id of the searched Document.", + "type": "string" }, - "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" + "modelScores": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDoubleList" }, - "type": "array" + "description": "Output only. Google provided available scores.", + "readOnly": true, + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { - "description": "Specifies the image query input.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo": { + "description": "Information about the session.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", "properties": { - "imageBytes": { - "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { - "description": "Specification to enable natural language understanding capabilities for search requests.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": { + "description": "Summary of the top N search results specified by the summary spec.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", "properties": { - "filterExtractionCondition": { - "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", - "enum": [ - "CONDITION_UNSPECIFIED", - "DISABLED", - "ENABLED" - ], - "enumDescriptions": [ - "Server behavior defaults to `DISABLED`.", - "Disables NL filter extraction.", - "Enables NL filter extraction." - ], - "type": "string" + "safetyAttributes": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", + "description": "A collection of Safety Attribute categories and their associated confidence scores." }, - "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.", + "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", + "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2", + "TIME_OUT" + ], + "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. Google skips the summary if the query is chit chat. 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.", + "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`.", + "The time out case. Google skips the summary if the time out." + ], "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": { - "description": "The specification for personalization.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", - "properties": { - "mode": { - "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", - "enum": [ - "MODE_UNSPECIFIED", - "AUTO", - "DISABLED" - ], - "enumDescriptions": [ - "Default value. In this case, server behavior defaults to Mode.AUTO.", - "Personalization is enabled if data quality requirements are met.", - "Disable personalization." - ], + }, + "summaryText": { + "description": "The summary content.", "type": "string" + }, + "summaryWithMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", + "description": "Summary with metadata information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { - "description": "Specification to determine under which conditions query expansion should occur.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation", "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." - ], + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", "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" + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource" + }, + "type": "array" + }, + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes/unicode.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { - "description": "Specification for search as you type in search requests.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata": { + "description": "Citation metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", "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." - ], + "citations": { + "description": "Citations for segments.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource", + "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", "type": "string" } }, "type": "object" }, - "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", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference": { + "description": "Document reference.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference", "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.", + "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" }, - "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" + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "Cloud Storage or HTTP uri for the document.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { - "description": "The specification for query spell correction.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent", "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." - ], + "content": { + "description": "Chunk textual content.", + "type": "string" + }, + "pageIdentifier": { + "description": "Page identifier.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponse": { - "description": "Response message for SearchService.Search method.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponse", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": { + "description": "Safety Attribute categories and their associated confidence scores.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", "properties": { - "appliedControls": { - "description": "Controls applied as part of the Control service.", + "categories": { + "description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.", "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. This also helps to identify a request during the customer support scenarios.", - "type": "string" - }, - "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" + "scores": { + "description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata": { + "description": "Summary with metadata information.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", + "properties": { + "citationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", + "description": "Citation metadata for given summary." }, - "facets": { - "description": "Results of facets requested by user.", + "references": { + "description": "Document References.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference" }, "type": "array" }, - "geoSearchDebugInfo": { + "summary": { + "description": "Summary text with no citation information.", + "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", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo" + "type": "string" }, "type": "array" }, - "guidedSearchResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", - "description": "Guided search result." + "createTime": { + "description": "Output only. ServingConfig created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "naturalLanguageQueryUnderstandingInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo", - "description": "Natural language query understanding information for the returned results." + "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." }, - "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.", + "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" }, - "oneBoxResults": { - "description": "A list of One Box results. There can be multiple One Box results of different types.", + "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": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult" + "type": "string" }, "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.", + "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" }, - "results": { - "description": "A list of matched documents. The order represents the ranking.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" + "type": "string" }, "type": "array" }, - "searchLinkPromotions": { - "description": "Promotions for site search.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion" + "type": "string" }, "type": "array" }, - "sessionInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", - "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." + "mediaConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", + "description": "The MediaConfig of the serving configuration." }, - "suggestedQuery": { - "description": "Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).", + "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" }, - "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" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet": { - "description": "A facet result.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet", - "properties": { - "dynamicFacet": { - "description": "Whether the facet is dynamically generated.", - "type": "boolean" - }, - "key": { - "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "type": "string" }, - "values": { - "description": "The facet values for this field.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue" + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue": { - "description": "A facet value which contains value names and their count.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue", - "properties": { - "count": { - "description": "Number of items that have this facet value.", - "format": "int64", - "type": "string" }, - "interval": { - "$ref": "GoogleCloudDiscoveryengineV1alphaInterval", - "description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals." + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." }, - "value": { - "description": "Text value of a facet, such as \"Black\" for facet \"colors\".", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo": { - "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo", - "properties": { - "errorMessage": { - "description": "The error produced.", + "promoteControlIds": { + "description": "Condition promote specifications. Maximum number of specifications is 100.", + "items": { + "type": "string" + }, + "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" }, - "originalAddressQuery": { - "description": "The address from which forward geocoding ingestion produced issues.", - "type": "string" - } - }, - "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", - "properties": { - "followUpQuestions": { - "description": "Suggested follow-up questions.", + "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" }, - "refinementAttributes": { - "description": "A list of ranked refinement attributes.", + "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": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute" + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute": { - "description": "Useful attribute for search result refinements.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute", - "properties": { - "attributeKey": { - "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", - "type": "string" - }, - "attributeValue": { - "description": "Attribute value used to refine the results. For example, `\"drama\"`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo": { - "description": "Information describing what natural language understanding was done on the input query.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo", - "properties": { - "extractedFilters": { - "description": "The filters that were extracted from the input query.", - "type": "string" }, - "rewrittenQuery": { - "description": "Rewritten input query minus the extracted filters.", + "solutionType": { + "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", + "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" }, - "sqlRequest": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest", - "description": "Optional. The SQL request that was generated from the natural language query understanding phase." + "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" }, - "structuredExtractedFilter": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", - "description": "The filters that were extracted from the input query represented in a structured form." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest": { - "description": "The SQL request that was generated from the natural language query understanding phase.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest", - "properties": { - "sqlQuery": { - "description": "Optional. The SQL query in text format.", + "updateTime": { + "description": "Output only. ServingConfig updated timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { - "description": "The filters that were extracted from the input query represented in a structured form.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", - "properties": { - "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", + "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { + "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", "properties": { - "expressions": { - "description": "The expressions that were ANDed together.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" - }, - "type": "array" + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": { - "description": "The expression denoting the filter that was extracted from the input query.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "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": { - "andExpr": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", - "description": "Logical \"And\" compound operator connecting multiple expressions." + "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" }, - "geolocationConstraint": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", - "description": "Geolocation constraint expression." + "contentWatchedPercentageThreshold": { + "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", + "format": "float", + "type": "number" }, - "numberConstraint": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", - "description": "Numerical constraint expression." + "contentWatchedSecondsThreshold": { + "description": "Specifies the content watched minutes threshold for demotion.", + "format": "float", + "type": "number" }, - "orExpr": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", - "description": "Logical \"Or\" compound operator connecting multiple expressions." + "demoteContentWatchedPastDays": { + "description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.", + "format": "int32", + "type": "integer" }, - "stringConstraint": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", - "description": "String constraint expression." + "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": { - "description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "GoogleCloudDiscoveryengineV1alphaSession": { + "description": "External session proto definition.", + "id": "GoogleCloudDiscoveryengineV1alphaSession", "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.", + "displayName": { + "description": "Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.", "type": "string" }, - "fieldName": { - "description": "The name of the geolocation field as defined in the schema.", + "endTime": { + "description": "Output only. The time the session finished.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "latitude": { - "description": "The latitude of the geolocation inferred from the input query.", - "format": "double", - "type": "number" + "isPinned": { + "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", + "type": "boolean" }, - "longitude": { - "description": "The longitude of the geolocation inferred from the input query.", - "format": "double", - "type": "number" + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "type": "string" }, - "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" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": { - "description": "Constraint expression of a number field. Example: price < 100.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", - "properties": { - "comparison": { - "description": "The comparison operation performed between the field value and the value specified in the constraint.", + "startTime": { + "description": "Output only. The time the session started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "The state of the session.", "enum": [ - "COMPARISON_UNSPECIFIED", - "EQUALS", - "LESS_THAN_EQUALS", - "LESS_THAN", - "GREATER_THAN_EQUALS", - "GREATER_THAN" + "STATE_UNSPECIFIED", + "IN_PROGRESS" ], "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." + "State is unspecified.", + "The session is currently open." ], "type": "string" }, - "fieldName": { - "description": "Name of the numerical field as defined in the schema.", - "type": "string" + "turns": { + "description": "Turns.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" + }, + "type": "array" }, - "querySegment": { - "description": "Identifies the keywords within the search query that match a filter.", + "userPseudoId": { + "description": "A unique identifier for tracking users.", "type": "string" - }, - "value": { - "description": "The value specified in the numerical constraint.", - "format": "double", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": { - "description": "Logical `Or` operator.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "GoogleCloudDiscoveryengineV1alphaSessionTurn": { + "description": "Represents a turn, including a query from the user and a answer from service.", + "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { - "expressions": { - "description": "The expressions that were ORed together.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" - }, - "type": "array" + "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" + }, + "detailedAnswer": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", + "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", + "readOnly": true + }, + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", + "description": "The user query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": { - "description": "Constraint expression of a string field.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata": { + "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata", "properties": { - "fieldName": { - "description": "Name of the string field as defined in the schema.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "querySegment": { - "description": "Identifies the keywords within the search query that match a filter.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult": { - "description": "OneBoxResult is a holder for all results of specific type that we want to display in UI differently.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult", + "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest": { + "description": "Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.", + "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest", "properties": { - "oneBoxType": { - "description": "The type of One Box result.", + "crawlRate": { + "description": "Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.", + "format": "int32", + "type": "integer" + }, + "crawlRateScope": { + "description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "type": "string" + }, + "crawlType": { + "description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.", "enum": [ - "ONE_BOX_TYPE_UNSPECIFIED", - "PEOPLE", - "ORGANIZATION", - "SLACK", - "KNOWLEDGE_GRAPH" + "CRAWL_TYPE_UNSPECIFIED", + "USER_TRIGGERED", + "AUTO_REFRESH" ], "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.", - "One Box result contains Knowledge Graph search responses." + "The crawl type is unspecified.", + "The crawl type is user-triggered.", + "The crawl type is auto-refresh." ], "type": "string" }, - "searchResults": { - "description": "The search results for this One Box.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" - }, - "type": "array" + "mode": { + "description": "Optional. Whether the rate is explicitly set by users, or set by vertex AI.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTOMATIC", + "EXPLICIT" + ], + "enumDescriptions": [ + "The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC.", + "Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify SetDedicatedCrawlRateRequest.CrawlType if the mode is AUTOMATIC.", + "Users explicitly set user-triggered or auto-refresh crawl rate." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": { - "description": "Information describing query expansion including whether expansion has occurred.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", + "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", + "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse", "properties": { - "expandedQuery": { - "description": "Bool describing whether query expansion has occurred.", - "type": "boolean" + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." }, - "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", + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult": { - "description": "Represents the search results.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult", + "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata": { + "description": "Metadata for DataConnectorService.SetUpDataConnector method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest": { + "description": "Request for DataConnectorService.SetUpDataConnector method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest", "properties": { - "chunk": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk", - "description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." - }, - "document": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." + "collectionDisplayName": { + "description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" }, - "id": { - "description": "Document.id of the searched Document.", + "collectionId": { + "description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. 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.", "type": "string" }, - "modelScores": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDoubleList" - }, - "description": "Google provided available scores.", - "type": "object" + "dataConnector": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector", + "description": "Required. The DataConnector to initialize in the newly created Collection." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo": { - "description": "Information about the session.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", + "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": { - "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.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": { - "description": "Summary of the top N search results specified by the summary spec.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": { + "description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest", "properties": { - "safetyAttributes": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", - "description": "A collection of Safety Attribute categories and their associated confidence scores." - }, - "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", - "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" - ], - "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. Google skips the summary if the query is chit chat. 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.", - "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." - ], - "type": "string" + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" }, - "type": "array" + "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" }, - "summaryText": { - "description": "The summary content.", - "type": "string" + "emptyDocumentDataMap": { + "description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.", + "type": "boolean" }, - "summaryWithMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", - "description": "Summary with metadata information." + "schema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation": { - "description": "Citation info for a segment.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation", - "properties": { - "endIndex": { - "description": "End of the attributed segment, exclusive.", - "format": "int64", - "type": "string" - }, - "sources": { - "description": "Citation sources for the attributed segment.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource" - }, - "type": "array" - }, - "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes/unicode.", - "format": "int64", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSingleRegionKey": { + "description": "Metadata for single-regional CMEKs.", + "id": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey", + "properties": { + "kmsKey": { + "description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata": { - "description": "Citation metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", + "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { + "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", + "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", "properties": { - "citations": { - "description": "Citations for segments.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation" - }, - "type": "array" + "name": { + "description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource": { - "description": "Citation source.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource", + "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "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", + "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference": { - "description": "Document reference.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference", + "GoogleCloudDiscoveryengineV1alphaSitemap": { + "description": "A sitemap for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1alphaSitemap", "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/*`.", + "createTime": { + "description": "Output only. The sitemap's creation time.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "title": { - "description": "Title of the document.", + "name": { + "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", + "readOnly": true, "type": "string" }, "uri": { - "description": "Cloud Storage or HTTP uri for the document.", + "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": { - "description": "Chunk content.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent", + "GoogleCloudDiscoveryengineV1alphaSpannerSource": { + "description": "The Spanner source for importing data", + "id": "GoogleCloudDiscoveryengineV1alphaSpannerSource", "properties": { - "content": { - "description": "Chunk textual content.", + "databaseId": { + "description": "Required. The database ID of the source Spanner table.", "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": { - "description": "Safety Attribute categories and their associated confidence scores.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", + "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest": { + "description": "Request message for DataConnectorService.StartConnectorRun method.", + "id": "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest", "properties": { - "categories": { - "description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.", + "entities": { + "description": "Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced.", "items": { "type": "string" }, "type": "array" }, - "scores": { - "description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.", + "forceRefreshContent": { + "description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.", + "type": "boolean" + }, + "healthcareFhirResourceTypes": { + "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": { - "format": "float", - "type": "number" + "type": "string" }, "type": "array" + }, + "syncIdentity": { + "description": "If true, trigger Identity sync.", + "type": "boolean" + }, + "syncSinceTimestamp": { + "description": "Timestamp to indicate the point in time from which data should be synced for Streaming/Batch Data Connectors. This field is only utilized for Healthcare Connectors.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata": { - "description": "Summary with metadata information.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", + "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { + "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", + "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", "properties": { - "citationMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", - "description": "Citation metadata for given summary." - }, - "references": { - "description": "Document References.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference" - }, - "type": "array" + "blockPhrase": { + "description": "Required. Phrase to block from suggestions served. Can be maximum 125 characters.", + "type": "string" }, - "summary": { - "description": "Summary text with no citation information.", + "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." + ], "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", + "GoogleCloudDiscoveryengineV1alphaTargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "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" + "exactMatch": { + "description": "Immutable. 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" }, - "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." + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true }, - "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.", + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, "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.", + "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" }, - "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.", + "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" }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "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.", - "items": { - "type": "string" - }, - "type": "array" - }, - "personalizationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", - "description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." - }, - "promoteControlIds": { - "description": "Condition promote specifications. Maximum number of specifications is 100.", - "items": { - "type": "string" - }, - "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)`.", + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, "type": "string" }, - "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" + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true }, - "solutionType": { - "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" ], "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." + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." ], "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.", - "items": { - "type": "string" - }, - "type": "array" - }, "updateTime": { - "description": "Output only. ServingConfig updated timestamp.", + "description": "Output only. The target site's last updated time.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -20155,237 +22146,219 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { - "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", - "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", "properties": { - "contentSearchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", - "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." } }, "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", + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", "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.", - "format": "float", - "type": "number" - }, - "contentWatchedSecondsThreshold": { - "description": "Specifies the content watched minutes threshold for demotion.", - "format": "float", - "type": "number" - }, - "demoteContentWatchedPastDays": { - "description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.", - "format": "int32", - "type": "integer" - }, - "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.", + "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" }, - "GoogleCloudDiscoveryengineV1alphaSession": { - "description": "External session proto definition.", - "id": "GoogleCloudDiscoveryengineV1alphaSession", + "GoogleCloudDiscoveryengineV1alphaTextInput": { + "description": "Defines text input.", + "id": "GoogleCloudDiscoveryengineV1alphaTextInput", "properties": { - "displayName": { - "description": "Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.", - "type": "string" + "context": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversationContext", + "description": "Conversation context of the input." }, - "endTime": { - "description": "Output only. The time the session finished.", - "format": "google-datetime", - "readOnly": true, + "input": { + "description": "Text input.", "type": "string" - }, - "isPinned": { - "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", - "type": "boolean" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + } + }, + "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" }, - "startTime": { - "description": "Output only. The time the session started.", + "updateTime": { + "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" + }, + "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." }, - "state": { - "description": "The state of the session.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS" - ], - "enumDescriptions": [ - "State is unspecified.", - "The session is currently open." - ], - "type": "string" + "gcsTrainingInput": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", + "description": "Cloud Storage training input." }, - "turns": { - "description": "Turns.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" - }, - "type": "array" + "modelId": { + "description": "If not provided, a UUID will be generated.", + "type": "string" }, - "userPseudoId": { - "description": "A unique identifier for tracking users.", + "modelType": { + "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSessionTurn": { - "description": "Represents a turn, including a query from the user and a answer from service.", - "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput": { + "description": "Cloud Storage training data input.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", "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.", + "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" }, - "detailedAnswer": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", - "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", - "readOnly": true + "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" }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", - "description": "The user query." + "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" }, - "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata": { - "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata", + "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" }, - "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest": { - "description": "Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.", - "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest", + "GoogleCloudDiscoveryengineV1alphaTransactionInfo": { + "description": "A transaction represents the entire purchase transaction.", + "id": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", "properties": { - "crawlRate": { - "description": "Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.", - "format": "int32", - "type": "integer" + "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" }, - "crawlRateScope": { - "description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "currency": { + "description": "Required. Currency code. Use three-character ISO-4217 code.", "type": "string" }, - "crawlType": { - "description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.", - "enum": [ - "CRAWL_TYPE_UNSPECIFIED", - "USER_TRIGGERED", - "AUTO_REFRESH" - ], - "enumDescriptions": [ - "The crawl type is unspecified.", - "The crawl type is user-triggered.", - "The crawl type is auto-refresh." - ], - "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" }, - "mode": { - "description": "Optional. Whether the rate is explicitly set by users, or set by vertex AI.", - "enum": [ - "MODE_UNSPECIFIED", - "AUTOMATIC", - "EXPLICIT" - ], - "enumDescriptions": [ - "The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC.", - "Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify SetDedicatedCrawlRateRequest.CrawlType if the mode is AUTOMATIC.", - "Users explicitly set user-triggered or auto-refresh crawl rate." - ], + "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" }, - "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse": { - "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", - "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse", + "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { + "description": "Metadata associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "properties": { - "error": { - "$ref": "GoogleRpcStatus", - "description": "Errors from service when handling the request." - }, - "state": { - "description": "Output only. The state of the response.", - "enum": [ - "STATE_UNSPECIFIED", - "SUCCEEDED", - "FAILED" - ], - "enumDescriptions": [ - "The state is unspecified.", - "The state is successful.", - "The state is failed." - ], - "readOnly": true, + "engine": { + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata": { - "description": "Metadata for DataConnectorService.SetUpDataConnector method.", - "id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata", + "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" }, - "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest": { - "description": "Request for DataConnectorService.SetUpDataConnector method.", - "id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest", + "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { + "description": "Response associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata": { + "description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata", "properties": { - "collectionDisplayName": { - "description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "collectionId": { - "description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. 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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "dataConnector": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector", - "description": "Required. The DataConnector to initialize in the newly created Collection." } }, "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", + "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata": { + "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -20400,272 +22373,418 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": { - "description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.", - "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest", + "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { - "documentDataMap": { - "additionalProperties": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "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" - }, - "emptyDocumentDataMap": { - "description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.", - "type": "boolean" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "schema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "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" - }, - "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { - "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", - "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSingleRegionKey": { - "description": "Metadata for single-regional CMEKs.", - "id": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey", - "properties": { - "kmsKey": { - "description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { - "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", - "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", + "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": { + "description": "Request for UpdateSession method.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest", "properties": { - "name": { - "description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`", + "session": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSession", + "description": "Required. The Session to update." + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "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": { - "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" }, - "GoogleCloudDiscoveryengineV1alphaSitemap": { - "description": "A sitemap for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1alphaSitemap", + "GoogleCloudDiscoveryengineV1alphaUserEvent": { + "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", + "id": "GoogleCloudDiscoveryengineV1alphaUserEvent", "properties": { - "createTime": { - "description": "Output only. The sitemap's creation time.", - "format": "google-datetime", - "readOnly": true, + "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" + }, + "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." + }, + "conversionType": { + "description": "Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by \"-\", such as \"watch\", \"good-visit\" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.", + "type": "string" + }, + "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" + }, + "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" + }, + "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" }, - "name": { - "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", - "readOnly": true, + "eventTime": { + "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", + "format": "google-datetime", "type": "string" }, - "uri": { - "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", + "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 * `add-feedback`: Add a user feedback. 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. Custom conversion value: * `conversion`: Customer defined conversion event.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSpannerSource": { - "description": "The Spanner source for importing data", - "id": "GoogleCloudDiscoveryengineV1alphaSpannerSource", - "properties": { - "databaseId": { - "description": "Required. The database ID of the source Spanner table.", + }, + "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" }, - "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" + "mediaInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaMediaInfo", + "description": "Media-specific info." }, - "instanceId": { - "description": "Required. The instance ID of the source Spanner table.", - "type": "string" + "pageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPageInfo", + "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`." }, - "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" + "panel": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo", + "description": "Panel metadata associated with this user event." }, - "tableId": { - "description": "Required. The table name of the Spanner database that needs to be imported.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest": { - "description": "Request message for DataConnectorService.StartConnectorRun method.", - "id": "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest", - "properties": { - "entities": { - "description": "Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced.", + "panels": { + "description": "Optional. List of panels associated with this event. Used for page-level impression data.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo" + }, + "type": "array" + }, + "promotionIds": { + "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", "items": { "type": "string" }, "type": "array" }, - "forceRefreshContent": { - "description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.", - "type": "boolean" + "searchInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchInfo", + "description": "SearchService.Search details related to the event. This field should be set for `search` event." }, - "healthcareFhirResourceTypes": { - "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.", + "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" + }, + "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" }, - "syncIdentity": { - "description": "If true, trigger Identity sync.", - "type": "boolean" + "transactionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", + "description": "The transaction metadata (if any) associated with this user event." }, - "syncSinceTimestamp": { - "description": "Timestamp to indicate the point in time from which data should be synced for Streaming/Batch Data Connectors. This field is only utilized for Healthcare Connectors.", - "format": "google-datetime", + "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" }, - "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { - "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", - "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", + "GoogleCloudDiscoveryengineV1alphaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { - "blockPhrase": { - "description": "Required. Phrase to block from suggestions served. Can be maximum 125 characters.", + "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" }, - "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." - ], + "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" }, - "GoogleCloudDiscoveryengineV1alphaTargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", + "GoogleCloudDiscoveryengineV1alphaWidgetConfig": { + "description": "WidgetConfig captures configs at the Widget level.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfig", "properties": { - "exactMatch": { - "description": "Immutable. 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.", + "accessSettings": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings", + "description": "Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties." + }, + "allowPublicAccess": { + "deprecated": true, + "description": "Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.", "type": "boolean" }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", - "description": "Output only. Failure reason.", + "allowlistedDomains": { + "deprecated": true, + "description": "Allowlisted domains that can load this widget.", + "items": { + "type": "string" + }, + "type": "array" + }, + "assistantSettings": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings", + "description": "Optional. Output only. Describes the assistant settings of the widget.", "readOnly": true }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "collectionComponents": { + "description": "Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent" + }, + "readOnly": true, + "type": "array" + }, + "configId": { + "description": "Output only. Unique obfuscated identifier of a WidgetConfig.", "readOnly": true, "type": "string" }, - "indexingStatus": { - "description": "Output only. Indexing status.", + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "deprecated": true, + "description": "The content search spec that configs the desired behavior of content search." + }, + "createTime": { + "description": "Output only. Timestamp the WidgetConfig was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customerProvidedConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig", + "description": "Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.", + "readOnly": true + }, + "dataStoreType": { + "description": "Output only. The type of the parent data store.", "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" + "DATA_STORE_TYPE_UNSPECIFIED", + "SITE_SEARCH", + "STRUCTURED", + "UNSTRUCTURED", + "BLENDED" ], "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." + "Unspecified data store type.", + "The parent data store contains a site search engine.", + "The parent data store contains a search engine for structured data.", + "The parent data store contains a search engine for unstructured data.", + "The parent data store is served for blended search with multiple data stores." ], "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, + "dataStoreUiConfigs": { + "deprecated": true, + "description": "Configurable UI configurations per data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig" + }, + "type": "array" + }, + "defaultSearchRequestOrderBy": { + "deprecated": true, + "description": "The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body", "type": "string" }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "displayName": { + "description": "Required. The human readable widget 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" }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", + "enableAutocomplete": { + "deprecated": true, + "description": "Whether or not to enable autocomplete.", + "type": "boolean" + }, + "enableConversationalSearch": { + "deprecated": true, + "description": "Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).", + "type": "boolean" + }, + "enableQualityFeedback": { + "deprecated": true, + "description": "Turn on or off collecting the search result quality feedback from end users.", + "type": "boolean" + }, + "enableResultScore": { + "description": "Whether to show the result score.", + "type": "boolean" + }, + "enableSafeSearch": { + "deprecated": true, + "description": "Whether to enable safe search.", + "type": "boolean" + }, + "enableSearchAsYouType": { + "deprecated": true, + "description": "Whether to enable search-as-you-type behavior for the search widget", + "type": "boolean" + }, + "enableSnippetResultSummary": { + "deprecated": true, + "description": "Turn on or off summary for each snippets result.", + "type": "boolean" + }, + "enableSummarization": { + "deprecated": true, + "description": "Turn on or off summarization for the search response.", + "type": "boolean" + }, + "enableWebApp": { + "deprecated": true, + "description": "Whether to enable standalone web app.", + "type": "boolean" + }, + "experimentalFeatures": { + "additionalProperties": { + "type": "string" + }, + "description": "Allows to toggle unstable/experimental features in the widget (or web app)", + "type": "object" + }, + "facetField": { + "deprecated": true, + "description": "The configuration and appearance of facets in the end user view.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField" + }, + "type": "array" + }, + "fieldsUiComponentsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField" + }, + "deprecated": true, + "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.", + "type": "object" + }, + "homepageSetting": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting", + "description": "Optional. Describes the homepage settings of the widget." + }, + "industryVertical": { + "description": "Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated 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." + ], "readOnly": true, "type": "string" }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true + "llmEnabled": { + "description": "Output only. Whether LLM is enabled in the corresponding data store.", + "readOnly": true, + "type": "boolean" }, - "type": { - "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "minimumDataTermAccepted": { + "description": "Output only. Whether the customer accepted data use terms.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "resultDisplayType": { + "deprecated": true, + "description": "The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.", + "enum": [ + "RESULT_DISPLAY_TYPE_UNSPECIFIED", + "SNIPPET", + "EXTRACTIVE_ANSWER" + ], + "enumDescriptions": [ + "Unspecified display type (default to showing snippet).", + "Display results from the snippet field.", + "Display results from extractive answers field." + ], + "type": "string" + }, + "solutionType": { + "description": "Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.", "enum": [ - "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." + "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" }, + "uiBranding": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings", + "description": "Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors." + }, + "uiSettings": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings", + "description": "Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties." + }, "updateTime": { - "description": "Output only. The target site's last updated time.", + "description": "Output only. Timestamp the WidgetConfig was updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -20673,405 +22792,437 @@ }, "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", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings": { + "description": "Describes widget access settings.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings", "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", + "allowPublicAccess": { + "description": "Whether public unauthenticated access is allowed.", + "type": "boolean" + }, + "allowlistedDomains": { + "description": "List of domains that are allowed to integrate the search widget.", + "items": { + "type": "string" + }, + "type": "array" + }, + "enableWebApp": { + "description": "Whether web app access is enabled.", + "type": "boolean" + }, + "languageCode": { + "description": "Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is \"en-US\".", "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.", + "workforceIdentityPoolProvider": { + "description": "Optional. The workforce identity pool provider used to access the widget.", "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", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings": { + "description": "Describes the assistant settings of the widget.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings", "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" + "googleSearchGroundingEnabled": { + "description": "Whether or not the Google search grounding toggle is shown.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest": { - "description": "Request message for SearchTuningService.TrainCustomModel method.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent": { + "description": "Read-only collection component that contains data store collections fields that may be used for filtering", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent", "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." - }, - "modelId": { - "description": "If not provided, a UUID will be generated.", + "connectorIconLink": { + "description": "Output only. The icon link of the connector source.", + "readOnly": true, "type": "string" }, - "modelType": { - "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput": { - "description": "Cloud Storage training data input.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", - "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\"}`", + "dataSource": { + "description": "The name of the data source, retrieved from `Collection.data_connector.data_source`.", "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\"}", + "dataStoreComponents": { + "description": "For the data store collection, list of the children data stores.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent" + }, + "type": "array" + }, + "displayName": { + "description": "The display name of the collection.", "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.", + "id": { + "description": "Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.", + "readOnly": true, "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`", + "name": { + "description": "The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { - "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig": { + "description": "Customer provided configurations.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig", "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.", - "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.", + "customerType": { + "description": "Customer type.", + "enum": [ + "DEFAULT_CUSTOMER", + "GOVERNMENT_CUSTOMER" + ], + "enumDescriptions": [ + "Default customer type.", + "Government customer type. Some features are disabled for government customers due to legal requirements." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTransactionInfo": { - "description": "A transaction represents the entire purchase transaction.", - "id": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent": { + "description": "Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent", "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" + "contentConfig": { + "description": "Output only. The content config of the data store.", + "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." + ], + "readOnly": true, + "type": "string" }, - "currency": { - "description": "Required. Currency code. Use three-character ISO-4217 code.", + "displayName": { + "description": "The display name of the data store.", "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" + "entityName": { + "description": "The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.", + "type": "string" }, - "tax": { - "description": "All the taxes associated with the transaction.", - "format": "float", - "type": "number" + "id": { + "description": "Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.", + "readOnly": true, + "type": "string" }, - "transactionId": { - "description": "The transaction ID with a length limit of 128 characters.", + "name": { + "description": "The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.", "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}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", + "workspaceType": { + "description": "Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP", + "GOOGLE_PEOPLE" + ], + "enumDescriptions": [ + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data", + "Workspace Data Store contains People data" + ], + "readOnly": true, "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" - }, - "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata": { - "description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig": { + "description": "UI component configuration for data store.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "facetField": { + "description": "Facet fields that store the mapping of fields to end user widget appearance.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField" + }, + "type": "array" + }, + "fieldsUiComponentsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField" + }, + "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.", + "type": "object" + }, + "id": { + "description": "Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "name": { + "description": "The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata": { - "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField": { + "description": "Facet fields that store the mapping of fields to end user widget appearance.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "displayName": { + "description": "Optional. The field name that end users will see.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "field": { + "description": "Required. Registered field name. The format is `field.abc`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting": { + "description": "Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "shortcuts": { + "description": "Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number)", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut": { + "description": "Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut", + "properties": { + "destinationUri": { + "description": "Optional. Destination URL of shortcut.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "icon": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigImage", + "description": "Optional. Icon URL of shortcut." + }, + "title": { + "description": "Optional. Title of the shortcut.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": { - "description": "Request for UpdateSession method.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigImage": { + "description": "Options to store an image.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigImage", "properties": { - "session": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSession", - "description": "Required. The Session to update." - }, - "updateMask": { - "description": "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.", - "format": "google-fieldmask", + "url": { + "description": "Image URL.", "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", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField": { + "description": "Facet field that maps to a UI Component.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "deviceVisibility": { + "description": "The field visibility on different types of devices.", + "items": { + "enum": [ + "DEVICE_VISIBILITY_UNSPECIFIED", + "MOBILE", + "DESKTOP" + ], + "enumDescriptions": [ + "Default value when not specified. Server returns INVALID_ARGUMENT if used in requests.", + "The UI component is visible on Mobile devices.", + "The UI component is visible on Browser-based client." + ], + "type": "string" + }, + "type": "array" + }, + "displayTemplate": { + "description": "The template to customize how the field is displayed. An example value would be a string that looks like: \"Price: {value}\".", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "field": { + "description": "Required. Registered field name. The format is `field.abc`.", "type": "string" } }, "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", + "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings": { + "description": "Describes widget UI branding settings.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings", "properties": { - "attributes": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomAttribute" + "logo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigImage", + "description": "Logo image." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings": { + "description": "Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings", + "properties": { + "dataStoreUiConfigs": { + "description": "Per data store configuration.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig" }, - "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" + "type": "array" }, - "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.", + "defaultSearchRequestOrderBy": { + "description": "The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body", "type": "string" }, - "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." + "disableUserEventsCollection": { + "description": "If set to true, the widget will not collect user events.", + "type": "boolean" }, - "conversionType": { - "description": "Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by \"-\", such as \"watch\", \"good-visit\" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.", - "type": "string" + "enableAutocomplete": { + "description": "Whether or not to enable autocomplete.", + "type": "boolean" }, - "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" + "enableQualityFeedback": { + "description": "Turn on or off collecting the search result quality feedback from end users.", + "type": "boolean" }, - "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.", + "enableSafeSearch": { + "description": "Whether to enable safe search.", "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" - }, - "type": "array" + "enableSearchAsYouType": { + "description": "Whether to enable search-as-you-type behavior for the search widget.", + "type": "boolean" }, - "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" + "enableVisualContentSummary": { + "description": "If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.", + "type": "boolean" }, - "eventTime": { - "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", - "format": "google-datetime", - "type": "string" + "generativeAnswerConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig", + "description": "Describes generative answer configuration." }, - "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 * `add-feedback`: Add a user feedback. 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. Custom conversion value: * `conversion`: Customer defined conversion event.", + "interactionType": { + "description": "Describes widget (or web app) interaction type", + "enum": [ + "INTERACTION_TYPE_UNSPECIFIED", + "SEARCH_ONLY", + "SEARCH_WITH_ANSWER", + "SEARCH_WITH_FOLLOW_UPS" + ], + "enumDescriptions": [ + "Not specified. Defaults to SEARCH_ONLY.", + "Search without a generative answer.", + "Search with the generative answer.", + "Search with the generative answer that supports follow up questions. Also known as multi-turn search." + ], "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.", + "resultDescriptionType": { + "description": "Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.", + "enum": [ + "RESULT_DISPLAY_TYPE_UNSPECIFIED", + "SNIPPET", + "EXTRACTIVE_ANSWER" + ], + "enumDescriptions": [ + "Unspecified display type (default to showing snippet).", + "Display results from the snippet field.", + "Display results from extractive answers field." + ], "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig": { + "description": "Describes configuration for generative answer.", + "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig", + "properties": { + "disableRelatedQuestions": { + "description": "Whether generated answer contains suggested related questions.", + "type": "boolean" }, - "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`." - }, - "panel": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo", - "description": "Panel metadata associated with this user event." - }, - "panels": { - "description": "Optional. List of panels associated with this event. Used for page-level impression data.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo" - }, - "type": "array" + "ignoreAdversarialQuery": { + "description": "Optional. Specifies whether to filter out queries that are adversarial.", + "type": "boolean" }, - "promotionIds": { - "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", - "items": { - "type": "string" - }, - "type": "array" + "ignoreLowRelevantContent": { + "description": "Optional. Specifies whether to filter out queries that are not relevant to the content.", + "type": "boolean" }, - "searchInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchInfo", - "description": "SearchService.Search details related to the event. This field should be set for `search` event." + "ignoreNonAnswerSeekingQuery": { + "description": "Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. 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" }, - "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.", + "imageSource": { + "description": "Optional. Source of image returned in the answer.", + "enum": [ + "IMAGE_SOURCE_UNSPECIFIED", + "ALL_AVAILABLE_SOURCES", + "CORPUS_IMAGE_ONLY", + "FIGURE_GENERATION_ONLY" + ], + "enumDescriptions": [ + "Unspecified image source (multimodal feature is disabled by default)", + "Behavior when service determines the pick from all available sources.", + "Include image from corpus in the answer.", + "Triggers figure generation in the answer." + ], "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" - }, - "transactionInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", - "description": "The transaction metadata (if any) associated with this user event." + "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" }, - "userInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Information about the end user." + "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" }, - "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" - }, - "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.", + "modelPromptPreamble": { + "description": "Text at the beginning of the prompt that instructs the model that generates the answer.", "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.", + "modelVersion": { + "description": "The model version used to generate the answer.", "type": "string" + }, + "resultCount": { + "description": "The number of top results to generate the answer from. Up to 10.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -21177,11 +23328,11 @@ "type": "boolean" }, "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "type": "string" }, "lastRotationTimestampMicros": { @@ -21191,7 +23342,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "type": "string" }, "singleRegionKeys": { @@ -21202,13 +23353,14 @@ "type": "array" }, "state": { - "description": "Output only. State of the CmekConfig.", + "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", + "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING" ], @@ -21218,6 +23370,7 @@ "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated." ], @@ -21369,26 +23522,90 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "GoogleCloudDiscoveryengineV1betaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "properties": { + "boost": { + "deprecated": true, + "description": "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" + }, + "fixedBoost": { + "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" + }, + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", + "properties": { + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "Optional. The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "Optional. 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" + }, + "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint", "properties": { - "boost": { - "deprecated": true, - "description": "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.", + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, - "fixedBoost": { - "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "boostAmount": { + "description": "Optional. 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" } @@ -21450,6 +23667,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": { + "description": "The historical crawl rate timeseries data, used for monitoring.", + "id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "properties": { + "qpsTimeSeries": { + "$ref": "GoogleMonitoringV3TimeSeries", + "description": "The QPS of the crawl rate." + } + }, + "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", @@ -21584,7 +23812,7 @@ "type": "string" }, "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -21596,6 +23824,14 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", + "type": "string" + }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -21716,6 +23952,29 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": { + "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", + "id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", + "properties": { + "autoRefreshCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl." + }, + "autoRefreshCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." + }, + "userTriggeredCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of user triggered dedicated crawl." + }, + "userTriggeredCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." + } + }, + "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", @@ -22064,6 +24323,10 @@ "$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." }, + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" @@ -22242,27 +24505,39 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse": { - "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", - "id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse", + "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "properties": { - "sitemapsMetadata": { - "description": "List of Sitemaps fetched.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata" - }, - "type": "array" + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", + "type": "boolean" + }, + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata": { - "description": "Contains a Sitemap and its metadata.", - "id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata", + "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata", "properties": { - "sitemap": { - "$ref": "GoogleCloudDiscoveryengineV1betaSitemap", - "description": "The Sitemap." + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", + "type": "string" } }, "type": "object" @@ -22373,6 +24648,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "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", @@ -22593,6 +24882,55 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", + "id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse", + "properties": { + "dedicatedCrawlRateTimeSeries": { + "$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", + "description": "The historical dedicated crawl rate timeseries data, used for monitoring." + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "organicCrawlRateTimeSeries": { + "$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", + "description": "The historical organic crawl rate timeseries data, used for monitoring." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": { + "description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.", + "id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", + "properties": { + "googleOrganicCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." + }, + "vertexAiOrganicCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", @@ -22813,6 +25151,49 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": { + "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata", + "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" + }, + "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -22857,7 +25238,7 @@ "type": "string" }, "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, @@ -22884,12 +25265,16 @@ "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 data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", + "description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, "type": "array" }, + "displaySpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", + "description": "Optional. Config for display feature, like match highlighting on search results." + }, "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." @@ -22960,15 +25345,33 @@ "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)`.", + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result", + "type": "string" + }, + "rankingExpressionBackend": { + "description": "Optional. The backend to use for the ranking expression evaluation.", + "enum": [ + "UNKNOWN", + "BYOE", + "CLEARBOX" + ], + "enumDescriptions": [ + "Default option for unspecified/unknown values.", + "Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", + "The expression is compiled into a Clearbox formula." + ], "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" }, + "relevanceScoreSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", + "description": "Optional. The specification for returning the relevance score." + }, "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.", + "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. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -23011,7 +25414,7 @@ }, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." }, "userLabels": { "additionalProperties": { @@ -23317,6 +25720,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": { + "description": "Specifies features for display, like match highlighting.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", + "properties": { + "matchHighlightingCondition": { + "description": "The condition under which match highlighting should occur.", + "enum": [ + "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", + "MATCH_HIGHLIGHTING_DISABLED", + "MATCH_HIGHLIGHTING_ENABLED" + ], + "enumDescriptions": [ + "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", + "Disables match highlighting on all documents.", + "Enables match highlighting on all documents." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", @@ -23509,6 +25933,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": { + "description": "The specification for returning the document relevance score.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", + "properties": { + "returnRelevanceScore": { + "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -23518,12 +25953,14 @@ "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", - "ENABLED" + "ENABLED", + "AUTO" ], "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", - "Enables Search As You Type." + "Enables Search As You Type.", + "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ], "type": "string" } @@ -23539,7 +25976,7 @@ "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.", + "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 similar 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" } @@ -23567,6 +26004,49 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { + "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", + "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" + }, + "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", + "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey", @@ -23892,6 +26372,47 @@ }, "type": "object" }, + "GoogleCloudNotebooklmV1alphaSourceId": { + "description": "SourceId is the last segment of the source's resource name.", + "id": "GoogleCloudNotebooklmV1alphaSourceId", + "properties": { + "id": { + "description": "The id of the source.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaUploadSourceFileRequest": { + "description": "Request for the SourceService.UploadSourceFile method.", + "id": "GoogleCloudNotebooklmV1alphaUploadSourceFileRequest", + "properties": { + "blob": { + "$ref": "GdataMedia", + "description": "Information about the file being uploaded." + }, + "mediaRequestInfo": { + "$ref": "ApiservingMediaRequestInfo", + "description": "Media upload request metadata." + } + }, + "type": "object" + }, + "GoogleCloudNotebooklmV1alphaUploadSourceFileResponse": { + "description": "Response for the SourceService.UploadSourceFile method.", + "id": "GoogleCloudNotebooklmV1alphaUploadSourceFileResponse", + "properties": { + "mediaResponseInfo": { + "$ref": "ApiservingMediaResponseInfo", + "description": "Media upload response metadata." + }, + "sourceId": { + "$ref": "GoogleCloudNotebooklmV1alphaSourceId", + "description": "The source id of the uploaded source." + } + }, + "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 9dff5857ec8..b919618899b 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -161,29 +161,85 @@ "resources": { "locations": { "methods": { - "generateGroundedContent": { - "description": "Generates grounded content.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:generateGroundedContent", + "obtainCrawlRate": { + "description": "Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate", "httpMethod": "POST", - "id": "discoveryengine.projects.locations.generateGroundedContent", + "id": "discoveryengine.projects.locations.obtainCrawlRate", "parameterOrder": [ "location" ], "parameters": { "location": { - "description": "Required. Location resource. Format: `projects/{project}/locations/{location}`.", + "description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+location}:generateGroundedContent", + "path": "v1beta/{+location}:obtainCrawlRate", "request": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest" + "$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest" }, "response": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse" + "$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeDedicatedCrawlRate": { + "description": "Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:removeDedicatedCrawlRate", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.removeDedicatedCrawlRate", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+location}:removeDedicatedCrawlRate", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setDedicatedCrawlRate": { + "description": "Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:setDedicatedCrawlRate", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.setDedicatedCrawlRate", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+location}:setDedicatedCrawlRate", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2464,6 +2520,37 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "fetch": { + "description": "Fetch Sitemaps in a DataStore.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The Sitemap uris.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent 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": "v1beta/{+parent}/sitemaps:fetch", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -3186,6 +3273,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "removeSuggestion": { + "description": "Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion", + "parameterOrder": [ + "completionConfig" + ], + "parameters": { + "completionConfig": { + "description": "Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+completionConfig}:removeSuggestion", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -6655,6 +6770,229 @@ } }, "identityMappingStores": { + "methods": { + "create": { + "description": "Creates a new Identity Mapping Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "cmekConfigName": { + "description": "Resource name of the CmekConfig to use for protecting this Identity Mapping Store.", + "location": "query", + "type": "string" + }, + "disableCmek": { + "description": "Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", + "location": "query", + "type": "boolean" + }, + "identityMappingStoreId": { + "description": "Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/identityMappingStores", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the Identity Mapping Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.identityMappingStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the Identity Mapping Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "importIdentityMappings": { + "description": "Imports a list of Identity Mapping Entries to an Identity Mapping Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:importIdentityMappings", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.importIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+identityMappingStore}:importIdentityMappings", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Identity Mapping Stores.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed 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 `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/identityMappingStores", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listIdentityMappings": { + "description": "Lists Identity Mappings in an Identity Mapping Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.listIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed 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 `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+identityMappingStore}:listIdentityMappings", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purgeIdentityMappings": { + "description": "Purges specified or all Identity Mapping Entries from an Identity Mapping Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings", + "parameterOrder": [ + "identityMappingStore" + ], + "parameters": { + "identityMappingStore": { + "description": "Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+identityMappingStore}:purgeIdentityMappings", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -7384,7 +7722,7 @@ } } }, - "revision": "20250121", + "revision": "20250312", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7640,18 +7978,55 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorContext": { - "description": "A description of the context in which an error occurred.", - "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": { + "description": "The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`", + "id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext", "properties": { - "httpRequest": { - "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", - "description": "The HTTP request which was processed when the error was triggered." + "connectorRun": { + "description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.", + "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." - } + "dataConnector": { + "description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.", + "type": "string" + }, + "endTime": { + "description": "The time when the connector run ended.", + "format": "google-datetime", + "type": "string" + }, + "entity": { + "description": "The entity to sync for the connector run.", + "type": "string" + }, + "operation": { + "description": "The operation resource name of the LRO to sync the connector.", + "type": "string" + }, + "startTime": { + "description": "The time when the connector run started.", + "format": "google-datetime", + "type": "string" + }, + "syncType": { + "description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`", + "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" }, @@ -7659,6 +8034,10 @@ "description": "An error log which is reported to the Error Reporting system.", "id": "GoogleCloudDiscoveryengineLoggingErrorLog", "properties": { + "connectorRunPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext", + "description": "The error payload that is populated on LRO connector sync APIs." + }, "context": { "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", "description": "A description of the context in which the error occurred." @@ -7815,11 +8194,11 @@ "type": "boolean" }, "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "type": "string" }, "lastRotationTimestampMicros": { @@ -7829,7 +8208,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "type": "string" }, "singleRegionKeys": { @@ -7840,13 +8219,14 @@ "type": "array" }, "state": { - "description": "Output only. State of the CmekConfig.", + "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", + "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING" ], @@ -7856,6 +8236,7 @@ "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated." ], @@ -8029,6 +8410,70 @@ "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" + }, + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", + "properties": { + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "Optional. The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "Optional. 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" + }, + "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" + }, + "boostAmount": { + "description": "Optional. 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" @@ -8139,6 +8584,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1CreateSitemapMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata", + "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", @@ -8199,7 +8661,7 @@ "type": "string" }, "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -8211,6 +8673,14 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", + "type": "string" + }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -8323,6 +8793,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata": { + "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata", + "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" + }, "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", @@ -8391,6 +8878,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata", + "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", @@ -8654,6 +9158,10 @@ "$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." }, + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" @@ -8742,6 +9250,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1HealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", + "properties": { + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", + "type": "boolean" + }, + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata", + "properties": { + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", + "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", @@ -8848,6 +9393,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "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", @@ -9189,7 +9748,7 @@ "type": "string" }, "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, @@ -9581,6 +10140,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Sitemap": { + "description": "A sitemap for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1Sitemap", + "properties": { + "createTime": { + "description": "Output only. The sitemap's creation time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1TargetSite": { "description": "A target site for the SiteSearchEngine.", "id": "GoogleCloudDiscoveryengineV1TargetSite", @@ -9880,6 +10461,49 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { + "description": "The connector level alert config.", + "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", + "properties": { + "alertEnrollments": { + "description": "Optional. The enrollment states of each alert.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment" + }, + "type": "array" + }, + "alertPolicyName": { + "description": "Immutable. The fully qualified resource name of the AlertPolicy.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": { + "description": "The alert enrollment status.", + "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment", + "properties": { + "alertId": { + "description": "Immutable. The id of an alert.", + "type": "string" + }, + "enrollState": { + "description": "Required. The enrollment status of a customer.", + "enum": [ + "ENROLL_STATES_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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -10012,7 +10636,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { "endIndex": { - "description": "End of the attributed segment, exclusive.", + "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -10024,7 +10648,7 @@ "type": "array" }, "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -10207,6 +10831,16 @@ }, "description": "Structured search data.", "type": "object" + }, + "title": { + "description": "Output only. The title of the document.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. The URI of the document.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -10418,6 +11052,30 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaBAPConfig": { + "description": "The configuration for the BAP connector.", + "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", + "properties": { + "supportedConnectorModes": { + "description": "Required. The supported connector modes for the associated BAP connection.", + "items": { + "enum": [ + "CONNECTOR_MODE_UNSPECIFIED", + "DATA_INGESTION", + "ACTIONS" + ], + "enumDescriptions": [ + "Connector mode unspecified.", + "Connector utilized for data ingestion.", + "Connector utilized for Actions" + ], + "type": "string" + }, + "type": "array" + } + }, + "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", @@ -10459,11 +11117,11 @@ "type": "boolean" }, "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "type": "string" }, "lastRotationTimestampMicros": { @@ -10473,7 +11131,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "type": "string" }, "singleRegionKeys": { @@ -10484,13 +11142,14 @@ "type": "array" }, "state": { - "description": "Output only. State of the CmekConfig.", + "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", + "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING" ], @@ -10500,6 +11159,7 @@ "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated." ], @@ -10644,7 +11304,8 @@ "OVERRUN", "CANCELLED", "PENDING", - "WARNING" + "WARNING", + "SKIPPED" ], "enumDescriptions": [ "Default value.", @@ -10654,7 +11315,8 @@ "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", "Data sync was scheduled but has been cancelled.", "Data sync is about to start.", - "The data sync completed with non-fatal errors." + "The data sync completed with non-fatal errors.", + "An ongoing connector run has been running longer than expected, causing this run to be skipped." ], "readOnly": true, "type": "string" @@ -10690,6 +11352,11 @@ "description": "Represents an entity that was synced in this ConnectorRun.", "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun", "properties": { + "deletedRecordCount": { + "description": "The number of documents deleted.", + "format": "int64", + "type": "string" + }, "entityName": { "description": "The name of the source entity.", "type": "string" @@ -10716,6 +11383,10 @@ "format": "int64", "type": "string" }, + "progress": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", + "description": "Metadata to generate the progress bar." + }, "sourceApiRequestCount": { "description": "The number of requests sent to 3p API.", "format": "int64", @@ -10731,7 +11402,8 @@ "OVERRUN", "CANCELLED", "PENDING", - "WARNING" + "WARNING", + "SKIPPED" ], "enumDescriptions": [ "Default value.", @@ -10741,7 +11413,8 @@ "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", "Data sync was scheduled but has been cancelled.", "Data sync is about to start.", - "The data sync completed with non-fatal errors." + "The data sync completed with non-fatal errors.", + "An ongoing connector run has been running longer than expected, causing this run to be skipped." ], "type": "string" }, @@ -10760,18 +11433,42 @@ "enum": [ "SYNC_TYPE_UNSPECIFIED", "FULL", - "INCREMENTAL" + "INCREMENTAL", + "REALTIME" ], "enumDescriptions": [ "Sync type unspecified.", "Sync triggers full sync of all documents.", - "Incremental sync of updated documents." + "Incremental sync of updated documents.", + "Realtime sync." ], "type": "string" } }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress": { + "description": "Represents the progress of a sync run.", + "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", + "properties": { + "currentCount": { + "description": "The current progress.", + "format": "int64", + "type": "string" + }, + "percentile": { + "description": "Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.", + "format": "float", + "type": "number" + }, + "totalCount": { + "description": "The total.", + "format": "int64", + "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", @@ -10879,13 +11576,77 @@ "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" + }, + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec", + "properties": { + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "Optional. The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "Optional. 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" + }, + "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" + }, + "boostAmount": { + "description": "Optional. 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" + }, + "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", @@ -11059,10 +11820,21 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig", "description": "Optional. Action configurations to make the connector support actions." }, + "alertPolicyConfigs": { + "description": "Optional. The connector level alert config.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig" + }, + "type": "array" + }, "autoRunDisabled": { "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.", "type": "boolean" }, + "bapConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig", + "description": "Optional. The configuration for establishing a BAP connection." + }, "blockingReasons": { "description": "Output only. User actions that must be completed before the connector can start syncing data.", "items": { @@ -11081,6 +11853,35 @@ "readOnly": true, "type": "array" }, + "connectorType": { + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system.", + "enum": [ + "CONNECTOR_TYPE_UNSPECIFIED", + "THIRD_PARTY", + "GCP_FHIR", + "BIG_QUERY", + "GCS", + "GOOGLE_MAIL", + "GOOGLE_CALENDAR", + "GOOGLE_DRIVE", + "NATIVE_CLOUD_IDENTITY", + "THIRD_PARTY_FEDERATED" + ], + "enumDescriptions": [ + "Default value.", + "Third party connector to connector to third party application.", + "Data connector connects between FHIR store and VAIS datastore.", + "Big query connector.", + "Google Cloud Storage connector.", + "Gmail connector.", + "Google Calendar connector.", + "Google Drive connector.", + "Native Cloud Identity connector for people search powered by People API.", + "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API." + ], + "readOnly": true, + "type": "string" + }, "createTime": { "description": "Output only. Timestamp the DataConnector was created at.", "format": "google-datetime", @@ -11161,6 +11962,29 @@ "readOnly": true, "type": "string" }, + "realtimeState": { + "description": "Output only. real-time sync state", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "RUNNING", + "WARNING", + "INITIALIZATION_FAILED" + ], + "enumDescriptions": [ + "Default value.", + "The connector is being set up.", + "The connector is successfully set up and awaiting next sync run.", + "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", + "The connector is actively syncing records from the data source.", + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)." + ], + "readOnly": true, + "type": "string" + }, "refreshInterval": { "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.", "format": "google-duration", @@ -11174,7 +11998,8 @@ "ACTIVE", "FAILED", "RUNNING", - "WARNING" + "WARNING", + "INITIALIZATION_FAILED" ], "enumDescriptions": [ "Default value.", @@ -11182,7 +12007,8 @@ "The connector is successfully set up and awaiting next sync run.", "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.", "The connector is actively syncing records from the data source.", - "The connector has completed a sync run, but encountered non-fatal errors." + "The connector has completed a sync run, but encountered non-fatal errors.", + "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)." ], "readOnly": true, "type": "string" @@ -11202,10 +12028,14 @@ "syncMode": { "description": "The data synchronization mode supported by the data connector.", "enum": [ - "PERIODIC" + "PERIODIC", + "STREAMING", + "UNSPECIFIED" ], "enumDescriptions": [ - "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync." + "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", + "The data will be synced in real time.", + "Connector that doesn't ingest data will have this value" ], "type": "string" }, @@ -11231,6 +12061,10 @@ "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", "type": "string" }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, "keyPropertyMappings": { "additionalProperties": { "type": "string" @@ -11245,6 +12079,10 @@ }, "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.", "type": "object" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", + "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector 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" @@ -11296,7 +12134,7 @@ "type": "string" }, "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -11308,6 +12146,14 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", + "type": "string" + }, "idpConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "description": "Output only. Data store level identity provider config.", @@ -11437,10 +12283,18 @@ "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", "id": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries", "properties": { + "autoRefreshCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl." + }, "autoRefreshCrawlRate": { "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." }, + "userTriggeredCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of user triggered dedicated crawl." + }, "userTriggeredCrawlRate": { "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." @@ -11448,6 +12302,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { + "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", + "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" + }, "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": { "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata", @@ -11879,6 +12750,10 @@ "$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." }, + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" @@ -12191,31 +13066,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": { - "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse", - "properties": { - "sitemapsMetadata": { - "description": "List of Sitemaps fetched.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": { - "description": "Contains a Sitemap and its metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata", - "properties": { - "sitemap": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSitemap", - "description": "The Sitemap." - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -12406,6 +13256,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", + "properties": { + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", + "type": "boolean" + }, + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata", + "properties": { + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": { "description": "The configuration for the identity data synchronization runs.", "id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", @@ -12564,6 +13451,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", @@ -13209,6 +14110,18 @@ "format": "int32", "type": "integer" }, + "noindexUris": { + "description": "URIs that have no index meta tag. Sample limited to 1000.", + "items": { + "type": "string" + }, + "type": "array" + }, + "noindexUrisCount": { + "description": "Total number of URIs that have no index meta tag.", + "format": "int32", + "type": "integer" + }, "pendingCount": { "description": "Total number of URIs that have yet to be crawled.", "format": "int32", @@ -13491,7 +14404,7 @@ "type": "string" }, "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, @@ -13522,12 +14435,16 @@ "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 data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", + "description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, + "displaySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", + "description": "Optional. Config for display feature, like match highlighting on search results." + }, "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." @@ -13598,15 +14515,33 @@ "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)`.", + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result", + "type": "string" + }, + "rankingExpressionBackend": { + "description": "Optional. The backend to use for the ranking expression evaluation.", + "enum": [ + "UNKNOWN", + "BYOE", + "CLEARBOX" + ], + "enumDescriptions": [ + "Default option for unspecified/unknown values.", + "Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", + "The expression is compiled into a Clearbox formula." + ], "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" }, + "relevanceScoreSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", + "description": "Optional. The specification for returning the relevance score." + }, "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.", + "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. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -13649,7 +14584,7 @@ }, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." }, "userLabels": { "additionalProperties": { @@ -13955,6 +14890,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": { + "description": "Specifies features for display, like match highlighting.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", + "properties": { + "matchHighlightingCondition": { + "description": "The condition under which match highlighting should occur.", + "enum": [ + "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", + "MATCH_HIGHLIGHTING_DISABLED", + "MATCH_HIGHLIGHTING_ENABLED" + ], + "enumDescriptions": [ + "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", + "Disables match highlighting on all documents.", + "Enables match highlighting on all documents." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", @@ -14147,6 +15103,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": { + "description": "The specification for returning the document relevance score.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", + "properties": { + "returnRelevanceScore": { + "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", @@ -14156,12 +15123,14 @@ "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", - "ENABLED" + "ENABLED", + "AUTO" ], "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", - "Enables Search As You Type." + "Enables Search As You Type.", + "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ], "type": "string" } @@ -14177,7 +15146,7 @@ "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.", + "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 similar 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" } @@ -14743,7 +15712,7 @@ "type": "string" }, "queryModel": { - "description": "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.", + "description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. 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.", "type": "string" }, "suggestionTypeSpecs": { @@ -14910,10 +15879,23 @@ "description": "The name of the dataStore that this suggestion belongs to.", "type": "string" }, + "destinationUri": { + "description": "The destination uri of the content suggestion.", + "type": "string" + }, "document": { "$ref": "GoogleCloudDiscoveryengineV1betaDocument", "description": "The document data snippet in the suggestion. Only a subset of fields will be populated." }, + "iconUri": { + "description": "The icon uri of the content suggestion.", + "type": "string" + }, + "score": { + "description": "The score of each suggestion. The score is in the range of [0, 1].", + "format": "double", + "type": "number" + }, "suggestion": { "description": "The suggestion for the query.", "type": "string" @@ -14929,6 +15911,14 @@ "description": "The name of the dataStore that this suggestion belongs to.", "type": "string" }, + "destinationUri": { + "description": "The destination uri of the person suggestion.", + "type": "string" + }, + "displayPhotoUri": { + "description": "The photo uri of the person suggestion.", + "type": "string" + }, "document": { "$ref": "GoogleCloudDiscoveryengineV1betaDocument", "description": "The document data snippet in the suggestion. Only a subset of fields is populated." @@ -14947,6 +15937,11 @@ ], "type": "string" }, + "score": { + "description": "The score of each suggestion. The score is in the range of [0, 1].", + "format": "double", + "type": "number" + }, "suggestion": { "description": "The suggestion for the query.", "type": "string" @@ -14972,6 +15967,11 @@ }, "type": "array" }, + "score": { + "description": "The score of each suggestion. The score is in the range of [0, 1].", + "format": "double", + "type": "number" + }, "suggestion": { "description": "The suggestion for the query.", "type": "string" @@ -14988,6 +15988,11 @@ "format": "google-datetime", "type": "string" }, + "score": { + "description": "The score of each suggestion. The score is in the range of [0, 1].", + "format": "double", + "type": "number" + }, "suggestion": { "description": "The suggestion for the query.", "type": "string" @@ -15173,7 +16178,7 @@ "id": "GoogleCloudDiscoveryengineV1betaAnswerCitation", "properties": { "endIndex": { - "description": "End of the attributed segment, exclusive.", + "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" }, @@ -15185,7 +16190,7 @@ "type": "array" }, "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64", "type": "string" } @@ -15436,6 +16441,10 @@ "description": "Query understanding specification.", "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec", "properties": { + "disableSpellCorrection": { + "description": "Optional. Whether to disable spell correction. The default value is `false`.", + "type": "boolean" + }, "queryClassificationSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", "description": "Query classification specification." @@ -15956,6 +16965,16 @@ }, "description": "Structured search data.", "type": "object" + }, + "title": { + "description": "Output only. The title of the document.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. The URI of the document.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -16555,7 +17574,7 @@ "type": "string" }, "endPos": { - "description": "Position indicating the end of the claim in the answer candidate, exclusive.", + "description": "Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).", "format": "int32", "type": "integer" }, @@ -16564,7 +17583,7 @@ "type": "boolean" }, "startPos": { - "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", + "description": "Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).", "format": "int32", "type": "integer" } @@ -16732,11 +17751,11 @@ "type": "boolean" }, "kmsKey": { - "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", + "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "kmsKeyVersion": { - "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", + "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "type": "string" }, "lastRotationTimestampMicros": { @@ -16746,7 +17765,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", + "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.", "type": "string" }, "singleRegionKeys": { @@ -16757,13 +17776,14 @@ "type": "array" }, "state": { - "description": "Output only. State of the CmekConfig.", + "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", + "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING" ], @@ -16773,6 +17793,7 @@ "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", + "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated." ], @@ -17039,21 +18060,85 @@ "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" + }, + "interpolationBoostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", + "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec": { + "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": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", "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", + "attributeType": { + "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "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" }, - "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" + "controlPoints": { + "description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "Optional. The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "Optional. 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" + }, + "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint": { + "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": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" + }, + "boostAmount": { + "description": "Optional. 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" + }, + "GoogleCloudDiscoveryengineV1betaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "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" @@ -17256,6 +18341,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": { + "description": "The historical crawl rate timeseries data, used for monitoring.", + "id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "properties": { + "qpsTimeSeries": { + "$ref": "GoogleMonitoringV3TimeSeries", + "description": "The QPS of the crawl rate." + } + }, + "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", @@ -17494,7 +18590,7 @@ "type": "string" }, "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, @@ -17506,6 +18602,14 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, + "healthcareFhirConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", + "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." + }, + "identityMappingStore": { + "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", + "type": "string" + }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -17626,6 +18730,29 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": { + "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", + "id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", + "properties": { + "autoRefreshCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl." + }, + "autoRefreshCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." + }, + "userTriggeredCrawlErrorRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's error rate time series of user triggered dedicated crawl." + }, + "userTriggeredCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." + } + }, + "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", @@ -18155,6 +19282,10 @@ "$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." }, + "allowCrossRegion": { + "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "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" @@ -18475,437 +19606,95 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest": { - "description": "Top-level message sent by the client for the `GenerateGroundedContent` method.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest", + "GoogleCloudDiscoveryengineV1betaGroundingFact": { + "description": "Grounding Fact.", + "id": "GoogleCloudDiscoveryengineV1betaGroundingFact", "properties": { - "contents": { - "description": "Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent" - }, - "type": "array" - }, - "generationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec", - "description": "Content generation specification." - }, - "groundingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec", - "description": "Grounding specification." - }, - "systemInstruction": { - "$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent", - "description": "Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them." - }, - "userLabels": { + "attributes": { "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.", + "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" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration": { - "description": "Describes the options to customize dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration", - "properties": { - "predictor": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor", - "description": "Specification for the predictor for dynamic retrieval." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor": { - "description": "Describes the predictor settings for dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor", - "properties": { - "threshold": { - "description": "The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source.", - "format": "float", - "type": "number" }, - "version": { - "description": "The version of the predictor to be used in dynamic retrieval.", - "enum": [ - "VERSION_UNSPECIFIED", - "V1_INDEPENDENT" - ], - "enumDescriptions": [ - "Automatically choose the best version of the retrieval predictor.", - "The V1 model which is evaluating each source independently." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec": { - "description": "Content generation specification.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec", - "properties": { - "frequencyPenalty": { - "description": "If specified, custom value for frequency penalty will be used.", - "format": "float", - "type": "number" - }, - "languageCode": { - "description": "Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).", - "type": "string" - }, - "maxOutputTokens": { - "description": "If specified, custom value for max output tokens will be used.", - "format": "int32", - "type": "integer" - }, - "modelId": { - "description": "Specifies which Vertex model id to use for generation.", + "factText": { + "description": "Text content of the fact. Can be at most 10K characters long.", "type": "string" - }, - "presencePenalty": { - "description": "If specified, custom value for presence penalty will be used.", - "format": "float", - "type": "number" - }, - "seed": { - "description": "If specified, custom value for the seed will be used.", - "format": "int32", - "type": "integer" - }, - "temperature": { - "description": "If specified, custom value for the temperature will be used.", - "format": "float", - "type": "number" - }, - "topK": { - "description": "If specified, custom value for top-k sampling will be used.", - "format": "int32", - "type": "integer" - }, - "topP": { - "description": "If specified, custom value for nucleus sampling will be used.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource": { - "description": "Grounding source.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource", + "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": { + "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", + "id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "properties": { - "googleSearchSource": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource", - "description": "If set, grounding is performed with Google Search." - }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource", - "description": "If set, grounding is performed with inline content." - }, - "searchSource": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource", - "description": "If set, grounding is performed with Vertex AI Search." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource": { - "description": "Google Search config parameters.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource", - "properties": { - "dynamicRetrievalConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration", - "description": "Optional. Specifies the dynamic retrieval configuration for the given source." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource": { - "description": "Message to be used for grounding based on inline content.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource", - "properties": { - "attributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content).", - "type": "object" + "enableConfigurableSchema": { + "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", + "type": "boolean" }, - "groundingFacts": { - "description": "List of facts to be used for grounding.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaGroundingFact" - }, - "type": "array" + "enableStaticIndexingForBatchIngestion": { + "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource": { - "description": "Message to be used for grounding with Vertex AI Search.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource", + "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry": { + "description": "Identity Mapping Entry that maps an external identity to an internal identity.", + "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry", "properties": { - "filter": { - "description": "Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter.", + "externalIdentity": { + "description": "Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.", "type": "string" }, - "maxResultCount": { - "description": "Number of search results to return. The default value is 10. The maximumm allowed value is 10.", - "format": "int32", - "type": "integer" - }, - "safeSearch": { - "description": "If set, safe search is enabled in Vertex AI Search requests.", - "type": "boolean" - }, - "servingConfig": { - "description": "The resource name of the Engine to use. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", + "groupId": { + "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec": { - "description": "Grounding specification.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec", - "properties": { - "groundingSources": { - "description": "Grounding sources.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse": { - "description": "Response for the `GenerateGroundedContent` method.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse", - "properties": { - "candidates": { - "description": "Generated candidates.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate": { - "description": "A response candidate generated from the model.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate", - "properties": { - "content": { - "$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent", - "description": "Content of the candidate." - }, - "groundingMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata", - "description": "Grounding metadata for the generated content." - }, - "groundingScore": { - "description": "The overall grounding score for the candidate, in the range of [0, 1].", - "format": "float", - "type": "number" - }, - "index": { - "description": "Index of the candidate.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata": { - "description": "Citation for the generated content.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata", - "properties": { - "groundingSupport": { - "description": "GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport" - }, - "type": "array" }, - "retrievalMetadata": { - "description": "Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata" - }, - "type": "array" - }, - "searchEntryPoint": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint", - "description": "Google search entry for the following-up web searches." - }, - "supportChunks": { - "description": "List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaFactChunk" - }, - "type": "array" - }, - "webSearchQueries": { - "description": "Web search queries for the following-up web search.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata": { - "description": "Describes the metadata about dynamic retrieval.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata", - "properties": { - "predictorMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata", - "description": "Metadata for the dynamic retrieval predictor." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata": { - "description": "Describes the metadata about the dynamic retrieval predictor.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata", - "properties": { - "prediction": { - "description": "The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding.", - "format": "float", - "type": "number" - }, - "version": { - "description": "The version of the predictor which was used in dynamic retrieval.", - "enum": [ - "VERSION_UNSPECIFIED", - "V1_INDEPENDENT" - ], - "enumDescriptions": [ - "Unspecified version, should never be used.", - "The V1 model which is evaluating each source independently." - ], + "userId": { + "description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport": { - "description": "Grounding info for a claim in the candidate and its support.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport", + "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": { + "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata", "properties": { - "claimText": { - "description": "Text for the claim in the candidate. Always provided when a support is found.", + "failureCount": { + "description": "The number of IdentityMappingEntries that failed to be processed.", + "format": "int64", "type": "string" }, - "supportChunkIndices": { - "description": "A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "supportScore": { - "description": "A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata": { - "description": "Describes the metadata associated with a retrieval step.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata", - "properties": { - "dynamicRetrievalMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata", - "description": "Metadata for dynamic retrieval." - }, - "source": { - "description": "Describes the source to which the metadata is referring to.", - "enum": [ - "SOURCE_UNSPECIFIED", - "VERTEX_AI_SEARCH", - "GOOGLE_SEARCH", - "INLINE_CONTENT", - "GOOGLE_MAPS" - ], - "enumDescriptions": [ - "Unspecified source.", - "Vertex AI search.", - "Google Search.", - "User inline provided content.", - "Google Maps." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint": { - "description": "Google search entry point.", - "id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint", - "properties": { - "renderedContent": { - "description": "Web content snippet that can be embedded in a web page or an app webview.", + "successCount": { + "description": "The number of IdentityMappingEntries that were successfully processed.", + "format": "int64", "type": "string" }, - "sdkBlob": { - "description": "Base64 encoded JSON representing array of tuple.", - "format": "byte", + "totalCount": { + "description": "The total number of IdentityMappingEntries that were processed.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent": { - "description": "Base structured datatype containing multi-part content of a message.", - "id": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent", + "GoogleCloudDiscoveryengineV1betaIdentityMappingStore": { + "description": "Identity Mapping Store which contains Identity Mapping Entries.", + "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore", "properties": { - "parts": { - "description": "Ordered `Parts` that constitute a single message.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart" - }, - "type": "array" + "cmekConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig", + "description": "Output only. CMEK-related information for the Identity Mapping Store.", + "readOnly": true }, - "role": { - "description": "Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart": { - "description": "Single part of content.", - "id": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart", - "properties": { - "text": { - "description": "Inline text.", + "kmsKeyName": { + "description": "Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaGroundingFact": { - "description": "Grounding Fact.", - "id": "GoogleCloudDiscoveryengineV1betaGroundingFact", - "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.", + "name": { + "description": "Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, @@ -19146,6 +19935,45 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest": { + "description": "Request message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest", + "properties": { + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource", + "description": "The inline source to import identity mapping entries from." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource": { + "description": "The inline source to import identity mapping entries from.", + "id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource", + "properties": { + "identityMappingEntries": { + "description": "A maximum of 10000 entries can be imported at one time", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "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", @@ -19605,6 +20433,42 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse": { + "description": "Response message for IdentityMappingStoreService.ListIdentityMappingStores", + "id": "GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse", + "properties": { + "identityMappingStores": { + "description": "The Identity Mapping Stores.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse": { + "description": "Response message for IdentityMappingStoreService.ListIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse", + "properties": { + "identityMappingEntries": { + "description": "The Identity Mapping Entries.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse": { "description": "Response message for SampleQueryService.ListSampleQueries method.", "id": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse", @@ -19756,6 +20620,66 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest": { + "description": "Request message for CrawlRateManagementService.ObtainCrawlRate method.", + "id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest", + "properties": { + "crawlRateScope": { + "description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", + "id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse", + "properties": { + "dedicatedCrawlRateTimeSeries": { + "$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", + "description": "The historical dedicated crawl rate timeseries data, used for monitoring." + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "organicCrawlRateTimeSeries": { + "$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", + "description": "The historical organic crawl rate timeseries data, used for monitoring." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": { + "description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.", + "id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", + "properties": { + "googleOrganicCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." + }, + "vertexAiOrganicCrawlRate": { + "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", + "description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1betaPageInfo", @@ -20020,6 +20944,39 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest": { + "description": "Request message for IdentityMappingStoreService.PurgeIdentityMappings", + "id": "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest", + "properties": { + "filter": { + "description": "Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 \"zulu\" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time > \"2012-04-23T18:25:43.511Z\" AND update_time < \"2012-04-23T18:30:43.511Z\"` * Deleting all identity mappings for a given external_id: `external_id = \"id1\"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided.", + "type": "string" + }, + "force": { + "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.", + "type": "boolean" + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource", + "description": "The inline source to purge identity mapping entries from." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource": { + "description": "The inline source to purge identity mapping entries from.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource", + "properties": { + "identityMappingEntries": { + "description": "A maximum of 10000 entries can be purged at one time", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry" + }, + "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", @@ -20155,7 +21112,7 @@ "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.", + "description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.", "type": "string" }, "query": { @@ -20316,7 +21273,7 @@ "id": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest", "properties": { "siteCredential": { - "description": "Optional. Full resource name of the `SiteCredential`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.", + "description": "Optional. Credential id to use for crawling.", "type": "string" }, "uris": { @@ -20329,6 +21286,94 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": { + "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata", + "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" + }, + "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest": { + "description": "Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest", + "properties": { + "crawlRateScope": { + "description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest": { + "description": "Request message for CompletionService.RemoveSuggestion method.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest", + "properties": { + "removeAllSearchHistorySuggestions": { + "description": "Remove all search history suggestions for the user.", + "type": "boolean" + }, + "removeTime": { + "description": "Required. Time at which the suggestion was removed. If not set, the current time will be used.", + "format": "google-datetime", + "type": "string" + }, + "searchHistorySuggestion": { + "description": "The search history suggestion to be removed.", + "type": "string" + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", + "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." + }, + "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 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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse": { + "description": "Response message for CompletionService.RemoveSuggestion method.", + "id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaReply": { "description": "Defines a reply message to user.", "id": "GoogleCloudDiscoveryengineV1betaReply", @@ -20620,7 +21665,7 @@ "type": "string" }, "uri": { - "description": "Required. The URL for the page the user wants to promote.", + "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, @@ -20647,12 +21692,16 @@ "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 data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", + "description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, "type": "array" }, + "displaySpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", + "description": "Optional. Config for display feature, like match highlighting on search results." + }, "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." @@ -20723,15 +21772,33 @@ "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)`.", + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result", + "type": "string" + }, + "rankingExpressionBackend": { + "description": "Optional. The backend to use for the ranking expression evaluation.", + "enum": [ + "UNKNOWN", + "BYOE", + "CLEARBOX" + ], + "enumDescriptions": [ + "Default option for unspecified/unknown values.", + "Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", + "The expression is compiled into a Clearbox formula." + ], "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" }, + "relevanceScoreSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", + "description": "Optional. The specification for returning the relevance score." + }, "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.", + "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. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -20774,7 +21841,7 @@ }, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." }, "userLabels": { "additionalProperties": { @@ -21080,6 +22147,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": { + "description": "Specifies features for display, like match highlighting.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", + "properties": { + "matchHighlightingCondition": { + "description": "The condition under which match highlighting should occur.", + "enum": [ + "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", + "MATCH_HIGHLIGHTING_DISABLED", + "MATCH_HIGHLIGHTING_ENABLED" + ], + "enumDescriptions": [ + "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", + "Disables match highlighting on all documents.", + "Enables match highlighting on all documents." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", @@ -21272,6 +22360,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": { + "description": "The specification for returning the document relevance score.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", + "properties": { + "returnRelevanceScore": { + "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -21281,12 +22380,14 @@ "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", - "ENABLED" + "ENABLED", + "AUTO" ], "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", - "Enables Search As You Type." + "Enables Search As You Type.", + "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ], "type": "string" } @@ -21302,7 +22403,7 @@ "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.", + "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 similar 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" } @@ -21520,6 +22621,13 @@ "description": "Information describing what natural language understanding was done on the input query.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo", "properties": { + "classifiedIntents": { + "description": "The classified intents from the input query.", + "items": { + "type": "string" + }, + "type": "array" + }, "extractedFilters": { "description": "The filters that were extracted from the input query.", "type": "string" @@ -21776,7 +22884,8 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaDoubleList" }, - "description": "Google provided available scores.", + "description": "Output only. Google provided available scores.", + "readOnly": true, "type": "object" } }, @@ -21818,7 +22927,8 @@ "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", - "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" + "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2", + "TIME_OUT" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", @@ -21830,7 +22940,8 @@ "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.", - "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." + "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`.", + "The time out case. Google skips the summary if the time out." ], "type": "string" }, @@ -22234,6 +23345,93 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { + "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", + "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" + }, + "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest": { + "description": "Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.", + "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest", + "properties": { + "crawlRate": { + "description": "Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.", + "format": "int32", + "type": "integer" + }, + "crawlRateScope": { + "description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", + "type": "string" + }, + "crawlType": { + "description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.", + "enum": [ + "CRAWL_TYPE_UNSPECIFIED", + "USER_TRIGGERED", + "AUTO_REFRESH" + ], + "enumDescriptions": [ + "The crawl type is unspecified.", + "The crawl type is user-triggered.", + "The crawl type is auto-refresh." + ], + "type": "string" + }, + "mode": { + "description": "Optional. Whether the rate is explicitly set by users, or set by vertex AI.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTOMATIC", + "EXPLICIT" + ], + "enumDescriptions": [ + "The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC.", + "Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify SetDedicatedCrawlRateRequest.CrawlType if the mode is AUTOMATIC.", + "Users explicitly set user-triggered or auto-refresh crawl rate." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": { + "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", + "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Errors from service when handling the request." + }, + "state": { + "description": "Output only. The state of the response.", + "enum": [ + "STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The state is successful.", + "The state is failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey", diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index ddd3796fcca..fccd3a04db4 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -303,6 +303,39 @@ export namespace discoveryengine_v1 { */ userLabels?: {[key: string]: string} | null; } + /** + * The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun` + */ + export interface Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext { + /** + * The full resource name of the Connector Run. Format: `projects/x/locations/x/collections/x/dataConnector/connectorRuns/x`. The `connector_run_id` is system-generated. + */ + connectorRun?: string | null; + /** + * The full resource name of the DataConnector. Format: `projects/x/locations/x/collections/x/dataConnector`. + */ + dataConnector?: string | null; + /** + * The time when the connector run ended. + */ + endTime?: string | null; + /** + * The entity to sync for the connector run. + */ + entity?: string | null; + /** + * The operation resource name of the LRO to sync the connector. + */ + operation?: string | null; + /** + * The time when the connector run started. + */ + startTime?: string | null; + /** + * The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL` + */ + syncType?: string | null; + } /** * A description of the context in which an error occurred. */ @@ -320,6 +353,10 @@ export namespace discoveryengine_v1 { * An error log which is reported to the Error Reporting system. */ export interface Schema$GoogleCloudDiscoveryengineLoggingErrorLog { + /** + * The error payload that is populated on LRO connector sync APIs. + */ + connectorRunPayload?: Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext; /** * A description of the context in which the error occurred. */ @@ -482,6 +519,32 @@ export namespace discoveryengine_v1 { */ disableInitialIndex?: boolean | null; } + /** + * The connector level alert config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig { + /** + * Optional. The enrollment states of each alert. + */ + alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment[]; + /** + * Immutable. The fully qualified resource name of the AlertPolicy. + */ + alertPolicyName?: string | null; + } + /** + * The alert enrollment status. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment { + /** + * Immutable. The id of an alert. + */ + alertId?: string | null; + /** + * Required. The enrollment status of a customer. + */ + enrollState?: string | null; + } /** * Defines an answer. */ @@ -548,7 +611,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation { /** - * End of the attributed segment, exclusive. + * End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ endIndex?: string | null; /** @@ -556,7 +619,7 @@ export namespace discoveryengine_v1 { */ sources?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[]; /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ startIndex?: string | null; } @@ -691,6 +754,14 @@ export namespace discoveryengine_v1 { * Structured search data. */ structData?: {[key: string]: any} | null; + /** + * Output only. The title of the document. + */ + title?: string | null; + /** + * Output only. The URI of the document. + */ + uri?: string | null; } /** * Unstructured document information. @@ -842,6 +913,15 @@ export namespace discoveryengine_v1 { */ query?: string | null; } + /** + * The configuration for the BAP connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig { + /** + * Required. The supported connector modes for the associated BAP connection. + */ + supportedConnectorModes?: string[] | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -873,11 +953,11 @@ export namespace discoveryengine_v1 { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -885,7 +965,7 @@ export namespace discoveryengine_v1 { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -893,7 +973,7 @@ export namespace discoveryengine_v1 { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1alphaSingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -1006,6 +1086,10 @@ export namespace discoveryengine_v1 { * Represents an entity that was synced in this ConnectorRun. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun { + /** + * The number of documents deleted. + */ + deletedRecordCount?: string | null; /** * The name of the source entity. */ @@ -1026,6 +1110,10 @@ export namespace discoveryengine_v1 { * The number of documents indexed. */ indexedRecordCount?: string | null; + /** + * Metadata to generate the progress bar. + */ + progress?: Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress; /** * The number of requests sent to 3p API. */ @@ -1047,6 +1135,23 @@ export namespace discoveryengine_v1 { */ syncType?: string | null; } + /** + * Represents the progress of a sync run. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress { + /** + * The current progress. + */ + currentCount?: string | null; + /** + * Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive. + */ + percentile?: number | null; + /** + * The total. + */ + totalCount?: 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`. */ @@ -1116,6 +1221,44 @@ export namespace discoveryengine_v1 { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -1256,14 +1399,26 @@ export namespace discoveryengine_v1 { * Optional. Action configurations to make the connector support actions. */ actionConfig?: Schema$GoogleCloudDiscoveryengineV1alphaActionConfig; + /** + * Optional. The connector level alert config. + */ + alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig[]; /** * Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. */ autoRunDisabled?: boolean | null; + /** + * Optional. The configuration for establishing a BAP connection. + */ + bapConfig?: Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig; /** * Output only. User actions that must be completed before the connector can start syncing data. */ blockingReasons?: string[] | null; + /** + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system. + */ + connectorType?: string | null; /** * Output only. Timestamp the DataConnector was created at. */ @@ -1320,6 +1475,10 @@ export namespace discoveryengine_v1 { * Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. */ privateConnectivityProjectId?: string | null; + /** + * Output only. real-time sync state + */ + realtimeState?: string | null; /** * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. */ @@ -1357,6 +1516,10 @@ export namespace discoveryengine_v1 { * The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` */ entityName?: string | null; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; /** * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */ @@ -1365,6 +1528,10 @@ export namespace discoveryengine_v1 { * The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. */ params?: {[key: string]: any} | null; + /** + * Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector 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; } /** * DataStore captures global settings and configs at the DataStore level. @@ -1395,7 +1562,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -1406,6 +1573,14 @@ export namespace discoveryengine_v1 { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Output only. Data store level identity provider config. */ @@ -1493,15 +1668,36 @@ export namespace discoveryengine_v1 { * The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries { + /** + * Vertex AI's error rate time series of auto-refresh dedicated crawl. + */ + autoRefreshCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; /** * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. */ autoRefreshCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; + /** + * Vertex AI's error rate time series of user triggered dedicated crawl. + */ + userTriggeredCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; /** * Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. */ userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; } + /** + * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata { + /** + * 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 CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -1824,6 +2020,10 @@ export namespace discoveryengine_v1 { * 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$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -2021,24 +2221,6 @@ export namespace discoveryengine_v1 { */ sampleQuerySet?: string | null; } - /** - * Response message for SiteSearchEngineService.FetchSitemaps method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse { - /** - * List of Sitemaps fetched. - */ - sitemapsMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata[]; - } - /** - * Contains a Sitemap and its metadata. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata { - /** - * The Sitemap. - */ - sitemap?: Schema$GoogleCloudDiscoveryengineV1alphaSitemap; - } /** * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. */ @@ -2114,6 +2296,36 @@ export namespace discoveryengine_v1 { */ documentDataMap?: {[key: string]: {[key: string]: any}} | null; } + /** + * Config to data store for `HEALTHCARE_FHIR` vertical. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig { + /** + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. + */ + enableConfigurableSchema?: boolean | null; + /** + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + */ + enableStaticIndexingForBatchIngestion?: boolean | null; + } + /** + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata { + /** + * The number of IdentityMappingEntries that failed to be processed. + */ + failureCount?: string | null; + /** + * The number of IdentityMappingEntries that were successfully processed. + */ + successCount?: string | null; + /** + * The total number of IdentityMappingEntries that were processed. + */ + totalCount?: string | null; + } /** * The configuration for the identity data synchronization runs. */ @@ -2230,6 +2442,15 @@ export namespace discoveryengine_v1 { */ gcsPrefix?: string | null; } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -2712,6 +2933,14 @@ export namespace discoveryengine_v1 { * Total number of unique URIs in the request that have invalid format. */ invalidUrisCount?: number | null; + /** + * URIs that have no index meta tag. Sample limited to 1000. + */ + noindexUris?: string[] | null; + /** + * Total number of URIs that have no index meta tag. + */ + noindexUrisCount?: number | null; /** * Total number of URIs that have yet to be crawled. */ @@ -2877,7 +3106,7 @@ export namespace discoveryengine_v1 { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -2906,9 +3135,13 @@ export namespace discoveryengine_v1 { */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + * Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; + /** + * Optional. Config for display feature, like match highlighting on search results. + */ + displaySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec; /** * 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. */ @@ -2970,15 +3203,23 @@ export namespace discoveryengine_v1 { */ 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 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. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double \> 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */ rankingExpression?: string | null; + /** + * Optional. The backend to use for the ranking expression evaluation. + */ + rankingExpressionBackend?: string | null; /** * 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. */ regionCode?: string | null; /** - * 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. + * Optional. The specification for returning the relevance score. + */ + relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec; + /** + * 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. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -3006,7 +3247,7 @@ export namespace discoveryengine_v1 { */ spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. */ userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; /** @@ -3238,6 +3479,15 @@ export namespace discoveryengine_v1 { */ filter?: string | null; } + /** + * Specifies features for display, like match highlighting. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec { + /** + * The condition under which match highlighting should occur. + */ + matchHighlightingCondition?: string | null; + } /** * The specification that uses customized query embedding vector to do semantic document retrieval. */ @@ -3358,6 +3608,15 @@ export namespace discoveryengine_v1 { */ pinUnexpandedResults?: boolean | null; } + /** + * The specification for returning the document relevance score. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec { + /** + * Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. + */ + returnRelevanceScore?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -3376,7 +3635,7 @@ export namespace discoveryengine_v1 { */ 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. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar 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; } @@ -3808,7 +4067,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitation { /** - * End of the attributed segment, exclusive. + * End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ endIndex?: string | null; /** @@ -3816,7 +4075,7 @@ export namespace discoveryengine_v1 { */ sources?: Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource[]; /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ startIndex?: string | null; } @@ -4019,6 +4278,10 @@ export namespace discoveryengine_v1 { * Query understanding specification. */ export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec { + /** + * Optional. Whether to disable spell correction. The default value is `false`. + */ + disableSpellCorrection?: boolean | null; /** * Query classification specification. */ @@ -4374,6 +4637,14 @@ export namespace discoveryengine_v1 { * Structured search data. */ structData?: {[key: string]: any} | null; + /** + * Output only. The title of the document. + */ + title?: string | null; + /** + * Output only. The URI of the document. + */ + uri?: string | null; } /** * Unstructured document information. @@ -4647,11 +4918,11 @@ export namespace discoveryengine_v1 { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -4659,7 +4930,7 @@ export namespace discoveryengine_v1 { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -4667,7 +4938,7 @@ export namespace discoveryengine_v1 { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1betaSingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -4783,6 +5054,44 @@ export namespace discoveryengine_v1 { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -4828,6 +5137,15 @@ export namespace discoveryengine_v1 { */ synonyms?: string[] | null; } + /** + * The historical crawl rate timeseries data, used for monitoring. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries { + /** + * The QPS of the crawl rate. + */ + qpsTimeSeries?: Schema$GoogleMonitoringV3TimeSeries; + } /** * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4922,7 +5240,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -4933,6 +5251,14 @@ export namespace discoveryengine_v1 { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Immutable. The industry vertical that the data store registers. */ @@ -5012,6 +5338,27 @@ export namespace discoveryengine_v1 { */ disabledForServing?: boolean | null; } + /** + * The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries { + /** + * Vertex AI's error rate time series of auto-refresh dedicated crawl. + */ + autoRefreshCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. + */ + autoRefreshCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's error rate time series of user triggered dedicated crawl. + */ + userTriggeredCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. + */ + userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -5270,6 +5617,10 @@ export namespace discoveryengine_v1 { * 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; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -5387,25 +5738,37 @@ export namespace discoveryengine_v1 { sampleQuerySet?: string | null; } /** - * Response message for SiteSearchEngineService.FetchSitemaps method. + * Config to data store for `HEALTHCARE_FHIR` vertical. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig { /** - * List of Sitemaps fetched. + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. */ - sitemapsMetadata?: Schema$GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata[]; - } - /** - * Contains a Sitemap and its metadata. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata { + enableConfigurableSchema?: boolean | null; /** - * The Sitemap. + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. */ - sitemap?: Schema$GoogleCloudDiscoveryengineV1betaSitemap; + enableStaticIndexingForBatchIngestion?: boolean | null; } /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata { + /** + * The number of IdentityMappingEntries that failed to be processed. + */ + failureCount?: string | null; + /** + * The number of IdentityMappingEntries that were successfully processed. + */ + successCount?: string | null; + /** + * The total number of IdentityMappingEntries that were processed. + */ + totalCount?: 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 { /** @@ -5485,6 +5848,15 @@ export namespace discoveryengine_v1 { */ gcsPrefix?: string | null; } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -5646,6 +6018,40 @@ export namespace discoveryengine_v1 { */ mode?: string | null; } + /** + * Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse { + /** + * The historical dedicated crawl rate timeseries data, used for monitoring. + */ + dedicatedCrawlRateTimeSeries?: Schema$GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries; + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * The historical organic crawl rate timeseries data, used for monitoring. + */ + organicCrawlRateTimeSeries?: Schema$GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries; + /** + * Output only. The state of the response. + */ + state?: string | null; + } + /** + * The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries { + /** + * Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots. + */ + googleOrganicCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot. + */ + vertexAiOrganicCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -5808,6 +6214,32 @@ export namespace discoveryengine_v1 { */ top5?: number | null; } + /** + * Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata { + /** + * 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 CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse { + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. The state of the response. + */ + state?: string | null; + } /** * Defines the structure and layout of a type of document data. */ @@ -5846,7 +6278,7 @@ export namespace discoveryengine_v1 { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -5871,9 +6303,13 @@ export namespace discoveryengine_v1 { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + * Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; + /** + * Optional. Config for display feature, like match highlighting on search results. + */ + displaySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec; /** * 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. */ @@ -5935,15 +6371,23 @@ export namespace discoveryengine_v1 { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * 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)`. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double \> 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */ rankingExpression?: string | null; + /** + * Optional. The backend to use for the ranking expression evaluation. + */ + rankingExpressionBackend?: string | null; /** * 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. */ regionCode?: string | null; /** - * 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. + * Optional. The specification for returning the relevance score. + */ + relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec; + /** + * 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. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -5971,7 +6415,7 @@ export namespace discoveryengine_v1 { */ spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. */ userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** @@ -6203,6 +6647,15 @@ export namespace discoveryengine_v1 { */ filter?: string | null; } + /** + * Specifies features for display, like match highlighting. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec { + /** + * The condition under which match highlighting should occur. + */ + matchHighlightingCondition?: string | null; + } /** * The specification that uses customized query embedding vector to do semantic document retrieval. */ @@ -6323,6 +6776,15 @@ export namespace discoveryengine_v1 { */ pinUnexpandedResults?: boolean | null; } + /** + * The specification for returning the document relevance score. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec { + /** + * Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. + */ + returnRelevanceScore?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -6341,7 +6803,7 @@ export namespace discoveryengine_v1 { */ 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. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar 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; } @@ -6354,6 +6816,32 @@ export namespace discoveryengine_v1 { */ mode?: string | null; } + /** + * Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata { + /** + * 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 CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse { + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. The state of the response. + */ + state?: string | null; + } /** * Metadata for single-regional CMEKs. */ @@ -6740,7 +7228,7 @@ export namespace discoveryengine_v1 { */ claimText?: string | null; /** - * Position indicating the end of the claim in the answer candidate, exclusive. + * Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */ endPos?: number | null; /** @@ -6748,7 +7236,7 @@ export namespace discoveryengine_v1 { */ groundingCheckRequired?: boolean | null; /** - * Position indicating the start of the claim in the answer candidate, measured in bytes. + * Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */ startPos?: number | null; } @@ -6879,11 +7367,11 @@ export namespace discoveryengine_v1 { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -6891,7 +7379,7 @@ export namespace discoveryengine_v1 { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -6899,7 +7387,7 @@ export namespace discoveryengine_v1 { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1SingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -7087,6 +7575,44 @@ export namespace discoveryengine_v1 { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -7284,6 +7810,19 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateSitemapMetadata { + /** + * 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. */ @@ -7385,7 +7924,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -7396,6 +7935,14 @@ export namespace discoveryengine_v1 { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Immutable. The industry vertical that the data store registers. */ @@ -7467,6 +8014,19 @@ export namespace discoveryengine_v1 { */ disabledForServing?: boolean | null; } + /** + * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata { + /** + * 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 DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -7519,6 +8079,19 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteSitemapMetadata { + /** + * 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. */ @@ -7750,6 +8323,15 @@ export namespace discoveryengine_v1 { */ useNativeText?: boolean | null; } + /** + * Double list. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DoubleList { + /** + * Double values. + */ + values?: number[] | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -7832,6 +8414,10 @@ export namespace discoveryengine_v1 { * 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; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -7927,6 +8513,24 @@ export namespace discoveryengine_v1 { */ totalSize?: number | null; } + /** + * Response message for SiteSearchEngineService.FetchSitemaps method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1FetchSitemapsResponse { + /** + * List of Sitemaps fetched. + */ + sitemapsMetadata?: Schema$GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata[]; + } + /** + * Contains a Sitemap and its metadata. + */ + export interface Schema$GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata { + /** + * The Sitemap. + */ + sitemap?: Schema$GoogleCloudDiscoveryengineV1Sitemap; + } /** * Cloud FhirStore source import data from. */ @@ -7983,348 +8587,113 @@ export namespace discoveryengine_v1 { inputUris?: string[] | null; } /** - * Top-level message sent by the client for the `GenerateGroundedContent` method. + * Grounding Fact. */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest { - /** - * Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - */ - contents?: Schema$GoogleCloudDiscoveryengineV1GroundedGenerationContent[]; - /** - * Content generation specification. - */ - generationSpec?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec; - /** - * Grounding specification. - */ - groundingSpec?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec; - /** - * Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them. - */ - systemInstruction?: Schema$GoogleCloudDiscoveryengineV1GroundedGenerationContent; + export interface Schema$GoogleCloudDiscoveryengineV1GroundingFact { /** - * 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. + * 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. */ - userLabels?: {[key: string]: string} | null; - } - /** - * Describes the options to customize dynamic retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration { + attributes?: {[key: string]: string} | null; /** - * Specification for the predictor for dynamic retrieval. + * Text content of the fact. Can be at most 10K characters long. */ - predictor?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor; + factText?: string | null; } /** - * Describes the predictor settings for dynamic retrieval. + * Config to data store for `HEALTHCARE_FHIR` vertical. */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor { + export interface Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig { /** - * The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source. + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. */ - threshold?: number | null; + enableConfigurableSchema?: boolean | null; /** - * The version of the predictor to be used in dynamic retrieval. + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. */ - version?: string | null; + enableStaticIndexingForBatchIngestion?: boolean | null; } /** - * Content generation specification. + * Identity Mapping Entry that maps an external identity to an internal identity. */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGenerationSpec { + export interface Schema$GoogleCloudDiscoveryengineV1IdentityMappingEntry { /** - * If specified, custom value for frequency penalty will be used. + * Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters. */ - frequencyPenalty?: number | null; + externalIdentity?: string | null; /** - * Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). + * Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config. */ - languageCode?: string | null; + groupId?: string | null; /** - * If specified, custom value for max output tokens will be used. + * User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config. */ - maxOutputTokens?: number | null; + userId?: string | null; + } + /** + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata { /** - * Specifies which Vertex model id to use for generation. + * The number of IdentityMappingEntries that failed to be processed. */ - modelId?: string | null; + failureCount?: string | null; /** - * If specified, custom value for presence penalty will be used. + * The number of IdentityMappingEntries that were successfully processed. */ - presencePenalty?: number | null; + successCount?: string | null; /** - * If specified, custom value for the seed will be used. + * The total number of IdentityMappingEntries that were processed. */ - seed?: number | null; + totalCount?: string | null; + } + /** + * Identity Mapping Store which contains Identity Mapping Entries. + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdentityMappingStore { /** - * If specified, custom value for the temperature will be used. + * Output only. CMEK-related information for the Identity Mapping Store. */ - temperature?: number | null; + cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig; /** - * If specified, custom value for top-k sampling will be used. + * Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field. */ - topK?: number | null; + kmsKeyName?: string | null; /** - * If specified, custom value for nucleus sampling will be used. + * Immutable. The full resource name of the identity mapping store. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - topP?: number | null; + name?: string | null; } /** - * Grounding source. + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource { + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { /** - * If set, grounding is performed with Google Search. + * Operation create time. */ - googleSearchSource?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource; + createTime?: string | null; /** - * If set, grounding is performed with inline content. + * Count of CompletionSuggestions that failed to be imported. */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource; + failureCount?: string | null; /** - * If set, grounding is performed with Vertex AI Search. + * Count of CompletionSuggestions successfully imported. */ - searchSource?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource; - } - /** - * Google Search config parameters. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceGoogleSearchSource { + successCount?: string | null; /** - * Optional. Specifies the dynamic retrieval configuration for the given source. + * Operation last update time. If the operation is done, this is also the finish time. */ - dynamicRetrievalConfig?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestDynamicRetrievalConfiguration; + updateTime?: string | null; } /** - * Message to be used for grounding based on inline content. + * Request message for CompletionService.ImportCompletionSuggestions method. */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceInlineSource { + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest { /** - * Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content). + * BigQuery input source. */ - attributes?: {[key: string]: string} | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1BigQuerySource; /** - * List of facts to be used for grounding. - */ - groundingFacts?: Schema$GoogleCloudDiscoveryengineV1GroundingFact[]; - } - /** - * Message to be used for grounding with Vertex AI Search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource { - /** - * Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter. - */ - filter?: string | null; - /** - * Number of search results to return. The default value is 10. The maximumm allowed value is 10. - */ - maxResultCount?: number | null; - /** - * If set, safe search is enabled in Vertex AI Search requests. - */ - safeSearch?: boolean | null; - /** - * The resource name of the Engine to use. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - servingConfig?: string | null; - } - /** - * Grounding specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSpec { - /** - * Grounding sources. - */ - groundingSources?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSource[]; - } - /** - * Response for the `GenerateGroundedContent` method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponse { - /** - * Generated candidates. - */ - candidates?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate[]; - } - /** - * A response candidate generated from the model. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidate { - /** - * Content of the candidate. - */ - content?: Schema$GoogleCloudDiscoveryengineV1GroundedGenerationContent; - /** - * Grounding metadata for the generated content. - */ - groundingMetadata?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata; - /** - * The overall grounding score for the candidate, in the range of [0, 1]. - */ - groundingScore?: number | null; - /** - * Index of the candidate. - */ - index?: number | null; - } - /** - * Citation for the generated content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata { - /** - * GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact. - */ - groundingSupport?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport[]; - /** - * Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users. - */ - retrievalMetadata?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata[]; - /** - * Google search entry for the following-up web searches. - */ - searchEntryPoint?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint; - /** - * List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request. - */ - supportChunks?: Schema$GoogleCloudDiscoveryengineV1FactChunk[]; - /** - * Web search queries for the following-up web search. - */ - webSearchQueries?: string[] | null; - } - /** - * Describes the metadata about dynamic retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata { - /** - * Metadata for the dynamic retrieval predictor. - */ - predictorMetadata?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata; - } - /** - * Describes the metadata about the dynamic retrieval predictor. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata { - /** - * The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding. - */ - prediction?: number | null; - /** - * The version of the predictor which was used in dynamic retrieval. - */ - version?: string | null; - } - /** - * Grounding info for a claim in the candidate and its support. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport { - /** - * Text for the claim in the candidate. Always provided when a support is found. - */ - claimText?: string | null; - /** - * A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim. - */ - supportChunkIndices?: number[] | null; - /** - * A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks. - */ - supportScore?: number | null; - } - /** - * Describes the metadata associated with a retrieval step. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata { - /** - * Metadata for dynamic retrieval. - */ - dynamicRetrievalMetadata?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata; - /** - * Describes the source to which the metadata is referring to. - */ - source?: string | null; - } - /** - * Google search entry point. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint { - /** - * Web content snippet that can be embedded in a web page or an app webview. - */ - renderedContent?: string | null; - /** - * Base64 encoded JSON representing array of tuple. - */ - sdkBlob?: string | null; - } - /** - * Base structured datatype containing multi-part content of a message. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GroundedGenerationContent { - /** - * Ordered `Parts` that constitute a single message. - */ - parts?: Schema$GoogleCloudDiscoveryengineV1GroundedGenerationContentPart[]; - /** - * Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset. - */ - role?: string | null; - } - /** - * Single part of content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GroundedGenerationContentPart { - /** - * Inline text. - */ - text?: string | null; - } - /** - * Grounding Fact. - */ - export interface Schema$GoogleCloudDiscoveryengineV1GroundingFact { - /** - * 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. - */ - attributes?: {[key: string]: string} | null; - /** - * Text content of the fact. Can be at most 10K characters long. - */ - 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$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; - } - /** - * Request message for CompletionService.ImportCompletionSuggestions method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest { - /** - * BigQuery input source. - */ - bigquerySource?: Schema$GoogleCloudDiscoveryengineV1BigQuerySource; - /** - * The desired location of errors incurred during the Import. + * The desired location of errors incurred during the Import. */ errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; /** @@ -8479,6 +8848,33 @@ export namespace discoveryengine_v1 { */ gcsPrefix?: string | null; } + /** + * Request message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest { + /** + * The inline source to import identity mapping entries from. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource; + } + /** + * The inline source to import identity mapping entries from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource { + /** + * A maximum of 10000 entries can be imported at one time + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1IdentityMappingEntry[]; + } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse { + /** + * 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. */ @@ -8698,6 +9094,32 @@ export namespace discoveryengine_v1 { */ nextPageToken?: string | null; } + /** + * Response message for IdentityMappingStoreService.ListIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse { + /** + * The Identity Mapping Entries. + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1IdentityMappingEntry[]; + /** + * 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; + } + /** + * Response message for IdentityMappingStoreService.ListIdentityMappingStores + */ + export interface Schema$GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse { + /** + * The Identity Mapping Stores. + */ + identityMappingStores?: Schema$GoogleCloudDiscoveryengineV1IdentityMappingStore[]; + /** + * 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; + } /** * Response message for SchemaService.ListSchemas method. */ @@ -8976,6 +9398,32 @@ export namespace discoveryengine_v1 { */ gcsPrefix?: string | null; } + /** + * Request message for IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest { + /** + * Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 "zulu" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time \> "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` * Deleting all identity mappings for a given external_id: `external_id = "id1"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided. + */ + filter?: string | null; + /** + * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field. + */ + force?: boolean | null; + /** + * The inline source to purge identity mapping entries from. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource; + } + /** + * The inline source to purge identity mapping entries from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource { + /** + * A maximum of 10000 entries can be purged at one time + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1IdentityMappingEntry[]; + } /** * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -9062,7 +9510,7 @@ export namespace discoveryengine_v1 { */ 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. + * The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. */ model?: string | null; /** @@ -9163,7 +9611,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1RecrawlUrisRequest { /** - * Optional. Full resource name of the `SiteCredential`, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/siteCredentials/x`. Only set to crawl private URIs. + * Optional. Credential id to use for crawling. */ siteCredential?: string | null; /** @@ -9264,7 +9712,7 @@ export namespace discoveryengine_v1 { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -9289,9 +9737,13 @@ export namespace discoveryengine_v1 { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec; /** - * Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + * Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[]; + /** + * Optional. Config for display feature, like match highlighting on search results. + */ + displaySpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec; /** * 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. */ @@ -9340,6 +9792,14 @@ export namespace discoveryengine_v1 { * The query expansion specification that specifies the conditions under which query expansion occurs. */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec; + /** + * Optional. The specification for returning the relevance score. + */ + relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec; + /** + * 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. This feature is not supported for healthcare search. + */ + relevanceThreshold?: string | null; /** * Whether to turn on safe search. This is only supported for website search. */ @@ -9361,7 +9821,7 @@ export namespace discoveryengine_v1 { */ spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. */ userInfo?: Schema$GoogleCloudDiscoveryengineV1UserInfo; /** @@ -9593,6 +10053,15 @@ export namespace discoveryengine_v1 { */ filter?: string | null; } + /** + * Specifies features for display, like match highlighting. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec { + /** + * The condition under which match highlighting should occur. + */ + matchHighlightingCondition?: string | null; + } /** * A facet specification to perform faceted search. */ @@ -9669,6 +10138,15 @@ export namespace discoveryengine_v1 { */ pinUnexpandedResults?: boolean | null; } + /** + * The specification for returning the document relevance score. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec { + /** + * Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. + */ + returnRelevanceScore?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -9687,7 +10165,7 @@ export namespace discoveryengine_v1 { */ 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. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar 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; } @@ -9812,6 +10290,12 @@ export namespace discoveryengine_v1 { * Document.id of the searched Document. */ id?: string | null; + /** + * Output only. Google provided available scores. + */ + modelScores?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1DoubleList; + } | null; } /** * Information about the session. @@ -10124,6 +10608,23 @@ export namespace discoveryengine_v1 { */ kmsKey?: string | null; } + /** + * A sitemap for the SiteSearchEngine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Sitemap { + /** + * Output only. The sitemap's creation time. + */ + createTime?: string | null; + /** + * Output only. The fully qualified resource name of the sitemap. `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/sitemaps/x` The `sitemap_id` suffix is system-generated. + */ + name?: string | null; + /** + * Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. + */ + uri?: string | null; + } /** * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. */ @@ -10912,119 +11413,7 @@ export namespace discoveryengine_v1 { this.context ); } - - /** - * Generates grounded 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. - */ - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - options: StreamMethodOptions - ): GaxiosPromise; - generateGroundedContent( - params?: Params$Resource$Projects$Locations$Generategroundedcontent, - options?: MethodOptions - ): GaxiosPromise; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - callback: BodyResponseCallback - ): void; - generateGroundedContent( - callback: BodyResponseCallback - ): void; - generateGroundedContent( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Generategroundedcontent - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Generategroundedcontent; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Generategroundedcontent; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+location}:generateGroundedContent').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 - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Generategroundedcontent - extends StandardParameters { - /** - * Required. Location resource. Format: `projects/{project\}/locations/{location\}`. - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1GenerateGroundedContentRequest; - } + } export class Resource$Projects$Locations$Collections { context: APIRequestContext; @@ -17642,6 +18031,7 @@ export namespace discoveryengine_v1 { export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { context: APIRequestContext; operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; + sitemaps: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps; targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; constructor(context: APIRequestContext) { this.context = context; @@ -17649,6 +18039,10 @@ export namespace discoveryengine_v1 { new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( this.context ); + this.sitemaps = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps( + this.context + ); this.targetSites = new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( this.context @@ -18431,55 +18825,50 @@ export namespace discoveryengine_v1 { pageToken?: string; } - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps { 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. + * Creates a Sitemap. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, options?: MethodOptions ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, callback: BodyResponseCallback ): void; - batchCreate( + create( callback: BodyResponseCallback ): void; - batchCreate( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18495,13 +18884,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create; 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$Datastores$Sitesearchengine$Sitemaps$Create; options = {}; } @@ -18515,7 +18904,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/targetSites:batchCreate').replace( + url: (rootUrl + '/v1/{+parent}/sitemaps').replace( /([^:]\/)\/+/g, '$1' ), @@ -18540,43 +18929,43 @@ export namespace discoveryengine_v1 { } /** - * Creates a TargetSite. + * Deletes a Sitemap. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, callback: BodyResponseCallback ): void; - create( + delete( callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18592,13 +18981,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete; 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$Datastores$Sitesearchengine$Sitemaps$Delete; options = {}; } @@ -18612,18 +19001,15 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/targetSites').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) { @@ -18637,65 +19023,65 @@ export namespace discoveryengine_v1 { } /** - * Deletes a TargetSite. + * Fetch Sitemaps in 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$Sitesearchengine$Targetsites$Delete, + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + fetch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + ): GaxiosPromise; + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, - callback: BodyResponseCallback + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + fetch( + callback: BodyResponseCallback ): void; - delete( + fetch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch + | 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$Datastores$Sitesearchengine$Sitemaps$Fetch; 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$Datastores$Sitesearchengine$Sitemaps$Fetch; options = {}; } @@ -18709,87 +19095,135 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/sitemaps:fetch').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$Sitesearchengine$Sitemaps$Create + extends StandardParameters { /** - * Gets a TargetSite. + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1Sitemap; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete + extends StandardParameters { + /** + * Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch + extends StandardParameters { + /** + * The Sitemap uris. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: 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$Sitesearchengine$Targetsites$Get, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + batchCreate( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -18803,89 +19237,90 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+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); } } /** - * Gets a list of TargetSites. + * 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$Sitesearchengine$Targetsites$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -18903,7 +19338,7 @@ export namespace discoveryengine_v1 { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -18914,55 +19349,53 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TargetSite. + * 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$Sitesearchengine$Targetsites$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + 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$Sitesearchengine$Targetsites$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback ): void; - patch( + delete( callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18978,13 +19411,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$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$Sitesearchengine$Targetsites$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -18999,7 +19432,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -19018,82 +19451,9 @@ export namespace discoveryengine_v1 { 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$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest; - } - 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$GoogleCloudDiscoveryengineV1TargetSite; - } - 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$GoogleCloudDiscoveryengineV1TargetSite; - } - - 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. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19101,57 +19461,57 @@ export namespace discoveryengine_v1 { * @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, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get - | 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$Sitesearchengine$Targetsites$Operations$Get; + {}) 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$Sitesearchengine$Targetsites$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -19177,17 +19537,19 @@ export namespace discoveryengine_v1 { 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 list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19195,57 +19557,57 @@ export namespace discoveryengine_v1 { * @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, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - | 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$Sitesearchengine$Targetsites$Operations$List; + {}) 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$Sitesearchengine$Targetsites$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -19259,7 +19621,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), @@ -19269,94 +19631,60 @@ export namespace discoveryengine_v1 { 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. + * 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. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback ): void; - import( + patch( callback: BodyResponseCallback ): void; - import( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19372,13 +19700,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {}) 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$Suggestiondenylistentries$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -19392,17 +19720,15 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/suggestionDenyListEntries:import' - ).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) { @@ -19414,45 +19740,118 @@ export namespace discoveryengine_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + extends StandardParameters { /** - * Permanently deletes all SuggestionDenyListEntry for a 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$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest; + } + 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$GoogleCloudDiscoveryengineV1TargetSite; + } + 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$GoogleCloudDiscoveryengineV1TargetSite; + } + + 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. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options?: MethodOptions ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, callback: BodyResponseCallback ): void; - purge( + get( callback: BodyResponseCallback ): void; - purge( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19468,13 +19867,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {}) 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$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; options = {}; } @@ -19488,17 +19887,15 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/suggestionDenyListEntries:purge' - ).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) { @@ -19510,95 +19907,67 @@ export namespace discoveryengine_v1 { 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$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest; - } - 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$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest; - } - - 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. + * 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. */ - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$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$Datastores$Sitesearchengine$Targetsites$Operations$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$Datastores$Sitesearchengine$Targetsites$Operations$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$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$Userevents$Collect; + {}) 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$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; options = {}; } @@ -19612,7 +19981,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:collect').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -19622,22 +19991,58 @@ export namespace discoveryengine_v1 { 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$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 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19645,27 +20050,27 @@ export namespace discoveryengine_v1 { * @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, + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions ): GaxiosPromise; import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback ): void; import( @@ -19673,7 +20078,7 @@ export namespace discoveryengine_v1 { ): void; import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19689,13 +20094,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$Suggestiondenylistentries$Import; 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$Suggestiondenylistentries$Import; options = {}; } @@ -19709,10 +20114,9 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -19734,7 +20138,7 @@ export namespace discoveryengine_v1 { } /** - * 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. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19742,27 +20146,27 @@ export namespace discoveryengine_v1 { * @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, + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions ): GaxiosPromise; purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback ): void; purge( @@ -19770,7 +20174,7 @@ export namespace discoveryengine_v1 { ): void; purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19786,13 +20190,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + {}) 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$Userevents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -19806,10 +20210,9 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -19829,67 +20232,95 @@ export namespace discoveryengine_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + extends StandardParameters { /** - * Writes a single user event. + * 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$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest; + } + 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$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest; + } + + 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. */ - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + collect( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - write( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - | 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$Userevents$Write; + {}) 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$Write; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; options = {}; } @@ -19903,11 +20334,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:write').replace( + url: (rootUrl + '/v1/{+parent}/userEvents:collect').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -19918,147 +20349,53 @@ export namespace discoveryengine_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$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 resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect 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; - /** - * 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$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/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. + * 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. */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest; - } - 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$GoogleCloudDiscoveryengineV1UserEvent; - } - - 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, callback: BodyResponseCallback ): void; - create( + import( callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20074,13 +20411,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; + {}) 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$Engines$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; options = {}; } @@ -20094,7 +20431,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/engines').replace( + url: (rootUrl + '/v1/{+parent}/userEvents:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -20119,43 +20456,43 @@ export namespace discoveryengine_v1 { } /** - * Deletes a Engine. + * 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$Collections$Engines$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, callback: BodyResponseCallback ): void; - delete( + purge( callback: BodyResponseCallback ): void; - delete( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Delete + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20171,13 +20508,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {}) 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$Engines$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; options = {}; } @@ -20191,15 +20528,18 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/userEvents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -20213,65 +20553,65 @@ export namespace discoveryengine_v1 { } /** - * Gets a Engine. + * 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$Collections$Engines$Get, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Get, + write( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - get( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Get - | 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$Engines$Get; + {}) 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$Engines$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; options = {}; } @@ -20285,89 +20625,1580 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+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$Collections$Datastores$Userevents$Collect + extends StandardParameters { /** - * 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. + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise + ets?: string; + /** + * Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect 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; + /** + * 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$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/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest; + } + 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$GoogleCloudDiscoveryengineV1UserEvent; + } + + 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$Create; + 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}/engines').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 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$Engines$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$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 + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$Delete; + 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: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$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 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. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$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/{+parent}/engines').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 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. + */ + 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; + + 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 + '/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$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$GoogleCloudDiscoveryengineV1Engine; + } + 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\}/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$GoogleCloudDiscoveryengineV1Engine; + } + + 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. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$Controls$Create; + 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}/controls').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 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. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$Controls$Delete; + 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: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$Controls$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 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. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Controls$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$Controls$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/{+parent}/controls').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 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. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Engines$Controls$Patch; + 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: '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$Engines$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\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1Control; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/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\}/locations/{location\}/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\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1Control; + } + + 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 + '/v1/{+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. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Conversations$Create; + 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}/conversations').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 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. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Conversations$Delete; + 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: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$List; + {}) 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$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; options = {}; } @@ -20381,92 +22212,89 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/engines').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 an Engine + * 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$Engines$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Patch - | 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$Patch; + {}) 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$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; options = {}; } @@ -20480,162 +22308,92 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+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 ); } } - } - - 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$GoogleCloudDiscoveryengineV1Engine; - } - 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\}/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$GoogleCloudDiscoveryengineV1Engine; - } - - 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. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create - | 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$Controls$Create; + {}) 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$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; options = {}; } @@ -20649,88 +22407,174 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/controls').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) { - 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\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1ConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1Conversation; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/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\}/locations/{location\}/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\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1Conversation; + } + + 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. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - | 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$Controls$Delete; + {}) 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$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; options = {}; } @@ -20745,7 +22589,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -20756,75 +22600,75 @@ export namespace discoveryengine_v1 { 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$Engines$Controls$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get - | 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$Controls$Get; + {}) 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$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; options = {}; } @@ -20838,7 +22682,10 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -20850,77 +22697,111 @@ export namespace discoveryengine_v1 { 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; + } /** - * 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$Engines$Controls$List, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + answer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - list( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$List - | 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$Controls$List; + {}) 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$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; options = {}; } @@ -20934,34 +22815,34 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/controls').replace( + url: (rootUrl + '/v1/{+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. + * 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`. @@ -20969,57 +22850,57 @@ export namespace discoveryengine_v1 { * @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$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$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$Controls$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$Controls$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$Controls$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$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; options = {}; } @@ -21045,150 +22926,77 @@ export namespace discoveryengine_v1 { 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 - 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\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1Control; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/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\}/locations/{location\}/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\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1Control; - } - - export class Resource$Projects$Locations$Collections$Engines$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * 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. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - converse( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - | 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$Conversations$Converse; + {}) 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$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; options = {}; } @@ -21202,7 +23010,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:converse').replace( + url: (rootUrl + '/v1/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), @@ -21212,82 +23020,82 @@ export namespace discoveryengine_v1 { 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. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + search( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - create( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - | 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$Conversations$Create; + {}) 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$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; options = {}; } @@ -21301,7 +23109,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( + url: (rootUrl + '/v1/{+servingConfig}:search').replace( /([^:]\/)\/+/g, '$1' ), @@ -21311,78 +23119,82 @@ export namespace discoveryengine_v1 { 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 ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + searchLite( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + searchLite( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + ): GaxiosPromise; + searchLite( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + searchLite( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, - callback: BodyResponseCallback + searchLite( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + searchLite( + callback: BodyResponseCallback + ): void; + searchLite( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite + | 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$Engines$Servingconfigs$Searchlite; 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$Servingconfigs$Searchlite; options = {}; } @@ -21396,87 +23208,92 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+servingConfig}:searchLite').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. + * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a 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. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + streamAnswer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + ): GaxiosPromise; + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, - callback: BodyResponseCallback + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + streamAnswer( + callback: BodyResponseCallback ): void; - get( + streamAnswer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer + | 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$Servingconfigs$Streamanswer; 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$Servingconfigs$Streamanswer; options = {}; } @@ -21490,89 +23307,181 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+servingConfig}:streamAnswer').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$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$GoogleCloudDiscoveryengineV1AnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$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$GoogleCloudDiscoveryengineV1ServingConfig; + } + 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; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1RecommendRequest; + } + 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; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1SearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite + 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$GoogleCloudDiscoveryengineV1SearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer + 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$GoogleCloudDiscoveryengineV1AnswerQueryRequest; + } + + 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 + ); } /** - * 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$Engines$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - | 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$List; + {}) 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$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; options = {}; } @@ -21586,11 +23495,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( + url: (rootUrl + '/v1/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -21601,77 +23510,73 @@ export namespace discoveryengine_v1 { 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$Engines$Conversations$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$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$Engines$Conversations$Patch; + {}) 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$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; options = {}; } @@ -21686,7 +23591,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -21697,104 +23602,17 @@ export namespace discoveryengine_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$Collections$Engines$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1ConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1Conversation; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/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\}/locations/{location\}/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\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1Conversation; - } - - 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. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21802,57 +23620,57 @@ export namespace discoveryengine_v1 { * @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$Engines$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$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$Operations$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$Operations$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$Operations$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$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; options = {}; } @@ -21878,17 +23696,19 @@ export namespace discoveryengine_v1 { 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`. @@ -21896,57 +23716,57 @@ export namespace discoveryengine_v1 { * @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$Engines$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$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$Operations$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$Operations$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$Operations$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$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; options = {}; } @@ -21960,7 +23780,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -21970,116 +23790,82 @@ export namespace discoveryengine_v1 { 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$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. + * 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. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - answer( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer - | 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$Servingconfigs$Answer; + {}) 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$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; options = {}; } @@ -22093,188 +23879,166 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+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$Sessions$Create + extends StandardParameters { /** - * 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. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; + parent?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1Session; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + extends StandardParameters { + /** + * Optional. If set to true, the full session including all answer details will be returned. + */ + includeAnswerDetails?: boolean; + /** + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/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` * `is_pinned` Example: * "update_time desc" * "create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned first, then by update_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\}/locations/{location\}/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; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1Session; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.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 class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Makes a recommendation, which requires a contextual user event. + * 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. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - recommend( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - | 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$Servingconfigs$Recommend; + {}) 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$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; options = {}; } @@ -22288,92 +24052,104 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+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 ); } } + } + + 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\}/locations/{location\}/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; + } /** - * Performs a search. + * 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. */ - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + get( + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + get( + params?: Params$Resource$Projects$Locations$Collections$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + get( + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Operations$Get, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - search( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search - | 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$Servingconfigs$Search; + {}) 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$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Operations$Get; options = {}; } @@ -22387,92 +24163,87 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+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( - parameters - ); + return createAPIRequest(parameters); } } /** - * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. + * 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. */ - searchLite( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + list( + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - searchLite( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + list( + params?: Params$Resource$Projects$Locations$Collections$Operations$List, options?: MethodOptions - ): GaxiosPromise; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + list( + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Operations$List, + callback: BodyResponseCallback ): void; - searchLite( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - searchLite( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite - | 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$Servingconfigs$Searchlite; + {}) 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$Servingconfigs$Searchlite; + {} as Params$Resource$Projects$Locations$Collections$Operations$List; options = {}; } @@ -22486,92 +24257,175 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:searchLite').replace( + url: (rootUrl + '/v1/{+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$Operations$Get + extends StandardParameters { /** - * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. + * 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 + ); + } + + /** + * 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. */ - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: StreamMethodOptions ): GaxiosPromise; - streamAnswer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + completeQuery( + params?: Params$Resource$Projects$Locations$Datastores$Completequery, options?: MethodOptions - ): GaxiosPromise; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + callback: BodyResponseCallback ): void; - streamAnswer( - callback: BodyResponseCallback + completeQuery( + callback: BodyResponseCallback ): void; - streamAnswer( + completeQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer - | 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$Streamanswer; + {}) 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$Streamanswer; + {} as Params$Resource$Projects$Locations$Datastores$Completequery; options = {}; } @@ -22585,123 +24439,34 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:streamAnswer').replace( + url: (rootUrl + '/v1/{+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 ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$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$GoogleCloudDiscoveryengineV1AnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$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$GoogleCloudDiscoveryengineV1ServingConfig; - } - 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; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1RecommendRequest; - } - 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; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1SearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite - 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$GoogleCloudDiscoveryengineV1SearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer - 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$GoogleCloudDiscoveryengineV1AnswerQueryRequest; - } - - 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 Session. If the Session to create already exists, an ALREADY_EXISTS 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`. @@ -22709,57 +24474,56 @@ export namespace discoveryengine_v1 { * @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$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params?: Params$Resource$Projects$Locations$Datastores$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$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$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$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$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + params = {} as Params$Resource$Projects$Locations$Datastores$Create; options = {}; } @@ -22773,7 +24537,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), @@ -22788,19 +24552,17 @@ export namespace discoveryengine_v1 { 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 a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22808,53 +24570,56 @@ export namespace discoveryengine_v1 { * @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$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete - | 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$Sessions$Delete; + {}) 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$Sessions$Delete; + params = {} as Params$Resource$Projects$Locations$Datastores$Delete; options = {}; } @@ -22880,17 +24645,17 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Session. + * Gets a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22898,57 +24663,152 @@ export namespace discoveryengine_v1 { * @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$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Datastores$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$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$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$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$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 + '/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 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$Datastores$Getsitesearchengine, + options: StreamMethodOptions + ): GaxiosPromise; + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + options?: MethodOptions + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + 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 + ): void; + getSiteSearchEngine( + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; options = {}; } @@ -22974,19 +24834,19 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Sessions by their parent 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`. @@ -22994,57 +24854,56 @@ export namespace discoveryengine_v1 { * @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, + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$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$Sessions$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$Sessions$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$Sessions$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$Sessions$List; + params = {} as Params$Resource$Projects$Locations$Datastores$List; options = {}; } @@ -23058,7 +24917,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), @@ -23073,19 +24932,19 @@ export namespace discoveryengine_v1 { 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. + * Updates a DataStore * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23093,57 +24952,56 @@ export namespace discoveryengine_v1 { * @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, + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$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$Sessions$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$Sessions$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$Sessions$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$Sessions$Patch; + params = {} as Params$Resource$Projects$Locations$Datastores$Patch; options = {}; } @@ -23169,265 +25027,206 @@ export namespace discoveryengine_v1 { 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 + export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * 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 { + /** + * Resource name of the CmekConfig to use for protecting this DataStore. + */ + cmekConfigName?: string; + /** + * 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; + /** + * DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + */ + disableCmek?: boolean; + /** + * 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$GoogleCloudDiscoveryengineV1Session; + requestBody?: Schema$GoogleCloudDiscoveryengineV1DataStore; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + export interface Params$Resource$Projects$Locations$Datastores$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_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$Sessions$Get + export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters { /** - * Optional. If set to true, the full session including all answer details will be 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. */ - includeAnswerDetails?: boolean; + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * 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$Engines$Sessions$List + export interface Params$Resource$Projects$Locations$Datastores$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 by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` */ 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` * `is_pinned` Example: * "update_time desc" * "create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned first, then by update_time. - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * 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, received from a previous `ListSessions` 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. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * 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$Sessions$Patch + export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * 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 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 DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1Session; + requestBody?: Schema$GoogleCloudDiscoveryengineV1DataStore; } - export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + 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; - } - - /** - * 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 + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + this.documents = + new Resource$Projects$Locations$Datastores$Branches$Documents( + this.context ); - } else { - return createAPIRequest( - parameters + this.operations = + new Resource$Projects$Locations$Datastores$Branches$Operations( + this.context ); - } - } - } - - 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\}/locations/{location\}/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. + * 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. - */ - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + */ + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Operations$Get, + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + ): GaxiosPromise; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, - callback: BodyResponseCallback + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchGetDocumentsMetadata( + callback: BodyResponseCallback ): void; - get( + batchGetDocumentsMetadata( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$Get - | 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$Operations$Get; + {}) 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$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; options = {}; } @@ -23441,87 +25240,115 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+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$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { + /** + * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} + */ + 'matcher.fhirMatcher.fhirResources'?: string[]; + /** + * 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 { + 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 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$Operations$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$List - | 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$Operations$List; + {}) 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$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; options = {}; } @@ -23535,175 +25362,182 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/documents').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$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. + * 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. */ - 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 + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$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$Datastores$Branches$Documents$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$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 + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( - this.context - ); + } else { + return createAPIRequest(parameters); + } } /** - * Completes the specified user input with keyword suggestions. + * 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. */ - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Datastores$Completequery, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - completeQuery( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completequery - | 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$Datastores$Completequery; + {}) 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$Completequery; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; options = {}; } @@ -23717,70 +25551,67 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+dataStore}:completeQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', 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. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Create, + import( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, callback: BodyResponseCallback ): void; - create( + import( callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Create + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23796,12 +25627,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Create; + {}) 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$Create; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; options = {}; } @@ -23815,7 +25647,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataStores').replace( + url: (rootUrl + '/v1/{+parent}/documents:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -23840,64 +25672,65 @@ export namespace discoveryengine_v1 { } /** - * Deletes a DataStore. + * 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. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Delete, + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Delete - | 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$Datastores$Delete; + {}) 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$Datastores$Delete; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; options = {}; } @@ -23911,86 +25744,92 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+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(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a 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. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Get, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Get - | 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$Get; + {}) 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$Get; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; options = {}; } @@ -24005,7 +25844,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -24016,77 +25855,77 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the SiteSearchEngine. + * 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. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - | 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$Datastores$Getsitesearchengine; + {}) 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$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; options = {}; } @@ -24100,88 +25939,183 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+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$Datastores$Branches$Documents$Create + extends StandardParameters { /** - * Lists all the DataStores associated with the project. + * 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 128 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$GoogleCloudDiscoveryengineV1Document; + } + 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$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$GoogleCloudDiscoveryengineV1ImportDocumentsRequest; + } + 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$GoogleCloudDiscoveryengineV1Document; + } + 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$GoogleCloudDiscoveryengineV1PurgeDocumentsRequest; + } + + 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. */ - list( - params: Params$Resource$Projects$Locations$Datastores$List, + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$List, + cancel( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$List, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$List - | 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$List; + {}) 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$List; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; options = {}; } @@ -24195,91 +26129,87 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataStores').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 + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); } } /** - * Updates 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. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Patch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Patch - | 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$Patch; + {}) 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$Patch; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; options = {}; } @@ -24294,7 +26224,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -24305,206 +26235,75 @@ export namespace discoveryengine_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$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 { - /** - * Resource name of the CmekConfig to use for protecting this DataStore. - */ - cmekConfigName?: string; - /** - * 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; - /** - * DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. - */ - disableCmek?: boolean; - /** - * 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$GoogleCloudDiscoveryengineV1DataStore; - } - 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$GoogleCloudDiscoveryengineV1DataStore; - } - - 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 - ); - } /** - * Gets index freshness metadata for Documents. Supported for website search only. + * 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. */ - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - batchGetDocumentsMetadata( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options?: MethodOptions - ): GaxiosPromise; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata - | 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$Branches$Batchgetdocumentsmetadata; + {}) 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$Branches$Batchgetdocumentsmetadata; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; options = {}; } @@ -24518,7 +26317,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/batchGetDocumentsMetadata').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -24528,105 +26327,128 @@ export namespace discoveryengine_v1 { 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$Batchgetdocumentsmetadata + 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 extends StandardParameters { /** - * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} + * The name of the operation resource. */ - 'matcher.fhirMatcher.fhirResources'?: string[]; + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + extends StandardParameters { /** - * The exact URIs to match by. + * The standard list filter. */ - 'matcher.urisMatcher.uris'?: string[]; + filter?: string; /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * The name of the operation's parent resource. */ - parent?: string; + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Branches$Documents { + export class Resource$Projects$Locations$Datastores$Completionsuggestions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a Document. + * 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$Branches$Documents$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + import( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - | 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$Branches$Documents$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$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; options = {}; } @@ -24640,10 +26462,9 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -24655,73 +26476,75 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Document. + * 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$Branches$Documents$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + purge( + callback: BodyResponseCallback + ): void; + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete - | 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$Branches$Documents$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$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; options = {}; } @@ -24735,87 +26558,121 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1/{+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$Completionsuggestions$Import + extends StandardParameters { /** - * Gets a Document. + * 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$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest; + } + 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$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest; + } + + 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$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$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$Branches$Documents$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$Branches$Documents$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$Branches$Documents$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$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; options = {}; } @@ -24829,89 +26686,88 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+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 ); } } /** - * 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 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$Datastores$Branches$Documents$Import, + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$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$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$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$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$Branches$Documents$Import; + {}) 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$Import; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; options = {}; } @@ -24925,90 +26781,87 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/documents:import').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); } } /** - * Gets a list of Documents. + * 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$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$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$Branches$Documents$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$Branches$Documents$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$Branches$Documents$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$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; options = {}; } @@ -25022,92 +26875,89 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/documents').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 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. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params?: Params$Resource$Projects$Locations$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$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$Branches$Documents$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$Branches$Documents$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$Branches$Documents$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$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Controls$List; options = {}; } @@ -25121,89 +26971,92 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+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 ); } } /** - * 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 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. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$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$Controls$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$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$Purge; + {}) 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$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; options = {}; } @@ -25217,277 +27070,162 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/documents:purge').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) { - 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$Controls$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 128 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-_/. */ - documentId?: string; + controlId?: string; /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1Document; + requestBody?: Schema$GoogleCloudDiscoveryengineV1Control; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + export interface Params$Resource$Projects$Locations$Datastores$Controls$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 Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + export interface Params$Resource$Projects$Locations$Datastores$Controls$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 Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + export interface Params$Resource$Projects$Locations$Datastores$Controls$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. - */ - parent?: string; - - /** - * Request body metadata + * 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. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - extends StandardParameters { + filter?: 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. + * Optional. 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. + * 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\}/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\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + export interface Params$Resource$Projects$Locations$Datastores$Controls$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/x/locations/global/dataStore/x/controls/x` */ name?: string; /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + * 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$GoogleCloudDiscoveryengineV1Document; - } - 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$GoogleCloudDiscoveryengineV1PurgeDocumentsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1Control; } - export class Resource$Projects$Locations$Datastores$Branches$Operations { + export class Resource$Projects$Locations$Datastores$Conversations { 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$Datastores$Branches$Operations$Cancel, - options: StreamMethodOptions - ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) 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$Branches$Operations$Cancel; - 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}: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. + * 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$Datastores$Branches$Operations$Get, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + converse( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - get( + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get - | 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$Operations$Get; + {}) 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$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; options = {}; } @@ -25501,8 +27239,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -25513,75 +27254,77 @@ export namespace discoveryengine_v1 { 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`. + * 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. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List - | 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$Operations$List; + {}) 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$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; options = {}; } @@ -25595,138 +27338,88 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+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 ); } } - } - - 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 - 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. + * 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$Completionsuggestions$Import, + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$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$Completionsuggestions$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$Completionsuggestions$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$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; options = {}; } @@ -25740,217 +27433,183 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/completionSuggestions:import' - ).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); } } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * 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. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + get( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - purge( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge - | 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$Completionsuggestions$Purge; + {}) 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$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$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/{+parent}/completionSuggestions: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$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$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest; - } - 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$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest; - } - - export class Resource$Projects$Locations$Datastores$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + 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 + ); + } } /** - * 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. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, + list( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Create - | 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$Controls$Create; + {}) 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$Controls$Create; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; options = {}; } @@ -25964,11 +27623,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/controls').replace( + url: (rootUrl + '/v1/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -25979,73 +27638,77 @@ export namespace discoveryengine_v1 { 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. + * 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. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Delete - | 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$Controls$Delete; + {}) 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$Controls$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; options = {}; } @@ -26060,7 +27723,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -26071,17 +27734,116 @@ export namespace discoveryengine_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$Datastores$Conversations$Converse + extends StandardParameters { /** - * Gets a Control. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1ConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1Conversation; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/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\}/locations/{location\}/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\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1Conversation; + } + + 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -26089,57 +27851,57 @@ export namespace discoveryengine_v1 { * @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$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$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$Models$Operations$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$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$Datastores$Controls$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$Controls$Get; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; options = {}; } @@ -26165,19 +27927,17 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Controls by their parent 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`. @@ -26185,57 +27945,57 @@ export namespace discoveryengine_v1 { * @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$Models$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Controls$List, + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$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$Models$Operations$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$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$Controls$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$Controls$List; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; options = {}; } @@ -26249,7 +28009,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/controls').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -26259,82 +28019,116 @@ export namespace discoveryengine_v1 { 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$Models$Operations$Get + extends StandardParameters { /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$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$Operations$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$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$Controls$Patch; + {}) 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$Controls$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; options = {}; } @@ -26346,164 +28140,89 @@ export namespace discoveryengine_v1 { const rootUrl = options.rootUrl || 'https://discoveryengine.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$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\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1Control; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/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\}/locations/{location\}/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\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1Control; - } - - export class Resource$Projects$Locations$Datastores$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + 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); + } } /** - * Converses 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. */ - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params?: Params$Resource$Projects$Locations$Datastores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$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$Operations$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$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$Conversations$Converse; + {}) 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$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Datastores$Operations$List; options = {}; } @@ -26517,11 +28236,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:converse').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -26532,19 +28251,53 @@ export namespace discoveryengine_v1 { 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 { /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * 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; + } + + /** + * Creates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -26552,57 +28305,57 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$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$Conversations$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$Conversations$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$Conversations$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$Conversations$Create; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; options = {}; } @@ -26616,7 +28369,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( + url: (rootUrl + '/v1/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -26631,19 +28384,17 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Conversation. If the Conversation 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`. @@ -26651,53 +28402,57 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$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$Conversations$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$Conversations$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$Conversations$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$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; options = {}; } @@ -26723,17 +28478,17 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Conversation. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -26741,57 +28496,57 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$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$Conversations$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$Conversations$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$Conversations$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$Conversations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; options = {}; } @@ -26817,19 +28572,19 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Conversations 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`. @@ -26837,57 +28592,57 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$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$Conversations$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$Conversations$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$Conversations$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$Conversations$List; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; options = {}; } @@ -26901,7 +28656,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( + url: (rootUrl + '/v1/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -26916,19 +28671,19 @@ export namespace discoveryengine_v1 { 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 Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -26936,57 +28691,57 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$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$Conversations$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$Conversations$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$Conversations$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$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; options = {}; } @@ -27012,268 +28767,144 @@ export namespace discoveryengine_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$Datastores$Conversations$Converse + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/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 + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1ConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create - extends StandardParameters { + parent?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_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$GoogleCloudDiscoveryengineV1Conversation; + requestBody?: Schema$GoogleCloudDiscoveryengineV1Schema; } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_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$Conversations$Get + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_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$Conversations$List + export interface Params$Resource$Projects$Locations$Datastores$Schemas$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. + * 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 `ListConversations` 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\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_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$Conversations$Patch + export interface Params$Resource$Projects$Locations$Datastores$Schemas$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`. + * 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; /** - * 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. + * 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$GoogleCloudDiscoveryengineV1Conversation; - } - - 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 - ); - } + requestBody?: Schema$GoogleCloudDiscoveryengineV1Schema; } - export class Resource$Projects$Locations$Datastores$Models$Operations { + export class Resource$Projects$Locations$Datastores$Servingconfigs { 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$Datastores$Models$Operations$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - callback: BodyResponseCallback - ): void; - 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 + '/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`. + * 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$Models$Operations$List, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + answer( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$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$Models$Operations$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$Models$Operations$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$Models$Operations$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$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; options = {}; } @@ -27287,126 +28918,92 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + 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$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 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$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$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$Operations$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$Operations$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$Operations$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$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; options = {}; } @@ -27421,7 +29018,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -27432,75 +29029,77 @@ export namespace discoveryengine_v1 { 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`. + * 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$Operations$List, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Operations$List, + recommend( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$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$Operations$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$Operations$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$Operations$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$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; options = {}; } @@ -27514,126 +29113,92 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + 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$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; - } /** - * Creates a Schema. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + search( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - create( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Create - | 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$Schemas$Create; + {}) 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$Schemas$Create; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; options = {}; } @@ -27647,7 +29212,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/schemas').replace( + url: (rootUrl + '/v1/{+servingConfig}:search').replace( /([^:]\/)\/+/g, '$1' ), @@ -27657,80 +29222,82 @@ export namespace discoveryengine_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Schema. + * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + searchLite( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + searchLite( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + ): GaxiosPromise; + searchLite( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + searchLite( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, - callback: BodyResponseCallback + searchLite( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + searchLite( + callback: BodyResponseCallback ): void; - delete( + searchLite( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite + | 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$Servingconfigs$Searchlite; 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$Servingconfigs$Searchlite; options = {}; } @@ -27744,87 +29311,92 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+servingConfig}:searchLite').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 Schema. + * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a 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. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + streamAnswer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + streamAnswer( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + ): GaxiosPromise; + streamAnswer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + streamAnswer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - callback: BodyResponseCallback + streamAnswer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + streamAnswer( + callback: BodyResponseCallback ): void; - get( + streamAnswer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer + | 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$Servingconfigs$Streamanswer; 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$Servingconfigs$Streamanswer; options = {}; } @@ -27833,94 +29405,186 @@ export namespace discoveryengine_v1 { 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 + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+servingConfig}:streamAnswer').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$GoogleCloudDiscoveryengineV1AnswerQueryRequest; + } + 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$GoogleCloudDiscoveryengineV1ServingConfig; + } + 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$GoogleCloudDiscoveryengineV1RecommendRequest; + } + 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$GoogleCloudDiscoveryengineV1SearchRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite + 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$GoogleCloudDiscoveryengineV1SearchRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer + 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$GoogleCloudDiscoveryengineV1AnswerQueryRequest; + } + + 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 ); - } } /** - * Gets a list of Schemas. + * 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$Schemas$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$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$Schemas$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$Schemas$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$Schemas$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$Schemas$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; options = {}; } @@ -27934,11 +29598,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/schemas').replace( + url: (rootUrl + '/v1/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -27949,77 +29613,73 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Schema. + * 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$Schemas$Patch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$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$Schemas$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$Schemas$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$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; options = {}; } @@ -28034,7 +29694,7 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -28045,144 +29705,171 @@ export namespace discoveryengine_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$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$GoogleCloudDiscoveryengineV1Schema; - } - 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. + * 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. */ - name?: string; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Sessions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1Schema; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + options = {}; + } - export class Resource$Projects$Locations$Datastores$Servingconfigs { - 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 + '/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 + ); + } } /** - * Answer query method. + * 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. */ - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + list( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - answer( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer - | 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$Servingconfigs$Answer; + {}) 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$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; options = {}; } @@ -28196,34 +29883,34 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:answer').replace( + url: (rootUrl + '/v1/{+parent}/sessions').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 ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * 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`. @@ -28231,57 +29918,57 @@ export namespace discoveryengine_v1 { * @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$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Sessions$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$Sessions$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$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$Servingconfigs$Patch; + {}) 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$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; options = {}; } @@ -28307,77 +29994,154 @@ export namespace discoveryengine_v1 { 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 { /** - * Makes a recommendation, which requires a contextual user event. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1Session; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get + extends StandardParameters { + /** + * Optional. If set to true, the full session including all answer details will be returned. + */ + includeAnswerDetails?: boolean; + /** + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/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` * `is_pinned` Example: * "update_time desc" * "create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned first, then by update_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\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1Session; + } + + 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. */ - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - recommend( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend - | 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$Servingconfigs$Recommend; + {}) 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$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; options = {}; } @@ -28391,92 +30155,114 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+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 ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + extends StandardParameters { /** - * Performs a search. + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Datastores$Sitesearchengine { + context: APIRequestContext; + sitemaps: Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps; + targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.sitemaps = + new Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps( + this.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. */ - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + disableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - search( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search - | 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$Servingconfigs$Search; + {}) 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$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -28490,92 +30276,89 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. + * 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. */ - searchLite( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - searchLite( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - searchLite( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + ): GaxiosPromise; + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, - callback: BodyResponseCallback + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + callback: BodyResponseCallback ): void; - searchLite( - callback: BodyResponseCallback + enableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - searchLite( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite - | 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$Servingconfigs$Searchlite; + {}) 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$Servingconfigs$Searchlite; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -28589,92 +30372,89 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:searchLite').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. + * 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. */ - streamAnswer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - streamAnswer( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + recrawlUris( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions - ): GaxiosPromise; - streamAnswer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, - callback: BodyResponseCallback + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback ): void; - streamAnswer( - callback: BodyResponseCallback + recrawlUris( + callback: BodyResponseCallback ): void; - streamAnswer( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer - | BodyResponseCallback + | 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$Servingconfigs$Streamanswer; + {}) 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$Servingconfigs$Streamanswer; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -28688,7 +30468,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+servingConfig}:streamAnswer').replace( + url: (rootUrl + '/v1/{+siteSearchEngine}:recrawlUris').replace( /([^:]\/)\/+/g, '$1' ), @@ -28698,113 +30478,66 @@ export namespace discoveryengine_v1 { options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], 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$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$GoogleCloudDiscoveryengineV1AnswerQueryRequest; - } - 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$GoogleCloudDiscoveryengineV1ServingConfig; - } - 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$GoogleCloudDiscoveryengineV1RecommendRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch 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. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - servingConfig?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1SearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch 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. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - servingConfig?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1SearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris 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. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - servingConfig?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1RecrawlUrisRequest; } - export class Resource$Projects$Locations$Datastores$Sessions { + export class Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps { 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 - ); } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Sitemap. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -28812,57 +30545,57 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$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$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create; 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$Sitesearchengine$Sitemaps$Create; options = {}; } @@ -28876,7 +30609,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+parent}/sitemaps').replace( /([^:]\/)\/+/g, '$1' ), @@ -28891,19 +30624,17 @@ export namespace discoveryengine_v1 { 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 a Sitemap. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -28911,53 +30642,57 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$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$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete; 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$Sitesearchengine$Sitemaps$Delete; options = {}; } @@ -28983,75 +30718,212 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Session. + * Fetch Sitemaps in 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$Datastores$Sessions$Get, + fetch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + fetch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + ): GaxiosPromise; + fetch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, + callback: BodyResponseCallback + ): void; + fetch( + callback: BodyResponseCallback + ): void; + fetch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch; + 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}/sitemaps:fetch').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$Sitesearchengine$Sitemaps$Create + extends StandardParameters { + /** + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1Sitemap; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete + extends StandardParameters { + /** + * Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch + extends StandardParameters { + /** + * The Sitemap uris. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + } + + 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. + */ + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + options: StreamMethodOptions + ): GaxiosPromise; + batchCreate( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + options?: MethodOptions + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - get( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Get - | 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$Sessions$Get; + {}) 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$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -29065,89 +30937,90 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+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 Sessions by their parent 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$Datastores$Sessions$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$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$Datastores$Sitesearchengine$Targetsites$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$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$Sessions$List; + {}) 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$Sessions$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -29161,11 +31034,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -29176,77 +31049,75 @@ export namespace discoveryengine_v1 { 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. + * 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$Datastores$Sessions$Patch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Patch - | 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$Sessions$Patch; + {}) 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$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -29261,107 +31132,28 @@ export namespace discoveryengine_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', 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\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1Session; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get - extends StandardParameters { - /** - * Optional. If set to true, the full session including all answer details will be returned. - */ - includeAnswerDetails?: boolean; - /** - * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/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` * `is_pinned` Example: * "update_time desc" * "create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned first, then by update_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\}/locations/{location\}/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$GoogleCloudDiscoveryengineV1Session; - } - - export class Resource$Projects$Locations$Datastores$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Gets a Answer. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -29369,57 +31161,57 @@ export namespace discoveryengine_v1 { * @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$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$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$Sessions$Answers$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$Sessions$Answers$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$Sessions$Answers$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$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -29445,97 +31237,77 @@ export namespace discoveryengine_v1 { 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\}/locations/{location\}/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 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. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$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$Datastores$Sitesearchengine$Targetsites$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$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$Sitesearchengine$Disableadvancedsitesearch; + {}) 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$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -29549,67 +31321,70 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/targetSites').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. + * 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. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + patch( callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29625,13 +31400,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) 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$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -29645,17 +31420,15 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -29667,45 +31440,118 @@ export namespace discoveryengine_v1 { 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 on-demand recrawl for a list of URIs. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest; + } + 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$GoogleCloudDiscoveryengineV1TargetSite; + } + 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$GoogleCloudDiscoveryengineV1TargetSite; + } + + export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = 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. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + import( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback ): void; - recrawlUris( + import( callback: BodyResponseCallback ): void; - recrawlUris( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29721,13 +31567,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {}) 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$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -29741,18 +31587,17 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+siteSearchEngine}:recrawlUris').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -29764,89 +31609,45 @@ export namespace discoveryengine_v1 { 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$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest; - } - 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$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest; - } - 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$GoogleCloudDiscoveryengineV1RecrawlUrisRequest; - } - - export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates TargetSite in a batch. + * 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. */ - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback ): void; - batchCreate( + purge( callback: BodyResponseCallback ): void; - batchCreate( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29862,13 +31663,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) 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$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -29882,10 +31683,9 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/targetSites:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -29905,67 +31705,95 @@ export namespace discoveryengine_v1 { 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$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest; + } + 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$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest; + } + + export class Resource$Projects$Locations$Datastores$Userevents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Creates a TargetSite. + * 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. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + collect( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - create( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create - | 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$Sitesearchengine$Targetsites$Create; + {}) 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$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; options = {}; } @@ -29979,11 +31807,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/targetSites').replace( + url: (rootUrl + '/v1/{+parent}/userEvents:collect').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -29994,53 +31822,53 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a TargetSite. + * 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. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, callback: BodyResponseCallback ): void; - delete( + import( callback: BodyResponseCallback ): void; - delete( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + | Params$Resource$Projects$Locations$Datastores$Userevents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -30056,13 +31884,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {}) 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$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; options = {}; } @@ -30076,15 +31904,18 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/userEvents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -30098,65 +31929,65 @@ export namespace discoveryengine_v1 { } /** - * Gets a TargetSite. + * 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. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - get( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - | 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$Sitesearchengine$Targetsites$Get; + {}) 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$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; options = {}; } @@ -30170,89 +32001,90 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+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 list of TargetSites. + * 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. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + write( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - list( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - | 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$Sitesearchengine$Targetsites$List; + {}) 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$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; options = {}; } @@ -30266,11 +32098,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/targetSites').replace( + url: (rootUrl + '/v1/{+parent}/userEvents:write').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -30281,77 +32113,144 @@ export namespace discoveryengine_v1 { 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 { /** - * Updates a TargetSite. + * 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 resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect 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; + /** + * 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$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/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest; + } + 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$GoogleCloudDiscoveryengineV1UserEvent; + } + + 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. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + check( + params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + ): GaxiosPromise; + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, - callback: BodyResponseCallback + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + check( + callback: BodyResponseCallback ): void; - patch( + check( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch - | 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$Patch; + {}) 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$Patch; + {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; options = {}; } @@ -30365,160 +32264,117 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+groundingConfig}:check').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + 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$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$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest; - } - 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$GoogleCloudDiscoveryengineV1TargetSite; - } - 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$Groundingconfigs$Check 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 grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. */ - name?: string; + groundingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1TargetSite; + requestBody?: Schema$GoogleCloudDiscoveryengineV1CheckGroundingRequest; } - export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { + export class Resource$Projects$Locations$Identitymappingstores { context: APIRequestContext; + operations: Resource$Projects$Locations$Identitymappingstores$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Identitymappingstores$Operations( + this.context + ); } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Creates a new Identity Mapping Store. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + create( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Create, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - import( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$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$Import; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Create; 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$Identitymappingstores$Create; options = {}; } @@ -30532,9 +32388,10 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/identityMappingStores').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -30546,53 +32403,55 @@ export namespace discoveryengine_v1 { 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 the Identity Mapping Store. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + delete( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Delete, options?: MethodOptions ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, callback: BodyResponseCallback ): void; - purge( + delete( callback: BodyResponseCallback ): void; - purge( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + | Params$Resource$Projects$Locations$Identitymappingstores$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -30608,13 +32467,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Delete; 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$Identitymappingstores$Delete; options = {}; } @@ -30628,17 +32487,15 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/suggestionDenyListEntries:purge' - ).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) { @@ -30650,95 +32507,67 @@ export namespace discoveryengine_v1 { 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$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest; - } - 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$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest; - } - - 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. + * Gets the Identity Mapping Store. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$Get, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + get( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Get, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$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$Identitymappingstores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$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$Identitymappingstores$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$Identitymappingstores$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$Identitymappingstores$Get; options = {}; } @@ -30752,68 +32581,67 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:collect').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(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. + * Imports a list of Identity Mapping Entries to an Identity Mapping Store. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + importIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, callback: BodyResponseCallback ): void; - import( + importIdentityMappings( callback: BodyResponseCallback ): void; - import( + importIdentityMappings( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Import + | Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -30829,13 +32657,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; 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$Identitymappingstores$Importidentitymappings; options = {}; } @@ -30849,18 +32677,17 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+identityMappingStore}:importIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], context: this.context, }; if (callback) { @@ -30874,65 +32701,65 @@ export namespace discoveryengine_v1 { } /** - * 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. + * Lists all Identity Mapping Stores. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + list( + params?: Params$Resource$Projects$Locations$Identitymappingstores$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$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$Identitymappingstores$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$Identitymappingstores$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$Identitymappingstores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; + {} as Params$Resource$Projects$Locations$Identitymappingstores$List; options = {}; } @@ -30946,11 +32773,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:purge').replace( + url: (rootUrl + '/v1/{+parent}/identityMappingStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -30961,75 +32788,77 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Writes a single user event. + * Lists Identity Mappings in an Identity Mapping Store. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + listIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + ): GaxiosPromise; + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, - callback: BodyResponseCallback + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + listIdentityMappings( + callback: BodyResponseCallback ): void; - write( + listIdentityMappings( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings + | 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$Identitymappingstores$Listidentitymappings; 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$Identitymappingstores$Listidentitymappings; options = {}; } @@ -31043,159 +32872,91 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1/{+identityMappingStore}:listIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], 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 resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect 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; - /** - * 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$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/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest; - } - 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$GoogleCloudDiscoveryengineV1UserEvent; - } - - export class Resource$Projects$Locations$Groundingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Performs a grounding check. + * Purges specified or all Identity Mapping Entries from an Identity Mapping Store. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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, + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: StreamMethodOptions ): GaxiosPromise; - check( - params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, + purgeIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options?: MethodOptions - ): GaxiosPromise; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + ): GaxiosPromise; + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, - callback: BodyResponseCallback + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + callback: BodyResponseCallback ): void; - check( - callback: BodyResponseCallback + purgeIdentityMappings( + callback: BodyResponseCallback ): void; - check( + purgeIdentityMappings( paramsOrCallback?: - | Params$Resource$Projects$Locations$Groundingconfigs$Check - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings + | 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$Identitymappingstores$Purgeidentitymappings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; options = {}; } @@ -31209,56 +32970,121 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+groundingConfig}:check').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+identityMappingStore}:purgeIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['groundingConfig'], - pathParams: ['groundingConfig'], + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], 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 + export interface Params$Resource$Projects$Locations$Identitymappingstores$Create extends StandardParameters { /** - * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. + * Resource name of the CmekConfig to use for protecting this Identity Mapping Store. */ - groundingConfig?: string; + cmekConfigName?: string; + /** + * Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + */ + disableCmek?: boolean; + /** + * Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + */ + identityMappingStoreId?: string; + /** + * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1CheckGroundingRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1IdentityMappingStore; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Delete + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Get + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + name?: string; } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; - export class Resource$Projects$Locations$Identitymappingstores { - context: APIRequestContext; - operations: Resource$Projects$Locations$Identitymappingstores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Identitymappingstores$Operations( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$List + extends StandardParameters { + /** + * Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + /** + * Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest; } export class Resource$Projects$Locations$Identitymappingstores$Operations { diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 06907bcbcd1..a3f87e2555c 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -112,6 +112,7 @@ export namespace discoveryengine_v1alpha { */ export class Discoveryengine { context: APIRequestContext; + media: Resource$Media; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,10 +121,428 @@ export namespace discoveryengine_v1alpha { google, }; + this.media = new Resource$Media(this.context); this.projects = new Resource$Projects(this.context); } } + /** + * Extra information added to operations that support Scotty media requests. + */ + export interface Schema$ApiservingMediaRequestInfo { + /** + * The number of current bytes uploaded or downloaded. + */ + currentBytes?: string | null; + /** + * Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications. + */ + customData?: string | null; + /** + * Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information. + */ + diffObjectVersion?: string | null; + /** + * The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929 + */ + finalStatus?: number | null; + /** + * The type of notification received from Scotty. + */ + notificationType?: string | null; + /** + * The Scotty request ID. + */ + requestId?: string | null; + /** + * The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange() + */ + requestReceivedParamsServingInfo?: string | null; + /** + * The total size of the file. + */ + totalBytes?: string | null; + /** + * Whether the total bytes field contains an estimated data. + */ + totalBytesIsEstimated?: boolean | null; + } + /** + * This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 \} + */ + export interface Schema$ApiservingMediaResponseInfo { + /** + * Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications. + */ + customData?: string | null; + /** + * Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform. + */ + dataStorageTransform?: string | null; + /** + * Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget. + */ + dynamicDropTarget?: string | null; + /** + * Specifies the Scotty dropzone to use for uploads. + */ + dynamicDropzone?: string | null; + /** + * Diff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information. + */ + mediaForDiff?: Schema$GdataMedia; + /** + * Request class to use for all Blobstore operations for this request. + */ + requestClass?: string | null; + /** + * Requester ID passed along to be recorded in the Scotty logs + */ + scottyAgentUserId?: string | null; + /** + * Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog + */ + scottyCustomerLog?: string | null; + /** + * Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM. + */ + trafficClassField?: string | null; + /** + * Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header. + */ + verifyHashFromHeader?: boolean | null; + } + /** + * Information to read/write to blobstore2. + */ + export interface Schema$GdataBlobstore2Info { + /** + * The blob generation id. + */ + blobGeneration?: string | null; + /** + * The blob id, e.g., /blobstore/prod/playground/scotty + */ + blobId?: string | null; + /** + * Read handle passed from Bigstore -\> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. + */ + downloadReadHandle?: string | null; + /** + * The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + */ + readToken?: string | null; + /** + * Metadata passed from Blobstore -\> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. + */ + uploadMetadataContainer?: string | null; + } + /** + * A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. + */ + export interface Schema$GdataCompositeMedia { + /** + * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef. + */ + blobRef?: string | null; + /** + * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob. + */ + blobstore2Info?: Schema$GdataBlobstore2Info; + /** + * A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. + */ + cosmoBinaryReference?: string | null; + /** + * crc32.c hash for the payload. + */ + crc32cHash?: number | null; + /** + * Media data, set if reference_type is INLINE + */ + inline?: string | null; + /** + * Size of the data, in bytes + */ + length?: string | null; + /** + * MD5 hash for the payload. + */ + md5Hash?: string | null; + /** + * Reference to a TI Blob, set if reference_type is BIGSTORE_REF. + */ + objectId?: Schema$GdataObjectId; + /** + * Path to the data, set if reference_type is PATH + */ + path?: string | null; + /** + * Describes what the field reference contains. + */ + referenceType?: string | null; + /** + * SHA-1 hash for the payload. + */ + sha1Hash?: string | null; + } + /** + * Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty. + */ + export interface Schema$GdataContentTypeInfo { + /** + * Scotty's best guess of what the content type of the file is. + */ + bestGuess?: string | null; + /** + * The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file. + */ + fromBytes?: string | null; + /** + * The content type of the file derived from the file extension of the original file name used by the client. + */ + fromFileName?: string | null; + /** + * The content type of the file as specified in the request headers, multipart headers, or RUPIO start request. + */ + fromHeader?: string | null; + /** + * The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API). + */ + fromUrlPath?: string | null; + } + /** + * Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. + */ + export interface Schema$GdataDiffChecksumsResponse { + /** + * Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol. + */ + checksumsLocation?: Schema$GdataCompositeMedia; + /** + * The chunk size of checksums. Must be a multiple of 256KB. + */ + chunkSizeBytes?: string | null; + /** + * If set, calculate the checksums based on the contents and return them to the caller. + */ + objectLocation?: Schema$GdataCompositeMedia; + /** + * The total size of the server object. + */ + objectSizeBytes?: string | null; + /** + * The object version of the object the checksums are being returned for. + */ + objectVersion?: string | null; + } + /** + * Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. + */ + export interface Schema$GdataDiffDownloadResponse { + /** + * The original object location. + */ + objectLocation?: Schema$GdataCompositeMedia; + } + /** + * A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. + */ + export interface Schema$GdataDiffUploadRequest { + /** + * The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol. + */ + checksumsInfo?: Schema$GdataCompositeMedia; + /** + * The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. + */ + objectInfo?: Schema$GdataCompositeMedia; + /** + * The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in. + */ + objectVersion?: string | null; + } + /** + * Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. + */ + export interface Schema$GdataDiffUploadResponse { + /** + * The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload. + */ + objectVersion?: string | null; + /** + * The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification. + */ + originalObject?: Schema$GdataCompositeMedia; + } + /** + * Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. + */ + export interface Schema$GdataDiffVersionResponse { + /** + * The total size of the server object. + */ + objectSizeBytes?: string | null; + /** + * The version of the object stored at the server. + */ + objectVersion?: string | null; + } + /** + * Parameters specific to media downloads. + */ + export interface Schema$GdataDownloadParameters { + /** + * A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client. + */ + allowGzipCompression?: boolean | null; + /** + * Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty. + */ + ignoreRange?: boolean | null; + } + /** + * A reference to data stored on the filesystem, on GFS or in blobstore. + */ + export interface Schema$GdataMedia { + /** + * Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time. + */ + algorithm?: string | null; + /** + * Use object_id instead. + */ + bigstoreObjectRef?: string | null; + /** + * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef. + */ + blobRef?: string | null; + /** + * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob. + */ + blobstore2Info?: Schema$GdataBlobstore2Info; + /** + * A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified. + */ + compositeMedia?: Schema$GdataCompositeMedia[]; + /** + * MIME type of the data + */ + contentType?: string | null; + /** + * Extended content type information provided for Scotty uploads. + */ + contentTypeInfo?: Schema$GdataContentTypeInfo; + /** + * A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. + */ + cosmoBinaryReference?: string | null; + /** + * For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported. + */ + crc32cHash?: number | null; + /** + * Set if reference_type is DIFF_CHECKSUMS_RESPONSE. + */ + diffChecksumsResponse?: Schema$GdataDiffChecksumsResponse; + /** + * Set if reference_type is DIFF_DOWNLOAD_RESPONSE. + */ + diffDownloadResponse?: Schema$GdataDiffDownloadResponse; + /** + * Set if reference_type is DIFF_UPLOAD_REQUEST. + */ + diffUploadRequest?: Schema$GdataDiffUploadRequest; + /** + * Set if reference_type is DIFF_UPLOAD_RESPONSE. + */ + diffUploadResponse?: Schema$GdataDiffUploadResponse; + /** + * Set if reference_type is DIFF_VERSION_RESPONSE. + */ + diffVersionResponse?: Schema$GdataDiffVersionResponse; + /** + * Parameters for a media download. + */ + downloadParameters?: Schema$GdataDownloadParameters; + /** + * Original file name + */ + filename?: string | null; + /** + * Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. + */ + hash?: string | null; + /** + * For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification. + */ + hashVerified?: boolean | null; + /** + * Media data, set if reference_type is INLINE + */ + inline?: string | null; + /** + * |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence. + */ + isPotentialRetry?: boolean | null; + /** + * Size of the data, in bytes + */ + length?: string | null; + /** + * Scotty-provided MD5 hash for an upload. + */ + md5Hash?: string | null; + /** + * Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA. + */ + mediaId?: string | null; + /** + * Reference to a TI Blob, set if reference_type is BIGSTORE_REF. + */ + objectId?: Schema$GdataObjectId; + /** + * Path to the data, set if reference_type is PATH + */ + path?: string | null; + /** + * Describes what the field reference contains. + */ + referenceType?: string | null; + /** + * Scotty-provided SHA1 hash for an upload. + */ + sha1Hash?: string | null; + /** + * Scotty-provided SHA256 hash for an upload. + */ + sha256Hash?: string | null; + /** + * Time at which the media data was last updated, in milliseconds since UNIX epoch + */ + timestamp?: string | null; + /** + * A unique fingerprint/version id for the media data + */ + token?: string | null; + } + /** + * This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. + */ + export interface Schema$GdataObjectId { + /** + * The name of the bucket to which this object belongs. + */ + bucketName?: string | null; + /** + * Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions + */ + generation?: string | null; + /** + * The name of the object. + */ + objectName?: string | null; + } /** * `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. */ @@ -303,6 +722,39 @@ export namespace discoveryengine_v1alpha { */ userLabels?: {[key: string]: string} | null; } + /** + * The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun` + */ + export interface Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext { + /** + * The full resource name of the Connector Run. Format: `projects/x/locations/x/collections/x/dataConnector/connectorRuns/x`. The `connector_run_id` is system-generated. + */ + connectorRun?: string | null; + /** + * The full resource name of the DataConnector. Format: `projects/x/locations/x/collections/x/dataConnector`. + */ + dataConnector?: string | null; + /** + * The time when the connector run ended. + */ + endTime?: string | null; + /** + * The entity to sync for the connector run. + */ + entity?: string | null; + /** + * The operation resource name of the LRO to sync the connector. + */ + operation?: string | null; + /** + * The time when the connector run started. + */ + startTime?: string | null; + /** + * The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL` + */ + syncType?: string | null; + } /** * A description of the context in which an error occurred. */ @@ -320,6 +772,10 @@ export namespace discoveryengine_v1alpha { * An error log which is reported to the Error Reporting system. */ export interface Schema$GoogleCloudDiscoveryengineLoggingErrorLog { + /** + * The error payload that is populated on LRO connector sync APIs. + */ + connectorRunPayload?: Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext; /** * A description of the context in which the error occurred. */ @@ -457,7 +913,7 @@ export namespace discoveryengine_v1alpha { */ query?: string | null; /** - * 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. + * Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. 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 | null; /** @@ -549,10 +1005,22 @@ export namespace discoveryengine_v1alpha { * The name of the dataStore that this suggestion belongs to. */ dataStore?: string | null; + /** + * The destination uri of the content suggestion. + */ + destinationUri?: string | null; /** * The document data snippet in the suggestion. Only a subset of fields will be populated. */ document?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + /** + * The icon uri of the content suggestion. + */ + iconUri?: string | null; + /** + * The score of each suggestion. The score is in the range of [0, 1]. + */ + score?: number | null; /** * The suggestion for the query. */ @@ -566,6 +1034,14 @@ export namespace discoveryengine_v1alpha { * The name of the dataStore that this suggestion belongs to. */ dataStore?: string | null; + /** + * The destination uri of the person suggestion. + */ + destinationUri?: string | null; + /** + * The photo uri of the person suggestion. + */ + displayPhotoUri?: string | null; /** * The document data snippet in the suggestion. Only a subset of fields is populated. */ @@ -574,6 +1050,10 @@ export namespace discoveryengine_v1alpha { * The type of the person. */ personType?: string | null; + /** + * The score of each suggestion. The score is in the range of [0, 1]. + */ + score?: number | null; /** * The suggestion for the query. */ @@ -591,6 +1071,10 @@ export namespace discoveryengine_v1alpha { * The name of the dataStore that this suggestion belongs to. */ dataStore?: string[] | null; + /** + * The score of each suggestion. The score is in the range of [0, 1]. + */ + score?: number | null; /** * The suggestion for the query. */ @@ -604,6 +1088,10 @@ export namespace discoveryengine_v1alpha { * The time when this recent rearch happened. */ recentSearchTime?: string | null; + /** + * The score of each suggestion. The score is in the range of [0, 1]. + */ + score?: number | null; /** * The suggestion for the query. */ @@ -622,6 +1110,32 @@ export namespace discoveryengine_v1alpha { */ disableInitialIndex?: boolean | null; } + /** + * The connector level alert config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig { + /** + * Optional. The enrollment states of each alert. + */ + alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment[]; + /** + * Immutable. The fully qualified resource name of the AlertPolicy. + */ + alertPolicyName?: string | null; + } + /** + * The alert enrollment status. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment { + /** + * Immutable. The id of an alert. + */ + alertId?: string | null; + /** + * Required. The enrollment status of a customer. + */ + enrollState?: string | null; + } /** * AlloyDB source import data from. */ @@ -717,7 +1231,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation { /** - * End of the attributed segment, exclusive. + * End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ endIndex?: string | null; /** @@ -725,7 +1239,7 @@ export namespace discoveryengine_v1alpha { */ sources?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[]; /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ startIndex?: string | null; } @@ -928,6 +1442,10 @@ export namespace discoveryengine_v1alpha { * Query understanding specification. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec { + /** + * Optional. Whether to disable spell correction. The default value is `false`. + */ + disableSpellCorrection?: boolean | null; /** * Query classification specification. */ @@ -1291,6 +1809,14 @@ export namespace discoveryengine_v1alpha { * Structured search data. */ structData?: {[key: string]: any} | null; + /** + * Output only. The title of the document. + */ + title?: string | null; + /** + * Output only. The URI of the document. + */ + uri?: string | null; } /** * Unstructured document information. @@ -1442,6 +1968,15 @@ export namespace discoveryengine_v1alpha { */ query?: string | null; } + /** + * The configuration for the BAP connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig { + /** + * Required. The supported connector modes for the associated BAP connection. + */ + supportedConnectorModes?: string[] | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -1693,7 +2228,7 @@ export namespace discoveryengine_v1alpha { */ claimText?: string | null; /** - * Position indicating the end of the claim in the answer candidate, exclusive. + * Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */ endPos?: number | null; /** @@ -1701,7 +2236,7 @@ export namespace discoveryengine_v1alpha { */ groundingCheckRequired?: boolean | null; /** - * Position indicating the start of the claim in the answer candidate, measured in bytes. + * Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */ startPos?: number | null; } @@ -1895,11 +2430,11 @@ export namespace discoveryengine_v1alpha { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -1907,7 +2442,7 @@ export namespace discoveryengine_v1alpha { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -1915,7 +2450,7 @@ export namespace discoveryengine_v1alpha { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1alphaSingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -2100,6 +2635,10 @@ export namespace discoveryengine_v1alpha { * Represents an entity that was synced in this ConnectorRun. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun { + /** + * The number of documents deleted. + */ + deletedRecordCount?: string | null; /** * The name of the source entity. */ @@ -2120,6 +2659,10 @@ export namespace discoveryengine_v1alpha { * The number of documents indexed. */ indexedRecordCount?: string | null; + /** + * Metadata to generate the progress bar. + */ + progress?: Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress; /** * The number of requests sent to 3p API. */ @@ -2141,6 +2684,23 @@ export namespace discoveryengine_v1alpha { */ syncType?: string | null; } + /** + * Represents the progress of a sync run. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress { + /** + * The current progress. + */ + currentCount?: string | null; + /** + * Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive. + */ + percentile?: number | null; + /** + * The total. + */ + totalCount?: 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`. */ @@ -2210,6 +2770,44 @@ export namespace discoveryengine_v1alpha { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -2530,14 +3128,26 @@ export namespace discoveryengine_v1alpha { * Optional. Action configurations to make the connector support actions. */ actionConfig?: Schema$GoogleCloudDiscoveryengineV1alphaActionConfig; + /** + * Optional. The connector level alert config. + */ + alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig[]; /** * Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. */ autoRunDisabled?: boolean | null; + /** + * Optional. The configuration for establishing a BAP connection. + */ + bapConfig?: Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig; /** * Output only. User actions that must be completed before the connector can start syncing data. */ blockingReasons?: string[] | null; + /** + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system. + */ + connectorType?: string | null; /** * Output only. Timestamp the DataConnector was created at. */ @@ -2594,6 +3204,10 @@ export namespace discoveryengine_v1alpha { * Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. */ privateConnectivityProjectId?: string | null; + /** + * Output only. real-time sync state + */ + realtimeState?: string | null; /** * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. */ @@ -2631,6 +3245,10 @@ export namespace discoveryengine_v1alpha { * The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` */ entityName?: string | null; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; /** * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */ @@ -2639,6 +3257,10 @@ export namespace discoveryengine_v1alpha { * The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. */ params?: {[key: string]: any} | null; + /** + * Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector 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; } /** * DataStore captures global settings and configs at the DataStore level. @@ -2669,7 +3291,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -2680,6 +3302,14 @@ export namespace discoveryengine_v1alpha { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Output only. Data store level identity provider config. */ @@ -2767,15 +3397,36 @@ export namespace discoveryengine_v1alpha { * The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries { + /** + * Vertex AI's error rate time series of auto-refresh dedicated crawl. + */ + autoRefreshCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; /** * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. */ autoRefreshCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; + /** + * Vertex AI's error rate time series of user triggered dedicated crawl. + */ + userTriggeredCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; /** * Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. */ userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; } + /** + * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata { + /** + * 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 CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -3262,6 +3913,10 @@ export namespace discoveryengine_v1alpha { * 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$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -3675,283 +4330,6 @@ export namespace discoveryengine_v1alpha { */ inputUris?: string[] | null; } - /** - * Top-level message sent by the client for the `GenerateGroundedContent` method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest { - /** - * Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - */ - contents?: Schema$GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent[]; - /** - * Content generation specification. - */ - generationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec; - /** - * Grounding specification. - */ - groundingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec; - /** - * Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them. - */ - systemInstruction?: Schema$GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent; - /** - * 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; - } - /** - * Describes the options to customize dynamic retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration { - /** - * Specification for the predictor for dynamic retrieval. - */ - predictor?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor; - } - /** - * Describes the predictor settings for dynamic retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor { - /** - * The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source. - */ - threshold?: number | null; - /** - * The version of the predictor to be used in dynamic retrieval. - */ - version?: string | null; - } - /** - * Content generation specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec { - /** - * If specified, custom value for frequency penalty will be used. - */ - frequencyPenalty?: number | null; - /** - * Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). - */ - languageCode?: string | null; - /** - * If specified, custom value for max output tokens will be used. - */ - maxOutputTokens?: number | null; - /** - * Specifies which Vertex model id to use for generation. - */ - modelId?: string | null; - /** - * If specified, custom value for presence penalty will be used. - */ - presencePenalty?: number | null; - /** - * If specified, custom value for the seed will be used. - */ - seed?: number | null; - /** - * If specified, custom value for the temperature will be used. - */ - temperature?: number | null; - /** - * If specified, custom value for top-k sampling will be used. - */ - topK?: number | null; - /** - * If specified, custom value for nucleus sampling will be used. - */ - topP?: number | null; - } - /** - * Grounding source. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource { - /** - * If set, grounding is performed with Google Search. - */ - googleSearchSource?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource; - /** - * If set, grounding is performed with inline content. - */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource; - /** - * If set, grounding is performed with Vertex AI Search. - */ - searchSource?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource; - } - /** - * Google Search config parameters. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource { - /** - * Optional. Specifies the dynamic retrieval configuration for the given source. - */ - dynamicRetrievalConfig?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration; - } - /** - * Message to be used for grounding based on inline content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource { - /** - * Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content). - */ - attributes?: {[key: string]: string} | null; - /** - * List of facts to be used for grounding. - */ - groundingFacts?: Schema$GoogleCloudDiscoveryengineV1alphaGroundingFact[]; - } - /** - * Message to be used for grounding with Vertex AI Search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource { - /** - * Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter. - */ - filter?: string | null; - /** - * Number of search results to return. The default value is 10. The maximumm allowed value is 10. - */ - maxResultCount?: number | null; - /** - * If set, safe search is enabled in Vertex AI Search requests. - */ - safeSearch?: boolean | null; - /** - * The resource name of the Engine to use. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - servingConfig?: string | null; - } - /** - * Grounding specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec { - /** - * Grounding sources. - */ - groundingSources?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource[]; - } - /** - * Response for the `GenerateGroundedContent` method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse { - /** - * Generated candidates. - */ - candidates?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate[]; - } - /** - * A response candidate generated from the model. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate { - /** - * Content of the candidate. - */ - content?: Schema$GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent; - /** - * Grounding metadata for the generated content. - */ - groundingMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata; - /** - * The overall grounding score for the candidate, in the range of [0, 1]. - */ - groundingScore?: number | null; - /** - * Index of the candidate. - */ - index?: number | null; - } - /** - * Citation for the generated content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata { - /** - * GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact. - */ - groundingSupport?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport[]; - /** - * Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users. - */ - retrievalMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata[]; - /** - * Google search entry for the following-up web searches. - */ - searchEntryPoint?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint; - /** - * List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request. - */ - supportChunks?: Schema$GoogleCloudDiscoveryengineV1alphaFactChunk[]; - /** - * Web search queries for the following-up web search. - */ - webSearchQueries?: string[] | null; - } - /** - * Describes the metadata about dynamic retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata { - /** - * Metadata for the dynamic retrieval predictor. - */ - predictorMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata; - } - /** - * Describes the metadata about the dynamic retrieval predictor. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata { - /** - * The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding. - */ - prediction?: number | null; - /** - * The version of the predictor which was used in dynamic retrieval. - */ - version?: string | null; - } - /** - * Grounding info for a claim in the candidate and its support. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport { - /** - * Text for the claim in the candidate. Always provided when a support is found. - */ - claimText?: string | null; - /** - * A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim. - */ - supportChunkIndices?: number[] | null; - /** - * A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks. - */ - supportScore?: number | null; - } - /** - * Describes the metadata associated with a retrieval step. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata { - /** - * Metadata for dynamic retrieval. - */ - dynamicRetrievalMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata; - /** - * Describes the source to which the metadata is referring to. - */ - source?: string | null; - } - /** - * Google search entry point. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint { - /** - * Web content snippet that can be embedded in a web page or an app webview. - */ - renderedContent?: string | null; - /** - * Base64 encoded JSON representing array of tuple. - */ - sdkBlob?: string | null; - } /** * Request for GetSession method. */ @@ -3974,28 +4352,6 @@ export namespace discoveryengine_v1alpha { */ documentDataMap?: {[key: string]: {[key: string]: any}} | null; } - /** - * Base structured datatype containing multi-part content of a message. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent { - /** - * Ordered `Parts` that constitute a single message. - */ - parts?: Schema$GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart[]; - /** - * Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset. - */ - role?: string | null; - } - /** - * Single part of content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart { - /** - * Inline text. - */ - text?: string | null; - } /** * Grounding Fact. */ @@ -4026,6 +4382,74 @@ export namespace discoveryengine_v1alpha { */ maxRelatedQuestions?: number | null; } + /** + * Config to data store for `HEALTHCARE_FHIR` vertical. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig { + /** + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. + */ + enableConfigurableSchema?: boolean | null; + /** + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + */ + enableStaticIndexingForBatchIngestion?: boolean | null; + } + /** + * Identity Mapping Entry that maps an external identity to an internal identity. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry { + /** + * Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters. + */ + externalIdentity?: string | null; + /** + * Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config. + */ + groupId?: string | null; + /** + * User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config. + */ + userId?: string | null; + } + /** + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata { + /** + * The number of IdentityMappingEntries that failed to be processed. + */ + failureCount?: string | null; + /** + * The number of IdentityMappingEntries that were successfully processed. + */ + successCount?: string | null; + /** + * The total number of IdentityMappingEntries that were processed. + */ + totalCount?: string | null; + } + /** + * Identity Mapping Store which contains Identity Mapping Entries. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingStore { + /** + * Output only. CMEK-related information for the Identity Mapping Store. + */ + cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig; + /** + * Output only. The identity provider configuration this is bound to translate the identity mapping entries within. + */ + idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig; + /** + * Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field. + */ + kmsKeyName?: string | null; + /** + * Immutable. The full resource name of the identity mapping store. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * The configuration for the identity data synchronization runs. */ @@ -4246,6 +4670,33 @@ export namespace discoveryengine_v1alpha { */ gcsPrefix?: string | null; } + /** + * Request message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest { + /** + * The inline source to import identity mapping entries from. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource; + } + /** + * The inline source to import identity mapping entries from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource { + /** + * A maximum of 10000 entries can be imported at one time + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry[]; + } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4641,6 +5092,32 @@ export namespace discoveryengine_v1alpha { */ nextPageToken?: string | null; } + /** + * Response message for IdentityMappingStoreService.ListIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse { + /** + * The Identity Mapping Entries. + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry[]; + /** + * 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; + } + /** + * Response message for IdentityMappingStoreService.ListIdentityMappingStores + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse { + /** + * The Identity Mapping Stores. + */ + identityMappingStores?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingStore[]; + /** + * 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; + } /** * Response message for SampleQueryService.ListSampleQueries method. */ @@ -5067,6 +5544,32 @@ export namespace discoveryengine_v1alpha { */ gcsPrefix?: string | null; } + /** + * Request message for IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest { + /** + * Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 "zulu" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time \> "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` * Deleting all identity mappings for a given external_id: `external_id = "id1"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided. + */ + filter?: string | null; + /** + * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field. + */ + force?: boolean | null; + /** + * The inline source to purge identity mapping entries from. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource; + } + /** + * The inline source to purge identity mapping entries from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource { + /** + * A maximum of 10000 entries can be purged at one time + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry[]; + } /** * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -5229,7 +5732,7 @@ export namespace discoveryengine_v1alpha { */ 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. + * The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. */ model?: string | null; /** @@ -5341,6 +5844,14 @@ export namespace discoveryengine_v1alpha { * Total number of unique URIs in the request that have invalid format. */ invalidUrisCount?: number | null; + /** + * URIs that have no index meta tag. Sample limited to 1000. + */ + noindexUris?: string[] | null; + /** + * Total number of URIs that have no index meta tag. + */ + noindexUrisCount?: number | null; /** * Total number of URIs that have yet to be crawled. */ @@ -5375,7 +5886,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest { /** - * Optional. Full resource name of the `SiteCredential`, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/siteCredentials/x`. Only set to crawl private URIs. + * Optional. Credential id to use for crawling. */ siteCredential?: string | null; /** @@ -5457,6 +5968,35 @@ export namespace discoveryengine_v1alpha { */ state?: string | null; } + /** + * Request message for CompletionService.RemoveSuggestion method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest { + /** + * Remove all search history suggestions for the user. + */ + removeAllSearchHistorySuggestions?: boolean | null; + /** + * Required. Time at which the suggestion was removed. If not set, the current time will be used. + */ + removeTime?: string | null; + /** + * The search history suggestion to be removed. + */ + searchHistorySuggestion?: string | null; + /** + * Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + */ + userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; + /** + * 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 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. + */ + userPseudoId?: string | null; + } + /** + * Response message for CompletionService.RemoveSuggestion method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse {} /** * Defines a reply message to user. */ @@ -5781,7 +6321,7 @@ export namespace discoveryengine_v1alpha { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -5810,9 +6350,13 @@ export namespace discoveryengine_v1alpha { */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + * Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; + /** + * Optional. Config for display feature, like match highlighting on search results. + */ + displaySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec; /** * 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. */ @@ -5874,15 +6418,23 @@ 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 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. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double \> 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */ rankingExpression?: string | null; + /** + * Optional. The backend to use for the ranking expression evaluation. + */ + rankingExpressionBackend?: string | null; /** * 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. */ regionCode?: string | null; /** - * 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. + * Optional. The specification for returning the relevance score. + */ + relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec; + /** + * 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. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -5910,7 +6462,7 @@ export namespace discoveryengine_v1alpha { */ spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. */ userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; /** @@ -6142,6 +6694,15 @@ export namespace discoveryengine_v1alpha { */ filter?: string | null; } + /** + * Specifies features for display, like match highlighting. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec { + /** + * The condition under which match highlighting should occur. + */ + matchHighlightingCondition?: string | null; + } /** * The specification that uses customized query embedding vector to do semantic document retrieval. */ @@ -6262,6 +6823,15 @@ export namespace discoveryengine_v1alpha { */ pinUnexpandedResults?: boolean | null; } + /** + * The specification for returning the document relevance score. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec { + /** + * Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. + */ + returnRelevanceScore?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -6280,7 +6850,7 @@ export namespace discoveryengine_v1alpha { */ 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. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar 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; } @@ -6440,6 +7010,10 @@ export namespace discoveryengine_v1alpha { * Information describing what natural language understanding was done on the input query. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo { + /** + * The classified intents from the input query. + */ + classifiedIntents?: string[] | null; /** * The filters that were extracted from the input query. */ @@ -6624,7 +7198,7 @@ export namespace discoveryengine_v1alpha { */ id?: string | null; /** - * Google provided available scores. + * Output only. Google provided available scores. */ modelScores?: { [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDoubleList; @@ -7536,6 +8110,449 @@ export namespace discoveryengine_v1alpha { */ userId?: string | null; } + /** + * WidgetConfig captures configs at the Widget level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfig { + /** + * Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. + */ + accessSettings?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings; + /** + * Allowlisted domains that can load this widget. + */ + allowlistedDomains?: string[] | null; + /** + * Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. + */ + allowPublicAccess?: boolean | null; + /** + * Optional. Output only. Describes the assistant settings of the widget. + */ + assistantSettings?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings; + /** + * Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. + */ + collectionComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[]; + /** + * Output only. Unique obfuscated identifier of a WidgetConfig. + */ + configId?: string | null; + /** + * The content search spec that configs the desired behavior of content search. + */ + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec; + /** + * Output only. Timestamp the WidgetConfig was created. + */ + createTime?: string | null; + /** + * Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. + */ + customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig; + /** + * Output only. The type of the parent data store. + */ + dataStoreType?: string | null; + /** + * Configurable UI configurations per data store. + */ + dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[]; + /** + * The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body + */ + defaultSearchRequestOrderBy?: string | null; + /** + * Required. The human readable widget 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; + /** + * Whether or not to enable autocomplete. + */ + enableAutocomplete?: boolean | null; + /** + * Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). + */ + enableConversationalSearch?: boolean | null; + /** + * Turn on or off collecting the search result quality feedback from end users. + */ + enableQualityFeedback?: boolean | null; + /** + * Whether to show the result score. + */ + enableResultScore?: boolean | null; + /** + * Whether to enable safe search. + */ + enableSafeSearch?: boolean | null; + /** + * Whether to enable search-as-you-type behavior for the search widget + */ + enableSearchAsYouType?: boolean | null; + /** + * Turn on or off summary for each snippets result. + */ + enableSnippetResultSummary?: boolean | null; + /** + * Turn on or off summarization for the search response. + */ + enableSummarization?: boolean | null; + /** + * Whether to enable standalone web app. + */ + enableWebApp?: boolean | null; + /** + * Allows to toggle unstable/experimental features in the widget (or web app) + */ + experimentalFeatures?: {[key: string]: string} | null; + /** + * The configuration and appearance of facets in the end user view. + */ + facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[]; + /** + * The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. + */ + fieldsUiComponentsMap?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField; + } | null; + /** + * Optional. Describes the homepage settings of the widget. + */ + homepageSetting?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting; + /** + * Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. + */ + industryVertical?: string | null; + /** + * Output only. Whether LLM is enabled in the corresponding data store. + */ + llmEnabled?: boolean | null; + /** + * Output only. Whether the customer accepted data use terms. + */ + minimumDataTermAccepted?: boolean | null; + /** + * Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users. + */ + resultDisplayType?: string | null; + /** + * Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. + */ + solutionType?: string | null; + /** + * Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. + */ + uiBranding?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings; + /** + * Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties. + */ + uiSettings?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings; + /** + * Output only. Timestamp the WidgetConfig was updated. + */ + updateTime?: string | null; + } + /** + * Describes widget access settings. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings { + /** + * List of domains that are allowed to integrate the search widget. + */ + allowlistedDomains?: string[] | null; + /** + * Whether public unauthenticated access is allowed. + */ + allowPublicAccess?: boolean | null; + /** + * Whether web app access is enabled. + */ + enableWebApp?: boolean | null; + /** + * Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US". + */ + languageCode?: string | null; + /** + * Optional. The workforce identity pool provider used to access the widget. + */ + workforceIdentityPoolProvider?: string | null; + } + /** + * Describes the assistant settings of the widget. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings { + /** + * Whether or not the Google search grounding toggle is shown. + */ + googleSearchGroundingEnabled?: boolean | null; + } + /** + * Read-only collection component that contains data store collections fields that may be used for filtering + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent { + /** + * Output only. The icon link of the connector source. + */ + connectorIconLink?: string | null; + /** + * The name of the data source, retrieved from `Collection.data_connector.data_source`. + */ + dataSource?: string | null; + /** + * For the data store collection, list of the children data stores. + */ + dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[]; + /** + * The display name of the collection. + */ + displayName?: string | null; + /** + * Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. + */ + id?: string | null; + /** + * The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field. + */ + name?: string | null; + } + /** + * Customer provided configurations. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig { + /** + * Customer type. + */ + customerType?: string | null; + } + /** + * Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent { + /** + * Output only. The content config of the data store. + */ + contentConfig?: string | null; + /** + * The display name of the data store. + */ + displayName?: string | null; + /** + * The name of the entity, retrieved from `Collection.data_connector.entities.entityName`. + */ + entityName?: string | null; + /** + * Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. + */ + id?: string | null; + /** + * The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field. + */ + name?: string | null; + /** + * Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`. + */ + workspaceType?: string | null; + } + /** + * UI component configuration for data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig { + /** + * Facet fields that store the mapping of fields to end user widget appearance. + */ + facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[]; + /** + * The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. + */ + fieldsUiComponentsMap?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField; + } | null; + /** + * Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. + */ + id?: string | null; + /** + * The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field. + */ + name?: string | null; + } + /** + * Facet fields that store the mapping of fields to end user widget appearance. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField { + /** + * Optional. The field name that end users will see. + */ + displayName?: string | null; + /** + * Required. Registered field name. The format is `field.abc`. + */ + field?: string | null; + } + /** + * Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting { + /** + * Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number) + */ + shortcuts?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut[]; + } + /** + * Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut { + /** + * Optional. Destination URL of shortcut. + */ + destinationUri?: string | null; + /** + * Optional. Icon URL of shortcut. + */ + icon?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigImage; + /** + * Optional. Title of the shortcut. + */ + title?: string | null; + } + /** + * Options to store an image. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigImage { + /** + * Image URL. + */ + url?: string | null; + } + /** + * Describes widget UI branding settings. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings { + /** + * Logo image. + */ + logo?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigImage; + } + /** + * Facet field that maps to a UI Component. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField { + /** + * The field visibility on different types of devices. + */ + deviceVisibility?: string[] | null; + /** + * The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}". + */ + displayTemplate?: string | null; + /** + * Required. Registered field name. The format is `field.abc`. + */ + field?: string | null; + } + /** + * Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings { + /** + * Per data store configuration. + */ + dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[]; + /** + * The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body + */ + defaultSearchRequestOrderBy?: string | null; + /** + * If set to true, the widget will not collect user events. + */ + disableUserEventsCollection?: boolean | null; + /** + * Whether or not to enable autocomplete. + */ + enableAutocomplete?: boolean | null; + /** + * Turn on or off collecting the search result quality feedback from end users. + */ + enableQualityFeedback?: boolean | null; + /** + * Whether to enable safe search. + */ + enableSafeSearch?: boolean | null; + /** + * Whether to enable search-as-you-type behavior for the search widget. + */ + enableSearchAsYouType?: boolean | null; + /** + * If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. + */ + enableVisualContentSummary?: boolean | null; + /** + * Describes generative answer configuration. + */ + generativeAnswerConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig; + /** + * Describes widget (or web app) interaction type + */ + interactionType?: string | null; + /** + * Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. + */ + resultDescriptionType?: string | null; + } + /** + * Describes configuration for generative answer. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig { + /** + * Whether generated answer contains suggested related questions. + */ + disableRelatedQuestions?: boolean | null; + /** + * Optional. Specifies whether to filter out queries that are adversarial. + */ + ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out queries that are not relevant to the content. + */ + ignoreLowRelevantContent?: boolean | null; + /** + * Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. 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; + /** + * Optional. Source of image returned in the answer. + */ + imageSource?: string | 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. + */ + languageCode?: string | 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; + /** + * Text at the beginning of the prompt that instructs the model that generates the answer. + */ + modelPromptPreamble?: string | null; + /** + * The model version used to generate the answer. + */ + modelVersion?: string | null; + /** + * The number of top results to generate the answer from. Up to 10. + */ + resultCount?: number | null; + } /** * Config to store data store type configuration for workspace data */ @@ -7623,11 +8640,11 @@ export namespace discoveryengine_v1alpha { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -7635,7 +8652,7 @@ export namespace discoveryengine_v1alpha { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -7643,7 +8660,7 @@ export namespace discoveryengine_v1alpha { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1betaSingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -7759,6 +8776,44 @@ export namespace discoveryengine_v1alpha { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -7804,6 +8859,15 @@ export namespace discoveryengine_v1alpha { */ synonyms?: string[] | null; } + /** + * The historical crawl rate timeseries data, used for monitoring. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries { + /** + * The QPS of the crawl rate. + */ + qpsTimeSeries?: Schema$GoogleMonitoringV3TimeSeries; + } /** * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -7898,7 +8962,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -7909,6 +8973,14 @@ export namespace discoveryengine_v1alpha { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Immutable. The industry vertical that the data store registers. */ @@ -7988,6 +9060,27 @@ export namespace discoveryengine_v1alpha { */ disabledForServing?: boolean | null; } + /** + * The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries { + /** + * Vertex AI's error rate time series of auto-refresh dedicated crawl. + */ + autoRefreshCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. + */ + autoRefreshCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's error rate time series of user triggered dedicated crawl. + */ + userTriggeredCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. + */ + userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -8246,6 +9339,10 @@ export namespace discoveryengine_v1alpha { * 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; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -8363,22 +9460,34 @@ export namespace discoveryengine_v1alpha { sampleQuerySet?: string | null; } /** - * Response message for SiteSearchEngineService.FetchSitemaps method. + * Config to data store for `HEALTHCARE_FHIR` vertical. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig { /** - * List of Sitemaps fetched. + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. + */ + enableConfigurableSchema?: boolean | null; + /** + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. */ - sitemapsMetadata?: Schema$GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata[]; + enableStaticIndexingForBatchIngestion?: boolean | null; } /** - * Contains a Sitemap and its metadata. + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata { /** - * The Sitemap. + * The number of IdentityMappingEntries that failed to be processed. + */ + failureCount?: string | null; + /** + * The number of IdentityMappingEntries that were successfully processed. */ - sitemap?: Schema$GoogleCloudDiscoveryengineV1betaSitemap; + successCount?: string | null; + /** + * The total number of IdentityMappingEntries that were processed. + */ + totalCount?: string | null; } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -8461,6 +9570,15 @@ export namespace discoveryengine_v1alpha { */ gcsPrefix?: string | null; } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -8622,6 +9740,40 @@ export namespace discoveryengine_v1alpha { */ mode?: string | null; } + /** + * Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse { + /** + * The historical dedicated crawl rate timeseries data, used for monitoring. + */ + dedicatedCrawlRateTimeSeries?: Schema$GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries; + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * The historical organic crawl rate timeseries data, used for monitoring. + */ + organicCrawlRateTimeSeries?: Schema$GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries; + /** + * Output only. The state of the response. + */ + state?: string | null; + } + /** + * The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries { + /** + * Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots. + */ + googleOrganicCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot. + */ + vertexAiOrganicCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -8784,6 +9936,32 @@ export namespace discoveryengine_v1alpha { */ top5?: number | null; } + /** + * Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata { + /** + * 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 CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse { + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. The state of the response. + */ + state?: string | null; + } /** * Defines the structure and layout of a type of document data. */ @@ -8822,7 +10000,7 @@ export namespace discoveryengine_v1alpha { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -8847,9 +10025,13 @@ export namespace discoveryengine_v1alpha { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + * Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; + /** + * Optional. Config for display feature, like match highlighting on search results. + */ + displaySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec; /** * 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. */ @@ -8911,15 +10093,23 @@ export namespace discoveryengine_v1alpha { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * 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)`. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double \> 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */ rankingExpression?: string | null; + /** + * Optional. The backend to use for the ranking expression evaluation. + */ + rankingExpressionBackend?: string | null; /** * 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. */ regionCode?: string | null; /** - * 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. + * Optional. The specification for returning the relevance score. + */ + relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec; + /** + * 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. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -8947,7 +10137,7 @@ export namespace discoveryengine_v1alpha { */ spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. */ userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** @@ -9179,6 +10369,15 @@ export namespace discoveryengine_v1alpha { */ filter?: string | null; } + /** + * Specifies features for display, like match highlighting. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec { + /** + * The condition under which match highlighting should occur. + */ + matchHighlightingCondition?: string | null; + } /** * The specification that uses customized query embedding vector to do semantic document retrieval. */ @@ -9299,6 +10498,15 @@ export namespace discoveryengine_v1alpha { */ pinUnexpandedResults?: boolean | null; } + /** + * The specification for returning the document relevance score. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec { + /** + * Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. + */ + returnRelevanceScore?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -9317,7 +10525,7 @@ export namespace discoveryengine_v1alpha { */ 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. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar 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; } @@ -9330,6 +10538,32 @@ export namespace discoveryengine_v1alpha { */ mode?: string | null; } + /** + * Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata { + /** + * 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 CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse { + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. The state of the response. + */ + state?: string | null; + } /** * Metadata for single-regional CMEKs. */ @@ -9552,11 +10786,11 @@ export namespace discoveryengine_v1alpha { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -9564,7 +10798,7 @@ export namespace discoveryengine_v1alpha { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -9572,7 +10806,7 @@ export namespace discoveryengine_v1alpha { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1SingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -9688,6 +10922,44 @@ export namespace discoveryengine_v1alpha { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -9772,6 +11044,19 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateSitemapMetadata { + /** + * 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. */ @@ -9810,7 +11095,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -9821,6 +11106,14 @@ export namespace discoveryengine_v1alpha { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Immutable. The industry vertical that the data store registers. */ @@ -9892,6 +11185,19 @@ export namespace discoveryengine_v1alpha { */ disabledForServing?: boolean | null; } + /** + * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata { + /** + * 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 DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -9944,6 +11250,19 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteSitemapMetadata { + /** + * 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. */ @@ -10137,6 +11456,10 @@ export namespace discoveryengine_v1alpha { * 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; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -10194,6 +11517,36 @@ export namespace discoveryengine_v1alpha { */ searchTier?: string | null; } + /** + * Config to data store for `HEALTHCARE_FHIR` vertical. + */ + export interface Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig { + /** + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. + */ + enableConfigurableSchema?: boolean | null; + /** + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + */ + enableStaticIndexingForBatchIngestion?: boolean | null; + } + /** + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata { + /** + * The number of IdentityMappingEntries that failed to be processed. + */ + failureCount?: string | null; + /** + * The number of IdentityMappingEntries that were successfully processed. + */ + successCount?: string | null; + /** + * The total number of IdentityMappingEntries that were processed. + */ + totalCount?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -10275,6 +11628,15 @@ export namespace discoveryengine_v1alpha { */ gcsPrefix?: string | null; } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse { + /** + * 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. */ @@ -10527,7 +11889,7 @@ export namespace discoveryengine_v1alpha { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -10798,6 +12160,23 @@ export namespace discoveryengine_v1alpha { */ kmsKey?: string | null; } + /** + * A sitemap for the SiteSearchEngine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Sitemap { + /** + * Output only. The sitemap's creation time. + */ + createTime?: string | null; + /** + * Output only. The fully qualified resource name of the sitemap. `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/sitemaps/x` The `sitemap_id` suffix is system-generated. + */ + name?: string | null; + /** + * Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. + */ + uri?: string | null; + } /** * Verification information for target sites in advanced site search. */ @@ -10972,6 +12351,41 @@ export namespace discoveryengine_v1alpha { */ type?: string | null; } + /** + * SourceId is the last segment of the source's resource name. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaSourceId { + /** + * The id of the source. + */ + id?: string | null; + } + /** + * Request for the SourceService.UploadSourceFile method. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaUploadSourceFileRequest { + /** + * Information about the file being uploaded. + */ + blob?: Schema$GdataMedia; + /** + * Media upload request metadata. + */ + mediaRequestInfo?: Schema$ApiservingMediaRequestInfo; + } + /** + * Response for the SourceService.UploadSourceFile method. + */ + export interface Schema$GoogleCloudNotebooklmV1alphaUploadSourceFileResponse { + /** + * Media upload response metadata. + */ + mediaResponseInfo?: Schema$ApiservingMediaResponseInfo; + /** + * The source id of the uploaded source. + */ + sourceId?: Schema$GoogleCloudNotebooklmV1alphaSourceId; + } /** * The request message for Operations.CancelOperation. */ @@ -11216,6 +12630,140 @@ export namespace discoveryengine_v1alpha { version?: string | null; } + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Uploads a file for Notebook LM to use. Creates a 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. + */ + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Media$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Media$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Upload; + 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}/sources:uploadFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: ( + rootUrl + '/upload/v1alpha/{+parent}/sources:uploadFile' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Media$Upload extends StandardParameters { + /** + * Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaUploadSourceFileRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + export class Resource$Projects { context: APIRequestContext; locations: Resource$Projects$Locations; @@ -11695,104 +13243,6 @@ export namespace discoveryengine_v1alpha { } } - /** - * Generates grounded 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. - */ - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - options: StreamMethodOptions - ): GaxiosPromise; - generateGroundedContent( - params?: Params$Resource$Projects$Locations$Generategroundedcontent, - options?: MethodOptions - ): GaxiosPromise; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - callback: BodyResponseCallback - ): void; - generateGroundedContent( - callback: BodyResponseCallback - ): void; - generateGroundedContent( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Generategroundedcontent - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Generategroundedcontent; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Generategroundedcontent; - 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}:generateGroundedContent' - ).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. * @@ -12569,18 +14019,6 @@ export namespace discoveryengine_v1alpha { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest; } - export interface Params$Resource$Projects$Locations$Generategroundedcontent - extends StandardParameters { - /** - * Required. Location resource. Format: `projects/{project\}/locations/{location\}`. - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest; - } export interface Params$Resource$Projects$Locations$Getaclconfig extends StandardParameters { /** @@ -12658,7 +14096,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Updatecmekconfig extends StandardParameters { /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string; /** @@ -12678,6 +14116,99 @@ export namespace discoveryengine_v1alpha { this.context = context; } + /** + * De-provisions a CmekConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Cmekconfigs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cmekconfigs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$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 the CmekConfig. * @@ -12965,6 +14496,13 @@ export namespace discoveryengine_v1alpha { } } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Delete + extends StandardParameters { + /** + * Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Cmekconfigs$Get extends StandardParameters { /** @@ -12982,7 +14520,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch extends StandardParameters { /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string; /** @@ -14156,6 +15694,7 @@ export namespace discoveryengine_v1alpha { siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; + widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs; constructor(context: APIRequestContext) { this.context = context; this.branches = @@ -14214,6 +15753,10 @@ export namespace discoveryengine_v1alpha { new Resource$Projects$Locations$Collections$Datastores$Userevents( this.context ); + this.widgetConfigs = + new Resource$Projects$Locations$Collections$Datastores$Widgetconfigs( + this.context + ); } /** @@ -22599,6 +24142,105 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + + /** + * Fetch Sitemaps in 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. + */ + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + options: StreamMethodOptions + ): GaxiosPromise; + fetch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + options?: MethodOptions + ): GaxiosPromise; + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + callback: BodyResponseCallback + ): void; + fetch( + callback: BodyResponseCallback + ): void; + fetch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch; + 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}/sitemaps:fetch').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$Sitesearchengine$Sitemaps$Create @@ -22620,6 +24262,17 @@ export namespace discoveryengine_v1alpha { */ name?: string; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch + extends StandardParameters { + /** + * The Sitemap uris. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + } export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { context: APIRequestContext; @@ -24179,6 +25832,121 @@ export namespace discoveryengine_v1alpha { requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; } + export class Resource$Projects$Locations$Collections$Datastores$Widgetconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a WidgetConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Widgetconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get + extends StandardParameters { + /** + * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + */ + acceptCache?: boolean; + /** + * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + */ + name?: string; + } + export class Resource$Projects$Locations$Collections$Engines { context: APIRequestContext; completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig; @@ -24187,6 +25955,7 @@ export namespace discoveryengine_v1alpha { operations: Resource$Projects$Locations$Collections$Engines$Operations; servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; sessions: Resource$Projects$Locations$Collections$Engines$Sessions; + widgetConfigs: Resource$Projects$Locations$Collections$Engines$Widgetconfigs; constructor(context: APIRequestContext) { this.context = context; this.completionConfig = @@ -24213,6 +25982,10 @@ export namespace discoveryengine_v1alpha { new Resource$Projects$Locations$Collections$Engines$Sessions( this.context ); + this.widgetConfigs = + new Resource$Projects$Locations$Collections$Engines$Widgetconfigs( + this.context + ); } /** @@ -25198,6 +26971,104 @@ export namespace discoveryengine_v1alpha { ); } } + + /** + * Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + options: StreamMethodOptions + ): GaxiosPromise; + removeSuggestion( + params?: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + options?: MethodOptions + ): GaxiosPromise; + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + callback: BodyResponseCallback + ): void; + removeSuggestion( + callback: BodyResponseCallback + ): void; + removeSuggestion( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+completionConfig}:removeSuggestion' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['completionConfig'], + pathParams: ['completionConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery @@ -25212,6 +27083,18 @@ export namespace discoveryengine_v1alpha { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest; } + export interface Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion + extends StandardParameters { + /** + * Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + */ + completionConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest; + } export class Resource$Projects$Locations$Collections$Engines$Controls { context: APIRequestContext; @@ -28222,6 +30105,121 @@ export namespace discoveryengine_v1alpha { name?: string; } + export class Resource$Projects$Locations$Collections$Engines$Widgetconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a WidgetConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Widgetconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get + extends StandardParameters { + /** + * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + */ + acceptCache?: boolean; + /** + * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + */ + name?: string; + } + export class Resource$Projects$Locations$Collections$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -28464,6 +30462,7 @@ export namespace discoveryengine_v1alpha { siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; userEvents: Resource$Projects$Locations$Datastores$Userevents; + widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs; constructor(context: APIRequestContext) { this.context = context; this.branches = new Resource$Projects$Locations$Datastores$Branches( @@ -28507,6 +30506,8 @@ export namespace discoveryengine_v1alpha { this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( this.context ); + this.widgetConfigs = + new Resource$Projects$Locations$Datastores$Widgetconfigs(this.context); } /** @@ -37223,6 +39224,121 @@ export namespace discoveryengine_v1alpha { requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; } + export class Resource$Projects$Locations$Datastores$Widgetconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a WidgetConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Widgetconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get + extends StandardParameters { + /** + * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + */ + acceptCache?: boolean; + /** + * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + */ + name?: string; + } + export class Resource$Projects$Locations$Evaluations { context: APIRequestContext; operations: Resource$Projects$Locations$Evaluations$Operations; @@ -37910,6 +40026,778 @@ export namespace discoveryengine_v1alpha { this.context ); } + + /** + * Creates a new Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$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}/identityMappingStores').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 Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$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 the Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$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 + ); + } + } + + /** + * Imports a list of Identity Mapping Entries to an Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + options: StreamMethodOptions + ): GaxiosPromise; + importIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + options?: MethodOptions + ): GaxiosPromise; + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + callback: BodyResponseCallback + ): void; + importIdentityMappings( + callback: BodyResponseCallback + ): void; + importIdentityMappings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1alpha/{+identityMappingStore}:importIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all Identity Mapping Stores. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Identitymappingstores$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$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}/identityMappingStores').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 + ); + } + } + + /** + * Lists Identity Mappings in an Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + options: StreamMethodOptions + ): GaxiosPromise; + listIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + options?: MethodOptions + ): GaxiosPromise; + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + callback: BodyResponseCallback + ): void; + listIdentityMappings( + callback: BodyResponseCallback + ): void; + listIdentityMappings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+identityMappingStore}:listIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Purges specified or all Identity Mapping Entries from an Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + options: StreamMethodOptions + ): GaxiosPromise; + purgeIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + options?: MethodOptions + ): GaxiosPromise; + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + callback: BodyResponseCallback + ): void; + purgeIdentityMappings( + callback: BodyResponseCallback + ): void; + purgeIdentityMappings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+identityMappingStore}:purgeIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Identitymappingstores$Create + extends StandardParameters { + /** + * Resource name of the CmekConfig to use for protecting this Identity Mapping Store. + */ + cmekConfigName?: string; + /** + * Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + */ + disableCmek?: boolean; + /** + * Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + */ + identityMappingStoreId?: string; + /** + * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingStore; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Delete + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Get + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$List + extends StandardParameters { + /** + * Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + /** + * Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest; } export class Resource$Projects$Locations$Identitymappingstores$Operations { diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 5d67030676e..dcfea6bddc9 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -303,6 +303,39 @@ export namespace discoveryengine_v1beta { */ userLabels?: {[key: string]: string} | null; } + /** + * The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun` + */ + export interface Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext { + /** + * The full resource name of the Connector Run. Format: `projects/x/locations/x/collections/x/dataConnector/connectorRuns/x`. The `connector_run_id` is system-generated. + */ + connectorRun?: string | null; + /** + * The full resource name of the DataConnector. Format: `projects/x/locations/x/collections/x/dataConnector`. + */ + dataConnector?: string | null; + /** + * The time when the connector run ended. + */ + endTime?: string | null; + /** + * The entity to sync for the connector run. + */ + entity?: string | null; + /** + * The operation resource name of the LRO to sync the connector. + */ + operation?: string | null; + /** + * The time when the connector run started. + */ + startTime?: string | null; + /** + * The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL` + */ + syncType?: string | null; + } /** * A description of the context in which an error occurred. */ @@ -320,6 +353,10 @@ export namespace discoveryengine_v1beta { * An error log which is reported to the Error Reporting system. */ export interface Schema$GoogleCloudDiscoveryengineLoggingErrorLog { + /** + * The error payload that is populated on LRO connector sync APIs. + */ + connectorRunPayload?: Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext; /** * A description of the context in which the error occurred. */ @@ -453,6 +490,32 @@ export namespace discoveryengine_v1beta { */ disableInitialIndex?: boolean | null; } + /** + * The connector level alert config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig { + /** + * Optional. The enrollment states of each alert. + */ + alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment[]; + /** + * Immutable. The fully qualified resource name of the AlertPolicy. + */ + alertPolicyName?: string | null; + } + /** + * The alert enrollment status. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment { + /** + * Immutable. The id of an alert. + */ + alertId?: string | null; + /** + * Required. The enrollment status of a customer. + */ + enrollState?: string | null; + } /** * Defines an answer. */ @@ -519,7 +582,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation { /** - * End of the attributed segment, exclusive. + * End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ endIndex?: string | null; /** @@ -527,7 +590,7 @@ export namespace discoveryengine_v1beta { */ sources?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[]; /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ startIndex?: string | null; } @@ -662,6 +725,14 @@ export namespace discoveryengine_v1beta { * Structured search data. */ structData?: {[key: string]: any} | null; + /** + * Output only. The title of the document. + */ + title?: string | null; + /** + * Output only. The URI of the document. + */ + uri?: string | null; } /** * Unstructured document information. @@ -813,6 +884,15 @@ export namespace discoveryengine_v1beta { */ query?: string | null; } + /** + * The configuration for the BAP connector. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig { + /** + * Required. The supported connector modes for the associated BAP connection. + */ + supportedConnectorModes?: string[] | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -844,11 +924,11 @@ export namespace discoveryengine_v1beta { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -856,7 +936,7 @@ export namespace discoveryengine_v1beta { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -864,7 +944,7 @@ export namespace discoveryengine_v1beta { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1alphaSingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -977,6 +1057,10 @@ export namespace discoveryengine_v1beta { * Represents an entity that was synced in this ConnectorRun. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun { + /** + * The number of documents deleted. + */ + deletedRecordCount?: string | null; /** * The name of the source entity. */ @@ -997,6 +1081,10 @@ export namespace discoveryengine_v1beta { * The number of documents indexed. */ indexedRecordCount?: string | null; + /** + * Metadata to generate the progress bar. + */ + progress?: Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress; /** * The number of requests sent to 3p API. */ @@ -1018,6 +1106,23 @@ export namespace discoveryengine_v1beta { */ syncType?: string | null; } + /** + * Represents the progress of a sync run. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress { + /** + * The current progress. + */ + currentCount?: string | null; + /** + * Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive. + */ + percentile?: number | null; + /** + * The total. + */ + totalCount?: 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`. */ @@ -1087,6 +1192,44 @@ export namespace discoveryengine_v1beta { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -1227,14 +1370,26 @@ export namespace discoveryengine_v1beta { * Optional. Action configurations to make the connector support actions. */ actionConfig?: Schema$GoogleCloudDiscoveryengineV1alphaActionConfig; + /** + * Optional. The connector level alert config. + */ + alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig[]; /** * Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. */ autoRunDisabled?: boolean | null; + /** + * Optional. The configuration for establishing a BAP connection. + */ + bapConfig?: Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig; /** * Output only. User actions that must be completed before the connector can start syncing data. */ blockingReasons?: string[] | null; + /** + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system. + */ + connectorType?: string | null; /** * Output only. Timestamp the DataConnector was created at. */ @@ -1291,6 +1446,10 @@ export namespace discoveryengine_v1beta { * Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. */ privateConnectivityProjectId?: string | null; + /** + * Output only. real-time sync state + */ + realtimeState?: string | null; /** * Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. */ @@ -1328,6 +1487,10 @@ export namespace discoveryengine_v1beta { * The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` */ entityName?: string | null; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; /** * Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */ @@ -1336,6 +1499,10 @@ export namespace discoveryengine_v1beta { * The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. */ params?: {[key: string]: any} | null; + /** + * Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector 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; } /** * DataStore captures global settings and configs at the DataStore level. @@ -1366,7 +1533,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -1377,6 +1544,14 @@ export namespace discoveryengine_v1beta { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Output only. Data store level identity provider config. */ @@ -1464,15 +1639,36 @@ export namespace discoveryengine_v1beta { * The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries { + /** + * Vertex AI's error rate time series of auto-refresh dedicated crawl. + */ + autoRefreshCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; /** * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. */ autoRefreshCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; + /** + * Vertex AI's error rate time series of user triggered dedicated crawl. + */ + userTriggeredCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; /** * Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. */ userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries; } + /** + * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata { + /** + * 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 CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -1795,6 +1991,10 @@ export namespace discoveryengine_v1beta { * 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$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -1992,24 +2192,6 @@ export namespace discoveryengine_v1beta { */ sampleQuerySet?: string | null; } - /** - * Response message for SiteSearchEngineService.FetchSitemaps method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse { - /** - * List of Sitemaps fetched. - */ - sitemapsMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata[]; - } - /** - * Contains a Sitemap and its metadata. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata { - /** - * The Sitemap. - */ - sitemap?: Schema$GoogleCloudDiscoveryengineV1alphaSitemap; - } /** * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. */ @@ -2085,6 +2267,36 @@ export namespace discoveryengine_v1beta { */ documentDataMap?: {[key: string]: {[key: string]: any}} | null; } + /** + * Config to data store for `HEALTHCARE_FHIR` vertical. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig { + /** + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. + */ + enableConfigurableSchema?: boolean | null; + /** + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + */ + enableStaticIndexingForBatchIngestion?: boolean | null; + } + /** + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata { + /** + * The number of IdentityMappingEntries that failed to be processed. + */ + failureCount?: string | null; + /** + * The number of IdentityMappingEntries that were successfully processed. + */ + successCount?: string | null; + /** + * The total number of IdentityMappingEntries that were processed. + */ + totalCount?: string | null; + } /** * The configuration for the identity data synchronization runs. */ @@ -2201,6 +2413,15 @@ export namespace discoveryengine_v1beta { */ gcsPrefix?: string | null; } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -2683,6 +2904,14 @@ export namespace discoveryengine_v1beta { * Total number of unique URIs in the request that have invalid format. */ invalidUrisCount?: number | null; + /** + * URIs that have no index meta tag. Sample limited to 1000. + */ + noindexUris?: string[] | null; + /** + * Total number of URIs that have no index meta tag. + */ + noindexUrisCount?: number | null; /** * Total number of URIs that have yet to be crawled. */ @@ -2848,7 +3077,7 @@ export namespace discoveryengine_v1beta { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -2877,9 +3106,13 @@ export namespace discoveryengine_v1beta { */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + * Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; + /** + * Optional. Config for display feature, like match highlighting on search results. + */ + displaySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec; /** * 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. */ @@ -2941,15 +3174,23 @@ export namespace discoveryengine_v1beta { */ 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 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. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double \> 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */ rankingExpression?: string | null; + /** + * Optional. The backend to use for the ranking expression evaluation. + */ + rankingExpressionBackend?: string | null; /** * 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. */ regionCode?: string | null; /** - * 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. + * Optional. The specification for returning the relevance score. + */ + relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec; + /** + * 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. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -2977,7 +3218,7 @@ export namespace discoveryengine_v1beta { */ spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. */ userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; /** @@ -3209,6 +3450,15 @@ export namespace discoveryengine_v1beta { */ filter?: string | null; } + /** + * Specifies features for display, like match highlighting. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec { + /** + * The condition under which match highlighting should occur. + */ + matchHighlightingCondition?: string | null; + } /** * The specification that uses customized query embedding vector to do semantic document retrieval. */ @@ -3329,6 +3579,15 @@ export namespace discoveryengine_v1beta { */ pinUnexpandedResults?: boolean | null; } + /** + * The specification for returning the document relevance score. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec { + /** + * Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. + */ + returnRelevanceScore?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -3347,7 +3606,7 @@ export namespace discoveryengine_v1beta { */ 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. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar 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; } @@ -3752,7 +4011,7 @@ export namespace discoveryengine_v1beta { */ query?: string | null; /** - * 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. + * Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. 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 | null; /** @@ -3844,10 +4103,22 @@ export namespace discoveryengine_v1beta { * The name of the dataStore that this suggestion belongs to. */ dataStore?: string | null; + /** + * The destination uri of the content suggestion. + */ + destinationUri?: string | null; /** * The document data snippet in the suggestion. Only a subset of fields will be populated. */ document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + /** + * The icon uri of the content suggestion. + */ + iconUri?: string | null; + /** + * The score of each suggestion. The score is in the range of [0, 1]. + */ + score?: number | null; /** * The suggestion for the query. */ @@ -3861,6 +4132,14 @@ export namespace discoveryengine_v1beta { * The name of the dataStore that this suggestion belongs to. */ dataStore?: string | null; + /** + * The destination uri of the person suggestion. + */ + destinationUri?: string | null; + /** + * The photo uri of the person suggestion. + */ + displayPhotoUri?: string | null; /** * The document data snippet in the suggestion. Only a subset of fields is populated. */ @@ -3869,6 +4148,10 @@ export namespace discoveryengine_v1beta { * The type of the person. */ personType?: string | null; + /** + * The score of each suggestion. The score is in the range of [0, 1]. + */ + score?: number | null; /** * The suggestion for the query. */ @@ -3886,6 +4169,10 @@ export namespace discoveryengine_v1beta { * The name of the dataStore that this suggestion belongs to. */ dataStore?: string[] | null; + /** + * The score of each suggestion. The score is in the range of [0, 1]. + */ + score?: number | null; /** * The suggestion for the query. */ @@ -3899,6 +4186,10 @@ export namespace discoveryengine_v1beta { * The time when this recent rearch happened. */ recentSearchTime?: string | null; + /** + * The score of each suggestion. The score is in the range of [0, 1]. + */ + score?: number | null; /** * The suggestion for the query. */ @@ -4012,7 +4303,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation { /** - * End of the attributed segment, exclusive. + * End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ endIndex?: string | null; /** @@ -4020,7 +4311,7 @@ export namespace discoveryengine_v1beta { */ sources?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource[]; /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. */ startIndex?: string | null; } @@ -4223,6 +4514,10 @@ export namespace discoveryengine_v1beta { * Query understanding specification. */ export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec { + /** + * Optional. Whether to disable spell correction. The default value is `false`. + */ + disableSpellCorrection?: boolean | null; /** * Query classification specification. */ @@ -4582,6 +4877,14 @@ export namespace discoveryengine_v1beta { * Structured search data. */ structData?: {[key: string]: any} | null; + /** + * Output only. The title of the document. + */ + title?: string | null; + /** + * Output only. The URI of the document. + */ + uri?: string | null; } /** * Unstructured document information. @@ -4984,7 +5287,7 @@ export namespace discoveryengine_v1beta { */ claimText?: string | null; /** - * Position indicating the end of the claim in the answer candidate, exclusive. + * Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */ endPos?: number | null; /** @@ -4992,7 +5295,7 @@ export namespace discoveryengine_v1beta { */ groundingCheckRequired?: boolean | null; /** - * Position indicating the start of the claim in the answer candidate, measured in bytes. + * Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */ startPos?: number | null; } @@ -5123,11 +5426,11 @@ export namespace discoveryengine_v1beta { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -5135,7 +5438,7 @@ export namespace discoveryengine_v1beta { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -5143,7 +5446,7 @@ export namespace discoveryengine_v1beta { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1betaSingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -5331,6 +5634,44 @@ export namespace discoveryengine_v1beta { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -5493,6 +5834,15 @@ export namespace discoveryengine_v1beta { */ searchResults?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; } + /** + * The historical crawl rate timeseries data, used for monitoring. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries { + /** + * The QPS of the crawl rate. + */ + qpsTimeSeries?: Schema$GoogleMonitoringV3TimeSeries; + } /** * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -5650,7 +6000,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -5661,6 +6011,14 @@ export namespace discoveryengine_v1beta { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Immutable. The industry vertical that the data store registers. */ @@ -5740,6 +6098,27 @@ export namespace discoveryengine_v1beta { */ disabledForServing?: boolean | null; } + /** + * The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries { + /** + * Vertex AI's error rate time series of auto-refresh dedicated crawl. + */ + autoRefreshCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. + */ + autoRefreshCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's error rate time series of user triggered dedicated crawl. + */ + userTriggeredCrawlErrorRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. + */ + userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -6136,6 +6515,10 @@ export namespace discoveryengine_v1beta { * 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; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -6364,316 +6747,81 @@ export namespace discoveryengine_v1beta { inputUris?: string[] | null; } /** - * Top-level message sent by the client for the `GenerateGroundedContent` method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest { - /** - * Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - */ - contents?: Schema$GoogleCloudDiscoveryengineV1betaGroundedGenerationContent[]; - /** - * Content generation specification. - */ - generationSpec?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec; - /** - * Grounding specification. - */ - groundingSpec?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec; - /** - * Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them. - */ - systemInstruction?: Schema$GoogleCloudDiscoveryengineV1betaGroundedGenerationContent; - /** - * 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; - } - /** - * Describes the options to customize dynamic retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration { - /** - * Specification for the predictor for dynamic retrieval. - */ - predictor?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor; - } - /** - * Describes the predictor settings for dynamic retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor { - /** - * The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source. - */ - threshold?: number | null; - /** - * The version of the predictor to be used in dynamic retrieval. - */ - version?: string | null; - } - /** - * Content generation specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec { - /** - * If specified, custom value for frequency penalty will be used. - */ - frequencyPenalty?: number | null; - /** - * Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). - */ - languageCode?: string | null; - /** - * If specified, custom value for max output tokens will be used. - */ - maxOutputTokens?: number | null; - /** - * Specifies which Vertex model id to use for generation. - */ - modelId?: string | null; - /** - * If specified, custom value for presence penalty will be used. - */ - presencePenalty?: number | null; - /** - * If specified, custom value for the seed will be used. - */ - seed?: number | null; - /** - * If specified, custom value for the temperature will be used. - */ - temperature?: number | null; - /** - * If specified, custom value for top-k sampling will be used. - */ - topK?: number | null; - /** - * If specified, custom value for nucleus sampling will be used. - */ - topP?: number | null; - } - /** - * Grounding source. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource { - /** - * If set, grounding is performed with Google Search. - */ - googleSearchSource?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource; - /** - * If set, grounding is performed with inline content. - */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource; - /** - * If set, grounding is performed with Vertex AI Search. - */ - searchSource?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource; - } - /** - * Google Search config parameters. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource { - /** - * Optional. Specifies the dynamic retrieval configuration for the given source. - */ - dynamicRetrievalConfig?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration; - } - /** - * Message to be used for grounding based on inline content. + * Grounding Fact. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaGroundingFact { /** - * Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content). + * 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. */ attributes?: {[key: string]: string} | null; /** - * List of facts to be used for grounding. - */ - groundingFacts?: Schema$GoogleCloudDiscoveryengineV1betaGroundingFact[]; - } - /** - * Message to be used for grounding with Vertex AI Search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource { - /** - * Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter. - */ - filter?: string | null; - /** - * Number of search results to return. The default value is 10. The maximumm allowed value is 10. - */ - maxResultCount?: number | null; - /** - * If set, safe search is enabled in Vertex AI Search requests. - */ - safeSearch?: boolean | null; - /** - * The resource name of the Engine to use. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - servingConfig?: string | null; - } - /** - * Grounding specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec { - /** - * Grounding sources. - */ - groundingSources?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource[]; - } - /** - * Response for the `GenerateGroundedContent` method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse { - /** - * Generated candidates. - */ - candidates?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate[]; - } - /** - * A response candidate generated from the model. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate { - /** - * Content of the candidate. - */ - content?: Schema$GoogleCloudDiscoveryengineV1betaGroundedGenerationContent; - /** - * Grounding metadata for the generated content. - */ - groundingMetadata?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata; - /** - * The overall grounding score for the candidate, in the range of [0, 1]. - */ - groundingScore?: number | null; - /** - * Index of the candidate. - */ - index?: number | null; - } - /** - * Citation for the generated content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata { - /** - * GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact. - */ - groundingSupport?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport[]; - /** - * Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users. - */ - retrievalMetadata?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata[]; - /** - * Google search entry for the following-up web searches. - */ - searchEntryPoint?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint; - /** - * List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request. - */ - supportChunks?: Schema$GoogleCloudDiscoveryengineV1betaFactChunk[]; - /** - * Web search queries for the following-up web search. - */ - webSearchQueries?: string[] | null; - } - /** - * Describes the metadata about dynamic retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata { - /** - * Metadata for the dynamic retrieval predictor. + * Text content of the fact. Can be at most 10K characters long. */ - predictorMetadata?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata; + factText?: string | null; } /** - * Describes the metadata about the dynamic retrieval predictor. + * Config to data store for `HEALTHCARE_FHIR` vertical. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig { /** - * The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding. + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. */ - prediction?: number | null; + enableConfigurableSchema?: boolean | null; /** - * The version of the predictor which was used in dynamic retrieval. + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. */ - version?: string | null; + enableStaticIndexingForBatchIngestion?: boolean | null; } /** - * Grounding info for a claim in the candidate and its support. + * Identity Mapping Entry that maps an external identity to an internal identity. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport { + export interface Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingEntry { /** - * Text for the claim in the candidate. Always provided when a support is found. + * Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters. */ - claimText?: string | null; - /** - * A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim. - */ - supportChunkIndices?: number[] | null; - /** - * A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks. - */ - supportScore?: number | null; - } - /** - * Describes the metadata associated with a retrieval step. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata { + externalIdentity?: string | null; /** - * Metadata for dynamic retrieval. + * Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config. */ - dynamicRetrievalMetadata?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata; + groupId?: string | null; /** - * Describes the source to which the metadata is referring to. + * User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config. */ - source?: string | null; + userId?: string | null; } /** - * Google search entry point. + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint { - /** - * Web content snippet that can be embedded in a web page or an app webview. - */ - renderedContent?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata { /** - * Base64 encoded JSON representing array of tuple. + * The number of IdentityMappingEntries that failed to be processed. */ - sdkBlob?: string | null; - } - /** - * Base structured datatype containing multi-part content of a message. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGroundedGenerationContent { + failureCount?: string | null; /** - * Ordered `Parts` that constitute a single message. + * The number of IdentityMappingEntries that were successfully processed. */ - parts?: Schema$GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart[]; + successCount?: string | null; /** - * Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset. + * The total number of IdentityMappingEntries that were processed. */ - role?: string | null; + totalCount?: string | null; } /** - * Single part of content. + * Identity Mapping Store which contains Identity Mapping Entries. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart { + export interface Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingStore { /** - * Inline text. + * Output only. CMEK-related information for the Identity Mapping Store. */ - text?: string | null; - } - /** - * Grounding Fact. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGroundingFact { + cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig; /** - * 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. + * Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field. */ - attributes?: {[key: string]: string} | null; + kmsKeyName?: string | null; /** - * Text content of the fact. Can be at most 10K characters long. + * Immutable. The full resource name of the identity mapping store. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - factText?: string | null; + name?: string | null; } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -6860,6 +7008,33 @@ export namespace discoveryengine_v1beta { */ gcsPrefix?: string | null; } + /** + * Request message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest { + /** + * The inline source to import identity mapping entries from. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource; + } + /** + * The inline source to import identity mapping entries from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource { + /** + * A maximum of 10000 entries can be imported at one time + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingEntry[]; + } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -7207,6 +7382,32 @@ export namespace discoveryengine_v1beta { */ nextPageToken?: string | null; } + /** + * Response message for IdentityMappingStoreService.ListIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse { + /** + * The Identity Mapping Entries. + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingEntry[]; + /** + * 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; + } + /** + * Response message for IdentityMappingStoreService.ListIdentityMappingStores + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse { + /** + * The Identity Mapping Stores. + */ + identityMappingStores?: Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingStore[]; + /** + * 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; + } /** * Response message for SampleQueryService.ListSampleQueries method. */ @@ -7311,6 +7512,49 @@ export namespace discoveryengine_v1beta { */ mode?: string | null; } + /** + * Request message for CrawlRateManagementService.ObtainCrawlRate method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest { + /** + * Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. + */ + crawlRateScope?: string | null; + } + /** + * Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse { + /** + * The historical dedicated crawl rate timeseries data, used for monitoring. + */ + dedicatedCrawlRateTimeSeries?: Schema$GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries; + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * The historical organic crawl rate timeseries data, used for monitoring. + */ + organicCrawlRateTimeSeries?: Schema$GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries; + /** + * Output only. The state of the response. + */ + state?: string | null; + } + /** + * The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries { + /** + * Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots. + */ + googleOrganicCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + /** + * Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot. + */ + vertexAiOrganicCrawlRate?: Schema$GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries; + } /** * Detailed page information. */ @@ -7511,6 +7755,32 @@ export namespace discoveryengine_v1beta { */ gcsPrefix?: string | null; } + /** + * Request message for IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest { + /** + * Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 "zulu" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time \> "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` * Deleting all identity mappings for a given external_id: `external_id = "id1"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided. + */ + filter?: string | null; + /** + * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field. + */ + force?: boolean | null; + /** + * The inline source to purge identity mapping entries from. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource; + } + /** + * The inline source to purge identity mapping entries from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource { + /** + * A maximum of 10000 entries can be purged at one time + */ + identityMappingEntries?: Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingEntry[]; + } /** * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -7643,7 +7913,7 @@ export namespace discoveryengine_v1beta { */ 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. + * The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. */ model?: string | null; /** @@ -7744,7 +8014,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest { /** - * Optional. Full resource name of the `SiteCredential`, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/siteCredentials/x`. Only set to crawl private URIs. + * Optional. Credential id to use for crawling. */ siteCredential?: string | null; /** @@ -7752,6 +8022,70 @@ export namespace discoveryengine_v1beta { */ uris?: string[] | null; } + /** + * Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata { + /** + * 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 CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest { + /** + * Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. + */ + crawlRateScope?: string | null; + } + /** + * Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse { + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. The state of the response. + */ + state?: string | null; + } + /** + * Request message for CompletionService.RemoveSuggestion method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest { + /** + * Remove all search history suggestions for the user. + */ + removeAllSearchHistorySuggestions?: boolean | null; + /** + * Required. Time at which the suggestion was removed. If not set, the current time will be used. + */ + removeTime?: string | null; + /** + * The search history suggestion to be removed. + */ + searchHistorySuggestion?: string | null; + /** + * Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + */ + 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 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. + */ + userPseudoId?: string | null; + } + /** + * Response message for CompletionService.RemoveSuggestion method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse {} /** * Defines a reply message to user. */ @@ -7946,7 +8280,7 @@ export namespace discoveryengine_v1beta { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -7971,9 +8305,13 @@ export namespace discoveryengine_v1beta { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. + * Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */ dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; + /** + * Optional. Config for display feature, like match highlighting on search results. + */ + displaySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec; /** * 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. */ @@ -8035,15 +8373,23 @@ export namespace discoveryengine_v1beta { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * 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)`. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double \> 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result */ rankingExpression?: string | null; + /** + * Optional. The backend to use for the ranking expression evaluation. + */ + rankingExpressionBackend?: string | null; /** * 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. */ regionCode?: string | null; /** - * 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. + * Optional. The specification for returning the relevance score. + */ + relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec; + /** + * 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. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -8071,7 +8417,7 @@ export namespace discoveryengine_v1beta { */ spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. */ userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** @@ -8303,6 +8649,15 @@ export namespace discoveryengine_v1beta { */ filter?: string | null; } + /** + * Specifies features for display, like match highlighting. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec { + /** + * The condition under which match highlighting should occur. + */ + matchHighlightingCondition?: string | null; + } /** * The specification that uses customized query embedding vector to do semantic document retrieval. */ @@ -8423,6 +8778,15 @@ export namespace discoveryengine_v1beta { */ pinUnexpandedResults?: boolean | null; } + /** + * The specification for returning the document relevance score. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec { + /** + * Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. + */ + returnRelevanceScore?: boolean | null; + } /** * Specification for search as you type in search requests. */ @@ -8441,7 +8805,7 @@ export namespace discoveryengine_v1beta { */ 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. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar 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; } @@ -8601,6 +8965,10 @@ export namespace discoveryengine_v1beta { * Information describing what natural language understanding was done on the input query. */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo { + /** + * The classified intents from the input query. + */ + classifiedIntents?: string[] | null; /** * The filters that were extracted from the input query. */ @@ -8785,7 +9153,7 @@ export namespace discoveryengine_v1beta { */ id?: string | null; /** - * Google provided available scores. + * Output only. Google provided available scores. */ modelScores?: { [key: string]: Schema$GoogleCloudDiscoveryengineV1betaDoubleList; @@ -9101,6 +9469,53 @@ export namespace discoveryengine_v1beta { */ query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; } + /** + * Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata { + /** + * 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 CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest { + /** + * Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website. + */ + crawlRate?: number | null; + /** + * Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. + */ + crawlRateScope?: string | null; + /** + * Optional. Whether it's the crawl rate of user-triggered or auto-refresh. + */ + crawlType?: string | null; + /** + * Optional. Whether the rate is explicitly set by users, or set by vertex AI. + */ + mode?: string | null; + } + /** + * Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse { + /** + * Errors from service when handling the request. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. The state of the response. + */ + state?: string | null; + } /** * Metadata for single-regional CMEKs. */ @@ -9553,11 +9968,11 @@ export namespace discoveryengine_v1beta { */ isDefault?: boolean | null; /** - * Kms key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. + * KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`. */ kmsKey?: string | null; /** - * Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. + * KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion\}`. */ kmsKeyVersion?: string | null; /** @@ -9565,7 +9980,7 @@ export namespace discoveryengine_v1beta { */ lastRotationTimestampMicros?: string | null; /** - * Required. Name of the CmekConfig, of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmekConfig\}`. */ name?: string | null; /** @@ -9573,7 +9988,7 @@ export namespace discoveryengine_v1beta { */ singleRegionKeys?: Schema$GoogleCloudDiscoveryengineV1SingleRegionKey[]; /** - * Output only. State of the CmekConfig. + * Output only. The states of the CmekConfig. */ state?: string | null; } @@ -9689,6 +10104,44 @@ export namespace discoveryengine_v1beta { * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ fixedBoost?: number | null; + /** + * Optional. Complex specification for custom ranking based on customer defined attribute value. + */ + interpolationBoostSpec?: Schema$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec; + } + /** + * 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$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec { + /** + * Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint[]; + /** + * Optional. The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * Optional. The interpolation type to be applied to connect the control points listed below. + */ + 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$GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint { + /** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; } /** * Specified which products may be included in results. Uses same filter as boost. @@ -9773,6 +10226,19 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateSitemapMetadata { + /** + * 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. */ @@ -9811,7 +10277,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. The id of the default Schema associated to this data store. */ defaultSchemaId?: string | null; /** @@ -9822,6 +10288,14 @@ export namespace discoveryengine_v1beta { * Configuration for Document understanding and enrichment. */ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + /** + * Optional. Configuration for `HEALTHCARE_FHIR` vertical. + */ + healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig; + /** + * Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`. + */ + identityMappingStore?: string | null; /** * Immutable. The industry vertical that the data store registers. */ @@ -9893,6 +10367,19 @@ export namespace discoveryengine_v1beta { */ disabledForServing?: boolean | null; } + /** + * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata { + /** + * 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 DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -9945,6 +10432,19 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteSitemapMetadata { + /** + * 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. */ @@ -10138,6 +10638,10 @@ export namespace discoveryengine_v1beta { * 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; + /** + * Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + allowCrossRegion?: boolean | 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. */ @@ -10195,6 +10699,36 @@ export namespace discoveryengine_v1beta { */ searchTier?: string | null; } + /** + * Config to data store for `HEALTHCARE_FHIR` vertical. + */ + export interface Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig { + /** + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. + */ + enableConfigurableSchema?: boolean | null; + /** + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + */ + enableStaticIndexingForBatchIngestion?: boolean | null; + } + /** + * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata { + /** + * The number of IdentityMappingEntries that failed to be processed. + */ + failureCount?: string | null; + /** + * The number of IdentityMappingEntries that were successfully processed. + */ + successCount?: string | null; + /** + * The total number of IdentityMappingEntries that were processed. + */ + totalCount?: string | null; + } /** * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -10276,6 +10810,15 @@ export namespace discoveryengine_v1beta { */ gcsPrefix?: string | null; } + /** + * Response message for IdentityMappingStoreService.ImportIdentityMappings + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse { + /** + * 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. */ @@ -10528,7 +11071,7 @@ export namespace discoveryengine_v1beta { */ title?: string | null; /** - * Required. The URL for the page the user wants to promote. + * Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. */ uri?: string | null; } @@ -10799,6 +11342,23 @@ export namespace discoveryengine_v1beta { */ kmsKey?: string | null; } + /** + * A sitemap for the SiteSearchEngine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Sitemap { + /** + * Output only. The sitemap's creation time. + */ + createTime?: string | null; + /** + * Output only. The fully qualified resource name of the sitemap. `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/sitemaps/x` The `sitemap_id` suffix is system-generated. + */ + name?: string | null; + /** + * Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. + */ + uri?: string | null; + } /** * Verification information for target sites in advanced site search. */ @@ -11358,65 +11918,163 @@ export namespace discoveryengine_v1beta { } /** - * Generates grounded content. + * Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, + obtainCrawlRate( + params: Params$Resource$Projects$Locations$Obtaincrawlrate, options: StreamMethodOptions ): GaxiosPromise; - generateGroundedContent( - params?: Params$Resource$Projects$Locations$Generategroundedcontent, + obtainCrawlRate( + params?: Params$Resource$Projects$Locations$Obtaincrawlrate, options?: MethodOptions - ): GaxiosPromise; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, + ): GaxiosPromise; + obtainCrawlRate( + params: Params$Resource$Projects$Locations$Obtaincrawlrate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, + obtainCrawlRate( + params: Params$Resource$Projects$Locations$Obtaincrawlrate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateGroundedContent( - params: Params$Resource$Projects$Locations$Generategroundedcontent, - callback: BodyResponseCallback + obtainCrawlRate( + params: Params$Resource$Projects$Locations$Obtaincrawlrate, + callback: BodyResponseCallback ): void; - generateGroundedContent( - callback: BodyResponseCallback + obtainCrawlRate( + callback: BodyResponseCallback ): void; - generateGroundedContent( + obtainCrawlRate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Generategroundedcontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Obtaincrawlrate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Generategroundedcontent; + {}) as Params$Resource$Projects$Locations$Obtaincrawlrate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Obtaincrawlrate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+location}:obtainCrawlRate').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 + ); + } + } + + /** + * Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + options: StreamMethodOptions + ): GaxiosPromise; + removeDedicatedCrawlRate( + params?: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + options?: MethodOptions + ): GaxiosPromise; + removeDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Removededicatedcrawlrate, + callback: BodyResponseCallback + ): void; + removeDedicatedCrawlRate( + callback: BodyResponseCallback + ): void; + removeDedicatedCrawlRate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Removededicatedcrawlrate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Removededicatedcrawlrate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Generategroundedcontent; + {} as Params$Resource$Projects$Locations$Removededicatedcrawlrate; options = {}; } @@ -11431,7 +12089,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: ( - rootUrl + '/v1beta/{+location}:generateGroundedContent' + rootUrl + '/v1beta/{+location}:removeDedicatedCrawlRate' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -11444,29 +12102,146 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters + return createAPIRequest(parameters); + } + } + + /** + * Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + options: StreamMethodOptions + ): GaxiosPromise; + setDedicatedCrawlRate( + params?: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + options?: MethodOptions + ): GaxiosPromise; + setDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setDedicatedCrawlRate( + params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, + callback: BodyResponseCallback + ): void; + setDedicatedCrawlRate( + callback: BodyResponseCallback + ): void; + setDedicatedCrawlRate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Setdedicatedcrawlrate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Setdedicatedcrawlrate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Setdedicatedcrawlrate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+location}:setDedicatedCrawlRate' + ).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); } } } - export interface Params$Resource$Projects$Locations$Generategroundedcontent + export interface Params$Resource$Projects$Locations$Obtaincrawlrate + extends StandardParameters { + /** + * Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest; + } + export interface Params$Resource$Projects$Locations$Removededicatedcrawlrate + extends StandardParameters { + /** + * Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest; + } + export interface Params$Resource$Projects$Locations$Setdedicatedcrawlrate extends StandardParameters { /** - * Required. Location resource. Format: `projects/{project\}/locations/{location\}`. + * Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}` */ location?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest; } export class Resource$Projects$Locations$Collections { @@ -19418,6 +20193,105 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + + /** + * Fetch Sitemaps in 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. + */ + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + options: StreamMethodOptions + ): GaxiosPromise; + fetch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + options?: MethodOptions + ): GaxiosPromise; + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + callback: BodyResponseCallback + ): void; + fetch( + callback: BodyResponseCallback + ): void; + fetch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch; + 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}/sitemaps:fetch').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$Sitesearchengine$Sitemaps$Create @@ -19439,6 +20313,17 @@ export namespace discoveryengine_v1beta { */ name?: string; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch + extends StandardParameters { + /** + * The Sitemap uris. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + } export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { context: APIRequestContext; @@ -22017,6 +22902,104 @@ export namespace discoveryengine_v1beta { ); } } + + /** + * Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + options: StreamMethodOptions + ): GaxiosPromise; + removeSuggestion( + params?: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + options?: MethodOptions + ): GaxiosPromise; + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + callback: BodyResponseCallback + ): void; + removeSuggestion( + callback: BodyResponseCallback + ): void; + removeSuggestion( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+completionConfig}:removeSuggestion' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['completionConfig'], + pathParams: ['completionConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery @@ -22031,6 +23014,18 @@ export namespace discoveryengine_v1beta { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest; } + export interface Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion + extends StandardParameters { + /** + * Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + */ + completionConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest; + } export class Resource$Projects$Locations$Collections$Engines$Controls { context: APIRequestContext; @@ -34170,6 +35165,777 @@ export namespace discoveryengine_v1beta { this.context ); } + + /** + * Creates a new Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$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}/identityMappingStores').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 Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$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 the Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$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 + ); + } + } + + /** + * Imports a list of Identity Mapping Entries to an Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + options: StreamMethodOptions + ): GaxiosPromise; + importIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + options?: MethodOptions + ): GaxiosPromise; + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + callback: BodyResponseCallback + ): void; + importIdentityMappings( + callback: BodyResponseCallback + ): void; + importIdentityMappings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+identityMappingStore}:importIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all Identity Mapping Stores. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Identitymappingstores$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Identitymappingstores$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$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}/identityMappingStores').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 + ); + } + } + + /** + * Lists Identity Mappings in an Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + options: StreamMethodOptions + ): GaxiosPromise; + listIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + options?: MethodOptions + ): GaxiosPromise; + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + callback: BodyResponseCallback + ): void; + listIdentityMappings( + callback: BodyResponseCallback + ): void; + listIdentityMappings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+identityMappingStore}:listIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Purges specified or all Identity Mapping Entries from an Identity Mapping Store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + options: StreamMethodOptions + ): GaxiosPromise; + purgeIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + options?: MethodOptions + ): GaxiosPromise; + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + callback: BodyResponseCallback + ): void; + purgeIdentityMappings( + callback: BodyResponseCallback + ): void; + purgeIdentityMappings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+identityMappingStore}:purgeIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Identitymappingstores$Create + extends StandardParameters { + /** + * Resource name of the CmekConfig to use for protecting this Identity Mapping Store. + */ + cmekConfigName?: string; + /** + * Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + */ + disableCmek?: boolean; + /** + * Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + */ + identityMappingStoreId?: string; + /** + * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaIdentityMappingStore; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Delete + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Get + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$List + extends StandardParameters { + /** + * Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + /** + * Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest; } export class Resource$Projects$Locations$Identitymappingstores$Operations { From 9156d5842580e9007cecd74163bca03e3288a4f5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 057/144] feat(displayvideo): update the API #### displayvideo:v2 The following keys were added: - schemas.FrequencyCap.properties.timeUnit.enumDeprecated - schemas.TargetFrequency.properties.timeUnit.enumDeprecated The following keys were changed: - resources.customBiddingAlgorithms.methods.patch.description - resources.customBiddingAlgorithms.resources.scripts.methods.create.description - schemas.AssetAssociation.properties.asset.description - schemas.AssetAssociation.properties.role.description - schemas.AssetAssociation.properties.role.enumDescriptions - schemas.AudienceGroupAssignedTargetingOptionDetails.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.excludedGoogleAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedCombinedAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedCustomListGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedGoogleAudienceGroup.description - schemas.AudioVideoOffset.properties.percentage.description - schemas.AudioVideoOffset.properties.seconds.description - schemas.Campaign.properties.frequencyCap.description - schemas.CmTrackingAd.properties.cmAdId.description - schemas.CmTrackingAd.properties.cmCreativeId.description - schemas.CmTrackingAd.properties.cmPlacementId.description - schemas.CombinedAudienceGroup.properties.settings.description - schemas.ConversionCountingConfig.properties.floodlightActivityConfigs.description - schemas.Creative.properties.additionalDimensions.description - schemas.Creative.properties.appendedTag.description - schemas.Creative.properties.cmTrackingAd.description - schemas.Creative.properties.companionCreativeIds.description - schemas.Creative.properties.counterEvents.description - schemas.Creative.properties.creativeType.enumDescriptions - schemas.Creative.properties.iasCampaignMonitoring.description - schemas.Creative.properties.integrationCode.description - schemas.Creative.properties.jsTrackerUrl.description - schemas.Creative.properties.notes.description - schemas.Creative.properties.obaIcon.description - schemas.Creative.properties.progressOffset.description - schemas.Creative.properties.skipOffset.description - schemas.Creative.properties.skippable.description - schemas.Creative.properties.thirdPartyUrls.description - schemas.Creative.properties.timerEvents.description - schemas.Creative.properties.trackerUrls.description - schemas.Creative.properties.transcodes.description - schemas.CreativeConfig.properties.creativeType.enumDescriptions - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmType.enum - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmType.enumDescriptions - schemas.CustomListGroup.properties.settings.description - schemas.ExitEvent.properties.name.description - schemas.ExitEvent.properties.reportingName.description - schemas.FrequencyCap.properties.timeUnitCount.description - schemas.GoogleAudienceGroup.properties.settings.description - schemas.InsertionOrder.properties.bidStrategy.description - schemas.InsertionOrder.properties.insertionOrderType.description - schemas.InsertionOrder.properties.integrationDetails.description - schemas.InsertionOrder.properties.partnerCosts.description - schemas.InsertionOrderBudget.properties.automationType.description - schemas.InsertionOrderBudgetSegment.properties.campaignBudgetId.description - schemas.InsertionOrderBudgetSegment.properties.description.description - schemas.LineItem.properties.conversionCounting.description - schemas.MaximizeSpendBidStrategy.properties.customBiddingAlgorithmId.description - schemas.ObaIcon.properties.clickTrackingUrl.description - schemas.ObaIcon.properties.dimensions.description - schemas.ObaIcon.properties.landingPageUrl.description - schemas.ObaIcon.properties.position.description - schemas.ObaIcon.properties.program.description - schemas.ObaIcon.properties.resourceMimeType.description - schemas.ObaIcon.properties.resourceUrl.description - schemas.ObaIcon.properties.viewTrackingUrl.description - schemas.PerformanceGoalBidStrategy.properties.customBiddingAlgorithmId.description - schemas.ThirdPartyUrl.properties.type.description - schemas.ThirdPartyUrl.properties.url.description - schemas.Transcode.properties.audioBitRateKbps.description - schemas.Transcode.properties.audioSampleRateHz.description - schemas.Transcode.properties.bitRateKbps.description - schemas.Transcode.properties.dimensions.description - schemas.Transcode.properties.fileSizeBytes.description - schemas.Transcode.properties.frameRate.description - schemas.Transcode.properties.mimeType.description - schemas.Transcode.properties.name.description - schemas.Transcode.properties.transcoded.description - schemas.UniversalAdId.properties.id.description - schemas.UniversalAdId.properties.registry.description #### displayvideo:v3 The following keys were added: - resources.sdfuploadtasks.resources.operations.methods.get.description - resources.sdfuploadtasks.resources.operations.methods.get.flatPath - resources.sdfuploadtasks.resources.operations.methods.get.httpMethod - resources.sdfuploadtasks.resources.operations.methods.get.id - resources.sdfuploadtasks.resources.operations.methods.get.parameterOrder - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.description - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.location - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.pattern - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.required - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.type - resources.sdfuploadtasks.resources.operations.methods.get.path - resources.sdfuploadtasks.resources.operations.methods.get.response.$ref - resources.sdfuploadtasks.resources.operations.methods.get.scopes - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmType.enumDeprecated - schemas.FrequencyCap.properties.timeUnit.enumDeprecated - schemas.IntegralAdScience.properties.qualitySyncCustomSegmentId.description - schemas.IntegralAdScience.properties.qualitySyncCustomSegmentId.items.format - schemas.IntegralAdScience.properties.qualitySyncCustomSegmentId.items.type - schemas.IntegralAdScience.properties.qualitySyncCustomSegmentId.type - schemas.TargetFrequency.properties.timeUnit.enumDeprecated The following keys were changed: - resources.customBiddingAlgorithms.methods.patch.description - resources.customBiddingAlgorithms.resources.rules.methods.create.description - resources.customBiddingAlgorithms.resources.scripts.methods.create.description - resources.firstAndThirdPartyAudiences.methods.list.parameters.pageSize.description - schemas.AlgorithmRulesSignalComparison.properties.comparisonOperator.enumDescriptions - schemas.AssetAssociation.properties.asset.description - schemas.AssetAssociation.properties.role.description - schemas.AssetAssociation.properties.role.enumDescriptions - schemas.AudienceGroupAssignedTargetingOptionDetails.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.excludedFirstAndThirdPartyAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.excludedGoogleAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedCombinedAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedCustomListGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedFirstAndThirdPartyAudienceGroups.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedGoogleAudienceGroup.description - schemas.AudioVideoOffset.properties.percentage.description - schemas.AudioVideoOffset.properties.seconds.description - schemas.Campaign.properties.frequencyCap.description - schemas.CmTrackingAd.properties.cmAdId.description - schemas.CmTrackingAd.properties.cmCreativeId.description - schemas.CmTrackingAd.properties.cmPlacementId.description - schemas.CombinedAudienceGroup.properties.settings.description - schemas.ConversionCountingConfig.properties.floodlightActivityConfigs.description - schemas.Creative.properties.additionalDimensions.description - schemas.Creative.properties.appendedTag.description - schemas.Creative.properties.cmTrackingAd.description - schemas.Creative.properties.companionCreativeIds.description - schemas.Creative.properties.counterEvents.description - schemas.Creative.properties.creativeType.enumDescriptions - schemas.Creative.properties.iasCampaignMonitoring.description - schemas.Creative.properties.integrationCode.description - schemas.Creative.properties.jsTrackerUrl.description - schemas.Creative.properties.notes.description - schemas.Creative.properties.obaIcon.description - schemas.Creative.properties.progressOffset.description - schemas.Creative.properties.skipOffset.description - schemas.Creative.properties.skippable.description - schemas.Creative.properties.thirdPartyUrls.description - schemas.Creative.properties.timerEvents.description - schemas.Creative.properties.trackerUrls.description - schemas.Creative.properties.transcodes.description - schemas.CreativeConfig.properties.creativeType.enumDescriptions - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmType.enumDescriptions - schemas.CustomListGroup.properties.settings.description - schemas.ExitEvent.properties.name.description - schemas.ExitEvent.properties.reportingName.description - schemas.FirstAndThirdPartyAudience.properties.membershipDurationDays.description - schemas.FirstAndThirdPartyAudienceGroup.properties.settings.description - schemas.FirstAndThirdPartyAudienceTargetingSetting.properties.recency.description - schemas.FrequencyCap.properties.timeUnitCount.description - schemas.GoogleAudienceGroup.properties.settings.description - schemas.InsertionOrder.properties.bidStrategy.description - schemas.InsertionOrder.properties.insertionOrderType.description - schemas.InsertionOrder.properties.integrationDetails.description - schemas.InsertionOrder.properties.optimizationObjective.description - schemas.InsertionOrder.properties.partnerCosts.description - schemas.InsertionOrderBudget.properties.automationType.description - schemas.InsertionOrderBudgetSegment.properties.campaignBudgetId.description - schemas.InsertionOrderBudgetSegment.properties.description.description - schemas.LineItem.properties.conversionCounting.description - schemas.MaximizeSpendBidStrategy.properties.customBiddingAlgorithmId.description - schemas.ObaIcon.properties.clickTrackingUrl.description - schemas.ObaIcon.properties.dimensions.description - schemas.ObaIcon.properties.landingPageUrl.description - schemas.ObaIcon.properties.position.description - schemas.ObaIcon.properties.program.description - schemas.ObaIcon.properties.resourceMimeType.description - schemas.ObaIcon.properties.resourceUrl.description - schemas.ObaIcon.properties.viewTrackingUrl.description - schemas.PerformanceGoalBidStrategy.properties.customBiddingAlgorithmId.description - schemas.TargetingExpansionConfig.properties.enableOptimizedTargeting.description - schemas.ThirdPartyUrl.properties.type.description - schemas.ThirdPartyUrl.properties.url.description - schemas.Transcode.properties.audioBitRateKbps.description - schemas.Transcode.properties.audioSampleRateHz.description - schemas.Transcode.properties.bitRateKbps.description - schemas.Transcode.properties.dimensions.description - schemas.Transcode.properties.fileSizeBytes.description - schemas.Transcode.properties.frameRate.description - schemas.Transcode.properties.mimeType.description - schemas.Transcode.properties.name.description - schemas.Transcode.properties.transcoded.description - schemas.UniversalAdId.properties.id.description - schemas.UniversalAdId.properties.registry.description #### displayvideo:v4 The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/display-video-mediaplanning.description - auth.oauth2.scopes.https://www.googleapis.com/auth/display-video-user-management.description - resources.advertisers.methods.audit.description - resources.advertisers.methods.audit.flatPath - resources.advertisers.methods.audit.httpMethod - resources.advertisers.methods.audit.id - resources.advertisers.methods.audit.parameterOrder - resources.advertisers.methods.audit.parameters.advertiserId.description - resources.advertisers.methods.audit.parameters.advertiserId.format - resources.advertisers.methods.audit.parameters.advertiserId.location - resources.advertisers.methods.audit.parameters.advertiserId.pattern - resources.advertisers.methods.audit.parameters.advertiserId.required - resources.advertisers.methods.audit.parameters.advertiserId.type - resources.advertisers.methods.audit.parameters.readMask.description - resources.advertisers.methods.audit.parameters.readMask.format - resources.advertisers.methods.audit.parameters.readMask.location - resources.advertisers.methods.audit.parameters.readMask.type - resources.advertisers.methods.audit.path - resources.advertisers.methods.audit.response.$ref - resources.advertisers.methods.audit.scopes - resources.advertisers.methods.create.description - resources.advertisers.methods.create.flatPath - resources.advertisers.methods.create.httpMethod - resources.advertisers.methods.create.id - resources.advertisers.methods.create.parameterOrder - resources.advertisers.methods.create.path - resources.advertisers.methods.create.request.$ref - resources.advertisers.methods.create.response.$ref - resources.advertisers.methods.create.scopes - resources.advertisers.methods.delete.description - resources.advertisers.methods.delete.flatPath - resources.advertisers.methods.delete.httpMethod - resources.advertisers.methods.delete.id - resources.advertisers.methods.delete.parameterOrder - resources.advertisers.methods.delete.parameters.advertiserId.description - resources.advertisers.methods.delete.parameters.advertiserId.format - resources.advertisers.methods.delete.parameters.advertiserId.location - resources.advertisers.methods.delete.parameters.advertiserId.pattern - resources.advertisers.methods.delete.parameters.advertiserId.required - resources.advertisers.methods.delete.parameters.advertiserId.type - resources.advertisers.methods.delete.path - resources.advertisers.methods.delete.response.$ref - resources.advertisers.methods.delete.scopes - resources.advertisers.methods.editAssignedTargetingOptions.description - resources.advertisers.methods.editAssignedTargetingOptions.flatPath - resources.advertisers.methods.editAssignedTargetingOptions.httpMethod - resources.advertisers.methods.editAssignedTargetingOptions.id - resources.advertisers.methods.editAssignedTargetingOptions.parameterOrder - resources.advertisers.methods.editAssignedTargetingOptions.parameters.advertiserId.description - resources.advertisers.methods.editAssignedTargetingOptions.parameters.advertiserId.format - resources.advertisers.methods.editAssignedTargetingOptions.parameters.advertiserId.location - resources.advertisers.methods.editAssignedTargetingOptions.parameters.advertiserId.pattern - resources.advertisers.methods.editAssignedTargetingOptions.parameters.advertiserId.required - resources.advertisers.methods.editAssignedTargetingOptions.parameters.advertiserId.type - resources.advertisers.methods.editAssignedTargetingOptions.path - resources.advertisers.methods.editAssignedTargetingOptions.request.$ref - resources.advertisers.methods.editAssignedTargetingOptions.response.$ref - resources.advertisers.methods.editAssignedTargetingOptions.scopes - resources.advertisers.methods.get.description - resources.advertisers.methods.get.flatPath - resources.advertisers.methods.get.httpMethod - resources.advertisers.methods.get.id - resources.advertisers.methods.get.parameterOrder - resources.advertisers.methods.get.parameters.advertiserId.description - resources.advertisers.methods.get.parameters.advertiserId.format - resources.advertisers.methods.get.parameters.advertiserId.location - resources.advertisers.methods.get.parameters.advertiserId.pattern - resources.advertisers.methods.get.parameters.advertiserId.required - resources.advertisers.methods.get.parameters.advertiserId.type - resources.advertisers.methods.get.path - resources.advertisers.methods.get.response.$ref - resources.advertisers.methods.get.scopes - resources.advertisers.methods.list.description - resources.advertisers.methods.list.flatPath - resources.advertisers.methods.list.httpMethod - resources.advertisers.methods.list.id - resources.advertisers.methods.list.parameterOrder - resources.advertisers.methods.list.parameters.filter.description - resources.advertisers.methods.list.parameters.filter.location - resources.advertisers.methods.list.parameters.filter.type - resources.advertisers.methods.list.parameters.orderBy.description - resources.advertisers.methods.list.parameters.orderBy.location - resources.advertisers.methods.list.parameters.orderBy.type - resources.advertisers.methods.list.parameters.pageSize.description - resources.advertisers.methods.list.parameters.pageSize.format - resources.advertisers.methods.list.parameters.pageSize.location - resources.advertisers.methods.list.parameters.pageSize.type - resources.advertisers.methods.list.parameters.pageToken.description - resources.advertisers.methods.list.parameters.pageToken.location - resources.advertisers.methods.list.parameters.pageToken.type - resources.advertisers.methods.list.parameters.partnerId.description - resources.advertisers.methods.list.parameters.partnerId.format - resources.advertisers.methods.list.parameters.partnerId.location - resources.advertisers.methods.list.parameters.partnerId.type - resources.advertisers.methods.list.path - resources.advertisers.methods.list.response.$ref - resources.advertisers.methods.list.scopes - resources.advertisers.methods.listAssignedTargetingOptions.description - resources.advertisers.methods.listAssignedTargetingOptions.flatPath - resources.advertisers.methods.listAssignedTargetingOptions.httpMethod - resources.advertisers.methods.listAssignedTargetingOptions.id - resources.advertisers.methods.listAssignedTargetingOptions.parameterOrder - resources.advertisers.methods.listAssignedTargetingOptions.parameters.advertiserId.description - resources.advertisers.methods.listAssignedTargetingOptions.parameters.advertiserId.format - resources.advertisers.methods.listAssignedTargetingOptions.parameters.advertiserId.location - resources.advertisers.methods.listAssignedTargetingOptions.parameters.advertiserId.pattern - resources.advertisers.methods.listAssignedTargetingOptions.parameters.advertiserId.required - resources.advertisers.methods.listAssignedTargetingOptions.parameters.advertiserId.type - resources.advertisers.methods.listAssignedTargetingOptions.parameters.filter.description - resources.advertisers.methods.listAssignedTargetingOptions.parameters.filter.location - resources.advertisers.methods.listAssignedTargetingOptions.parameters.filter.type - resources.advertisers.methods.listAssignedTargetingOptions.parameters.orderBy.description - resources.advertisers.methods.listAssignedTargetingOptions.parameters.orderBy.location - resources.advertisers.methods.listAssignedTargetingOptions.parameters.orderBy.type - resources.advertisers.methods.listAssignedTargetingOptions.parameters.pageSize.description - resources.advertisers.methods.listAssignedTargetingOptions.parameters.pageSize.format - resources.advertisers.methods.listAssignedTargetingOptions.parameters.pageSize.location - resources.advertisers.methods.listAssignedTargetingOptions.parameters.pageSize.type - resources.advertisers.methods.listAssignedTargetingOptions.parameters.pageToken.description - resources.advertisers.methods.listAssignedTargetingOptions.parameters.pageToken.location - resources.advertisers.methods.listAssignedTargetingOptions.parameters.pageToken.type - resources.advertisers.methods.listAssignedTargetingOptions.path - resources.advertisers.methods.listAssignedTargetingOptions.response.$ref - resources.advertisers.methods.listAssignedTargetingOptions.scopes - resources.advertisers.methods.patch.description - resources.advertisers.methods.patch.flatPath - resources.advertisers.methods.patch.httpMethod - resources.advertisers.methods.patch.id - resources.advertisers.methods.patch.parameterOrder - resources.advertisers.methods.patch.parameters.advertiserId.description - resources.advertisers.methods.patch.parameters.advertiserId.format - resources.advertisers.methods.patch.parameters.advertiserId.location - resources.advertisers.methods.patch.parameters.advertiserId.pattern - resources.advertisers.methods.patch.parameters.advertiserId.required - resources.advertisers.methods.patch.parameters.advertiserId.type - resources.advertisers.methods.patch.parameters.updateMask.description - resources.advertisers.methods.patch.parameters.updateMask.format - resources.advertisers.methods.patch.parameters.updateMask.location - resources.advertisers.methods.patch.parameters.updateMask.type - resources.advertisers.methods.patch.path - resources.advertisers.methods.patch.request.$ref - resources.advertisers.methods.patch.response.$ref - resources.advertisers.methods.patch.scopes - resources.advertisers.resources.adGroupAds.methods.get.description - resources.advertisers.resources.adGroupAds.methods.get.flatPath - resources.advertisers.resources.adGroupAds.methods.get.httpMethod - resources.advertisers.resources.adGroupAds.methods.get.id - resources.advertisers.resources.adGroupAds.methods.get.parameterOrder - resources.advertisers.resources.adGroupAds.methods.get.parameters.adGroupAdId.description - resources.advertisers.resources.adGroupAds.methods.get.parameters.adGroupAdId.format - resources.advertisers.resources.adGroupAds.methods.get.parameters.adGroupAdId.location - resources.advertisers.resources.adGroupAds.methods.get.parameters.adGroupAdId.pattern - resources.advertisers.resources.adGroupAds.methods.get.parameters.adGroupAdId.required - resources.advertisers.resources.adGroupAds.methods.get.parameters.adGroupAdId.type - resources.advertisers.resources.adGroupAds.methods.get.parameters.advertiserId.description - resources.advertisers.resources.adGroupAds.methods.get.parameters.advertiserId.format - resources.advertisers.resources.adGroupAds.methods.get.parameters.advertiserId.location - resources.advertisers.resources.adGroupAds.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.adGroupAds.methods.get.parameters.advertiserId.required - resources.advertisers.resources.adGroupAds.methods.get.parameters.advertiserId.type - resources.advertisers.resources.adGroupAds.methods.get.path - resources.advertisers.resources.adGroupAds.methods.get.response.$ref - resources.advertisers.resources.adGroupAds.methods.get.scopes - resources.advertisers.resources.adGroupAds.methods.list.description - resources.advertisers.resources.adGroupAds.methods.list.flatPath - resources.advertisers.resources.adGroupAds.methods.list.httpMethod - resources.advertisers.resources.adGroupAds.methods.list.id - resources.advertisers.resources.adGroupAds.methods.list.parameterOrder - resources.advertisers.resources.adGroupAds.methods.list.parameters.advertiserId.description - resources.advertisers.resources.adGroupAds.methods.list.parameters.advertiserId.format - resources.advertisers.resources.adGroupAds.methods.list.parameters.advertiserId.location - resources.advertisers.resources.adGroupAds.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.adGroupAds.methods.list.parameters.advertiserId.required - resources.advertisers.resources.adGroupAds.methods.list.parameters.advertiserId.type - resources.advertisers.resources.adGroupAds.methods.list.parameters.filter.description - resources.advertisers.resources.adGroupAds.methods.list.parameters.filter.location - resources.advertisers.resources.adGroupAds.methods.list.parameters.filter.type - resources.advertisers.resources.adGroupAds.methods.list.parameters.orderBy.description - resources.advertisers.resources.adGroupAds.methods.list.parameters.orderBy.location - resources.advertisers.resources.adGroupAds.methods.list.parameters.orderBy.type - resources.advertisers.resources.adGroupAds.methods.list.parameters.pageSize.description - resources.advertisers.resources.adGroupAds.methods.list.parameters.pageSize.format - resources.advertisers.resources.adGroupAds.methods.list.parameters.pageSize.location - resources.advertisers.resources.adGroupAds.methods.list.parameters.pageSize.type - resources.advertisers.resources.adGroupAds.methods.list.parameters.pageToken.description - resources.advertisers.resources.adGroupAds.methods.list.parameters.pageToken.location - resources.advertisers.resources.adGroupAds.methods.list.parameters.pageToken.type - resources.advertisers.resources.adGroupAds.methods.list.path - resources.advertisers.resources.adGroupAds.methods.list.response.$ref - resources.advertisers.resources.adGroupAds.methods.list.scopes - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.description - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.flatPath - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.httpMethod - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.id - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameterOrder - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.adGroupIds.description - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.adGroupIds.format - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.adGroupIds.location - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.adGroupIds.repeated - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.adGroupIds.type - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.description - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.format - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.location - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.pattern - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.required - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.type - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.filter.description - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.filter.location - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.filter.type - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.orderBy.description - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.orderBy.location - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.orderBy.type - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.pageSize.description - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.pageSize.format - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.pageSize.location - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.pageSize.type - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.pageToken.description - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.pageToken.location - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.parameters.pageToken.type - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.path - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.response.$ref - resources.advertisers.resources.adGroups.methods.bulkListAssignedTargetingOptions.scopes - resources.advertisers.resources.adGroups.methods.get.description - resources.advertisers.resources.adGroups.methods.get.flatPath - resources.advertisers.resources.adGroups.methods.get.httpMethod - resources.advertisers.resources.adGroups.methods.get.id - resources.advertisers.resources.adGroups.methods.get.parameterOrder - resources.advertisers.resources.adGroups.methods.get.parameters.adGroupId.description - resources.advertisers.resources.adGroups.methods.get.parameters.adGroupId.format - resources.advertisers.resources.adGroups.methods.get.parameters.adGroupId.location - resources.advertisers.resources.adGroups.methods.get.parameters.adGroupId.pattern - resources.advertisers.resources.adGroups.methods.get.parameters.adGroupId.required - resources.advertisers.resources.adGroups.methods.get.parameters.adGroupId.type - resources.advertisers.resources.adGroups.methods.get.parameters.advertiserId.description - resources.advertisers.resources.adGroups.methods.get.parameters.advertiserId.format - resources.advertisers.resources.adGroups.methods.get.parameters.advertiserId.location - resources.advertisers.resources.adGroups.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.adGroups.methods.get.parameters.advertiserId.required - resources.advertisers.resources.adGroups.methods.get.parameters.advertiserId.type - resources.advertisers.resources.adGroups.methods.get.path - resources.advertisers.resources.adGroups.methods.get.response.$ref - resources.advertisers.resources.adGroups.methods.get.scopes - resources.advertisers.resources.adGroups.methods.list.description - resources.advertisers.resources.adGroups.methods.list.flatPath - resources.advertisers.resources.adGroups.methods.list.httpMethod - resources.advertisers.resources.adGroups.methods.list.id - resources.advertisers.resources.adGroups.methods.list.parameterOrder - resources.advertisers.resources.adGroups.methods.list.parameters.advertiserId.description - resources.advertisers.resources.adGroups.methods.list.parameters.advertiserId.format - resources.advertisers.resources.adGroups.methods.list.parameters.advertiserId.location - resources.advertisers.resources.adGroups.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.adGroups.methods.list.parameters.advertiserId.required - resources.advertisers.resources.adGroups.methods.list.parameters.advertiserId.type - resources.advertisers.resources.adGroups.methods.list.parameters.filter.description - resources.advertisers.resources.adGroups.methods.list.parameters.filter.location - resources.advertisers.resources.adGroups.methods.list.parameters.filter.type - resources.advertisers.resources.adGroups.methods.list.parameters.orderBy.description - resources.advertisers.resources.adGroups.methods.list.parameters.orderBy.location - resources.advertisers.resources.adGroups.methods.list.parameters.orderBy.type - resources.advertisers.resources.adGroups.methods.list.parameters.pageSize.description - resources.advertisers.resources.adGroups.methods.list.parameters.pageSize.format - resources.advertisers.resources.adGroups.methods.list.parameters.pageSize.location - resources.advertisers.resources.adGroups.methods.list.parameters.pageSize.type - resources.advertisers.resources.adGroups.methods.list.parameters.pageToken.description - resources.advertisers.resources.adGroups.methods.list.parameters.pageToken.location - resources.advertisers.resources.adGroups.methods.list.parameters.pageToken.type - resources.advertisers.resources.adGroups.methods.list.path - resources.advertisers.resources.adGroups.methods.list.response.$ref - resources.advertisers.resources.adGroups.methods.list.scopes - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.flatPath - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.httpMethod - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.id - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameterOrder - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.adGroupId.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.adGroupId.format - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.adGroupId.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.adGroupId.pattern - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.adGroupId.required - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.adGroupId.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.format - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.required - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.pattern - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.required - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.enum - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.enumDescriptions - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.pattern - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.required - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.path - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.response.$ref - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.scopes - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.flatPath - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.httpMethod - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.id - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameterOrder - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.adGroupId.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.adGroupId.format - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.adGroupId.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.adGroupId.pattern - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.adGroupId.required - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.adGroupId.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.format - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.required - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.format - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.description - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.enum - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.enumDescriptions - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.location - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.pattern - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.required - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.type - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.path - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.response.$ref - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.scopes - resources.advertisers.resources.assets.methods.upload.description - resources.advertisers.resources.assets.methods.upload.flatPath - resources.advertisers.resources.assets.methods.upload.httpMethod - resources.advertisers.resources.assets.methods.upload.id - resources.advertisers.resources.assets.methods.upload.mediaUpload.accept - resources.advertisers.resources.assets.methods.upload.mediaUpload.protocols.simple.multipart - resources.advertisers.resources.assets.methods.upload.mediaUpload.protocols.simple.path - resources.advertisers.resources.assets.methods.upload.parameterOrder - resources.advertisers.resources.assets.methods.upload.parameters.advertiserId.description - resources.advertisers.resources.assets.methods.upload.parameters.advertiserId.format - resources.advertisers.resources.assets.methods.upload.parameters.advertiserId.location - resources.advertisers.resources.assets.methods.upload.parameters.advertiserId.pattern - resources.advertisers.resources.assets.methods.upload.parameters.advertiserId.required - resources.advertisers.resources.assets.methods.upload.parameters.advertiserId.type - resources.advertisers.resources.assets.methods.upload.path - resources.advertisers.resources.assets.methods.upload.request.$ref - resources.advertisers.resources.assets.methods.upload.response.$ref - resources.advertisers.resources.assets.methods.upload.scopes - resources.advertisers.resources.assets.methods.upload.supportsMediaUpload - resources.advertisers.resources.campaigns.methods.create.description - resources.advertisers.resources.campaigns.methods.create.flatPath - resources.advertisers.resources.campaigns.methods.create.httpMethod - resources.advertisers.resources.campaigns.methods.create.id - resources.advertisers.resources.campaigns.methods.create.parameterOrder - resources.advertisers.resources.campaigns.methods.create.parameters.advertiserId.description - resources.advertisers.resources.campaigns.methods.create.parameters.advertiserId.format - resources.advertisers.resources.campaigns.methods.create.parameters.advertiserId.location - resources.advertisers.resources.campaigns.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.campaigns.methods.create.parameters.advertiserId.required - resources.advertisers.resources.campaigns.methods.create.parameters.advertiserId.type - resources.advertisers.resources.campaigns.methods.create.path - resources.advertisers.resources.campaigns.methods.create.request.$ref - resources.advertisers.resources.campaigns.methods.create.response.$ref - resources.advertisers.resources.campaigns.methods.create.scopes - resources.advertisers.resources.campaigns.methods.delete.description - resources.advertisers.resources.campaigns.methods.delete.flatPath - resources.advertisers.resources.campaigns.methods.delete.httpMethod - resources.advertisers.resources.campaigns.methods.delete.id - resources.advertisers.resources.campaigns.methods.delete.parameterOrder - resources.advertisers.resources.campaigns.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.campaigns.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.campaigns.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.campaigns.methods.delete.parameters.advertiserId.pattern - resources.advertisers.resources.campaigns.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.campaigns.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.campaigns.methods.delete.parameters.campaignId.description - resources.advertisers.resources.campaigns.methods.delete.parameters.campaignId.format - resources.advertisers.resources.campaigns.methods.delete.parameters.campaignId.location - resources.advertisers.resources.campaigns.methods.delete.parameters.campaignId.pattern - resources.advertisers.resources.campaigns.methods.delete.parameters.campaignId.required - resources.advertisers.resources.campaigns.methods.delete.parameters.campaignId.type - resources.advertisers.resources.campaigns.methods.delete.path - resources.advertisers.resources.campaigns.methods.delete.response.$ref - resources.advertisers.resources.campaigns.methods.delete.scopes - resources.advertisers.resources.campaigns.methods.get.description - resources.advertisers.resources.campaigns.methods.get.flatPath - resources.advertisers.resources.campaigns.methods.get.httpMethod - resources.advertisers.resources.campaigns.methods.get.id - resources.advertisers.resources.campaigns.methods.get.parameterOrder - resources.advertisers.resources.campaigns.methods.get.parameters.advertiserId.description - resources.advertisers.resources.campaigns.methods.get.parameters.advertiserId.format - resources.advertisers.resources.campaigns.methods.get.parameters.advertiserId.location - resources.advertisers.resources.campaigns.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.campaigns.methods.get.parameters.advertiserId.required - resources.advertisers.resources.campaigns.methods.get.parameters.advertiserId.type - resources.advertisers.resources.campaigns.methods.get.parameters.campaignId.description - resources.advertisers.resources.campaigns.methods.get.parameters.campaignId.format - resources.advertisers.resources.campaigns.methods.get.parameters.campaignId.location - resources.advertisers.resources.campaigns.methods.get.parameters.campaignId.pattern - resources.advertisers.resources.campaigns.methods.get.parameters.campaignId.required - resources.advertisers.resources.campaigns.methods.get.parameters.campaignId.type - resources.advertisers.resources.campaigns.methods.get.path - resources.advertisers.resources.campaigns.methods.get.response.$ref - resources.advertisers.resources.campaigns.methods.get.scopes - resources.advertisers.resources.campaigns.methods.list.description - resources.advertisers.resources.campaigns.methods.list.flatPath - resources.advertisers.resources.campaigns.methods.list.httpMethod - resources.advertisers.resources.campaigns.methods.list.id - resources.advertisers.resources.campaigns.methods.list.parameterOrder - resources.advertisers.resources.campaigns.methods.list.parameters.advertiserId.description - resources.advertisers.resources.campaigns.methods.list.parameters.advertiserId.format - resources.advertisers.resources.campaigns.methods.list.parameters.advertiserId.location - resources.advertisers.resources.campaigns.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.campaigns.methods.list.parameters.advertiserId.required - resources.advertisers.resources.campaigns.methods.list.parameters.advertiserId.type - resources.advertisers.resources.campaigns.methods.list.parameters.filter.description - resources.advertisers.resources.campaigns.methods.list.parameters.filter.location - resources.advertisers.resources.campaigns.methods.list.parameters.filter.type - resources.advertisers.resources.campaigns.methods.list.parameters.orderBy.description - resources.advertisers.resources.campaigns.methods.list.parameters.orderBy.location - resources.advertisers.resources.campaigns.methods.list.parameters.orderBy.type - resources.advertisers.resources.campaigns.methods.list.parameters.pageSize.description - resources.advertisers.resources.campaigns.methods.list.parameters.pageSize.format - resources.advertisers.resources.campaigns.methods.list.parameters.pageSize.location - resources.advertisers.resources.campaigns.methods.list.parameters.pageSize.type - resources.advertisers.resources.campaigns.methods.list.parameters.pageToken.description - resources.advertisers.resources.campaigns.methods.list.parameters.pageToken.location - resources.advertisers.resources.campaigns.methods.list.parameters.pageToken.type - resources.advertisers.resources.campaigns.methods.list.path - resources.advertisers.resources.campaigns.methods.list.response.$ref - resources.advertisers.resources.campaigns.methods.list.scopes - resources.advertisers.resources.campaigns.methods.patch.description - resources.advertisers.resources.campaigns.methods.patch.flatPath - resources.advertisers.resources.campaigns.methods.patch.httpMethod - resources.advertisers.resources.campaigns.methods.patch.id - resources.advertisers.resources.campaigns.methods.patch.parameterOrder - resources.advertisers.resources.campaigns.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.campaigns.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.campaigns.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.campaigns.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.campaigns.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.campaigns.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.campaigns.methods.patch.parameters.campaignId.description - resources.advertisers.resources.campaigns.methods.patch.parameters.campaignId.format - resources.advertisers.resources.campaigns.methods.patch.parameters.campaignId.location - resources.advertisers.resources.campaigns.methods.patch.parameters.campaignId.pattern - resources.advertisers.resources.campaigns.methods.patch.parameters.campaignId.required - resources.advertisers.resources.campaigns.methods.patch.parameters.campaignId.type - resources.advertisers.resources.campaigns.methods.patch.parameters.updateMask.description - resources.advertisers.resources.campaigns.methods.patch.parameters.updateMask.format - resources.advertisers.resources.campaigns.methods.patch.parameters.updateMask.location - resources.advertisers.resources.campaigns.methods.patch.parameters.updateMask.type - resources.advertisers.resources.campaigns.methods.patch.path - resources.advertisers.resources.campaigns.methods.patch.request.$ref - resources.advertisers.resources.campaigns.methods.patch.response.$ref - resources.advertisers.resources.campaigns.methods.patch.scopes - resources.advertisers.resources.channels.methods.create.description - resources.advertisers.resources.channels.methods.create.flatPath - resources.advertisers.resources.channels.methods.create.httpMethod - resources.advertisers.resources.channels.methods.create.id - resources.advertisers.resources.channels.methods.create.parameterOrder - resources.advertisers.resources.channels.methods.create.parameters.advertiserId.description - resources.advertisers.resources.channels.methods.create.parameters.advertiserId.format - resources.advertisers.resources.channels.methods.create.parameters.advertiserId.location - resources.advertisers.resources.channels.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.channels.methods.create.parameters.advertiserId.required - resources.advertisers.resources.channels.methods.create.parameters.advertiserId.type - resources.advertisers.resources.channels.methods.create.parameters.partnerId.description - resources.advertisers.resources.channels.methods.create.parameters.partnerId.format - resources.advertisers.resources.channels.methods.create.parameters.partnerId.location - resources.advertisers.resources.channels.methods.create.parameters.partnerId.type - resources.advertisers.resources.channels.methods.create.path - resources.advertisers.resources.channels.methods.create.request.$ref - resources.advertisers.resources.channels.methods.create.response.$ref - resources.advertisers.resources.channels.methods.create.scopes - resources.advertisers.resources.channels.methods.get.description - resources.advertisers.resources.channels.methods.get.flatPath - resources.advertisers.resources.channels.methods.get.httpMethod - resources.advertisers.resources.channels.methods.get.id - resources.advertisers.resources.channels.methods.get.parameterOrder - resources.advertisers.resources.channels.methods.get.parameters.advertiserId.description - resources.advertisers.resources.channels.methods.get.parameters.advertiserId.format - resources.advertisers.resources.channels.methods.get.parameters.advertiserId.location - resources.advertisers.resources.channels.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.channels.methods.get.parameters.advertiserId.required - resources.advertisers.resources.channels.methods.get.parameters.advertiserId.type - resources.advertisers.resources.channels.methods.get.parameters.channelId.description - resources.advertisers.resources.channels.methods.get.parameters.channelId.format - resources.advertisers.resources.channels.methods.get.parameters.channelId.location - resources.advertisers.resources.channels.methods.get.parameters.channelId.pattern - resources.advertisers.resources.channels.methods.get.parameters.channelId.required - resources.advertisers.resources.channels.methods.get.parameters.channelId.type - resources.advertisers.resources.channels.methods.get.parameters.partnerId.description - resources.advertisers.resources.channels.methods.get.parameters.partnerId.format - resources.advertisers.resources.channels.methods.get.parameters.partnerId.location - resources.advertisers.resources.channels.methods.get.parameters.partnerId.type - resources.advertisers.resources.channels.methods.get.path - resources.advertisers.resources.channels.methods.get.response.$ref - resources.advertisers.resources.channels.methods.get.scopes - resources.advertisers.resources.channels.methods.list.description - resources.advertisers.resources.channels.methods.list.flatPath - resources.advertisers.resources.channels.methods.list.httpMethod - resources.advertisers.resources.channels.methods.list.id - resources.advertisers.resources.channels.methods.list.parameterOrder - resources.advertisers.resources.channels.methods.list.parameters.advertiserId.description - resources.advertisers.resources.channels.methods.list.parameters.advertiserId.format - resources.advertisers.resources.channels.methods.list.parameters.advertiserId.location - resources.advertisers.resources.channels.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.channels.methods.list.parameters.advertiserId.required - resources.advertisers.resources.channels.methods.list.parameters.advertiserId.type - resources.advertisers.resources.channels.methods.list.parameters.filter.description - resources.advertisers.resources.channels.methods.list.parameters.filter.location - resources.advertisers.resources.channels.methods.list.parameters.filter.type - resources.advertisers.resources.channels.methods.list.parameters.orderBy.description - resources.advertisers.resources.channels.methods.list.parameters.orderBy.location - resources.advertisers.resources.channels.methods.list.parameters.orderBy.type - resources.advertisers.resources.channels.methods.list.parameters.pageSize.description - resources.advertisers.resources.channels.methods.list.parameters.pageSize.format - resources.advertisers.resources.channels.methods.list.parameters.pageSize.location - resources.advertisers.resources.channels.methods.list.parameters.pageSize.type - resources.advertisers.resources.channels.methods.list.parameters.pageToken.description - resources.advertisers.resources.channels.methods.list.parameters.pageToken.location - resources.advertisers.resources.channels.methods.list.parameters.pageToken.type - resources.advertisers.resources.channels.methods.list.parameters.partnerId.description - resources.advertisers.resources.channels.methods.list.parameters.partnerId.format - resources.advertisers.resources.channels.methods.list.parameters.partnerId.location - resources.advertisers.resources.channels.methods.list.parameters.partnerId.type - resources.advertisers.resources.channels.methods.list.path - resources.advertisers.resources.channels.methods.list.response.$ref - resources.advertisers.resources.channels.methods.list.scopes - resources.advertisers.resources.channels.methods.patch.description - resources.advertisers.resources.channels.methods.patch.flatPath - resources.advertisers.resources.channels.methods.patch.httpMethod - resources.advertisers.resources.channels.methods.patch.id - resources.advertisers.resources.channels.methods.patch.parameterOrder - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.channels.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.channels.methods.patch.parameters.channelId.description - resources.advertisers.resources.channels.methods.patch.parameters.channelId.format - resources.advertisers.resources.channels.methods.patch.parameters.channelId.location - resources.advertisers.resources.channels.methods.patch.parameters.channelId.required - resources.advertisers.resources.channels.methods.patch.parameters.channelId.type - resources.advertisers.resources.channels.methods.patch.parameters.partnerId.description - resources.advertisers.resources.channels.methods.patch.parameters.partnerId.format - resources.advertisers.resources.channels.methods.patch.parameters.partnerId.location - resources.advertisers.resources.channels.methods.patch.parameters.partnerId.type - resources.advertisers.resources.channels.methods.patch.parameters.updateMask.description - resources.advertisers.resources.channels.methods.patch.parameters.updateMask.format - resources.advertisers.resources.channels.methods.patch.parameters.updateMask.location - resources.advertisers.resources.channels.methods.patch.parameters.updateMask.type - resources.advertisers.resources.channels.methods.patch.path - resources.advertisers.resources.channels.methods.patch.request.$ref - resources.advertisers.resources.channels.methods.patch.response.$ref - resources.advertisers.resources.channels.methods.patch.scopes - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.description - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.flatPath - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.id - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.path - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.request.$ref - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.bulkEdit.scopes - resources.advertisers.resources.channels.resources.sites.methods.create.description - resources.advertisers.resources.channels.resources.sites.methods.create.flatPath - resources.advertisers.resources.channels.resources.sites.methods.create.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.create.id - resources.advertisers.resources.channels.resources.sites.methods.create.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.partnerId.description - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.partnerId.format - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.partnerId.location - resources.advertisers.resources.channels.resources.sites.methods.create.parameters.partnerId.type - resources.advertisers.resources.channels.resources.sites.methods.create.path - resources.advertisers.resources.channels.resources.sites.methods.create.request.$ref - resources.advertisers.resources.channels.resources.sites.methods.create.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.create.scopes - resources.advertisers.resources.channels.resources.sites.methods.delete.description - resources.advertisers.resources.channels.resources.sites.methods.delete.flatPath - resources.advertisers.resources.channels.resources.sites.methods.delete.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.delete.id - resources.advertisers.resources.channels.resources.sites.methods.delete.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.partnerId.description - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.partnerId.format - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.partnerId.location - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.partnerId.type - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.description - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.location - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.pattern - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.required - resources.advertisers.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.type - resources.advertisers.resources.channels.resources.sites.methods.delete.path - resources.advertisers.resources.channels.resources.sites.methods.delete.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.delete.scopes - resources.advertisers.resources.channels.resources.sites.methods.list.description - resources.advertisers.resources.channels.resources.sites.methods.list.flatPath - resources.advertisers.resources.channels.resources.sites.methods.list.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.list.id - resources.advertisers.resources.channels.resources.sites.methods.list.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.filter.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.filter.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.filter.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.orderBy.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.orderBy.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.orderBy.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageSize.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageSize.format - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageSize.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageSize.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageToken.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageToken.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.pageToken.type - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.partnerId.description - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.partnerId.format - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.partnerId.location - resources.advertisers.resources.channels.resources.sites.methods.list.parameters.partnerId.type - resources.advertisers.resources.channels.resources.sites.methods.list.path - resources.advertisers.resources.channels.resources.sites.methods.list.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.list.scopes - resources.advertisers.resources.channels.resources.sites.methods.replace.description - resources.advertisers.resources.channels.resources.sites.methods.replace.flatPath - resources.advertisers.resources.channels.resources.sites.methods.replace.httpMethod - resources.advertisers.resources.channels.resources.sites.methods.replace.id - resources.advertisers.resources.channels.resources.sites.methods.replace.parameterOrder - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.advertiserId.description - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.advertiserId.format - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.advertiserId.location - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.advertiserId.required - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.advertiserId.type - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.channelId.description - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.channelId.format - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.channelId.location - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.channelId.pattern - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.channelId.required - resources.advertisers.resources.channels.resources.sites.methods.replace.parameters.channelId.type - resources.advertisers.resources.channels.resources.sites.methods.replace.path - resources.advertisers.resources.channels.resources.sites.methods.replace.request.$ref - resources.advertisers.resources.channels.resources.sites.methods.replace.response.$ref - resources.advertisers.resources.channels.resources.sites.methods.replace.scopes - resources.advertisers.resources.creatives.methods.create.description - resources.advertisers.resources.creatives.methods.create.flatPath - resources.advertisers.resources.creatives.methods.create.httpMethod - resources.advertisers.resources.creatives.methods.create.id - resources.advertisers.resources.creatives.methods.create.parameterOrder - resources.advertisers.resources.creatives.methods.create.parameters.advertiserId.description - resources.advertisers.resources.creatives.methods.create.parameters.advertiserId.format - resources.advertisers.resources.creatives.methods.create.parameters.advertiserId.location - resources.advertisers.resources.creatives.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.creatives.methods.create.parameters.advertiserId.required - resources.advertisers.resources.creatives.methods.create.parameters.advertiserId.type - resources.advertisers.resources.creatives.methods.create.path - resources.advertisers.resources.creatives.methods.create.request.$ref - resources.advertisers.resources.creatives.methods.create.response.$ref - resources.advertisers.resources.creatives.methods.create.scopes - resources.advertisers.resources.creatives.methods.delete.description - resources.advertisers.resources.creatives.methods.delete.flatPath - resources.advertisers.resources.creatives.methods.delete.httpMethod - resources.advertisers.resources.creatives.methods.delete.id - resources.advertisers.resources.creatives.methods.delete.parameterOrder - resources.advertisers.resources.creatives.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.creatives.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.creatives.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.creatives.methods.delete.parameters.advertiserId.pattern - resources.advertisers.resources.creatives.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.creatives.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.creatives.methods.delete.parameters.creativeId.description - resources.advertisers.resources.creatives.methods.delete.parameters.creativeId.format - resources.advertisers.resources.creatives.methods.delete.parameters.creativeId.location - resources.advertisers.resources.creatives.methods.delete.parameters.creativeId.pattern - resources.advertisers.resources.creatives.methods.delete.parameters.creativeId.required - resources.advertisers.resources.creatives.methods.delete.parameters.creativeId.type - resources.advertisers.resources.creatives.methods.delete.path - resources.advertisers.resources.creatives.methods.delete.response.$ref - resources.advertisers.resources.creatives.methods.delete.scopes - resources.advertisers.resources.creatives.methods.get.description - resources.advertisers.resources.creatives.methods.get.flatPath - resources.advertisers.resources.creatives.methods.get.httpMethod - resources.advertisers.resources.creatives.methods.get.id - resources.advertisers.resources.creatives.methods.get.parameterOrder - resources.advertisers.resources.creatives.methods.get.parameters.advertiserId.description - resources.advertisers.resources.creatives.methods.get.parameters.advertiserId.format - resources.advertisers.resources.creatives.methods.get.parameters.advertiserId.location - resources.advertisers.resources.creatives.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.creatives.methods.get.parameters.advertiserId.required - resources.advertisers.resources.creatives.methods.get.parameters.advertiserId.type - resources.advertisers.resources.creatives.methods.get.parameters.creativeId.description - resources.advertisers.resources.creatives.methods.get.parameters.creativeId.format - resources.advertisers.resources.creatives.methods.get.parameters.creativeId.location - resources.advertisers.resources.creatives.methods.get.parameters.creativeId.pattern - resources.advertisers.resources.creatives.methods.get.parameters.creativeId.required - resources.advertisers.resources.creatives.methods.get.parameters.creativeId.type - resources.advertisers.resources.creatives.methods.get.path - resources.advertisers.resources.creatives.methods.get.response.$ref - resources.advertisers.resources.creatives.methods.get.scopes - resources.advertisers.resources.creatives.methods.list.description - resources.advertisers.resources.creatives.methods.list.flatPath - resources.advertisers.resources.creatives.methods.list.httpMethod - resources.advertisers.resources.creatives.methods.list.id - resources.advertisers.resources.creatives.methods.list.parameterOrder - resources.advertisers.resources.creatives.methods.list.parameters.advertiserId.description - resources.advertisers.resources.creatives.methods.list.parameters.advertiserId.format - resources.advertisers.resources.creatives.methods.list.parameters.advertiserId.location - resources.advertisers.resources.creatives.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.creatives.methods.list.parameters.advertiserId.required - resources.advertisers.resources.creatives.methods.list.parameters.advertiserId.type - resources.advertisers.resources.creatives.methods.list.parameters.filter.description - resources.advertisers.resources.creatives.methods.list.parameters.filter.location - resources.advertisers.resources.creatives.methods.list.parameters.filter.type - resources.advertisers.resources.creatives.methods.list.parameters.orderBy.description - resources.advertisers.resources.creatives.methods.list.parameters.orderBy.location - resources.advertisers.resources.creatives.methods.list.parameters.orderBy.type - resources.advertisers.resources.creatives.methods.list.parameters.pageSize.description - resources.advertisers.resources.creatives.methods.list.parameters.pageSize.format - resources.advertisers.resources.creatives.methods.list.parameters.pageSize.location - resources.advertisers.resources.creatives.methods.list.parameters.pageSize.type - resources.advertisers.resources.creatives.methods.list.parameters.pageToken.description - resources.advertisers.resources.creatives.methods.list.parameters.pageToken.location - resources.advertisers.resources.creatives.methods.list.parameters.pageToken.type - resources.advertisers.resources.creatives.methods.list.path - resources.advertisers.resources.creatives.methods.list.response.$ref - resources.advertisers.resources.creatives.methods.list.scopes - resources.advertisers.resources.creatives.methods.patch.description - resources.advertisers.resources.creatives.methods.patch.flatPath - resources.advertisers.resources.creatives.methods.patch.httpMethod - resources.advertisers.resources.creatives.methods.patch.id - resources.advertisers.resources.creatives.methods.patch.parameterOrder - resources.advertisers.resources.creatives.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.creatives.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.creatives.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.creatives.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.creatives.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.creatives.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.creatives.methods.patch.parameters.creativeId.description - resources.advertisers.resources.creatives.methods.patch.parameters.creativeId.format - resources.advertisers.resources.creatives.methods.patch.parameters.creativeId.location - resources.advertisers.resources.creatives.methods.patch.parameters.creativeId.pattern - resources.advertisers.resources.creatives.methods.patch.parameters.creativeId.required - resources.advertisers.resources.creatives.methods.patch.parameters.creativeId.type - resources.advertisers.resources.creatives.methods.patch.parameters.updateMask.description - resources.advertisers.resources.creatives.methods.patch.parameters.updateMask.format - resources.advertisers.resources.creatives.methods.patch.parameters.updateMask.location - resources.advertisers.resources.creatives.methods.patch.parameters.updateMask.type - resources.advertisers.resources.creatives.methods.patch.path - resources.advertisers.resources.creatives.methods.patch.request.$ref - resources.advertisers.resources.creatives.methods.patch.response.$ref - resources.advertisers.resources.creatives.methods.patch.scopes - resources.advertisers.resources.insertionOrders.methods.create.description - resources.advertisers.resources.insertionOrders.methods.create.flatPath - resources.advertisers.resources.insertionOrders.methods.create.httpMethod - resources.advertisers.resources.insertionOrders.methods.create.id - resources.advertisers.resources.insertionOrders.methods.create.parameterOrder - resources.advertisers.resources.insertionOrders.methods.create.parameters.advertiserId.description - resources.advertisers.resources.insertionOrders.methods.create.parameters.advertiserId.format - resources.advertisers.resources.insertionOrders.methods.create.parameters.advertiserId.location - resources.advertisers.resources.insertionOrders.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.insertionOrders.methods.create.parameters.advertiserId.required - resources.advertisers.resources.insertionOrders.methods.create.parameters.advertiserId.type - resources.advertisers.resources.insertionOrders.methods.create.path - resources.advertisers.resources.insertionOrders.methods.create.request.$ref - resources.advertisers.resources.insertionOrders.methods.create.response.$ref - resources.advertisers.resources.insertionOrders.methods.create.scopes - resources.advertisers.resources.insertionOrders.methods.delete.description - resources.advertisers.resources.insertionOrders.methods.delete.flatPath - resources.advertisers.resources.insertionOrders.methods.delete.httpMethod - resources.advertisers.resources.insertionOrders.methods.delete.id - resources.advertisers.resources.insertionOrders.methods.delete.parameterOrder - resources.advertisers.resources.insertionOrders.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.insertionOrders.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.insertionOrders.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.insertionOrders.methods.delete.parameters.advertiserId.pattern - resources.advertisers.resources.insertionOrders.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.insertionOrders.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.insertionOrders.methods.delete.parameters.insertionOrderId.description - resources.advertisers.resources.insertionOrders.methods.delete.parameters.insertionOrderId.format - resources.advertisers.resources.insertionOrders.methods.delete.parameters.insertionOrderId.location - resources.advertisers.resources.insertionOrders.methods.delete.parameters.insertionOrderId.pattern - resources.advertisers.resources.insertionOrders.methods.delete.parameters.insertionOrderId.required - resources.advertisers.resources.insertionOrders.methods.delete.parameters.insertionOrderId.type - resources.advertisers.resources.insertionOrders.methods.delete.path - resources.advertisers.resources.insertionOrders.methods.delete.response.$ref - resources.advertisers.resources.insertionOrders.methods.delete.scopes - resources.advertisers.resources.insertionOrders.methods.get.description - resources.advertisers.resources.insertionOrders.methods.get.flatPath - resources.advertisers.resources.insertionOrders.methods.get.httpMethod - resources.advertisers.resources.insertionOrders.methods.get.id - resources.advertisers.resources.insertionOrders.methods.get.parameterOrder - resources.advertisers.resources.insertionOrders.methods.get.parameters.advertiserId.description - resources.advertisers.resources.insertionOrders.methods.get.parameters.advertiserId.format - resources.advertisers.resources.insertionOrders.methods.get.parameters.advertiserId.location - resources.advertisers.resources.insertionOrders.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.insertionOrders.methods.get.parameters.advertiserId.required - resources.advertisers.resources.insertionOrders.methods.get.parameters.advertiserId.type - resources.advertisers.resources.insertionOrders.methods.get.parameters.insertionOrderId.description - resources.advertisers.resources.insertionOrders.methods.get.parameters.insertionOrderId.format - resources.advertisers.resources.insertionOrders.methods.get.parameters.insertionOrderId.location - resources.advertisers.resources.insertionOrders.methods.get.parameters.insertionOrderId.pattern - resources.advertisers.resources.insertionOrders.methods.get.parameters.insertionOrderId.required - resources.advertisers.resources.insertionOrders.methods.get.parameters.insertionOrderId.type - resources.advertisers.resources.insertionOrders.methods.get.path - resources.advertisers.resources.insertionOrders.methods.get.response.$ref - resources.advertisers.resources.insertionOrders.methods.get.scopes - resources.advertisers.resources.insertionOrders.methods.list.description - resources.advertisers.resources.insertionOrders.methods.list.flatPath - resources.advertisers.resources.insertionOrders.methods.list.httpMethod - resources.advertisers.resources.insertionOrders.methods.list.id - resources.advertisers.resources.insertionOrders.methods.list.parameterOrder - resources.advertisers.resources.insertionOrders.methods.list.parameters.advertiserId.description - resources.advertisers.resources.insertionOrders.methods.list.parameters.advertiserId.format - resources.advertisers.resources.insertionOrders.methods.list.parameters.advertiserId.location - resources.advertisers.resources.insertionOrders.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.insertionOrders.methods.list.parameters.advertiserId.required - resources.advertisers.resources.insertionOrders.methods.list.parameters.advertiserId.type - resources.advertisers.resources.insertionOrders.methods.list.parameters.filter.description - resources.advertisers.resources.insertionOrders.methods.list.parameters.filter.location - resources.advertisers.resources.insertionOrders.methods.list.parameters.filter.type - resources.advertisers.resources.insertionOrders.methods.list.parameters.orderBy.description - resources.advertisers.resources.insertionOrders.methods.list.parameters.orderBy.location - resources.advertisers.resources.insertionOrders.methods.list.parameters.orderBy.type - resources.advertisers.resources.insertionOrders.methods.list.parameters.pageSize.description - resources.advertisers.resources.insertionOrders.methods.list.parameters.pageSize.format - resources.advertisers.resources.insertionOrders.methods.list.parameters.pageSize.location - resources.advertisers.resources.insertionOrders.methods.list.parameters.pageSize.type - resources.advertisers.resources.insertionOrders.methods.list.parameters.pageToken.description - resources.advertisers.resources.insertionOrders.methods.list.parameters.pageToken.location - resources.advertisers.resources.insertionOrders.methods.list.parameters.pageToken.type - resources.advertisers.resources.insertionOrders.methods.list.path - resources.advertisers.resources.insertionOrders.methods.list.response.$ref - resources.advertisers.resources.insertionOrders.methods.list.scopes - resources.advertisers.resources.insertionOrders.methods.patch.description - resources.advertisers.resources.insertionOrders.methods.patch.flatPath - resources.advertisers.resources.insertionOrders.methods.patch.httpMethod - resources.advertisers.resources.insertionOrders.methods.patch.id - resources.advertisers.resources.insertionOrders.methods.patch.parameterOrder - resources.advertisers.resources.insertionOrders.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.insertionOrders.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.insertionOrders.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.insertionOrders.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.insertionOrders.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.insertionOrders.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.insertionOrders.methods.patch.parameters.insertionOrderId.description - resources.advertisers.resources.insertionOrders.methods.patch.parameters.insertionOrderId.format - resources.advertisers.resources.insertionOrders.methods.patch.parameters.insertionOrderId.location - resources.advertisers.resources.insertionOrders.methods.patch.parameters.insertionOrderId.pattern - resources.advertisers.resources.insertionOrders.methods.patch.parameters.insertionOrderId.required - resources.advertisers.resources.insertionOrders.methods.patch.parameters.insertionOrderId.type - resources.advertisers.resources.insertionOrders.methods.patch.parameters.updateMask.description - resources.advertisers.resources.insertionOrders.methods.patch.parameters.updateMask.format - resources.advertisers.resources.insertionOrders.methods.patch.parameters.updateMask.location - resources.advertisers.resources.insertionOrders.methods.patch.parameters.updateMask.type - resources.advertisers.resources.insertionOrders.methods.patch.path - resources.advertisers.resources.insertionOrders.methods.patch.request.$ref - resources.advertisers.resources.insertionOrders.methods.patch.response.$ref - resources.advertisers.resources.insertionOrders.methods.patch.scopes - resources.advertisers.resources.invoices.methods.list.description - resources.advertisers.resources.invoices.methods.list.flatPath - resources.advertisers.resources.invoices.methods.list.httpMethod - resources.advertisers.resources.invoices.methods.list.id - resources.advertisers.resources.invoices.methods.list.parameterOrder - resources.advertisers.resources.invoices.methods.list.parameters.advertiserId.description - resources.advertisers.resources.invoices.methods.list.parameters.advertiserId.format - resources.advertisers.resources.invoices.methods.list.parameters.advertiserId.location - resources.advertisers.resources.invoices.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.invoices.methods.list.parameters.advertiserId.required - resources.advertisers.resources.invoices.methods.list.parameters.advertiserId.type - resources.advertisers.resources.invoices.methods.list.parameters.issueMonth.description - resources.advertisers.resources.invoices.methods.list.parameters.issueMonth.location - resources.advertisers.resources.invoices.methods.list.parameters.issueMonth.type - resources.advertisers.resources.invoices.methods.list.parameters.loiSapinInvoiceType.description - resources.advertisers.resources.invoices.methods.list.parameters.loiSapinInvoiceType.enum - resources.advertisers.resources.invoices.methods.list.parameters.loiSapinInvoiceType.enumDescriptions - resources.advertisers.resources.invoices.methods.list.parameters.loiSapinInvoiceType.location - resources.advertisers.resources.invoices.methods.list.parameters.loiSapinInvoiceType.type - resources.advertisers.resources.invoices.methods.list.parameters.pageSize.description - resources.advertisers.resources.invoices.methods.list.parameters.pageSize.format - resources.advertisers.resources.invoices.methods.list.parameters.pageSize.location - resources.advertisers.resources.invoices.methods.list.parameters.pageSize.type - resources.advertisers.resources.invoices.methods.list.parameters.pageToken.description - resources.advertisers.resources.invoices.methods.list.parameters.pageToken.location - resources.advertisers.resources.invoices.methods.list.parameters.pageToken.type - resources.advertisers.resources.invoices.methods.list.path - resources.advertisers.resources.invoices.methods.list.response.$ref - resources.advertisers.resources.invoices.methods.list.scopes - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.description - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.flatPath - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.httpMethod - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.id - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameterOrder - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.advertiserId.description - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.advertiserId.format - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.advertiserId.location - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.advertiserId.pattern - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.advertiserId.required - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.advertiserId.type - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.invoiceMonth.description - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.invoiceMonth.location - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.parameters.invoiceMonth.type - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.path - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.response.$ref - resources.advertisers.resources.invoices.methods.lookupInvoiceCurrency.scopes - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.description - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.flatPath - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.httpMethod - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.id - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.parameterOrder - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.path - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.request.$ref - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.response.$ref - resources.advertisers.resources.lineItems.methods.bulkEditAssignedTargetingOptions.scopes - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.description - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.flatPath - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.httpMethod - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.id - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameterOrder - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.filter.description - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.filter.location - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.filter.type - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.lineItemIds.description - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.lineItemIds.format - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.lineItemIds.location - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.lineItemIds.repeated - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.lineItemIds.type - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.orderBy.description - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.orderBy.location - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.orderBy.type - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.pageSize.description - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.pageSize.format - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.pageSize.location - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.pageSize.type - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.pageToken.description - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.pageToken.location - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.parameters.pageToken.type - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.path - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.response.$ref - resources.advertisers.resources.lineItems.methods.bulkListAssignedTargetingOptions.scopes - resources.advertisers.resources.lineItems.methods.bulkUpdate.description - resources.advertisers.resources.lineItems.methods.bulkUpdate.flatPath - resources.advertisers.resources.lineItems.methods.bulkUpdate.httpMethod - resources.advertisers.resources.lineItems.methods.bulkUpdate.id - resources.advertisers.resources.lineItems.methods.bulkUpdate.parameterOrder - resources.advertisers.resources.lineItems.methods.bulkUpdate.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.bulkUpdate.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.bulkUpdate.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.bulkUpdate.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.bulkUpdate.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.bulkUpdate.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.bulkUpdate.path - resources.advertisers.resources.lineItems.methods.bulkUpdate.request.$ref - resources.advertisers.resources.lineItems.methods.bulkUpdate.response.$ref - resources.advertisers.resources.lineItems.methods.bulkUpdate.scopes - resources.advertisers.resources.lineItems.methods.create.description - resources.advertisers.resources.lineItems.methods.create.flatPath - resources.advertisers.resources.lineItems.methods.create.httpMethod - resources.advertisers.resources.lineItems.methods.create.id - resources.advertisers.resources.lineItems.methods.create.parameterOrder - resources.advertisers.resources.lineItems.methods.create.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.create.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.create.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.create.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.create.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.create.path - resources.advertisers.resources.lineItems.methods.create.request.$ref - resources.advertisers.resources.lineItems.methods.create.response.$ref - resources.advertisers.resources.lineItems.methods.create.scopes - resources.advertisers.resources.lineItems.methods.delete.description - resources.advertisers.resources.lineItems.methods.delete.flatPath - resources.advertisers.resources.lineItems.methods.delete.httpMethod - resources.advertisers.resources.lineItems.methods.delete.id - resources.advertisers.resources.lineItems.methods.delete.parameterOrder - resources.advertisers.resources.lineItems.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.delete.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.delete.parameters.lineItemId.description - resources.advertisers.resources.lineItems.methods.delete.parameters.lineItemId.format - resources.advertisers.resources.lineItems.methods.delete.parameters.lineItemId.location - resources.advertisers.resources.lineItems.methods.delete.parameters.lineItemId.pattern - resources.advertisers.resources.lineItems.methods.delete.parameters.lineItemId.required - resources.advertisers.resources.lineItems.methods.delete.parameters.lineItemId.type - resources.advertisers.resources.lineItems.methods.delete.path - resources.advertisers.resources.lineItems.methods.delete.response.$ref - resources.advertisers.resources.lineItems.methods.delete.scopes - resources.advertisers.resources.lineItems.methods.duplicate.description - resources.advertisers.resources.lineItems.methods.duplicate.flatPath - resources.advertisers.resources.lineItems.methods.duplicate.httpMethod - resources.advertisers.resources.lineItems.methods.duplicate.id - resources.advertisers.resources.lineItems.methods.duplicate.parameterOrder - resources.advertisers.resources.lineItems.methods.duplicate.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.duplicate.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.duplicate.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.duplicate.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.duplicate.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.duplicate.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.duplicate.parameters.lineItemId.description - resources.advertisers.resources.lineItems.methods.duplicate.parameters.lineItemId.format - resources.advertisers.resources.lineItems.methods.duplicate.parameters.lineItemId.location - resources.advertisers.resources.lineItems.methods.duplicate.parameters.lineItemId.pattern - resources.advertisers.resources.lineItems.methods.duplicate.parameters.lineItemId.required - resources.advertisers.resources.lineItems.methods.duplicate.parameters.lineItemId.type - resources.advertisers.resources.lineItems.methods.duplicate.path - resources.advertisers.resources.lineItems.methods.duplicate.request.$ref - resources.advertisers.resources.lineItems.methods.duplicate.response.$ref - resources.advertisers.resources.lineItems.methods.duplicate.scopes - resources.advertisers.resources.lineItems.methods.generateDefault.description - resources.advertisers.resources.lineItems.methods.generateDefault.flatPath - resources.advertisers.resources.lineItems.methods.generateDefault.httpMethod - resources.advertisers.resources.lineItems.methods.generateDefault.id - resources.advertisers.resources.lineItems.methods.generateDefault.parameterOrder - resources.advertisers.resources.lineItems.methods.generateDefault.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.generateDefault.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.generateDefault.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.generateDefault.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.generateDefault.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.generateDefault.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.generateDefault.path - resources.advertisers.resources.lineItems.methods.generateDefault.request.$ref - resources.advertisers.resources.lineItems.methods.generateDefault.response.$ref - resources.advertisers.resources.lineItems.methods.generateDefault.scopes - resources.advertisers.resources.lineItems.methods.get.description - resources.advertisers.resources.lineItems.methods.get.flatPath - resources.advertisers.resources.lineItems.methods.get.httpMethod - resources.advertisers.resources.lineItems.methods.get.id - resources.advertisers.resources.lineItems.methods.get.parameterOrder - resources.advertisers.resources.lineItems.methods.get.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.get.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.get.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.get.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.get.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.get.parameters.lineItemId.description - resources.advertisers.resources.lineItems.methods.get.parameters.lineItemId.format - resources.advertisers.resources.lineItems.methods.get.parameters.lineItemId.location - resources.advertisers.resources.lineItems.methods.get.parameters.lineItemId.pattern - resources.advertisers.resources.lineItems.methods.get.parameters.lineItemId.required - resources.advertisers.resources.lineItems.methods.get.parameters.lineItemId.type - resources.advertisers.resources.lineItems.methods.get.path - resources.advertisers.resources.lineItems.methods.get.response.$ref - resources.advertisers.resources.lineItems.methods.get.scopes - resources.advertisers.resources.lineItems.methods.list.description - resources.advertisers.resources.lineItems.methods.list.flatPath - resources.advertisers.resources.lineItems.methods.list.httpMethod - resources.advertisers.resources.lineItems.methods.list.id - resources.advertisers.resources.lineItems.methods.list.parameterOrder - resources.advertisers.resources.lineItems.methods.list.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.list.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.list.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.list.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.list.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.list.parameters.filter.description - resources.advertisers.resources.lineItems.methods.list.parameters.filter.location - resources.advertisers.resources.lineItems.methods.list.parameters.filter.type - resources.advertisers.resources.lineItems.methods.list.parameters.orderBy.description - resources.advertisers.resources.lineItems.methods.list.parameters.orderBy.location - resources.advertisers.resources.lineItems.methods.list.parameters.orderBy.type - resources.advertisers.resources.lineItems.methods.list.parameters.pageSize.description - resources.advertisers.resources.lineItems.methods.list.parameters.pageSize.format - resources.advertisers.resources.lineItems.methods.list.parameters.pageSize.location - resources.advertisers.resources.lineItems.methods.list.parameters.pageSize.type - resources.advertisers.resources.lineItems.methods.list.parameters.pageToken.description - resources.advertisers.resources.lineItems.methods.list.parameters.pageToken.location - resources.advertisers.resources.lineItems.methods.list.parameters.pageToken.type - resources.advertisers.resources.lineItems.methods.list.path - resources.advertisers.resources.lineItems.methods.list.response.$ref - resources.advertisers.resources.lineItems.methods.list.scopes - resources.advertisers.resources.lineItems.methods.patch.description - resources.advertisers.resources.lineItems.methods.patch.flatPath - resources.advertisers.resources.lineItems.methods.patch.httpMethod - resources.advertisers.resources.lineItems.methods.patch.id - resources.advertisers.resources.lineItems.methods.patch.parameterOrder - resources.advertisers.resources.lineItems.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.lineItems.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.lineItems.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.lineItems.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.lineItems.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.lineItems.methods.patch.parameters.lineItemId.description - resources.advertisers.resources.lineItems.methods.patch.parameters.lineItemId.format - resources.advertisers.resources.lineItems.methods.patch.parameters.lineItemId.location - resources.advertisers.resources.lineItems.methods.patch.parameters.lineItemId.pattern - resources.advertisers.resources.lineItems.methods.patch.parameters.lineItemId.required - resources.advertisers.resources.lineItems.methods.patch.parameters.lineItemId.type - resources.advertisers.resources.lineItems.methods.patch.parameters.updateMask.description - resources.advertisers.resources.lineItems.methods.patch.parameters.updateMask.format - resources.advertisers.resources.lineItems.methods.patch.parameters.updateMask.location - resources.advertisers.resources.lineItems.methods.patch.parameters.updateMask.type - resources.advertisers.resources.lineItems.methods.patch.path - resources.advertisers.resources.lineItems.methods.patch.request.$ref - resources.advertisers.resources.lineItems.methods.patch.response.$ref - resources.advertisers.resources.lineItems.methods.patch.scopes - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.flatPath - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.httpMethod - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.id - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameterOrder - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.lineItemId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.lineItemId.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.lineItemId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.lineItemId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.lineItemId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.lineItemId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.enum - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.enumDescriptions - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.path - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.request.$ref - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.response.$ref - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.scopes - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.flatPath - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.httpMethod - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.id - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameterOrder - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.lineItemId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.lineItemId.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.lineItemId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.lineItemId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.lineItemId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.lineItemId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.enum - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.enumDescriptions - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.path - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.response.$ref - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.scopes - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.flatPath - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.httpMethod - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.id - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameterOrder - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.lineItemId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.lineItemId.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.lineItemId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.lineItemId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.lineItemId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.lineItemId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.enum - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.enumDescriptions - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.path - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.response.$ref - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.scopes - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.flatPath - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.httpMethod - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.id - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameterOrder - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.lineItemId.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.lineItemId.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.lineItemId.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.lineItemId.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.lineItemId.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.lineItemId.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.format - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.description - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.enum - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.enumDescriptions - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.location - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.pattern - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.required - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.type - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.path - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.response.$ref - resources.advertisers.resources.lineItems.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.scopes - resources.advertisers.resources.locationLists.methods.create.description - resources.advertisers.resources.locationLists.methods.create.flatPath - resources.advertisers.resources.locationLists.methods.create.httpMethod - resources.advertisers.resources.locationLists.methods.create.id - resources.advertisers.resources.locationLists.methods.create.parameterOrder - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.description - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.format - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.location - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.required - resources.advertisers.resources.locationLists.methods.create.parameters.advertiserId.type - resources.advertisers.resources.locationLists.methods.create.path - resources.advertisers.resources.locationLists.methods.create.request.$ref - resources.advertisers.resources.locationLists.methods.create.response.$ref - resources.advertisers.resources.locationLists.methods.create.scopes - resources.advertisers.resources.locationLists.methods.get.description - resources.advertisers.resources.locationLists.methods.get.flatPath - resources.advertisers.resources.locationLists.methods.get.httpMethod - resources.advertisers.resources.locationLists.methods.get.id - resources.advertisers.resources.locationLists.methods.get.parameterOrder - resources.advertisers.resources.locationLists.methods.get.parameters.advertiserId.description - resources.advertisers.resources.locationLists.methods.get.parameters.advertiserId.format - resources.advertisers.resources.locationLists.methods.get.parameters.advertiserId.location - resources.advertisers.resources.locationLists.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.locationLists.methods.get.parameters.advertiserId.required - resources.advertisers.resources.locationLists.methods.get.parameters.advertiserId.type - resources.advertisers.resources.locationLists.methods.get.parameters.locationListId.description - resources.advertisers.resources.locationLists.methods.get.parameters.locationListId.format - resources.advertisers.resources.locationLists.methods.get.parameters.locationListId.location - resources.advertisers.resources.locationLists.methods.get.parameters.locationListId.pattern - resources.advertisers.resources.locationLists.methods.get.parameters.locationListId.required - resources.advertisers.resources.locationLists.methods.get.parameters.locationListId.type - resources.advertisers.resources.locationLists.methods.get.path - resources.advertisers.resources.locationLists.methods.get.response.$ref - resources.advertisers.resources.locationLists.methods.get.scopes - resources.advertisers.resources.locationLists.methods.list.description - resources.advertisers.resources.locationLists.methods.list.flatPath - resources.advertisers.resources.locationLists.methods.list.httpMethod - resources.advertisers.resources.locationLists.methods.list.id - resources.advertisers.resources.locationLists.methods.list.parameterOrder - resources.advertisers.resources.locationLists.methods.list.parameters.advertiserId.description - resources.advertisers.resources.locationLists.methods.list.parameters.advertiserId.format - resources.advertisers.resources.locationLists.methods.list.parameters.advertiserId.location - resources.advertisers.resources.locationLists.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.locationLists.methods.list.parameters.advertiserId.required - resources.advertisers.resources.locationLists.methods.list.parameters.advertiserId.type - resources.advertisers.resources.locationLists.methods.list.parameters.filter.description - resources.advertisers.resources.locationLists.methods.list.parameters.filter.location - resources.advertisers.resources.locationLists.methods.list.parameters.filter.type - resources.advertisers.resources.locationLists.methods.list.parameters.orderBy.description - resources.advertisers.resources.locationLists.methods.list.parameters.orderBy.location - resources.advertisers.resources.locationLists.methods.list.parameters.orderBy.type - resources.advertisers.resources.locationLists.methods.list.parameters.pageSize.description - resources.advertisers.resources.locationLists.methods.list.parameters.pageSize.format - resources.advertisers.resources.locationLists.methods.list.parameters.pageSize.location - resources.advertisers.resources.locationLists.methods.list.parameters.pageSize.type - resources.advertisers.resources.locationLists.methods.list.parameters.pageToken.description - resources.advertisers.resources.locationLists.methods.list.parameters.pageToken.location - resources.advertisers.resources.locationLists.methods.list.parameters.pageToken.type - resources.advertisers.resources.locationLists.methods.list.path - resources.advertisers.resources.locationLists.methods.list.response.$ref - resources.advertisers.resources.locationLists.methods.list.scopes - resources.advertisers.resources.locationLists.methods.patch.description - resources.advertisers.resources.locationLists.methods.patch.flatPath - resources.advertisers.resources.locationLists.methods.patch.httpMethod - resources.advertisers.resources.locationLists.methods.patch.id - resources.advertisers.resources.locationLists.methods.patch.parameterOrder - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.locationLists.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.description - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.format - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.location - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.required - resources.advertisers.resources.locationLists.methods.patch.parameters.locationListId.type - resources.advertisers.resources.locationLists.methods.patch.parameters.updateMask.description - resources.advertisers.resources.locationLists.methods.patch.parameters.updateMask.format - resources.advertisers.resources.locationLists.methods.patch.parameters.updateMask.location - resources.advertisers.resources.locationLists.methods.patch.parameters.updateMask.type - resources.advertisers.resources.locationLists.methods.patch.path - resources.advertisers.resources.locationLists.methods.patch.request.$ref - resources.advertisers.resources.locationLists.methods.patch.response.$ref - resources.advertisers.resources.locationLists.methods.patch.scopes - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.flatPath - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.httpMethod - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.id - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameterOrder - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.advertiserId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.pattern - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.parameters.locationListId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.path - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.request.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.response.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.scopes - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.flatPath - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.httpMethod - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.id - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameterOrder - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.advertiserId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.parameters.locationListId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.path - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.request.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.response.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.create.scopes - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.flatPath - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.httpMethod - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.id - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameterOrder - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.pattern - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.assignedLocationId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.parameters.locationListId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.path - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.response.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.delete.scopes - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.flatPath - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.httpMethod - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.id - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameterOrder - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.advertiserId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.filter.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.filter.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.filter.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.required - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.locationListId.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.orderBy.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.orderBy.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.orderBy.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageSize.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageSize.format - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageSize.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageSize.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageToken.description - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageToken.location - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.parameters.pageToken.type - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.path - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.response.$ref - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.list.scopes - resources.advertisers.resources.negativeKeywordLists.methods.create.description - resources.advertisers.resources.negativeKeywordLists.methods.create.flatPath - resources.advertisers.resources.negativeKeywordLists.methods.create.httpMethod - resources.advertisers.resources.negativeKeywordLists.methods.create.id - resources.advertisers.resources.negativeKeywordLists.methods.create.parameterOrder - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.methods.create.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.methods.create.path - resources.advertisers.resources.negativeKeywordLists.methods.create.request.$ref - resources.advertisers.resources.negativeKeywordLists.methods.create.response.$ref - resources.advertisers.resources.negativeKeywordLists.methods.create.scopes - resources.advertisers.resources.negativeKeywordLists.methods.delete.description - resources.advertisers.resources.negativeKeywordLists.methods.delete.flatPath - resources.advertisers.resources.negativeKeywordLists.methods.delete.httpMethod - resources.advertisers.resources.negativeKeywordLists.methods.delete.id - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameterOrder - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.methods.delete.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.methods.delete.path - resources.advertisers.resources.negativeKeywordLists.methods.delete.response.$ref - resources.advertisers.resources.negativeKeywordLists.methods.delete.scopes - resources.advertisers.resources.negativeKeywordLists.methods.get.description - resources.advertisers.resources.negativeKeywordLists.methods.get.flatPath - resources.advertisers.resources.negativeKeywordLists.methods.get.httpMethod - resources.advertisers.resources.negativeKeywordLists.methods.get.id - resources.advertisers.resources.negativeKeywordLists.methods.get.parameterOrder - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.methods.get.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.methods.get.path - resources.advertisers.resources.negativeKeywordLists.methods.get.response.$ref - resources.advertisers.resources.negativeKeywordLists.methods.get.scopes - resources.advertisers.resources.negativeKeywordLists.methods.list.description - resources.advertisers.resources.negativeKeywordLists.methods.list.flatPath - resources.advertisers.resources.negativeKeywordLists.methods.list.httpMethod - resources.advertisers.resources.negativeKeywordLists.methods.list.id - resources.advertisers.resources.negativeKeywordLists.methods.list.parameterOrder - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.pageSize.description - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.pageSize.format - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.pageSize.location - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.pageSize.type - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.pageToken.description - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.pageToken.location - resources.advertisers.resources.negativeKeywordLists.methods.list.parameters.pageToken.type - resources.advertisers.resources.negativeKeywordLists.methods.list.path - resources.advertisers.resources.negativeKeywordLists.methods.list.response.$ref - resources.advertisers.resources.negativeKeywordLists.methods.list.scopes - resources.advertisers.resources.negativeKeywordLists.methods.patch.description - resources.advertisers.resources.negativeKeywordLists.methods.patch.flatPath - resources.advertisers.resources.negativeKeywordLists.methods.patch.httpMethod - resources.advertisers.resources.negativeKeywordLists.methods.patch.id - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameterOrder - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.updateMask.description - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.updateMask.format - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.updateMask.location - resources.advertisers.resources.negativeKeywordLists.methods.patch.parameters.updateMask.type - resources.advertisers.resources.negativeKeywordLists.methods.patch.path - resources.advertisers.resources.negativeKeywordLists.methods.patch.request.$ref - resources.advertisers.resources.negativeKeywordLists.methods.patch.response.$ref - resources.advertisers.resources.negativeKeywordLists.methods.patch.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.request.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.bulkEdit.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.request.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.create.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.keywordValue.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.delete.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.filter.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.filter.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.filter.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.orderBy.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.orderBy.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.orderBy.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageSize.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageSize.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageSize.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageSize.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageToken.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageToken.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.parameters.pageToken.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.list.scopes - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.flatPath - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.httpMethod - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.id - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameterOrder - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.advertiserId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.advertiserId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.advertiserId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.advertiserId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.advertiserId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.negativeKeywordListId.description - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.negativeKeywordListId.format - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.negativeKeywordListId.location - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.negativeKeywordListId.pattern - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.negativeKeywordListId.required - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.parameters.negativeKeywordListId.type - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.path - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.request.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.response.$ref - resources.advertisers.resources.negativeKeywordLists.resources.negativeKeywords.methods.replace.scopes - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.flatPath - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.httpMethod - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.id - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameterOrder - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.format - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.advertiserId.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.enum - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.enumDescriptions - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.path - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.request.$ref - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.response.$ref - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.scopes - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.flatPath - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.httpMethod - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.id - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameterOrder - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.format - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.advertiserId.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.enum - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.enumDescriptions - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.path - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.response.$ref - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.scopes - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.flatPath - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.httpMethod - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.id - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameterOrder - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.format - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.advertiserId.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.enum - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.enumDescriptions - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.path - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.response.$ref - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.scopes - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.flatPath - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.httpMethod - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.id - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameterOrder - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.format - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.advertiserId.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.format - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.description - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.enum - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.enumDescriptions - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.location - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.pattern - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.required - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.type - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.path - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.response.$ref - resources.advertisers.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.scopes - resources.combinedAudiences.methods.get.description - resources.combinedAudiences.methods.get.flatPath - resources.combinedAudiences.methods.get.httpMethod - resources.combinedAudiences.methods.get.id - resources.combinedAudiences.methods.get.parameterOrder - resources.combinedAudiences.methods.get.parameters.advertiserId.description - resources.combinedAudiences.methods.get.parameters.advertiserId.format - resources.combinedAudiences.methods.get.parameters.advertiserId.location - resources.combinedAudiences.methods.get.parameters.advertiserId.type - resources.combinedAudiences.methods.get.parameters.combinedAudienceId.description - resources.combinedAudiences.methods.get.parameters.combinedAudienceId.format - resources.combinedAudiences.methods.get.parameters.combinedAudienceId.location - resources.combinedAudiences.methods.get.parameters.combinedAudienceId.pattern - resources.combinedAudiences.methods.get.parameters.combinedAudienceId.required - resources.combinedAudiences.methods.get.parameters.combinedAudienceId.type - resources.combinedAudiences.methods.get.parameters.partnerId.description - resources.combinedAudiences.methods.get.parameters.partnerId.format - resources.combinedAudiences.methods.get.parameters.partnerId.location - resources.combinedAudiences.methods.get.parameters.partnerId.type - resources.combinedAudiences.methods.get.path - resources.combinedAudiences.methods.get.response.$ref - resources.combinedAudiences.methods.get.scopes - resources.combinedAudiences.methods.list.description - resources.combinedAudiences.methods.list.flatPath - resources.combinedAudiences.methods.list.httpMethod - resources.combinedAudiences.methods.list.id - resources.combinedAudiences.methods.list.parameterOrder - resources.combinedAudiences.methods.list.parameters.advertiserId.description - resources.combinedAudiences.methods.list.parameters.advertiserId.format - resources.combinedAudiences.methods.list.parameters.advertiserId.location - resources.combinedAudiences.methods.list.parameters.advertiserId.type - resources.combinedAudiences.methods.list.parameters.filter.description - resources.combinedAudiences.methods.list.parameters.filter.location - resources.combinedAudiences.methods.list.parameters.filter.type - resources.combinedAudiences.methods.list.parameters.orderBy.description - resources.combinedAudiences.methods.list.parameters.orderBy.location - resources.combinedAudiences.methods.list.parameters.orderBy.type - resources.combinedAudiences.methods.list.parameters.pageSize.description - resources.combinedAudiences.methods.list.parameters.pageSize.format - resources.combinedAudiences.methods.list.parameters.pageSize.location - resources.combinedAudiences.methods.list.parameters.pageSize.type - resources.combinedAudiences.methods.list.parameters.pageToken.description - resources.combinedAudiences.methods.list.parameters.pageToken.location - resources.combinedAudiences.methods.list.parameters.pageToken.type - resources.combinedAudiences.methods.list.parameters.partnerId.description - resources.combinedAudiences.methods.list.parameters.partnerId.format - resources.combinedAudiences.methods.list.parameters.partnerId.location - resources.combinedAudiences.methods.list.parameters.partnerId.type - resources.combinedAudiences.methods.list.path - resources.combinedAudiences.methods.list.response.$ref - resources.combinedAudiences.methods.list.scopes - resources.customBiddingAlgorithms.methods.create.description - resources.customBiddingAlgorithms.methods.create.flatPath - resources.customBiddingAlgorithms.methods.create.httpMethod - resources.customBiddingAlgorithms.methods.create.id - resources.customBiddingAlgorithms.methods.create.parameterOrder - resources.customBiddingAlgorithms.methods.create.path - resources.customBiddingAlgorithms.methods.create.request.$ref - resources.customBiddingAlgorithms.methods.create.response.$ref - resources.customBiddingAlgorithms.methods.create.scopes - resources.customBiddingAlgorithms.methods.get.description - resources.customBiddingAlgorithms.methods.get.flatPath - resources.customBiddingAlgorithms.methods.get.httpMethod - resources.customBiddingAlgorithms.methods.get.id - resources.customBiddingAlgorithms.methods.get.parameterOrder - resources.customBiddingAlgorithms.methods.get.parameters.advertiserId.description - resources.customBiddingAlgorithms.methods.get.parameters.advertiserId.format - resources.customBiddingAlgorithms.methods.get.parameters.advertiserId.location - resources.customBiddingAlgorithms.methods.get.parameters.advertiserId.type - resources.customBiddingAlgorithms.methods.get.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.methods.get.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.methods.get.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.methods.get.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.methods.get.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.methods.get.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.methods.get.parameters.partnerId.description - resources.customBiddingAlgorithms.methods.get.parameters.partnerId.format - resources.customBiddingAlgorithms.methods.get.parameters.partnerId.location - resources.customBiddingAlgorithms.methods.get.parameters.partnerId.type - resources.customBiddingAlgorithms.methods.get.path - resources.customBiddingAlgorithms.methods.get.response.$ref - resources.customBiddingAlgorithms.methods.get.scopes - resources.customBiddingAlgorithms.methods.list.description - resources.customBiddingAlgorithms.methods.list.flatPath - resources.customBiddingAlgorithms.methods.list.httpMethod - resources.customBiddingAlgorithms.methods.list.id - resources.customBiddingAlgorithms.methods.list.parameterOrder - resources.customBiddingAlgorithms.methods.list.parameters.advertiserId.description - resources.customBiddingAlgorithms.methods.list.parameters.advertiserId.format - resources.customBiddingAlgorithms.methods.list.parameters.advertiserId.location - resources.customBiddingAlgorithms.methods.list.parameters.advertiserId.type - resources.customBiddingAlgorithms.methods.list.parameters.filter.description - resources.customBiddingAlgorithms.methods.list.parameters.filter.location - resources.customBiddingAlgorithms.methods.list.parameters.filter.type - resources.customBiddingAlgorithms.methods.list.parameters.orderBy.description - resources.customBiddingAlgorithms.methods.list.parameters.orderBy.location - resources.customBiddingAlgorithms.methods.list.parameters.orderBy.type - resources.customBiddingAlgorithms.methods.list.parameters.pageSize.description - resources.customBiddingAlgorithms.methods.list.parameters.pageSize.format - resources.customBiddingAlgorithms.methods.list.parameters.pageSize.location - resources.customBiddingAlgorithms.methods.list.parameters.pageSize.type - resources.customBiddingAlgorithms.methods.list.parameters.pageToken.description - resources.customBiddingAlgorithms.methods.list.parameters.pageToken.location - resources.customBiddingAlgorithms.methods.list.parameters.pageToken.type - resources.customBiddingAlgorithms.methods.list.parameters.partnerId.description - resources.customBiddingAlgorithms.methods.list.parameters.partnerId.format - resources.customBiddingAlgorithms.methods.list.parameters.partnerId.location - resources.customBiddingAlgorithms.methods.list.parameters.partnerId.type - resources.customBiddingAlgorithms.methods.list.path - resources.customBiddingAlgorithms.methods.list.response.$ref - resources.customBiddingAlgorithms.methods.list.scopes - resources.customBiddingAlgorithms.methods.patch.description - resources.customBiddingAlgorithms.methods.patch.flatPath - resources.customBiddingAlgorithms.methods.patch.httpMethod - resources.customBiddingAlgorithms.methods.patch.id - resources.customBiddingAlgorithms.methods.patch.parameterOrder - resources.customBiddingAlgorithms.methods.patch.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.methods.patch.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.methods.patch.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.methods.patch.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.methods.patch.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.methods.patch.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.methods.patch.parameters.updateMask.description - resources.customBiddingAlgorithms.methods.patch.parameters.updateMask.format - resources.customBiddingAlgorithms.methods.patch.parameters.updateMask.location - resources.customBiddingAlgorithms.methods.patch.parameters.updateMask.type - resources.customBiddingAlgorithms.methods.patch.path - resources.customBiddingAlgorithms.methods.patch.request.$ref - resources.customBiddingAlgorithms.methods.patch.response.$ref - resources.customBiddingAlgorithms.methods.patch.scopes - resources.customBiddingAlgorithms.methods.uploadRules.description - resources.customBiddingAlgorithms.methods.uploadRules.flatPath - resources.customBiddingAlgorithms.methods.uploadRules.httpMethod - resources.customBiddingAlgorithms.methods.uploadRules.id - resources.customBiddingAlgorithms.methods.uploadRules.parameterOrder - resources.customBiddingAlgorithms.methods.uploadRules.parameters.advertiserId.description - resources.customBiddingAlgorithms.methods.uploadRules.parameters.advertiserId.format - resources.customBiddingAlgorithms.methods.uploadRules.parameters.advertiserId.location - resources.customBiddingAlgorithms.methods.uploadRules.parameters.advertiserId.type - resources.customBiddingAlgorithms.methods.uploadRules.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.methods.uploadRules.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.methods.uploadRules.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.methods.uploadRules.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.methods.uploadRules.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.methods.uploadRules.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.methods.uploadRules.parameters.partnerId.description - resources.customBiddingAlgorithms.methods.uploadRules.parameters.partnerId.format - resources.customBiddingAlgorithms.methods.uploadRules.parameters.partnerId.location - resources.customBiddingAlgorithms.methods.uploadRules.parameters.partnerId.type - resources.customBiddingAlgorithms.methods.uploadRules.path - resources.customBiddingAlgorithms.methods.uploadRules.response.$ref - resources.customBiddingAlgorithms.methods.uploadRules.scopes - resources.customBiddingAlgorithms.methods.uploadScript.description - resources.customBiddingAlgorithms.methods.uploadScript.flatPath - resources.customBiddingAlgorithms.methods.uploadScript.httpMethod - resources.customBiddingAlgorithms.methods.uploadScript.id - resources.customBiddingAlgorithms.methods.uploadScript.parameterOrder - resources.customBiddingAlgorithms.methods.uploadScript.parameters.advertiserId.description - resources.customBiddingAlgorithms.methods.uploadScript.parameters.advertiserId.format - resources.customBiddingAlgorithms.methods.uploadScript.parameters.advertiserId.location - resources.customBiddingAlgorithms.methods.uploadScript.parameters.advertiserId.type - resources.customBiddingAlgorithms.methods.uploadScript.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.methods.uploadScript.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.methods.uploadScript.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.methods.uploadScript.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.methods.uploadScript.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.methods.uploadScript.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.methods.uploadScript.parameters.partnerId.description - resources.customBiddingAlgorithms.methods.uploadScript.parameters.partnerId.format - resources.customBiddingAlgorithms.methods.uploadScript.parameters.partnerId.location - resources.customBiddingAlgorithms.methods.uploadScript.parameters.partnerId.type - resources.customBiddingAlgorithms.methods.uploadScript.path - resources.customBiddingAlgorithms.methods.uploadScript.response.$ref - resources.customBiddingAlgorithms.methods.uploadScript.scopes - resources.customBiddingAlgorithms.resources.rules.methods.create.description - resources.customBiddingAlgorithms.resources.rules.methods.create.flatPath - resources.customBiddingAlgorithms.resources.rules.methods.create.httpMethod - resources.customBiddingAlgorithms.resources.rules.methods.create.id - resources.customBiddingAlgorithms.resources.rules.methods.create.parameterOrder - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.advertiserId.description - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.advertiserId.format - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.advertiserId.location - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.advertiserId.type - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.partnerId.description - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.partnerId.format - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.partnerId.location - resources.customBiddingAlgorithms.resources.rules.methods.create.parameters.partnerId.type - resources.customBiddingAlgorithms.resources.rules.methods.create.path - resources.customBiddingAlgorithms.resources.rules.methods.create.request.$ref - resources.customBiddingAlgorithms.resources.rules.methods.create.response.$ref - resources.customBiddingAlgorithms.resources.rules.methods.create.scopes - resources.customBiddingAlgorithms.resources.rules.methods.get.description - resources.customBiddingAlgorithms.resources.rules.methods.get.flatPath - resources.customBiddingAlgorithms.resources.rules.methods.get.httpMethod - resources.customBiddingAlgorithms.resources.rules.methods.get.id - resources.customBiddingAlgorithms.resources.rules.methods.get.parameterOrder - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.advertiserId.description - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.advertiserId.format - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.advertiserId.location - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.advertiserId.type - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmRulesId.description - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmRulesId.format - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmRulesId.location - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmRulesId.pattern - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmRulesId.required - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.customBiddingAlgorithmRulesId.type - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.partnerId.description - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.partnerId.format - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.partnerId.location - resources.customBiddingAlgorithms.resources.rules.methods.get.parameters.partnerId.type - resources.customBiddingAlgorithms.resources.rules.methods.get.path - resources.customBiddingAlgorithms.resources.rules.methods.get.response.$ref - resources.customBiddingAlgorithms.resources.rules.methods.get.scopes - resources.customBiddingAlgorithms.resources.rules.methods.list.description - resources.customBiddingAlgorithms.resources.rules.methods.list.flatPath - resources.customBiddingAlgorithms.resources.rules.methods.list.httpMethod - resources.customBiddingAlgorithms.resources.rules.methods.list.id - resources.customBiddingAlgorithms.resources.rules.methods.list.parameterOrder - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.advertiserId.description - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.advertiserId.format - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.advertiserId.location - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.advertiserId.type - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.orderBy.description - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.orderBy.location - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.orderBy.type - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.pageSize.description - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.pageSize.format - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.pageSize.location - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.pageSize.type - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.pageToken.description - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.pageToken.location - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.pageToken.type - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.partnerId.description - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.partnerId.format - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.partnerId.location - resources.customBiddingAlgorithms.resources.rules.methods.list.parameters.partnerId.type - resources.customBiddingAlgorithms.resources.rules.methods.list.path - resources.customBiddingAlgorithms.resources.rules.methods.list.response.$ref - resources.customBiddingAlgorithms.resources.rules.methods.list.scopes - resources.customBiddingAlgorithms.resources.scripts.methods.create.description - resources.customBiddingAlgorithms.resources.scripts.methods.create.flatPath - resources.customBiddingAlgorithms.resources.scripts.methods.create.httpMethod - resources.customBiddingAlgorithms.resources.scripts.methods.create.id - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameterOrder - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.advertiserId.description - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.advertiserId.format - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.advertiserId.location - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.advertiserId.type - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.partnerId.description - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.partnerId.format - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.partnerId.location - resources.customBiddingAlgorithms.resources.scripts.methods.create.parameters.partnerId.type - resources.customBiddingAlgorithms.resources.scripts.methods.create.path - resources.customBiddingAlgorithms.resources.scripts.methods.create.request.$ref - resources.customBiddingAlgorithms.resources.scripts.methods.create.response.$ref - resources.customBiddingAlgorithms.resources.scripts.methods.create.scopes - resources.customBiddingAlgorithms.resources.scripts.methods.get.description - resources.customBiddingAlgorithms.resources.scripts.methods.get.flatPath - resources.customBiddingAlgorithms.resources.scripts.methods.get.httpMethod - resources.customBiddingAlgorithms.resources.scripts.methods.get.id - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameterOrder - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.advertiserId.description - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.advertiserId.format - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.advertiserId.location - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.advertiserId.type - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingScriptId.description - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingScriptId.format - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingScriptId.location - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingScriptId.pattern - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingScriptId.required - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.customBiddingScriptId.type - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.partnerId.description - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.partnerId.format - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.partnerId.location - resources.customBiddingAlgorithms.resources.scripts.methods.get.parameters.partnerId.type - resources.customBiddingAlgorithms.resources.scripts.methods.get.path - resources.customBiddingAlgorithms.resources.scripts.methods.get.response.$ref - resources.customBiddingAlgorithms.resources.scripts.methods.get.scopes - resources.customBiddingAlgorithms.resources.scripts.methods.list.description - resources.customBiddingAlgorithms.resources.scripts.methods.list.flatPath - resources.customBiddingAlgorithms.resources.scripts.methods.list.httpMethod - resources.customBiddingAlgorithms.resources.scripts.methods.list.id - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameterOrder - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.advertiserId.description - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.advertiserId.format - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.advertiserId.location - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.advertiserId.type - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.customBiddingAlgorithmId.description - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.customBiddingAlgorithmId.format - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.customBiddingAlgorithmId.location - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.customBiddingAlgorithmId.pattern - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.customBiddingAlgorithmId.required - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.customBiddingAlgorithmId.type - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.orderBy.description - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.orderBy.location - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.orderBy.type - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.pageSize.description - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.pageSize.format - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.pageSize.location - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.pageSize.type - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.pageToken.description - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.pageToken.location - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.pageToken.type - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.partnerId.description - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.partnerId.format - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.partnerId.location - resources.customBiddingAlgorithms.resources.scripts.methods.list.parameters.partnerId.type - resources.customBiddingAlgorithms.resources.scripts.methods.list.path - resources.customBiddingAlgorithms.resources.scripts.methods.list.response.$ref - resources.customBiddingAlgorithms.resources.scripts.methods.list.scopes - resources.customLists.methods.get.description - resources.customLists.methods.get.flatPath - resources.customLists.methods.get.httpMethod - resources.customLists.methods.get.id - resources.customLists.methods.get.parameterOrder - resources.customLists.methods.get.parameters.advertiserId.description - resources.customLists.methods.get.parameters.advertiserId.format - resources.customLists.methods.get.parameters.advertiserId.location - resources.customLists.methods.get.parameters.advertiserId.type - resources.customLists.methods.get.parameters.customListId.description - resources.customLists.methods.get.parameters.customListId.format - resources.customLists.methods.get.parameters.customListId.location - resources.customLists.methods.get.parameters.customListId.pattern - resources.customLists.methods.get.parameters.customListId.required - resources.customLists.methods.get.parameters.customListId.type - resources.customLists.methods.get.path - resources.customLists.methods.get.response.$ref - resources.customLists.methods.get.scopes - resources.customLists.methods.list.description - resources.customLists.methods.list.flatPath - resources.customLists.methods.list.httpMethod - resources.customLists.methods.list.id - resources.customLists.methods.list.parameterOrder - resources.customLists.methods.list.parameters.advertiserId.description - resources.customLists.methods.list.parameters.advertiserId.format - resources.customLists.methods.list.parameters.advertiserId.location - resources.customLists.methods.list.parameters.advertiserId.type - resources.customLists.methods.list.parameters.filter.description - resources.customLists.methods.list.parameters.filter.location - resources.customLists.methods.list.parameters.filter.type - resources.customLists.methods.list.parameters.orderBy.description - resources.customLists.methods.list.parameters.orderBy.location - resources.customLists.methods.list.parameters.orderBy.type - resources.customLists.methods.list.parameters.pageSize.description - resources.customLists.methods.list.parameters.pageSize.format - resources.customLists.methods.list.parameters.pageSize.location - resources.customLists.methods.list.parameters.pageSize.type - resources.customLists.methods.list.parameters.pageToken.description - resources.customLists.methods.list.parameters.pageToken.location - resources.customLists.methods.list.parameters.pageToken.type - resources.customLists.methods.list.path - resources.customLists.methods.list.response.$ref - resources.customLists.methods.list.scopes - resources.firstPartyAndPartnerAudiences.methods.create.description - resources.firstPartyAndPartnerAudiences.methods.create.flatPath - resources.firstPartyAndPartnerAudiences.methods.create.httpMethod - resources.firstPartyAndPartnerAudiences.methods.create.id - resources.firstPartyAndPartnerAudiences.methods.create.parameterOrder - resources.firstPartyAndPartnerAudiences.methods.create.parameters.advertiserId.description - resources.firstPartyAndPartnerAudiences.methods.create.parameters.advertiserId.format - resources.firstPartyAndPartnerAudiences.methods.create.parameters.advertiserId.location - resources.firstPartyAndPartnerAudiences.methods.create.parameters.advertiserId.type - resources.firstPartyAndPartnerAudiences.methods.create.path - resources.firstPartyAndPartnerAudiences.methods.create.request.$ref - resources.firstPartyAndPartnerAudiences.methods.create.response.$ref - resources.firstPartyAndPartnerAudiences.methods.create.scopes - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.description - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.flatPath - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.httpMethod - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.id - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.parameterOrder - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.parameters.firstPartyAndPartnerAudienceId.description - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.parameters.firstPartyAndPartnerAudienceId.format - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.parameters.firstPartyAndPartnerAudienceId.location - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.parameters.firstPartyAndPartnerAudienceId.pattern - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.parameters.firstPartyAndPartnerAudienceId.required - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.parameters.firstPartyAndPartnerAudienceId.type - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.path - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.request.$ref - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.response.$ref - resources.firstPartyAndPartnerAudiences.methods.editCustomerMatchMembers.scopes - resources.firstPartyAndPartnerAudiences.methods.get.description - resources.firstPartyAndPartnerAudiences.methods.get.flatPath - resources.firstPartyAndPartnerAudiences.methods.get.httpMethod - resources.firstPartyAndPartnerAudiences.methods.get.id - resources.firstPartyAndPartnerAudiences.methods.get.parameterOrder - resources.firstPartyAndPartnerAudiences.methods.get.parameters.advertiserId.description - resources.firstPartyAndPartnerAudiences.methods.get.parameters.advertiserId.format - resources.firstPartyAndPartnerAudiences.methods.get.parameters.advertiserId.location - resources.firstPartyAndPartnerAudiences.methods.get.parameters.advertiserId.type - resources.firstPartyAndPartnerAudiences.methods.get.parameters.firstPartyAndPartnerAudienceId.description - resources.firstPartyAndPartnerAudiences.methods.get.parameters.firstPartyAndPartnerAudienceId.format - resources.firstPartyAndPartnerAudiences.methods.get.parameters.firstPartyAndPartnerAudienceId.location - resources.firstPartyAndPartnerAudiences.methods.get.parameters.firstPartyAndPartnerAudienceId.pattern - resources.firstPartyAndPartnerAudiences.methods.get.parameters.firstPartyAndPartnerAudienceId.required - resources.firstPartyAndPartnerAudiences.methods.get.parameters.firstPartyAndPartnerAudienceId.type - resources.firstPartyAndPartnerAudiences.methods.get.parameters.partnerId.description - resources.firstPartyAndPartnerAudiences.methods.get.parameters.partnerId.format - resources.firstPartyAndPartnerAudiences.methods.get.parameters.partnerId.location - resources.firstPartyAndPartnerAudiences.methods.get.parameters.partnerId.type - resources.firstPartyAndPartnerAudiences.methods.get.path - resources.firstPartyAndPartnerAudiences.methods.get.response.$ref - resources.firstPartyAndPartnerAudiences.methods.get.scopes - resources.firstPartyAndPartnerAudiences.methods.list.description - resources.firstPartyAndPartnerAudiences.methods.list.flatPath - resources.firstPartyAndPartnerAudiences.methods.list.httpMethod - resources.firstPartyAndPartnerAudiences.methods.list.id - resources.firstPartyAndPartnerAudiences.methods.list.parameterOrder - resources.firstPartyAndPartnerAudiences.methods.list.parameters.advertiserId.description - resources.firstPartyAndPartnerAudiences.methods.list.parameters.advertiserId.format - resources.firstPartyAndPartnerAudiences.methods.list.parameters.advertiserId.location - resources.firstPartyAndPartnerAudiences.methods.list.parameters.advertiserId.type - resources.firstPartyAndPartnerAudiences.methods.list.parameters.filter.description - resources.firstPartyAndPartnerAudiences.methods.list.parameters.filter.location - resources.firstPartyAndPartnerAudiences.methods.list.parameters.filter.type - resources.firstPartyAndPartnerAudiences.methods.list.parameters.orderBy.description - resources.firstPartyAndPartnerAudiences.methods.list.parameters.orderBy.location - resources.firstPartyAndPartnerAudiences.methods.list.parameters.orderBy.type - resources.firstPartyAndPartnerAudiences.methods.list.parameters.pageSize.description - resources.firstPartyAndPartnerAudiences.methods.list.parameters.pageSize.format - resources.firstPartyAndPartnerAudiences.methods.list.parameters.pageSize.location - resources.firstPartyAndPartnerAudiences.methods.list.parameters.pageSize.type - resources.firstPartyAndPartnerAudiences.methods.list.parameters.pageToken.description - resources.firstPartyAndPartnerAudiences.methods.list.parameters.pageToken.location - resources.firstPartyAndPartnerAudiences.methods.list.parameters.pageToken.type - resources.firstPartyAndPartnerAudiences.methods.list.parameters.partnerId.description - resources.firstPartyAndPartnerAudiences.methods.list.parameters.partnerId.format - resources.firstPartyAndPartnerAudiences.methods.list.parameters.partnerId.location - resources.firstPartyAndPartnerAudiences.methods.list.parameters.partnerId.type - resources.firstPartyAndPartnerAudiences.methods.list.path - resources.firstPartyAndPartnerAudiences.methods.list.response.$ref - resources.firstPartyAndPartnerAudiences.methods.list.scopes - resources.firstPartyAndPartnerAudiences.methods.patch.description - resources.firstPartyAndPartnerAudiences.methods.patch.flatPath - resources.firstPartyAndPartnerAudiences.methods.patch.httpMethod - resources.firstPartyAndPartnerAudiences.methods.patch.id - resources.firstPartyAndPartnerAudiences.methods.patch.parameterOrder - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.advertiserId.description - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.advertiserId.format - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.advertiserId.location - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.advertiserId.type - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.firstPartyAndPartnerAudienceId.description - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.firstPartyAndPartnerAudienceId.format - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.firstPartyAndPartnerAudienceId.location - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.firstPartyAndPartnerAudienceId.pattern - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.firstPartyAndPartnerAudienceId.required - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.firstPartyAndPartnerAudienceId.type - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.updateMask.description - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.updateMask.format - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.updateMask.location - resources.firstPartyAndPartnerAudiences.methods.patch.parameters.updateMask.type - resources.firstPartyAndPartnerAudiences.methods.patch.path - resources.firstPartyAndPartnerAudiences.methods.patch.request.$ref - resources.firstPartyAndPartnerAudiences.methods.patch.response.$ref - resources.firstPartyAndPartnerAudiences.methods.patch.scopes - resources.floodlightGroups.methods.get.description - resources.floodlightGroups.methods.get.flatPath - resources.floodlightGroups.methods.get.httpMethod - resources.floodlightGroups.methods.get.id - resources.floodlightGroups.methods.get.parameterOrder - resources.floodlightGroups.methods.get.parameters.floodlightGroupId.description - resources.floodlightGroups.methods.get.parameters.floodlightGroupId.format - resources.floodlightGroups.methods.get.parameters.floodlightGroupId.location - resources.floodlightGroups.methods.get.parameters.floodlightGroupId.pattern - resources.floodlightGroups.methods.get.parameters.floodlightGroupId.required - resources.floodlightGroups.methods.get.parameters.floodlightGroupId.type - resources.floodlightGroups.methods.get.parameters.partnerId.description - resources.floodlightGroups.methods.get.parameters.partnerId.format - resources.floodlightGroups.methods.get.parameters.partnerId.location - resources.floodlightGroups.methods.get.parameters.partnerId.type - resources.floodlightGroups.methods.get.path - resources.floodlightGroups.methods.get.response.$ref - resources.floodlightGroups.methods.get.scopes - resources.floodlightGroups.methods.patch.description - resources.floodlightGroups.methods.patch.flatPath - resources.floodlightGroups.methods.patch.httpMethod - resources.floodlightGroups.methods.patch.id - resources.floodlightGroups.methods.patch.parameterOrder - resources.floodlightGroups.methods.patch.parameters.floodlightGroupId.description - resources.floodlightGroups.methods.patch.parameters.floodlightGroupId.format - resources.floodlightGroups.methods.patch.parameters.floodlightGroupId.location - resources.floodlightGroups.methods.patch.parameters.floodlightGroupId.required - resources.floodlightGroups.methods.patch.parameters.floodlightGroupId.type - resources.floodlightGroups.methods.patch.parameters.partnerId.description - resources.floodlightGroups.methods.patch.parameters.partnerId.format - resources.floodlightGroups.methods.patch.parameters.partnerId.location - resources.floodlightGroups.methods.patch.parameters.partnerId.type - resources.floodlightGroups.methods.patch.parameters.updateMask.description - resources.floodlightGroups.methods.patch.parameters.updateMask.format - resources.floodlightGroups.methods.patch.parameters.updateMask.location - resources.floodlightGroups.methods.patch.parameters.updateMask.type - resources.floodlightGroups.methods.patch.path - resources.floodlightGroups.methods.patch.request.$ref - resources.floodlightGroups.methods.patch.response.$ref - resources.floodlightGroups.methods.patch.scopes - resources.floodlightGroups.resources.floodlightActivities.methods.get.description - resources.floodlightGroups.resources.floodlightActivities.methods.get.flatPath - resources.floodlightGroups.resources.floodlightActivities.methods.get.httpMethod - resources.floodlightGroups.resources.floodlightActivities.methods.get.id - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameterOrder - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightActivityId.description - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightActivityId.format - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightActivityId.location - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightActivityId.pattern - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightActivityId.required - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightActivityId.type - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightGroupId.description - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightGroupId.format - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightGroupId.location - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightGroupId.pattern - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightGroupId.required - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.floodlightGroupId.type - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.partnerId.description - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.partnerId.format - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.partnerId.location - resources.floodlightGroups.resources.floodlightActivities.methods.get.parameters.partnerId.type - resources.floodlightGroups.resources.floodlightActivities.methods.get.path - resources.floodlightGroups.resources.floodlightActivities.methods.get.response.$ref - resources.floodlightGroups.resources.floodlightActivities.methods.get.scopes - resources.floodlightGroups.resources.floodlightActivities.methods.list.description - resources.floodlightGroups.resources.floodlightActivities.methods.list.flatPath - resources.floodlightGroups.resources.floodlightActivities.methods.list.httpMethod - resources.floodlightGroups.resources.floodlightActivities.methods.list.id - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameterOrder - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.floodlightGroupId.description - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.floodlightGroupId.format - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.floodlightGroupId.location - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.floodlightGroupId.pattern - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.floodlightGroupId.required - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.floodlightGroupId.type - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.orderBy.description - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.orderBy.location - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.orderBy.type - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.pageSize.description - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.pageSize.format - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.pageSize.location - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.pageSize.type - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.pageToken.description - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.pageToken.location - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.pageToken.type - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.partnerId.description - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.partnerId.format - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.partnerId.location - resources.floodlightGroups.resources.floodlightActivities.methods.list.parameters.partnerId.type - resources.floodlightGroups.resources.floodlightActivities.methods.list.path - resources.floodlightGroups.resources.floodlightActivities.methods.list.response.$ref - resources.floodlightGroups.resources.floodlightActivities.methods.list.scopes - resources.googleAudiences.methods.get.description - resources.googleAudiences.methods.get.flatPath - resources.googleAudiences.methods.get.httpMethod - resources.googleAudiences.methods.get.id - resources.googleAudiences.methods.get.parameterOrder - resources.googleAudiences.methods.get.parameters.advertiserId.description - resources.googleAudiences.methods.get.parameters.advertiserId.format - resources.googleAudiences.methods.get.parameters.advertiserId.location - resources.googleAudiences.methods.get.parameters.advertiserId.type - resources.googleAudiences.methods.get.parameters.googleAudienceId.description - resources.googleAudiences.methods.get.parameters.googleAudienceId.format - resources.googleAudiences.methods.get.parameters.googleAudienceId.location - resources.googleAudiences.methods.get.parameters.googleAudienceId.pattern - resources.googleAudiences.methods.get.parameters.googleAudienceId.required - resources.googleAudiences.methods.get.parameters.googleAudienceId.type - resources.googleAudiences.methods.get.parameters.partnerId.description - resources.googleAudiences.methods.get.parameters.partnerId.format - resources.googleAudiences.methods.get.parameters.partnerId.location - resources.googleAudiences.methods.get.parameters.partnerId.type - resources.googleAudiences.methods.get.path - resources.googleAudiences.methods.get.response.$ref - resources.googleAudiences.methods.get.scopes - resources.googleAudiences.methods.list.description - resources.googleAudiences.methods.list.flatPath - resources.googleAudiences.methods.list.httpMethod - resources.googleAudiences.methods.list.id - resources.googleAudiences.methods.list.parameterOrder - resources.googleAudiences.methods.list.parameters.advertiserId.description - resources.googleAudiences.methods.list.parameters.advertiserId.format - resources.googleAudiences.methods.list.parameters.advertiserId.location - resources.googleAudiences.methods.list.parameters.advertiserId.type - resources.googleAudiences.methods.list.parameters.filter.description - resources.googleAudiences.methods.list.parameters.filter.location - resources.googleAudiences.methods.list.parameters.filter.type - resources.googleAudiences.methods.list.parameters.orderBy.description - resources.googleAudiences.methods.list.parameters.orderBy.location - resources.googleAudiences.methods.list.parameters.orderBy.type - resources.googleAudiences.methods.list.parameters.pageSize.description - resources.googleAudiences.methods.list.parameters.pageSize.format - resources.googleAudiences.methods.list.parameters.pageSize.location - resources.googleAudiences.methods.list.parameters.pageSize.type - resources.googleAudiences.methods.list.parameters.pageToken.description - resources.googleAudiences.methods.list.parameters.pageToken.location - resources.googleAudiences.methods.list.parameters.pageToken.type - resources.googleAudiences.methods.list.parameters.partnerId.description - resources.googleAudiences.methods.list.parameters.partnerId.format - resources.googleAudiences.methods.list.parameters.partnerId.location - resources.googleAudiences.methods.list.parameters.partnerId.type - resources.googleAudiences.methods.list.path - resources.googleAudiences.methods.list.response.$ref - resources.googleAudiences.methods.list.scopes - resources.guaranteedOrders.methods.create.description - resources.guaranteedOrders.methods.create.flatPath - resources.guaranteedOrders.methods.create.httpMethod - resources.guaranteedOrders.methods.create.id - resources.guaranteedOrders.methods.create.parameterOrder - resources.guaranteedOrders.methods.create.parameters.advertiserId.description - resources.guaranteedOrders.methods.create.parameters.advertiserId.format - resources.guaranteedOrders.methods.create.parameters.advertiserId.location - resources.guaranteedOrders.methods.create.parameters.advertiserId.type - resources.guaranteedOrders.methods.create.parameters.partnerId.description - resources.guaranteedOrders.methods.create.parameters.partnerId.format - resources.guaranteedOrders.methods.create.parameters.partnerId.location - resources.guaranteedOrders.methods.create.parameters.partnerId.type - resources.guaranteedOrders.methods.create.path - resources.guaranteedOrders.methods.create.request.$ref - resources.guaranteedOrders.methods.create.response.$ref - resources.guaranteedOrders.methods.create.scopes - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.description - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.flatPath - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.httpMethod - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.id - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.parameterOrder - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.parameters.guaranteedOrderId.description - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.parameters.guaranteedOrderId.location - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.parameters.guaranteedOrderId.pattern - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.parameters.guaranteedOrderId.required - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.parameters.guaranteedOrderId.type - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.path - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.request.$ref - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.response.$ref - resources.guaranteedOrders.methods.editGuaranteedOrderReadAccessors.scopes - resources.guaranteedOrders.methods.get.description - resources.guaranteedOrders.methods.get.flatPath - resources.guaranteedOrders.methods.get.httpMethod - resources.guaranteedOrders.methods.get.id - resources.guaranteedOrders.methods.get.parameterOrder - resources.guaranteedOrders.methods.get.parameters.advertiserId.description - resources.guaranteedOrders.methods.get.parameters.advertiserId.format - resources.guaranteedOrders.methods.get.parameters.advertiserId.location - resources.guaranteedOrders.methods.get.parameters.advertiserId.type - resources.guaranteedOrders.methods.get.parameters.guaranteedOrderId.description - resources.guaranteedOrders.methods.get.parameters.guaranteedOrderId.location - resources.guaranteedOrders.methods.get.parameters.guaranteedOrderId.pattern - resources.guaranteedOrders.methods.get.parameters.guaranteedOrderId.required - resources.guaranteedOrders.methods.get.parameters.guaranteedOrderId.type - resources.guaranteedOrders.methods.get.parameters.partnerId.description - resources.guaranteedOrders.methods.get.parameters.partnerId.format - resources.guaranteedOrders.methods.get.parameters.partnerId.location - resources.guaranteedOrders.methods.get.parameters.partnerId.type - resources.guaranteedOrders.methods.get.path - resources.guaranteedOrders.methods.get.response.$ref - resources.guaranteedOrders.methods.get.scopes - resources.guaranteedOrders.methods.list.description - resources.guaranteedOrders.methods.list.flatPath - resources.guaranteedOrders.methods.list.httpMethod - resources.guaranteedOrders.methods.list.id - resources.guaranteedOrders.methods.list.parameterOrder - resources.guaranteedOrders.methods.list.parameters.advertiserId.description - resources.guaranteedOrders.methods.list.parameters.advertiserId.format - resources.guaranteedOrders.methods.list.parameters.advertiserId.location - resources.guaranteedOrders.methods.list.parameters.advertiserId.type - resources.guaranteedOrders.methods.list.parameters.filter.description - resources.guaranteedOrders.methods.list.parameters.filter.location - resources.guaranteedOrders.methods.list.parameters.filter.type - resources.guaranteedOrders.methods.list.parameters.orderBy.description - resources.guaranteedOrders.methods.list.parameters.orderBy.location - resources.guaranteedOrders.methods.list.parameters.orderBy.type - resources.guaranteedOrders.methods.list.parameters.pageSize.description - resources.guaranteedOrders.methods.list.parameters.pageSize.format - resources.guaranteedOrders.methods.list.parameters.pageSize.location - resources.guaranteedOrders.methods.list.parameters.pageSize.type - resources.guaranteedOrders.methods.list.parameters.pageToken.description - resources.guaranteedOrders.methods.list.parameters.pageToken.location - resources.guaranteedOrders.methods.list.parameters.pageToken.type - resources.guaranteedOrders.methods.list.parameters.partnerId.description - resources.guaranteedOrders.methods.list.parameters.partnerId.format - resources.guaranteedOrders.methods.list.parameters.partnerId.location - resources.guaranteedOrders.methods.list.parameters.partnerId.type - resources.guaranteedOrders.methods.list.path - resources.guaranteedOrders.methods.list.response.$ref - resources.guaranteedOrders.methods.list.scopes - resources.guaranteedOrders.methods.patch.description - resources.guaranteedOrders.methods.patch.flatPath - resources.guaranteedOrders.methods.patch.httpMethod - resources.guaranteedOrders.methods.patch.id - resources.guaranteedOrders.methods.patch.parameterOrder - resources.guaranteedOrders.methods.patch.parameters.advertiserId.description - resources.guaranteedOrders.methods.patch.parameters.advertiserId.format - resources.guaranteedOrders.methods.patch.parameters.advertiserId.location - resources.guaranteedOrders.methods.patch.parameters.advertiserId.type - resources.guaranteedOrders.methods.patch.parameters.guaranteedOrderId.description - resources.guaranteedOrders.methods.patch.parameters.guaranteedOrderId.location - resources.guaranteedOrders.methods.patch.parameters.guaranteedOrderId.pattern - resources.guaranteedOrders.methods.patch.parameters.guaranteedOrderId.required - resources.guaranteedOrders.methods.patch.parameters.guaranteedOrderId.type - resources.guaranteedOrders.methods.patch.parameters.partnerId.description - resources.guaranteedOrders.methods.patch.parameters.partnerId.format - resources.guaranteedOrders.methods.patch.parameters.partnerId.location - resources.guaranteedOrders.methods.patch.parameters.partnerId.type - resources.guaranteedOrders.methods.patch.parameters.updateMask.description - resources.guaranteedOrders.methods.patch.parameters.updateMask.format - resources.guaranteedOrders.methods.patch.parameters.updateMask.location - resources.guaranteedOrders.methods.patch.parameters.updateMask.type - resources.guaranteedOrders.methods.patch.path - resources.guaranteedOrders.methods.patch.request.$ref - resources.guaranteedOrders.methods.patch.response.$ref - resources.guaranteedOrders.methods.patch.scopes - resources.inventorySourceGroups.methods.create.description - resources.inventorySourceGroups.methods.create.flatPath - resources.inventorySourceGroups.methods.create.httpMethod - resources.inventorySourceGroups.methods.create.id - resources.inventorySourceGroups.methods.create.parameterOrder - resources.inventorySourceGroups.methods.create.parameters.advertiserId.description - resources.inventorySourceGroups.methods.create.parameters.advertiserId.format - resources.inventorySourceGroups.methods.create.parameters.advertiserId.location - resources.inventorySourceGroups.methods.create.parameters.advertiserId.type - resources.inventorySourceGroups.methods.create.parameters.partnerId.description - resources.inventorySourceGroups.methods.create.parameters.partnerId.format - resources.inventorySourceGroups.methods.create.parameters.partnerId.location - resources.inventorySourceGroups.methods.create.parameters.partnerId.type - resources.inventorySourceGroups.methods.create.path - resources.inventorySourceGroups.methods.create.request.$ref - resources.inventorySourceGroups.methods.create.response.$ref - resources.inventorySourceGroups.methods.create.scopes - resources.inventorySourceGroups.methods.delete.description - resources.inventorySourceGroups.methods.delete.flatPath - resources.inventorySourceGroups.methods.delete.httpMethod - resources.inventorySourceGroups.methods.delete.id - resources.inventorySourceGroups.methods.delete.parameterOrder - resources.inventorySourceGroups.methods.delete.parameters.advertiserId.description - resources.inventorySourceGroups.methods.delete.parameters.advertiserId.format - resources.inventorySourceGroups.methods.delete.parameters.advertiserId.location - resources.inventorySourceGroups.methods.delete.parameters.advertiserId.type - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.methods.delete.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.methods.delete.parameters.partnerId.description - resources.inventorySourceGroups.methods.delete.parameters.partnerId.format - resources.inventorySourceGroups.methods.delete.parameters.partnerId.location - resources.inventorySourceGroups.methods.delete.parameters.partnerId.type - resources.inventorySourceGroups.methods.delete.path - resources.inventorySourceGroups.methods.delete.response.$ref - resources.inventorySourceGroups.methods.delete.scopes - resources.inventorySourceGroups.methods.get.description - resources.inventorySourceGroups.methods.get.flatPath - resources.inventorySourceGroups.methods.get.httpMethod - resources.inventorySourceGroups.methods.get.id - resources.inventorySourceGroups.methods.get.parameterOrder - resources.inventorySourceGroups.methods.get.parameters.advertiserId.description - resources.inventorySourceGroups.methods.get.parameters.advertiserId.format - resources.inventorySourceGroups.methods.get.parameters.advertiserId.location - resources.inventorySourceGroups.methods.get.parameters.advertiserId.type - resources.inventorySourceGroups.methods.get.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.methods.get.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.methods.get.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.methods.get.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.methods.get.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.methods.get.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.methods.get.parameters.partnerId.description - resources.inventorySourceGroups.methods.get.parameters.partnerId.format - resources.inventorySourceGroups.methods.get.parameters.partnerId.location - resources.inventorySourceGroups.methods.get.parameters.partnerId.type - resources.inventorySourceGroups.methods.get.path - resources.inventorySourceGroups.methods.get.response.$ref - resources.inventorySourceGroups.methods.get.scopes - resources.inventorySourceGroups.methods.list.description - resources.inventorySourceGroups.methods.list.flatPath - resources.inventorySourceGroups.methods.list.httpMethod - resources.inventorySourceGroups.methods.list.id - resources.inventorySourceGroups.methods.list.parameterOrder - resources.inventorySourceGroups.methods.list.parameters.advertiserId.description - resources.inventorySourceGroups.methods.list.parameters.advertiserId.format - resources.inventorySourceGroups.methods.list.parameters.advertiserId.location - resources.inventorySourceGroups.methods.list.parameters.advertiserId.type - resources.inventorySourceGroups.methods.list.parameters.filter.description - resources.inventorySourceGroups.methods.list.parameters.filter.location - resources.inventorySourceGroups.methods.list.parameters.filter.type - resources.inventorySourceGroups.methods.list.parameters.orderBy.description - resources.inventorySourceGroups.methods.list.parameters.orderBy.location - resources.inventorySourceGroups.methods.list.parameters.orderBy.type - resources.inventorySourceGroups.methods.list.parameters.pageSize.description - resources.inventorySourceGroups.methods.list.parameters.pageSize.format - resources.inventorySourceGroups.methods.list.parameters.pageSize.location - resources.inventorySourceGroups.methods.list.parameters.pageSize.type - resources.inventorySourceGroups.methods.list.parameters.pageToken.description - resources.inventorySourceGroups.methods.list.parameters.pageToken.location - resources.inventorySourceGroups.methods.list.parameters.pageToken.type - resources.inventorySourceGroups.methods.list.parameters.partnerId.description - resources.inventorySourceGroups.methods.list.parameters.partnerId.format - resources.inventorySourceGroups.methods.list.parameters.partnerId.location - resources.inventorySourceGroups.methods.list.parameters.partnerId.type - resources.inventorySourceGroups.methods.list.path - resources.inventorySourceGroups.methods.list.response.$ref - resources.inventorySourceGroups.methods.list.scopes - resources.inventorySourceGroups.methods.patch.description - resources.inventorySourceGroups.methods.patch.flatPath - resources.inventorySourceGroups.methods.patch.httpMethod - resources.inventorySourceGroups.methods.patch.id - resources.inventorySourceGroups.methods.patch.parameterOrder - resources.inventorySourceGroups.methods.patch.parameters.advertiserId.description - resources.inventorySourceGroups.methods.patch.parameters.advertiserId.format - resources.inventorySourceGroups.methods.patch.parameters.advertiserId.location - resources.inventorySourceGroups.methods.patch.parameters.advertiserId.type - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.methods.patch.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.methods.patch.parameters.partnerId.description - resources.inventorySourceGroups.methods.patch.parameters.partnerId.format - resources.inventorySourceGroups.methods.patch.parameters.partnerId.location - resources.inventorySourceGroups.methods.patch.parameters.partnerId.type - resources.inventorySourceGroups.methods.patch.parameters.updateMask.description - resources.inventorySourceGroups.methods.patch.parameters.updateMask.format - resources.inventorySourceGroups.methods.patch.parameters.updateMask.location - resources.inventorySourceGroups.methods.patch.parameters.updateMask.type - resources.inventorySourceGroups.methods.patch.path - resources.inventorySourceGroups.methods.patch.request.$ref - resources.inventorySourceGroups.methods.patch.response.$ref - resources.inventorySourceGroups.methods.patch.scopes - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.flatPath - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.httpMethod - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.id - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameterOrder - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.path - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.request.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.response.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.bulkEdit.scopes - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.flatPath - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.httpMethod - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.id - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameterOrder - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.advertiserId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.advertiserId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.advertiserId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.advertiserId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.partnerId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.partnerId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.partnerId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.parameters.partnerId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.path - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.request.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.response.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.create.scopes - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.flatPath - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.httpMethod - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.id - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameterOrder - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.advertiserId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.advertiserId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.advertiserId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.advertiserId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.assignedInventorySourceId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.partnerId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.partnerId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.partnerId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.parameters.partnerId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.path - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.response.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.delete.scopes - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.flatPath - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.httpMethod - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.id - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameterOrder - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.advertiserId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.advertiserId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.advertiserId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.advertiserId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.filter.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.filter.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.filter.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.pattern - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.required - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.inventorySourceGroupId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.orderBy.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.orderBy.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.orderBy.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageSize.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageSize.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageSize.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageSize.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageToken.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageToken.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.pageToken.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.partnerId.description - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.partnerId.format - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.partnerId.location - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.parameters.partnerId.type - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.path - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.response.$ref - resources.inventorySourceGroups.resources.assignedInventorySources.methods.list.scopes - resources.inventorySources.methods.create.description - resources.inventorySources.methods.create.flatPath - resources.inventorySources.methods.create.httpMethod - resources.inventorySources.methods.create.id - resources.inventorySources.methods.create.parameterOrder - resources.inventorySources.methods.create.parameters.advertiserId.description - resources.inventorySources.methods.create.parameters.advertiserId.format - resources.inventorySources.methods.create.parameters.advertiserId.location - resources.inventorySources.methods.create.parameters.advertiserId.type - resources.inventorySources.methods.create.parameters.partnerId.description - resources.inventorySources.methods.create.parameters.partnerId.format - resources.inventorySources.methods.create.parameters.partnerId.location - resources.inventorySources.methods.create.parameters.partnerId.type - resources.inventorySources.methods.create.path - resources.inventorySources.methods.create.request.$ref - resources.inventorySources.methods.create.response.$ref - resources.inventorySources.methods.create.scopes - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.description - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.flatPath - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.httpMethod - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.id - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.parameterOrder - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.parameters.inventorySourceId.description - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.parameters.inventorySourceId.format - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.parameters.inventorySourceId.location - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.parameters.inventorySourceId.pattern - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.parameters.inventorySourceId.required - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.parameters.inventorySourceId.type - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.path - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.request.$ref - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.response.$ref - resources.inventorySources.methods.editInventorySourceReadWriteAccessors.scopes - resources.inventorySources.methods.get.description - resources.inventorySources.methods.get.flatPath - resources.inventorySources.methods.get.httpMethod - resources.inventorySources.methods.get.id - resources.inventorySources.methods.get.parameterOrder - resources.inventorySources.methods.get.parameters.advertiserId.description - resources.inventorySources.methods.get.parameters.advertiserId.format - resources.inventorySources.methods.get.parameters.advertiserId.location - resources.inventorySources.methods.get.parameters.advertiserId.type - resources.inventorySources.methods.get.parameters.inventorySourceId.description - resources.inventorySources.methods.get.parameters.inventorySourceId.format - resources.inventorySources.methods.get.parameters.inventorySourceId.location - resources.inventorySources.methods.get.parameters.inventorySourceId.pattern - resources.inventorySources.methods.get.parameters.inventorySourceId.required - resources.inventorySources.methods.get.parameters.inventorySourceId.type - resources.inventorySources.methods.get.parameters.partnerId.description - resources.inventorySources.methods.get.parameters.partnerId.format - resources.inventorySources.methods.get.parameters.partnerId.location - resources.inventorySources.methods.get.parameters.partnerId.type - resources.inventorySources.methods.get.path - resources.inventorySources.methods.get.response.$ref - resources.inventorySources.methods.get.scopes - resources.inventorySources.methods.list.description - resources.inventorySources.methods.list.flatPath - resources.inventorySources.methods.list.httpMethod - resources.inventorySources.methods.list.id - resources.inventorySources.methods.list.parameterOrder - resources.inventorySources.methods.list.parameters.advertiserId.description - resources.inventorySources.methods.list.parameters.advertiserId.format - resources.inventorySources.methods.list.parameters.advertiserId.location - resources.inventorySources.methods.list.parameters.advertiserId.type - resources.inventorySources.methods.list.parameters.filter.description - resources.inventorySources.methods.list.parameters.filter.location - resources.inventorySources.methods.list.parameters.filter.type - resources.inventorySources.methods.list.parameters.orderBy.description - resources.inventorySources.methods.list.parameters.orderBy.location - resources.inventorySources.methods.list.parameters.orderBy.type - resources.inventorySources.methods.list.parameters.pageSize.description - resources.inventorySources.methods.list.parameters.pageSize.format - resources.inventorySources.methods.list.parameters.pageSize.location - resources.inventorySources.methods.list.parameters.pageSize.type - resources.inventorySources.methods.list.parameters.pageToken.description - resources.inventorySources.methods.list.parameters.pageToken.location - resources.inventorySources.methods.list.parameters.pageToken.type - resources.inventorySources.methods.list.parameters.partnerId.description - resources.inventorySources.methods.list.parameters.partnerId.format - resources.inventorySources.methods.list.parameters.partnerId.location - resources.inventorySources.methods.list.parameters.partnerId.type - resources.inventorySources.methods.list.path - resources.inventorySources.methods.list.response.$ref - resources.inventorySources.methods.list.scopes - resources.inventorySources.methods.patch.description - resources.inventorySources.methods.patch.flatPath - resources.inventorySources.methods.patch.httpMethod - resources.inventorySources.methods.patch.id - resources.inventorySources.methods.patch.parameterOrder - resources.inventorySources.methods.patch.parameters.advertiserId.description - resources.inventorySources.methods.patch.parameters.advertiserId.format - resources.inventorySources.methods.patch.parameters.advertiserId.location - resources.inventorySources.methods.patch.parameters.advertiserId.type - resources.inventorySources.methods.patch.parameters.inventorySourceId.description - resources.inventorySources.methods.patch.parameters.inventorySourceId.format - resources.inventorySources.methods.patch.parameters.inventorySourceId.location - resources.inventorySources.methods.patch.parameters.inventorySourceId.pattern - resources.inventorySources.methods.patch.parameters.inventorySourceId.required - resources.inventorySources.methods.patch.parameters.inventorySourceId.type - resources.inventorySources.methods.patch.parameters.partnerId.description - resources.inventorySources.methods.patch.parameters.partnerId.format - resources.inventorySources.methods.patch.parameters.partnerId.location - resources.inventorySources.methods.patch.parameters.partnerId.type - resources.inventorySources.methods.patch.parameters.updateMask.description - resources.inventorySources.methods.patch.parameters.updateMask.format - resources.inventorySources.methods.patch.parameters.updateMask.location - resources.inventorySources.methods.patch.parameters.updateMask.type - resources.inventorySources.methods.patch.path - resources.inventorySources.methods.patch.request.$ref - resources.inventorySources.methods.patch.response.$ref - resources.inventorySources.methods.patch.scopes - resources.partners.methods.editAssignedTargetingOptions.description - resources.partners.methods.editAssignedTargetingOptions.flatPath - resources.partners.methods.editAssignedTargetingOptions.httpMethod - resources.partners.methods.editAssignedTargetingOptions.id - resources.partners.methods.editAssignedTargetingOptions.parameterOrder - resources.partners.methods.editAssignedTargetingOptions.parameters.partnerId.description - resources.partners.methods.editAssignedTargetingOptions.parameters.partnerId.format - resources.partners.methods.editAssignedTargetingOptions.parameters.partnerId.location - resources.partners.methods.editAssignedTargetingOptions.parameters.partnerId.pattern - resources.partners.methods.editAssignedTargetingOptions.parameters.partnerId.required - resources.partners.methods.editAssignedTargetingOptions.parameters.partnerId.type - resources.partners.methods.editAssignedTargetingOptions.path - resources.partners.methods.editAssignedTargetingOptions.request.$ref - resources.partners.methods.editAssignedTargetingOptions.response.$ref - resources.partners.methods.editAssignedTargetingOptions.scopes - resources.partners.methods.get.description - resources.partners.methods.get.flatPath - resources.partners.methods.get.httpMethod - resources.partners.methods.get.id - resources.partners.methods.get.parameterOrder - resources.partners.methods.get.parameters.partnerId.description - resources.partners.methods.get.parameters.partnerId.format - resources.partners.methods.get.parameters.partnerId.location - resources.partners.methods.get.parameters.partnerId.pattern - resources.partners.methods.get.parameters.partnerId.required - resources.partners.methods.get.parameters.partnerId.type - resources.partners.methods.get.path - resources.partners.methods.get.response.$ref - resources.partners.methods.get.scopes - resources.partners.methods.list.description - resources.partners.methods.list.flatPath - resources.partners.methods.list.httpMethod - resources.partners.methods.list.id - resources.partners.methods.list.parameterOrder - resources.partners.methods.list.parameters.filter.description - resources.partners.methods.list.parameters.filter.location - resources.partners.methods.list.parameters.filter.type - resources.partners.methods.list.parameters.orderBy.description - resources.partners.methods.list.parameters.orderBy.location - resources.partners.methods.list.parameters.orderBy.type - resources.partners.methods.list.parameters.pageSize.description - resources.partners.methods.list.parameters.pageSize.format - resources.partners.methods.list.parameters.pageSize.location - resources.partners.methods.list.parameters.pageSize.type - resources.partners.methods.list.parameters.pageToken.description - resources.partners.methods.list.parameters.pageToken.location - resources.partners.methods.list.parameters.pageToken.type - resources.partners.methods.list.path - resources.partners.methods.list.response.$ref - resources.partners.methods.list.scopes - resources.partners.resources.channels.methods.create.description - resources.partners.resources.channels.methods.create.flatPath - resources.partners.resources.channels.methods.create.httpMethod - resources.partners.resources.channels.methods.create.id - resources.partners.resources.channels.methods.create.parameterOrder - resources.partners.resources.channels.methods.create.parameters.advertiserId.description - resources.partners.resources.channels.methods.create.parameters.advertiserId.format - resources.partners.resources.channels.methods.create.parameters.advertiserId.location - resources.partners.resources.channels.methods.create.parameters.advertiserId.type - resources.partners.resources.channels.methods.create.parameters.partnerId.description - resources.partners.resources.channels.methods.create.parameters.partnerId.format - resources.partners.resources.channels.methods.create.parameters.partnerId.location - resources.partners.resources.channels.methods.create.parameters.partnerId.pattern - resources.partners.resources.channels.methods.create.parameters.partnerId.required - resources.partners.resources.channels.methods.create.parameters.partnerId.type - resources.partners.resources.channels.methods.create.path - resources.partners.resources.channels.methods.create.request.$ref - resources.partners.resources.channels.methods.create.response.$ref - resources.partners.resources.channels.methods.create.scopes - resources.partners.resources.channels.methods.get.description - resources.partners.resources.channels.methods.get.flatPath - resources.partners.resources.channels.methods.get.httpMethod - resources.partners.resources.channels.methods.get.id - resources.partners.resources.channels.methods.get.parameterOrder - resources.partners.resources.channels.methods.get.parameters.advertiserId.description - resources.partners.resources.channels.methods.get.parameters.advertiserId.format - resources.partners.resources.channels.methods.get.parameters.advertiserId.location - resources.partners.resources.channels.methods.get.parameters.advertiserId.type - resources.partners.resources.channels.methods.get.parameters.channelId.description - resources.partners.resources.channels.methods.get.parameters.channelId.format - resources.partners.resources.channels.methods.get.parameters.channelId.location - resources.partners.resources.channels.methods.get.parameters.channelId.pattern - resources.partners.resources.channels.methods.get.parameters.channelId.required - resources.partners.resources.channels.methods.get.parameters.channelId.type - resources.partners.resources.channels.methods.get.parameters.partnerId.description - resources.partners.resources.channels.methods.get.parameters.partnerId.format - resources.partners.resources.channels.methods.get.parameters.partnerId.location - resources.partners.resources.channels.methods.get.parameters.partnerId.pattern - resources.partners.resources.channels.methods.get.parameters.partnerId.required - resources.partners.resources.channels.methods.get.parameters.partnerId.type - resources.partners.resources.channels.methods.get.path - resources.partners.resources.channels.methods.get.response.$ref - resources.partners.resources.channels.methods.get.scopes - resources.partners.resources.channels.methods.list.description - resources.partners.resources.channels.methods.list.flatPath - resources.partners.resources.channels.methods.list.httpMethod - resources.partners.resources.channels.methods.list.id - resources.partners.resources.channels.methods.list.parameterOrder - resources.partners.resources.channels.methods.list.parameters.advertiserId.description - resources.partners.resources.channels.methods.list.parameters.advertiserId.format - resources.partners.resources.channels.methods.list.parameters.advertiserId.location - resources.partners.resources.channels.methods.list.parameters.advertiserId.type - resources.partners.resources.channels.methods.list.parameters.filter.description - resources.partners.resources.channels.methods.list.parameters.filter.location - resources.partners.resources.channels.methods.list.parameters.filter.type - resources.partners.resources.channels.methods.list.parameters.orderBy.description - resources.partners.resources.channels.methods.list.parameters.orderBy.location - resources.partners.resources.channels.methods.list.parameters.orderBy.type - resources.partners.resources.channels.methods.list.parameters.pageSize.description - resources.partners.resources.channels.methods.list.parameters.pageSize.format - resources.partners.resources.channels.methods.list.parameters.pageSize.location - resources.partners.resources.channels.methods.list.parameters.pageSize.type - resources.partners.resources.channels.methods.list.parameters.pageToken.description - resources.partners.resources.channels.methods.list.parameters.pageToken.location - resources.partners.resources.channels.methods.list.parameters.pageToken.type - resources.partners.resources.channels.methods.list.parameters.partnerId.description - resources.partners.resources.channels.methods.list.parameters.partnerId.format - resources.partners.resources.channels.methods.list.parameters.partnerId.location - resources.partners.resources.channels.methods.list.parameters.partnerId.pattern - resources.partners.resources.channels.methods.list.parameters.partnerId.required - resources.partners.resources.channels.methods.list.parameters.partnerId.type - resources.partners.resources.channels.methods.list.path - resources.partners.resources.channels.methods.list.response.$ref - resources.partners.resources.channels.methods.list.scopes - resources.partners.resources.channels.methods.patch.description - resources.partners.resources.channels.methods.patch.flatPath - resources.partners.resources.channels.methods.patch.httpMethod - resources.partners.resources.channels.methods.patch.id - resources.partners.resources.channels.methods.patch.parameterOrder - resources.partners.resources.channels.methods.patch.parameters.advertiserId.description - resources.partners.resources.channels.methods.patch.parameters.advertiserId.format - resources.partners.resources.channels.methods.patch.parameters.advertiserId.location - resources.partners.resources.channels.methods.patch.parameters.advertiserId.type - resources.partners.resources.channels.methods.patch.parameters.channelId.description - resources.partners.resources.channels.methods.patch.parameters.channelId.format - resources.partners.resources.channels.methods.patch.parameters.channelId.location - resources.partners.resources.channels.methods.patch.parameters.channelId.required - resources.partners.resources.channels.methods.patch.parameters.channelId.type - resources.partners.resources.channels.methods.patch.parameters.partnerId.description - resources.partners.resources.channels.methods.patch.parameters.partnerId.format - resources.partners.resources.channels.methods.patch.parameters.partnerId.location - resources.partners.resources.channels.methods.patch.parameters.partnerId.pattern - resources.partners.resources.channels.methods.patch.parameters.partnerId.required - resources.partners.resources.channels.methods.patch.parameters.partnerId.type - resources.partners.resources.channels.methods.patch.parameters.updateMask.description - resources.partners.resources.channels.methods.patch.parameters.updateMask.format - resources.partners.resources.channels.methods.patch.parameters.updateMask.location - resources.partners.resources.channels.methods.patch.parameters.updateMask.type - resources.partners.resources.channels.methods.patch.path - resources.partners.resources.channels.methods.patch.request.$ref - resources.partners.resources.channels.methods.patch.response.$ref - resources.partners.resources.channels.methods.patch.scopes - resources.partners.resources.channels.resources.sites.methods.bulkEdit.description - resources.partners.resources.channels.resources.sites.methods.bulkEdit.flatPath - resources.partners.resources.channels.resources.sites.methods.bulkEdit.httpMethod - resources.partners.resources.channels.resources.sites.methods.bulkEdit.id - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameterOrder - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.bulkEdit.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.bulkEdit.path - resources.partners.resources.channels.resources.sites.methods.bulkEdit.request.$ref - resources.partners.resources.channels.resources.sites.methods.bulkEdit.response.$ref - resources.partners.resources.channels.resources.sites.methods.bulkEdit.scopes - resources.partners.resources.channels.resources.sites.methods.create.description - resources.partners.resources.channels.resources.sites.methods.create.flatPath - resources.partners.resources.channels.resources.sites.methods.create.httpMethod - resources.partners.resources.channels.resources.sites.methods.create.id - resources.partners.resources.channels.resources.sites.methods.create.parameterOrder - resources.partners.resources.channels.resources.sites.methods.create.parameters.advertiserId.description - resources.partners.resources.channels.resources.sites.methods.create.parameters.advertiserId.format - resources.partners.resources.channels.resources.sites.methods.create.parameters.advertiserId.location - resources.partners.resources.channels.resources.sites.methods.create.parameters.advertiserId.type - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.create.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.create.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.create.path - resources.partners.resources.channels.resources.sites.methods.create.request.$ref - resources.partners.resources.channels.resources.sites.methods.create.response.$ref - resources.partners.resources.channels.resources.sites.methods.create.scopes - resources.partners.resources.channels.resources.sites.methods.delete.description - resources.partners.resources.channels.resources.sites.methods.delete.flatPath - resources.partners.resources.channels.resources.sites.methods.delete.httpMethod - resources.partners.resources.channels.resources.sites.methods.delete.id - resources.partners.resources.channels.resources.sites.methods.delete.parameterOrder - resources.partners.resources.channels.resources.sites.methods.delete.parameters.advertiserId.description - resources.partners.resources.channels.resources.sites.methods.delete.parameters.advertiserId.format - resources.partners.resources.channels.resources.sites.methods.delete.parameters.advertiserId.location - resources.partners.resources.channels.resources.sites.methods.delete.parameters.advertiserId.type - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.delete.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.delete.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.description - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.location - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.pattern - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.required - resources.partners.resources.channels.resources.sites.methods.delete.parameters.urlOrAppId.type - resources.partners.resources.channels.resources.sites.methods.delete.path - resources.partners.resources.channels.resources.sites.methods.delete.response.$ref - resources.partners.resources.channels.resources.sites.methods.delete.scopes - resources.partners.resources.channels.resources.sites.methods.list.description - resources.partners.resources.channels.resources.sites.methods.list.flatPath - resources.partners.resources.channels.resources.sites.methods.list.httpMethod - resources.partners.resources.channels.resources.sites.methods.list.id - resources.partners.resources.channels.resources.sites.methods.list.parameterOrder - resources.partners.resources.channels.resources.sites.methods.list.parameters.advertiserId.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.advertiserId.format - resources.partners.resources.channels.resources.sites.methods.list.parameters.advertiserId.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.advertiserId.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.list.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.filter.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.filter.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.filter.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.orderBy.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.orderBy.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.orderBy.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageSize.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageSize.format - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageSize.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageSize.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageToken.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageToken.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.pageToken.type - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.pattern - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.list.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.list.path - resources.partners.resources.channels.resources.sites.methods.list.response.$ref - resources.partners.resources.channels.resources.sites.methods.list.scopes - resources.partners.resources.channels.resources.sites.methods.replace.description - resources.partners.resources.channels.resources.sites.methods.replace.flatPath - resources.partners.resources.channels.resources.sites.methods.replace.httpMethod - resources.partners.resources.channels.resources.sites.methods.replace.id - resources.partners.resources.channels.resources.sites.methods.replace.parameterOrder - resources.partners.resources.channels.resources.sites.methods.replace.parameters.channelId.description - resources.partners.resources.channels.resources.sites.methods.replace.parameters.channelId.format - resources.partners.resources.channels.resources.sites.methods.replace.parameters.channelId.location - resources.partners.resources.channels.resources.sites.methods.replace.parameters.channelId.pattern - resources.partners.resources.channels.resources.sites.methods.replace.parameters.channelId.required - resources.partners.resources.channels.resources.sites.methods.replace.parameters.channelId.type - resources.partners.resources.channels.resources.sites.methods.replace.parameters.partnerId.description - resources.partners.resources.channels.resources.sites.methods.replace.parameters.partnerId.format - resources.partners.resources.channels.resources.sites.methods.replace.parameters.partnerId.location - resources.partners.resources.channels.resources.sites.methods.replace.parameters.partnerId.required - resources.partners.resources.channels.resources.sites.methods.replace.parameters.partnerId.type - resources.partners.resources.channels.resources.sites.methods.replace.path - resources.partners.resources.channels.resources.sites.methods.replace.request.$ref - resources.partners.resources.channels.resources.sites.methods.replace.response.$ref - resources.partners.resources.channels.resources.sites.methods.replace.scopes - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.flatPath - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.httpMethod - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.id - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameterOrder - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.partnerId.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.partnerId.format - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.partnerId.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.partnerId.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.partnerId.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.partnerId.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.enum - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.enumDescriptions - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.parameters.targetingType.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.path - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.request.$ref - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.response.$ref - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.create.scopes - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.flatPath - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.httpMethod - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.id - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameterOrder - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.assignedTargetingOptionId.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.partnerId.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.partnerId.format - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.partnerId.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.partnerId.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.partnerId.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.partnerId.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.enum - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.enumDescriptions - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.parameters.targetingType.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.path - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.response.$ref - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete.scopes - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.flatPath - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.httpMethod - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.id - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameterOrder - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.assignedTargetingOptionId.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.partnerId.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.partnerId.format - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.partnerId.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.partnerId.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.partnerId.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.partnerId.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.enum - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.enumDescriptions - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.parameters.targetingType.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.path - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.response.$ref - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.get.scopes - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.flatPath - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.httpMethod - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.id - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameterOrder - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.filter.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.orderBy.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.format - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageSize.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.pageToken.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.partnerId.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.partnerId.format - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.partnerId.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.partnerId.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.partnerId.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.partnerId.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.description - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.enum - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.enumDescriptions - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.location - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.pattern - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.required - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.parameters.targetingType.type - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.path - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.response.$ref - resources.partners.resources.targetingTypes.resources.assignedTargetingOptions.methods.list.scopes - resources.sdfdownloadtasks.methods.create.description - resources.sdfdownloadtasks.methods.create.flatPath - resources.sdfdownloadtasks.methods.create.httpMethod - resources.sdfdownloadtasks.methods.create.id - resources.sdfdownloadtasks.methods.create.parameterOrder - resources.sdfdownloadtasks.methods.create.path - resources.sdfdownloadtasks.methods.create.request.$ref - resources.sdfdownloadtasks.methods.create.response.$ref - resources.sdfdownloadtasks.methods.create.scopes - resources.sdfuploadtasks.resources.operations.methods.get.description - resources.sdfuploadtasks.resources.operations.methods.get.flatPath - resources.sdfuploadtasks.resources.operations.methods.get.httpMethod - resources.sdfuploadtasks.resources.operations.methods.get.id - resources.sdfuploadtasks.resources.operations.methods.get.parameterOrder - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.description - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.location - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.pattern - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.required - resources.sdfuploadtasks.resources.operations.methods.get.parameters.name.type - resources.sdfuploadtasks.resources.operations.methods.get.path - resources.sdfuploadtasks.resources.operations.methods.get.response.$ref - resources.sdfuploadtasks.resources.operations.methods.get.scopes - resources.targetingTypes.resources.targetingOptions.methods.get.description - resources.targetingTypes.resources.targetingOptions.methods.get.flatPath - resources.targetingTypes.resources.targetingOptions.methods.get.httpMethod - resources.targetingTypes.resources.targetingOptions.methods.get.id - resources.targetingTypes.resources.targetingOptions.methods.get.parameterOrder - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.advertiserId.description - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.advertiserId.format - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.advertiserId.location - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.advertiserId.type - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingOptionId.description - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingOptionId.location - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingOptionId.pattern - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingOptionId.required - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingOptionId.type - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingType.description - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingType.enum - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingType.enumDescriptions - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingType.location - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingType.pattern - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingType.required - resources.targetingTypes.resources.targetingOptions.methods.get.parameters.targetingType.type - resources.targetingTypes.resources.targetingOptions.methods.get.path - resources.targetingTypes.resources.targetingOptions.methods.get.response.$ref - resources.targetingTypes.resources.targetingOptions.methods.get.scopes - resources.targetingTypes.resources.targetingOptions.methods.list.description - resources.targetingTypes.resources.targetingOptions.methods.list.flatPath - resources.targetingTypes.resources.targetingOptions.methods.list.httpMethod - resources.targetingTypes.resources.targetingOptions.methods.list.id - resources.targetingTypes.resources.targetingOptions.methods.list.parameterOrder - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.advertiserId.description - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.advertiserId.format - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.advertiserId.location - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.advertiserId.type - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.filter.description - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.filter.location - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.filter.type - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.orderBy.description - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.orderBy.location - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.orderBy.type - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.pageSize.description - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.pageSize.format - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.pageSize.location - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.pageSize.type - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.pageToken.description - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.pageToken.location - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.pageToken.type - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.targetingType.description - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.targetingType.enum - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.targetingType.enumDescriptions - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.targetingType.location - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.targetingType.pattern - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.targetingType.required - resources.targetingTypes.resources.targetingOptions.methods.list.parameters.targetingType.type - resources.targetingTypes.resources.targetingOptions.methods.list.path - resources.targetingTypes.resources.targetingOptions.methods.list.response.$ref - resources.targetingTypes.resources.targetingOptions.methods.list.scopes - resources.targetingTypes.resources.targetingOptions.methods.search.description - resources.targetingTypes.resources.targetingOptions.methods.search.flatPath - resources.targetingTypes.resources.targetingOptions.methods.search.httpMethod - resources.targetingTypes.resources.targetingOptions.methods.search.id - resources.targetingTypes.resources.targetingOptions.methods.search.parameterOrder - resources.targetingTypes.resources.targetingOptions.methods.search.parameters.targetingType.description - resources.targetingTypes.resources.targetingOptions.methods.search.parameters.targetingType.enum - resources.targetingTypes.resources.targetingOptions.methods.search.parameters.targetingType.enumDescriptions - resources.targetingTypes.resources.targetingOptions.methods.search.parameters.targetingType.location - resources.targetingTypes.resources.targetingOptions.methods.search.parameters.targetingType.pattern - resources.targetingTypes.resources.targetingOptions.methods.search.parameters.targetingType.required - resources.targetingTypes.resources.targetingOptions.methods.search.parameters.targetingType.type - resources.targetingTypes.resources.targetingOptions.methods.search.path - resources.targetingTypes.resources.targetingOptions.methods.search.request.$ref - resources.targetingTypes.resources.targetingOptions.methods.search.response.$ref - resources.targetingTypes.resources.targetingOptions.methods.search.scopes - resources.users.methods.bulkEditAssignedUserRoles.description - resources.users.methods.bulkEditAssignedUserRoles.flatPath - resources.users.methods.bulkEditAssignedUserRoles.httpMethod - resources.users.methods.bulkEditAssignedUserRoles.id - resources.users.methods.bulkEditAssignedUserRoles.parameterOrder - resources.users.methods.bulkEditAssignedUserRoles.parameters.userId.description - resources.users.methods.bulkEditAssignedUserRoles.parameters.userId.format - resources.users.methods.bulkEditAssignedUserRoles.parameters.userId.location - resources.users.methods.bulkEditAssignedUserRoles.parameters.userId.pattern - resources.users.methods.bulkEditAssignedUserRoles.parameters.userId.required - resources.users.methods.bulkEditAssignedUserRoles.parameters.userId.type - resources.users.methods.bulkEditAssignedUserRoles.path - resources.users.methods.bulkEditAssignedUserRoles.request.$ref - resources.users.methods.bulkEditAssignedUserRoles.response.$ref - resources.users.methods.bulkEditAssignedUserRoles.scopes - resources.users.methods.create.description - resources.users.methods.create.flatPath - resources.users.methods.create.httpMethod - resources.users.methods.create.id - resources.users.methods.create.parameterOrder - resources.users.methods.create.path - resources.users.methods.create.request.$ref - resources.users.methods.create.response.$ref - resources.users.methods.create.scopes - resources.users.methods.delete.description - resources.users.methods.delete.flatPath - resources.users.methods.delete.httpMethod - resources.users.methods.delete.id - resources.users.methods.delete.parameterOrder - resources.users.methods.delete.parameters.userId.description - resources.users.methods.delete.parameters.userId.format - resources.users.methods.delete.parameters.userId.location - resources.users.methods.delete.parameters.userId.pattern - resources.users.methods.delete.parameters.userId.required - resources.users.methods.delete.parameters.userId.type - resources.users.methods.delete.path - resources.users.methods.delete.response.$ref - resources.users.methods.delete.scopes - resources.users.methods.get.description - resources.users.methods.get.flatPath - resources.users.methods.get.httpMethod - resources.users.methods.get.id - resources.users.methods.get.parameterOrder - resources.users.methods.get.parameters.userId.description - resources.users.methods.get.parameters.userId.format - resources.users.methods.get.parameters.userId.location - resources.users.methods.get.parameters.userId.pattern - resources.users.methods.get.parameters.userId.required - resources.users.methods.get.parameters.userId.type - resources.users.methods.get.path - resources.users.methods.get.response.$ref - resources.users.methods.get.scopes - resources.users.methods.list.description - resources.users.methods.list.flatPath - resources.users.methods.list.httpMethod - resources.users.methods.list.id - resources.users.methods.list.parameterOrder - resources.users.methods.list.parameters.filter.description - resources.users.methods.list.parameters.filter.location - resources.users.methods.list.parameters.filter.type - resources.users.methods.list.parameters.orderBy.description - resources.users.methods.list.parameters.orderBy.location - resources.users.methods.list.parameters.orderBy.type - resources.users.methods.list.parameters.pageSize.description - resources.users.methods.list.parameters.pageSize.format - resources.users.methods.list.parameters.pageSize.location - resources.users.methods.list.parameters.pageSize.type - resources.users.methods.list.parameters.pageToken.description - resources.users.methods.list.parameters.pageToken.location - resources.users.methods.list.parameters.pageToken.type - resources.users.methods.list.path - resources.users.methods.list.response.$ref - resources.users.methods.list.scopes - resources.users.methods.patch.description - resources.users.methods.patch.flatPath - resources.users.methods.patch.httpMethod - resources.users.methods.patch.id - resources.users.methods.patch.parameterOrder - resources.users.methods.patch.parameters.updateMask.description - resources.users.methods.patch.parameters.updateMask.format - resources.users.methods.patch.parameters.updateMask.location - resources.users.methods.patch.parameters.updateMask.type - resources.users.methods.patch.parameters.userId.description - resources.users.methods.patch.parameters.userId.format - resources.users.methods.patch.parameters.userId.location - resources.users.methods.patch.parameters.userId.pattern - resources.users.methods.patch.parameters.userId.required - resources.users.methods.patch.parameters.userId.type - resources.users.methods.patch.path - resources.users.methods.patch.request.$ref - resources.users.methods.patch.response.$ref - resources.users.methods.patch.scopes - schemas.ActiveViewVideoViewabilityMetricConfig.description - schemas.ActiveViewVideoViewabilityMetricConfig.id - schemas.ActiveViewVideoViewabilityMetricConfig.properties.displayName.description - schemas.ActiveViewVideoViewabilityMetricConfig.properties.displayName.type - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumDuration.description - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumDuration.enum - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumDuration.enumDescriptions - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumDuration.type - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumQuartile.description - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumQuartile.enum - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumQuartile.enumDescriptions - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumQuartile.type - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumViewability.description - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumViewability.enum - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumViewability.enumDescriptions - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumViewability.type - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumVolume.description - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumVolume.enum - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumVolume.enumDescriptions - schemas.ActiveViewVideoViewabilityMetricConfig.properties.minimumVolume.type - schemas.ActiveViewVideoViewabilityMetricConfig.type - schemas.AdGroup.description - schemas.AdGroup.id - schemas.AdGroup.properties.adGroupFormat.description - schemas.AdGroup.properties.adGroupFormat.enum - schemas.AdGroup.properties.adGroupFormat.enumDescriptions - schemas.AdGroup.properties.adGroupFormat.type - schemas.AdGroup.properties.adGroupId.description - schemas.AdGroup.properties.adGroupId.format - schemas.AdGroup.properties.adGroupId.type - schemas.AdGroup.properties.advertiserId.description - schemas.AdGroup.properties.advertiserId.format - schemas.AdGroup.properties.advertiserId.type - schemas.AdGroup.properties.bidStrategy.$ref - schemas.AdGroup.properties.bidStrategy.description - schemas.AdGroup.properties.displayName.description - schemas.AdGroup.properties.displayName.type - schemas.AdGroup.properties.entityStatus.description - schemas.AdGroup.properties.entityStatus.enum - schemas.AdGroup.properties.entityStatus.enumDescriptions - schemas.AdGroup.properties.entityStatus.type - schemas.AdGroup.properties.lineItemId.description - schemas.AdGroup.properties.lineItemId.format - schemas.AdGroup.properties.lineItemId.type - schemas.AdGroup.properties.name.description - schemas.AdGroup.properties.name.type - schemas.AdGroup.properties.productFeedData.$ref - schemas.AdGroup.properties.productFeedData.description - schemas.AdGroup.properties.targetingExpansion.$ref - schemas.AdGroup.properties.targetingExpansion.description - schemas.AdGroup.type - schemas.AdGroupAd.description - schemas.AdGroupAd.id - schemas.AdGroupAd.properties.adGroupAdId.description - schemas.AdGroupAd.properties.adGroupAdId.format - schemas.AdGroupAd.properties.adGroupAdId.type - schemas.AdGroupAd.properties.adGroupId.description - schemas.AdGroupAd.properties.adGroupId.format - schemas.AdGroupAd.properties.adGroupId.type - schemas.AdGroupAd.properties.adUrls.description - schemas.AdGroupAd.properties.adUrls.items.$ref - schemas.AdGroupAd.properties.adUrls.type - schemas.AdGroupAd.properties.advertiserId.description - schemas.AdGroupAd.properties.advertiserId.format - schemas.AdGroupAd.properties.advertiserId.type - schemas.AdGroupAd.properties.audioAd.$ref - schemas.AdGroupAd.properties.audioAd.description - schemas.AdGroupAd.properties.bumperAd.$ref - schemas.AdGroupAd.properties.bumperAd.description - schemas.AdGroupAd.properties.displayName.description - schemas.AdGroupAd.properties.displayName.type - schemas.AdGroupAd.properties.displayVideoSourceAd.$ref - schemas.AdGroupAd.properties.displayVideoSourceAd.description - schemas.AdGroupAd.properties.entityStatus.description - schemas.AdGroupAd.properties.entityStatus.enum - schemas.AdGroupAd.properties.entityStatus.enumDescriptions - schemas.AdGroupAd.properties.entityStatus.type - schemas.AdGroupAd.properties.inStreamAd.$ref - schemas.AdGroupAd.properties.inStreamAd.description - schemas.AdGroupAd.properties.mastheadAd.$ref - schemas.AdGroupAd.properties.mastheadAd.description - schemas.AdGroupAd.properties.name.description - schemas.AdGroupAd.properties.name.type - schemas.AdGroupAd.properties.nonSkippableAd.$ref - schemas.AdGroupAd.properties.nonSkippableAd.description - schemas.AdGroupAd.properties.videoDiscoverAd.$ref - schemas.AdGroupAd.properties.videoDiscoverAd.description - schemas.AdGroupAd.properties.videoPerformanceAd.$ref - schemas.AdGroupAd.properties.videoPerformanceAd.description - schemas.AdGroupAd.type - schemas.AdGroupAssignedTargetingOption.description - schemas.AdGroupAssignedTargetingOption.id - schemas.AdGroupAssignedTargetingOption.properties.adGroupId.description - schemas.AdGroupAssignedTargetingOption.properties.adGroupId.format - schemas.AdGroupAssignedTargetingOption.properties.adGroupId.type - schemas.AdGroupAssignedTargetingOption.properties.assignedTargetingOption.$ref - schemas.AdGroupAssignedTargetingOption.properties.assignedTargetingOption.description - schemas.AdGroupAssignedTargetingOption.type - schemas.AdUrl.description - schemas.AdUrl.id - schemas.AdUrl.properties.type.description - schemas.AdUrl.properties.type.enum - schemas.AdUrl.properties.type.enumDescriptions - schemas.AdUrl.properties.type.type - schemas.AdUrl.properties.url.description - schemas.AdUrl.properties.url.type - schemas.AdUrl.type - schemas.Adloox.description - schemas.Adloox.id - schemas.Adloox.properties.adultExplicitSexualContent.description - schemas.Adloox.properties.adultExplicitSexualContent.enum - schemas.Adloox.properties.adultExplicitSexualContent.enumDescriptions - schemas.Adloox.properties.adultExplicitSexualContent.type - schemas.Adloox.properties.armsAmmunitionContent.description - schemas.Adloox.properties.armsAmmunitionContent.enum - schemas.Adloox.properties.armsAmmunitionContent.enumDescriptions - schemas.Adloox.properties.armsAmmunitionContent.type - schemas.Adloox.properties.crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent.description - schemas.Adloox.properties.crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent.enum - schemas.Adloox.properties.crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent.enumDescriptions - schemas.Adloox.properties.crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent.type - schemas.Adloox.properties.deathInjuryMilitaryConflictContent.description - schemas.Adloox.properties.deathInjuryMilitaryConflictContent.enum - schemas.Adloox.properties.deathInjuryMilitaryConflictContent.enumDescriptions - schemas.Adloox.properties.deathInjuryMilitaryConflictContent.type - schemas.Adloox.properties.debatedSensitiveSocialIssueContent.description - schemas.Adloox.properties.debatedSensitiveSocialIssueContent.enum - schemas.Adloox.properties.debatedSensitiveSocialIssueContent.enumDescriptions - schemas.Adloox.properties.debatedSensitiveSocialIssueContent.type - schemas.Adloox.properties.displayIabViewability.description - schemas.Adloox.properties.displayIabViewability.enum - schemas.Adloox.properties.displayIabViewability.enumDescriptions - schemas.Adloox.properties.displayIabViewability.type - schemas.Adloox.properties.excludedAdlooxCategories.description - schemas.Adloox.properties.excludedAdlooxCategories.items.enum - schemas.Adloox.properties.excludedAdlooxCategories.items.enumDescriptions - schemas.Adloox.properties.excludedAdlooxCategories.items.type - schemas.Adloox.properties.excludedAdlooxCategories.type - schemas.Adloox.properties.excludedFraudIvtMfaCategories.description - schemas.Adloox.properties.excludedFraudIvtMfaCategories.items.enum - schemas.Adloox.properties.excludedFraudIvtMfaCategories.items.enumDescriptions - schemas.Adloox.properties.excludedFraudIvtMfaCategories.items.type - schemas.Adloox.properties.excludedFraudIvtMfaCategories.type - schemas.Adloox.properties.hateSpeechActsAggressionContent.description - schemas.Adloox.properties.hateSpeechActsAggressionContent.enum - schemas.Adloox.properties.hateSpeechActsAggressionContent.enumDescriptions - schemas.Adloox.properties.hateSpeechActsAggressionContent.type - schemas.Adloox.properties.illegalDrugsTobaccoEcigarettesVapingAlcoholContent.description - schemas.Adloox.properties.illegalDrugsTobaccoEcigarettesVapingAlcoholContent.enum - schemas.Adloox.properties.illegalDrugsTobaccoEcigarettesVapingAlcoholContent.enumDescriptions - schemas.Adloox.properties.illegalDrugsTobaccoEcigarettesVapingAlcoholContent.type - schemas.Adloox.properties.misinformationContent.description - schemas.Adloox.properties.misinformationContent.enum - schemas.Adloox.properties.misinformationContent.enumDescriptions - schemas.Adloox.properties.misinformationContent.type - schemas.Adloox.properties.obscenityProfanityContent.description - schemas.Adloox.properties.obscenityProfanityContent.enum - schemas.Adloox.properties.obscenityProfanityContent.enumDescriptions - schemas.Adloox.properties.obscenityProfanityContent.type - schemas.Adloox.properties.onlinePiracyContent.description - schemas.Adloox.properties.onlinePiracyContent.enum - schemas.Adloox.properties.onlinePiracyContent.enumDescriptions - schemas.Adloox.properties.onlinePiracyContent.type - schemas.Adloox.properties.spamHarmfulContent.description - schemas.Adloox.properties.spamHarmfulContent.enum - schemas.Adloox.properties.spamHarmfulContent.enumDescriptions - schemas.Adloox.properties.spamHarmfulContent.type - schemas.Adloox.properties.terrorismContent.description - schemas.Adloox.properties.terrorismContent.enum - schemas.Adloox.properties.terrorismContent.enumDescriptions - schemas.Adloox.properties.terrorismContent.type - schemas.Adloox.properties.videoIabViewability.description - schemas.Adloox.properties.videoIabViewability.enum - schemas.Adloox.properties.videoIabViewability.enumDescriptions - schemas.Adloox.properties.videoIabViewability.type - schemas.Adloox.type - schemas.Advertiser.description - schemas.Advertiser.id - schemas.Advertiser.properties.adServerConfig.$ref - schemas.Advertiser.properties.adServerConfig.description - schemas.Advertiser.properties.advertiserId.description - schemas.Advertiser.properties.advertiserId.format - schemas.Advertiser.properties.advertiserId.readOnly - schemas.Advertiser.properties.advertiserId.type - schemas.Advertiser.properties.billingConfig.$ref - schemas.Advertiser.properties.billingConfig.description - schemas.Advertiser.properties.creativeConfig.$ref - schemas.Advertiser.properties.creativeConfig.description - schemas.Advertiser.properties.dataAccessConfig.$ref - schemas.Advertiser.properties.dataAccessConfig.description - schemas.Advertiser.properties.displayName.description - schemas.Advertiser.properties.displayName.type - schemas.Advertiser.properties.entityStatus.description - schemas.Advertiser.properties.entityStatus.enum - schemas.Advertiser.properties.entityStatus.enumDescriptions - schemas.Advertiser.properties.entityStatus.type - schemas.Advertiser.properties.generalConfig.$ref - schemas.Advertiser.properties.generalConfig.description - schemas.Advertiser.properties.integrationDetails.$ref - schemas.Advertiser.properties.integrationDetails.description - schemas.Advertiser.properties.name.description - schemas.Advertiser.properties.name.readOnly - schemas.Advertiser.properties.name.type - schemas.Advertiser.properties.partnerId.description - schemas.Advertiser.properties.partnerId.format - schemas.Advertiser.properties.partnerId.type - schemas.Advertiser.properties.prismaEnabled.description - schemas.Advertiser.properties.prismaEnabled.type - schemas.Advertiser.properties.servingConfig.$ref - schemas.Advertiser.properties.servingConfig.description - schemas.Advertiser.properties.updateTime.description - schemas.Advertiser.properties.updateTime.format - schemas.Advertiser.properties.updateTime.readOnly - schemas.Advertiser.properties.updateTime.type - schemas.Advertiser.type - schemas.AdvertiserAdServerConfig.description - schemas.AdvertiserAdServerConfig.id - schemas.AdvertiserAdServerConfig.properties.cmHybridConfig.$ref - schemas.AdvertiserAdServerConfig.properties.cmHybridConfig.description - schemas.AdvertiserAdServerConfig.properties.thirdPartyOnlyConfig.$ref - schemas.AdvertiserAdServerConfig.properties.thirdPartyOnlyConfig.description - schemas.AdvertiserAdServerConfig.type - schemas.AdvertiserBillingConfig.description - schemas.AdvertiserBillingConfig.id - schemas.AdvertiserBillingConfig.properties.billingProfileId.description - schemas.AdvertiserBillingConfig.properties.billingProfileId.format - schemas.AdvertiserBillingConfig.properties.billingProfileId.type - schemas.AdvertiserBillingConfig.type - schemas.AdvertiserCreativeConfig.description - schemas.AdvertiserCreativeConfig.id - schemas.AdvertiserCreativeConfig.properties.dynamicCreativeEnabled.description - schemas.AdvertiserCreativeConfig.properties.dynamicCreativeEnabled.type - schemas.AdvertiserCreativeConfig.properties.iasClientId.description - schemas.AdvertiserCreativeConfig.properties.iasClientId.format - schemas.AdvertiserCreativeConfig.properties.iasClientId.type - schemas.AdvertiserCreativeConfig.properties.obaComplianceDisabled.description - schemas.AdvertiserCreativeConfig.properties.obaComplianceDisabled.type - schemas.AdvertiserCreativeConfig.properties.videoCreativeDataSharingAuthorized.description - schemas.AdvertiserCreativeConfig.properties.videoCreativeDataSharingAuthorized.type - schemas.AdvertiserCreativeConfig.type - schemas.AdvertiserDataAccessConfig.description - schemas.AdvertiserDataAccessConfig.id - schemas.AdvertiserDataAccessConfig.properties.sdfConfig.$ref - schemas.AdvertiserDataAccessConfig.properties.sdfConfig.description - schemas.AdvertiserDataAccessConfig.type - schemas.AdvertiserGeneralConfig.description - schemas.AdvertiserGeneralConfig.id - schemas.AdvertiserGeneralConfig.properties.currencyCode.description - schemas.AdvertiserGeneralConfig.properties.currencyCode.type - schemas.AdvertiserGeneralConfig.properties.domainUrl.description - schemas.AdvertiserGeneralConfig.properties.domainUrl.type - schemas.AdvertiserGeneralConfig.properties.timeZone.description - schemas.AdvertiserGeneralConfig.properties.timeZone.readOnly - schemas.AdvertiserGeneralConfig.properties.timeZone.type - schemas.AdvertiserGeneralConfig.type - schemas.AdvertiserSdfConfig.description - schemas.AdvertiserSdfConfig.id - schemas.AdvertiserSdfConfig.properties.overridePartnerSdfConfig.description - schemas.AdvertiserSdfConfig.properties.overridePartnerSdfConfig.type - schemas.AdvertiserSdfConfig.properties.sdfConfig.$ref - schemas.AdvertiserSdfConfig.properties.sdfConfig.description - schemas.AdvertiserSdfConfig.type - schemas.AdvertiserTargetingConfig.description - schemas.AdvertiserTargetingConfig.id - schemas.AdvertiserTargetingConfig.properties.exemptTvFromViewabilityTargeting.description - schemas.AdvertiserTargetingConfig.properties.exemptTvFromViewabilityTargeting.type - schemas.AdvertiserTargetingConfig.type - schemas.AgeRangeAssignedTargetingOptionDetails.description - schemas.AgeRangeAssignedTargetingOptionDetails.id - schemas.AgeRangeAssignedTargetingOptionDetails.properties.ageRange.description - schemas.AgeRangeAssignedTargetingOptionDetails.properties.ageRange.enum - schemas.AgeRangeAssignedTargetingOptionDetails.properties.ageRange.enumDescriptions - schemas.AgeRangeAssignedTargetingOptionDetails.properties.ageRange.type - schemas.AgeRangeAssignedTargetingOptionDetails.type - schemas.AgeRangeTargetingOptionDetails.description - schemas.AgeRangeTargetingOptionDetails.id - schemas.AgeRangeTargetingOptionDetails.properties.ageRange.description - schemas.AgeRangeTargetingOptionDetails.properties.ageRange.enum - schemas.AgeRangeTargetingOptionDetails.properties.ageRange.enumDescriptions - schemas.AgeRangeTargetingOptionDetails.properties.ageRange.readOnly - schemas.AgeRangeTargetingOptionDetails.properties.ageRange.type - schemas.AgeRangeTargetingOptionDetails.type - schemas.AlgorithmRules.description - schemas.AlgorithmRules.id - schemas.AlgorithmRules.properties.impressionSignalRuleset.$ref - schemas.AlgorithmRules.properties.impressionSignalRuleset.description - schemas.AlgorithmRules.type - schemas.AlgorithmRulesComparisonValue.description - schemas.AlgorithmRulesComparisonValue.id - schemas.AlgorithmRulesComparisonValue.properties.boolValue.description - schemas.AlgorithmRulesComparisonValue.properties.boolValue.type - schemas.AlgorithmRulesComparisonValue.properties.creativeDimensionValue.$ref - schemas.AlgorithmRulesComparisonValue.properties.creativeDimensionValue.description - schemas.AlgorithmRulesComparisonValue.properties.dayAndTimeValue.$ref - schemas.AlgorithmRulesComparisonValue.properties.dayAndTimeValue.description - schemas.AlgorithmRulesComparisonValue.properties.deviceTypeValue.description - schemas.AlgorithmRulesComparisonValue.properties.deviceTypeValue.enum - schemas.AlgorithmRulesComparisonValue.properties.deviceTypeValue.enumDescriptions - schemas.AlgorithmRulesComparisonValue.properties.deviceTypeValue.type - schemas.AlgorithmRulesComparisonValue.properties.doubleValue.description - schemas.AlgorithmRulesComparisonValue.properties.doubleValue.format - schemas.AlgorithmRulesComparisonValue.properties.doubleValue.type - schemas.AlgorithmRulesComparisonValue.properties.environmentValue.description - schemas.AlgorithmRulesComparisonValue.properties.environmentValue.enum - schemas.AlgorithmRulesComparisonValue.properties.environmentValue.enumDescriptions - schemas.AlgorithmRulesComparisonValue.properties.environmentValue.type - schemas.AlgorithmRulesComparisonValue.properties.exchangeValue.description - schemas.AlgorithmRulesComparisonValue.properties.exchangeValue.enum - schemas.AlgorithmRulesComparisonValue.properties.exchangeValue.enumDescriptions - schemas.AlgorithmRulesComparisonValue.properties.exchangeValue.type - schemas.AlgorithmRulesComparisonValue.properties.int64Value.description - schemas.AlgorithmRulesComparisonValue.properties.int64Value.format - schemas.AlgorithmRulesComparisonValue.properties.int64Value.type - schemas.AlgorithmRulesComparisonValue.properties.onScreenPositionValue.description - schemas.AlgorithmRulesComparisonValue.properties.onScreenPositionValue.enum - schemas.AlgorithmRulesComparisonValue.properties.onScreenPositionValue.enumDescriptions - schemas.AlgorithmRulesComparisonValue.properties.onScreenPositionValue.type - schemas.AlgorithmRulesComparisonValue.properties.stringValue.description - schemas.AlgorithmRulesComparisonValue.properties.stringValue.type - schemas.AlgorithmRulesComparisonValue.type - schemas.AlgorithmRulesRule.description - schemas.AlgorithmRulesRule.id - schemas.AlgorithmRulesRule.properties.conditions.description - schemas.AlgorithmRulesRule.properties.conditions.items.$ref - schemas.AlgorithmRulesRule.properties.conditions.type - schemas.AlgorithmRulesRule.properties.defaultReturnValue.$ref - schemas.AlgorithmRulesRule.properties.defaultReturnValue.description - schemas.AlgorithmRulesRule.type - schemas.AlgorithmRulesRuleCondition.description - schemas.AlgorithmRulesRuleCondition.id - schemas.AlgorithmRulesRuleCondition.properties.returnValue.$ref - schemas.AlgorithmRulesRuleCondition.properties.returnValue.description - schemas.AlgorithmRulesRuleCondition.properties.signalComparisons.description - schemas.AlgorithmRulesRuleCondition.properties.signalComparisons.items.$ref - schemas.AlgorithmRulesRuleCondition.properties.signalComparisons.type - schemas.AlgorithmRulesRuleCondition.type - schemas.AlgorithmRulesRuleset.description - schemas.AlgorithmRulesRuleset.id - schemas.AlgorithmRulesRuleset.properties.aggregationType.description - schemas.AlgorithmRulesRuleset.properties.aggregationType.enum - schemas.AlgorithmRulesRuleset.properties.aggregationType.enumDescriptions - schemas.AlgorithmRulesRuleset.properties.aggregationType.type - schemas.AlgorithmRulesRuleset.properties.maxValue.description - schemas.AlgorithmRulesRuleset.properties.maxValue.format - schemas.AlgorithmRulesRuleset.properties.maxValue.type - schemas.AlgorithmRulesRuleset.properties.rules.description - schemas.AlgorithmRulesRuleset.properties.rules.items.$ref - schemas.AlgorithmRulesRuleset.properties.rules.type - schemas.AlgorithmRulesRuleset.type - schemas.AlgorithmRulesSignal.description - schemas.AlgorithmRulesSignal.id - schemas.AlgorithmRulesSignal.properties.impressionSignal.description - schemas.AlgorithmRulesSignal.properties.impressionSignal.enum - schemas.AlgorithmRulesSignal.properties.impressionSignal.enumDescriptions - schemas.AlgorithmRulesSignal.properties.impressionSignal.type - schemas.AlgorithmRulesSignal.type - schemas.AlgorithmRulesSignalComparison.description - schemas.AlgorithmRulesSignalComparison.id - schemas.AlgorithmRulesSignalComparison.properties.comparisonOperator.description - schemas.AlgorithmRulesSignalComparison.properties.comparisonOperator.enum - schemas.AlgorithmRulesSignalComparison.properties.comparisonOperator.enumDescriptions - schemas.AlgorithmRulesSignalComparison.properties.comparisonOperator.type - schemas.AlgorithmRulesSignalComparison.properties.comparisonValue.$ref - schemas.AlgorithmRulesSignalComparison.properties.comparisonValue.description - schemas.AlgorithmRulesSignalComparison.properties.signal.$ref - schemas.AlgorithmRulesSignalComparison.properties.signal.description - schemas.AlgorithmRulesSignalComparison.type - schemas.AlgorithmRulesSignalValue.description - schemas.AlgorithmRulesSignalValue.id - schemas.AlgorithmRulesSignalValue.properties.number.description - schemas.AlgorithmRulesSignalValue.properties.number.format - schemas.AlgorithmRulesSignalValue.properties.number.type - schemas.AlgorithmRulesSignalValue.type - schemas.AppAssignedTargetingOptionDetails.description - schemas.AppAssignedTargetingOptionDetails.id - schemas.AppAssignedTargetingOptionDetails.properties.appId.description - schemas.AppAssignedTargetingOptionDetails.properties.appId.type - schemas.AppAssignedTargetingOptionDetails.properties.appPlatform.description - schemas.AppAssignedTargetingOptionDetails.properties.appPlatform.enum - schemas.AppAssignedTargetingOptionDetails.properties.appPlatform.enumDescriptions - schemas.AppAssignedTargetingOptionDetails.properties.appPlatform.type - schemas.AppAssignedTargetingOptionDetails.properties.displayName.description - schemas.AppAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.AppAssignedTargetingOptionDetails.properties.displayName.type - schemas.AppAssignedTargetingOptionDetails.properties.negative.description - schemas.AppAssignedTargetingOptionDetails.properties.negative.type - schemas.AppAssignedTargetingOptionDetails.type - schemas.AppCategoryAssignedTargetingOptionDetails.description - schemas.AppCategoryAssignedTargetingOptionDetails.id - schemas.AppCategoryAssignedTargetingOptionDetails.properties.displayName.description - schemas.AppCategoryAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.AppCategoryAssignedTargetingOptionDetails.properties.displayName.type - schemas.AppCategoryAssignedTargetingOptionDetails.properties.negative.description - schemas.AppCategoryAssignedTargetingOptionDetails.properties.negative.type - schemas.AppCategoryAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.AppCategoryAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.AppCategoryAssignedTargetingOptionDetails.type - schemas.AppCategoryTargetingOptionDetails.description - schemas.AppCategoryTargetingOptionDetails.id - schemas.AppCategoryTargetingOptionDetails.properties.displayName.description - schemas.AppCategoryTargetingOptionDetails.properties.displayName.readOnly - schemas.AppCategoryTargetingOptionDetails.properties.displayName.type - schemas.AppCategoryTargetingOptionDetails.type - schemas.Asset.description - schemas.Asset.id - schemas.Asset.properties.content.description - schemas.Asset.properties.content.type - schemas.Asset.properties.mediaId.description - schemas.Asset.properties.mediaId.format - schemas.Asset.properties.mediaId.type - schemas.Asset.type - schemas.AssetAssociation.description - schemas.AssetAssociation.id - schemas.AssetAssociation.properties.asset.$ref - schemas.AssetAssociation.properties.asset.description - schemas.AssetAssociation.properties.role.description - schemas.AssetAssociation.properties.role.enum - schemas.AssetAssociation.properties.role.enumDescriptions - schemas.AssetAssociation.properties.role.type - schemas.AssetAssociation.type - schemas.AssignedInventorySource.description - schemas.AssignedInventorySource.id - schemas.AssignedInventorySource.properties.assignedInventorySourceId.description - schemas.AssignedInventorySource.properties.assignedInventorySourceId.format - schemas.AssignedInventorySource.properties.assignedInventorySourceId.readOnly - schemas.AssignedInventorySource.properties.assignedInventorySourceId.type - schemas.AssignedInventorySource.properties.inventorySourceId.description - schemas.AssignedInventorySource.properties.inventorySourceId.type - schemas.AssignedInventorySource.properties.name.description - schemas.AssignedInventorySource.properties.name.readOnly - schemas.AssignedInventorySource.properties.name.type - schemas.AssignedInventorySource.type - schemas.AssignedLocation.description - schemas.AssignedLocation.id - schemas.AssignedLocation.properties.assignedLocationId.description - schemas.AssignedLocation.properties.assignedLocationId.format - schemas.AssignedLocation.properties.assignedLocationId.readOnly - schemas.AssignedLocation.properties.assignedLocationId.type - schemas.AssignedLocation.properties.name.description - schemas.AssignedLocation.properties.name.readOnly - schemas.AssignedLocation.properties.name.type - schemas.AssignedLocation.properties.targetingOptionId.description - schemas.AssignedLocation.properties.targetingOptionId.type - schemas.AssignedLocation.type - schemas.AssignedTargetingOption.description - schemas.AssignedTargetingOption.id - schemas.AssignedTargetingOption.properties.ageRangeDetails.$ref - schemas.AssignedTargetingOption.properties.ageRangeDetails.description - schemas.AssignedTargetingOption.properties.appCategoryDetails.$ref - schemas.AssignedTargetingOption.properties.appCategoryDetails.description - schemas.AssignedTargetingOption.properties.appDetails.$ref - schemas.AssignedTargetingOption.properties.appDetails.description - schemas.AssignedTargetingOption.properties.assignedTargetingOptionId.description - schemas.AssignedTargetingOption.properties.assignedTargetingOptionId.readOnly - schemas.AssignedTargetingOption.properties.assignedTargetingOptionId.type - schemas.AssignedTargetingOption.properties.assignedTargetingOptionIdAlias.description - schemas.AssignedTargetingOption.properties.assignedTargetingOptionIdAlias.readOnly - schemas.AssignedTargetingOption.properties.assignedTargetingOptionIdAlias.type - schemas.AssignedTargetingOption.properties.audienceGroupDetails.$ref - schemas.AssignedTargetingOption.properties.audienceGroupDetails.description - schemas.AssignedTargetingOption.properties.audioContentTypeDetails.$ref - schemas.AssignedTargetingOption.properties.audioContentTypeDetails.description - schemas.AssignedTargetingOption.properties.authorizedSellerStatusDetails.$ref - schemas.AssignedTargetingOption.properties.authorizedSellerStatusDetails.description - schemas.AssignedTargetingOption.properties.browserDetails.$ref - schemas.AssignedTargetingOption.properties.browserDetails.description - schemas.AssignedTargetingOption.properties.businessChainDetails.$ref - schemas.AssignedTargetingOption.properties.businessChainDetails.description - schemas.AssignedTargetingOption.properties.carrierAndIspDetails.$ref - schemas.AssignedTargetingOption.properties.carrierAndIspDetails.description - schemas.AssignedTargetingOption.properties.categoryDetails.$ref - schemas.AssignedTargetingOption.properties.categoryDetails.description - schemas.AssignedTargetingOption.properties.channelDetails.$ref - schemas.AssignedTargetingOption.properties.channelDetails.description - schemas.AssignedTargetingOption.properties.contentDurationDetails.$ref - schemas.AssignedTargetingOption.properties.contentDurationDetails.description - schemas.AssignedTargetingOption.properties.contentGenreDetails.$ref - schemas.AssignedTargetingOption.properties.contentGenreDetails.description - schemas.AssignedTargetingOption.properties.contentInstreamPositionDetails.$ref - schemas.AssignedTargetingOption.properties.contentInstreamPositionDetails.description - schemas.AssignedTargetingOption.properties.contentOutstreamPositionDetails.$ref - schemas.AssignedTargetingOption.properties.contentOutstreamPositionDetails.description - schemas.AssignedTargetingOption.properties.contentStreamTypeDetails.$ref - schemas.AssignedTargetingOption.properties.contentStreamTypeDetails.description - schemas.AssignedTargetingOption.properties.dayAndTimeDetails.$ref - schemas.AssignedTargetingOption.properties.dayAndTimeDetails.description - schemas.AssignedTargetingOption.properties.deviceMakeModelDetails.$ref - schemas.AssignedTargetingOption.properties.deviceMakeModelDetails.description - schemas.AssignedTargetingOption.properties.deviceTypeDetails.$ref - schemas.AssignedTargetingOption.properties.deviceTypeDetails.description - schemas.AssignedTargetingOption.properties.digitalContentLabelExclusionDetails.$ref - schemas.AssignedTargetingOption.properties.digitalContentLabelExclusionDetails.description - schemas.AssignedTargetingOption.properties.environmentDetails.$ref - schemas.AssignedTargetingOption.properties.environmentDetails.description - schemas.AssignedTargetingOption.properties.exchangeDetails.$ref - schemas.AssignedTargetingOption.properties.exchangeDetails.description - schemas.AssignedTargetingOption.properties.genderDetails.$ref - schemas.AssignedTargetingOption.properties.genderDetails.description - schemas.AssignedTargetingOption.properties.geoRegionDetails.$ref - schemas.AssignedTargetingOption.properties.geoRegionDetails.description - schemas.AssignedTargetingOption.properties.householdIncomeDetails.$ref - schemas.AssignedTargetingOption.properties.householdIncomeDetails.description - schemas.AssignedTargetingOption.properties.inheritance.description - schemas.AssignedTargetingOption.properties.inheritance.enum - schemas.AssignedTargetingOption.properties.inheritance.enumDescriptions - schemas.AssignedTargetingOption.properties.inheritance.readOnly - schemas.AssignedTargetingOption.properties.inheritance.type - schemas.AssignedTargetingOption.properties.inventorySourceDetails.$ref - schemas.AssignedTargetingOption.properties.inventorySourceDetails.description - schemas.AssignedTargetingOption.properties.inventorySourceGroupDetails.$ref - schemas.AssignedTargetingOption.properties.inventorySourceGroupDetails.description - schemas.AssignedTargetingOption.properties.keywordDetails.$ref - schemas.AssignedTargetingOption.properties.keywordDetails.description - schemas.AssignedTargetingOption.properties.languageDetails.$ref - schemas.AssignedTargetingOption.properties.languageDetails.description - schemas.AssignedTargetingOption.properties.name.description - schemas.AssignedTargetingOption.properties.name.readOnly - schemas.AssignedTargetingOption.properties.name.type - schemas.AssignedTargetingOption.properties.nativeContentPositionDetails.$ref - schemas.AssignedTargetingOption.properties.nativeContentPositionDetails.description - schemas.AssignedTargetingOption.properties.negativeKeywordListDetails.$ref - schemas.AssignedTargetingOption.properties.negativeKeywordListDetails.description - schemas.AssignedTargetingOption.properties.omidDetails.$ref - schemas.AssignedTargetingOption.properties.omidDetails.description - schemas.AssignedTargetingOption.properties.onScreenPositionDetails.$ref - schemas.AssignedTargetingOption.properties.onScreenPositionDetails.description - schemas.AssignedTargetingOption.properties.operatingSystemDetails.$ref - schemas.AssignedTargetingOption.properties.operatingSystemDetails.description - schemas.AssignedTargetingOption.properties.parentalStatusDetails.$ref - schemas.AssignedTargetingOption.properties.parentalStatusDetails.description - schemas.AssignedTargetingOption.properties.poiDetails.$ref - schemas.AssignedTargetingOption.properties.poiDetails.description - schemas.AssignedTargetingOption.properties.proximityLocationListDetails.$ref - schemas.AssignedTargetingOption.properties.proximityLocationListDetails.description - schemas.AssignedTargetingOption.properties.regionalLocationListDetails.$ref - schemas.AssignedTargetingOption.properties.regionalLocationListDetails.description - schemas.AssignedTargetingOption.properties.sensitiveCategoryExclusionDetails.$ref - schemas.AssignedTargetingOption.properties.sensitiveCategoryExclusionDetails.description - schemas.AssignedTargetingOption.properties.sessionPositionDetails.$ref - schemas.AssignedTargetingOption.properties.sessionPositionDetails.description - schemas.AssignedTargetingOption.properties.subExchangeDetails.$ref - schemas.AssignedTargetingOption.properties.subExchangeDetails.description - schemas.AssignedTargetingOption.properties.targetingType.description - schemas.AssignedTargetingOption.properties.targetingType.enum - schemas.AssignedTargetingOption.properties.targetingType.enumDescriptions - schemas.AssignedTargetingOption.properties.targetingType.readOnly - schemas.AssignedTargetingOption.properties.targetingType.type - schemas.AssignedTargetingOption.properties.thirdPartyVerifierDetails.$ref - schemas.AssignedTargetingOption.properties.thirdPartyVerifierDetails.description - schemas.AssignedTargetingOption.properties.urlDetails.$ref - schemas.AssignedTargetingOption.properties.urlDetails.description - schemas.AssignedTargetingOption.properties.userRewardedContentDetails.$ref - schemas.AssignedTargetingOption.properties.userRewardedContentDetails.description - schemas.AssignedTargetingOption.properties.videoPlayerSizeDetails.$ref - schemas.AssignedTargetingOption.properties.videoPlayerSizeDetails.description - schemas.AssignedTargetingOption.properties.viewabilityDetails.$ref - schemas.AssignedTargetingOption.properties.viewabilityDetails.description - schemas.AssignedTargetingOption.properties.youtubeChannelDetails.$ref - schemas.AssignedTargetingOption.properties.youtubeChannelDetails.description - schemas.AssignedTargetingOption.properties.youtubeVideoDetails.$ref - schemas.AssignedTargetingOption.properties.youtubeVideoDetails.description - schemas.AssignedTargetingOption.type - schemas.AssignedUserRole.description - schemas.AssignedUserRole.id - schemas.AssignedUserRole.properties.advertiserId.description - schemas.AssignedUserRole.properties.advertiserId.format - schemas.AssignedUserRole.properties.advertiserId.type - schemas.AssignedUserRole.properties.assignedUserRoleId.description - schemas.AssignedUserRole.properties.assignedUserRoleId.readOnly - schemas.AssignedUserRole.properties.assignedUserRoleId.type - schemas.AssignedUserRole.properties.partnerId.description - schemas.AssignedUserRole.properties.partnerId.format - schemas.AssignedUserRole.properties.partnerId.type - schemas.AssignedUserRole.properties.userRole.description - schemas.AssignedUserRole.properties.userRole.enum - schemas.AssignedUserRole.properties.userRole.enumDescriptions - schemas.AssignedUserRole.properties.userRole.type - schemas.AssignedUserRole.type - schemas.AudienceGroupAssignedTargetingOptionDetails.description - schemas.AudienceGroupAssignedTargetingOptionDetails.id - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.excludedFirstPartyAndPartnerAudienceGroup.$ref - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.excludedFirstPartyAndPartnerAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.excludedGoogleAudienceGroup.$ref - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.excludedGoogleAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedCombinedAudienceGroup.$ref - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedCombinedAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedCustomListGroup.$ref - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedCustomListGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedFirstPartyAndPartnerAudienceGroups.description - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedFirstPartyAndPartnerAudienceGroups.items.$ref - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedFirstPartyAndPartnerAudienceGroups.type - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedGoogleAudienceGroup.$ref - schemas.AudienceGroupAssignedTargetingOptionDetails.properties.includedGoogleAudienceGroup.description - schemas.AudienceGroupAssignedTargetingOptionDetails.type - schemas.AudioAd.description - schemas.AudioAd.id - schemas.AudioAd.properties.displayUrl.description - schemas.AudioAd.properties.displayUrl.type - schemas.AudioAd.properties.finalUrl.description - schemas.AudioAd.properties.finalUrl.type - schemas.AudioAd.properties.trackingUrl.description - schemas.AudioAd.properties.trackingUrl.type - schemas.AudioAd.properties.video.$ref - schemas.AudioAd.properties.video.description - schemas.AudioAd.type - schemas.AudioContentTypeAssignedTargetingOptionDetails.description - schemas.AudioContentTypeAssignedTargetingOptionDetails.id - schemas.AudioContentTypeAssignedTargetingOptionDetails.properties.audioContentType.description - schemas.AudioContentTypeAssignedTargetingOptionDetails.properties.audioContentType.enum - schemas.AudioContentTypeAssignedTargetingOptionDetails.properties.audioContentType.enumDescriptions - schemas.AudioContentTypeAssignedTargetingOptionDetails.properties.audioContentType.type - schemas.AudioContentTypeAssignedTargetingOptionDetails.type - schemas.AudioContentTypeTargetingOptionDetails.description - schemas.AudioContentTypeTargetingOptionDetails.id - schemas.AudioContentTypeTargetingOptionDetails.properties.audioContentType.description - schemas.AudioContentTypeTargetingOptionDetails.properties.audioContentType.enum - schemas.AudioContentTypeTargetingOptionDetails.properties.audioContentType.enumDescriptions - schemas.AudioContentTypeTargetingOptionDetails.properties.audioContentType.readOnly - schemas.AudioContentTypeTargetingOptionDetails.properties.audioContentType.type - schemas.AudioContentTypeTargetingOptionDetails.type - schemas.AudioVideoOffset.description - schemas.AudioVideoOffset.id - schemas.AudioVideoOffset.properties.percentage.description - schemas.AudioVideoOffset.properties.percentage.format - schemas.AudioVideoOffset.properties.percentage.type - schemas.AudioVideoOffset.properties.seconds.description - schemas.AudioVideoOffset.properties.seconds.format - schemas.AudioVideoOffset.properties.seconds.type - schemas.AudioVideoOffset.type - schemas.AuditAdvertiserResponse.description - schemas.AuditAdvertiserResponse.id - schemas.AuditAdvertiserResponse.properties.adGroupCriteriaCount.description - schemas.AuditAdvertiserResponse.properties.adGroupCriteriaCount.format - schemas.AuditAdvertiserResponse.properties.adGroupCriteriaCount.type - schemas.AuditAdvertiserResponse.properties.campaignCriteriaCount.description - schemas.AuditAdvertiserResponse.properties.campaignCriteriaCount.format - schemas.AuditAdvertiserResponse.properties.campaignCriteriaCount.type - schemas.AuditAdvertiserResponse.properties.channelsCount.description - schemas.AuditAdvertiserResponse.properties.channelsCount.format - schemas.AuditAdvertiserResponse.properties.channelsCount.type - schemas.AuditAdvertiserResponse.properties.negativeKeywordListsCount.description - schemas.AuditAdvertiserResponse.properties.negativeKeywordListsCount.format - schemas.AuditAdvertiserResponse.properties.negativeKeywordListsCount.type - schemas.AuditAdvertiserResponse.properties.negativelyTargetedChannelsCount.description - schemas.AuditAdvertiserResponse.properties.negativelyTargetedChannelsCount.format - schemas.AuditAdvertiserResponse.properties.negativelyTargetedChannelsCount.type - schemas.AuditAdvertiserResponse.properties.usedCampaignsCount.description - schemas.AuditAdvertiserResponse.properties.usedCampaignsCount.format - schemas.AuditAdvertiserResponse.properties.usedCampaignsCount.type - schemas.AuditAdvertiserResponse.properties.usedInsertionOrdersCount.description - schemas.AuditAdvertiserResponse.properties.usedInsertionOrdersCount.format - schemas.AuditAdvertiserResponse.properties.usedInsertionOrdersCount.type - schemas.AuditAdvertiserResponse.properties.usedLineItemsCount.description - schemas.AuditAdvertiserResponse.properties.usedLineItemsCount.format - schemas.AuditAdvertiserResponse.properties.usedLineItemsCount.type - schemas.AuditAdvertiserResponse.type - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.description - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.id - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.properties.authorizedSellerStatus.description - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.properties.authorizedSellerStatus.enum - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.properties.authorizedSellerStatus.enumDescriptions - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.properties.authorizedSellerStatus.readOnly - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.properties.authorizedSellerStatus.type - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.AuthorizedSellerStatusAssignedTargetingOptionDetails.type - schemas.AuthorizedSellerStatusTargetingOptionDetails.description - schemas.AuthorizedSellerStatusTargetingOptionDetails.id - schemas.AuthorizedSellerStatusTargetingOptionDetails.properties.authorizedSellerStatus.description - schemas.AuthorizedSellerStatusTargetingOptionDetails.properties.authorizedSellerStatus.enum - schemas.AuthorizedSellerStatusTargetingOptionDetails.properties.authorizedSellerStatus.enumDescriptions - schemas.AuthorizedSellerStatusTargetingOptionDetails.properties.authorizedSellerStatus.readOnly - schemas.AuthorizedSellerStatusTargetingOptionDetails.properties.authorizedSellerStatus.type - schemas.AuthorizedSellerStatusTargetingOptionDetails.type - schemas.BiddingStrategy.description - schemas.BiddingStrategy.id - schemas.BiddingStrategy.properties.fixedBid.$ref - schemas.BiddingStrategy.properties.fixedBid.description - schemas.BiddingStrategy.properties.maximizeSpendAutoBid.$ref - schemas.BiddingStrategy.properties.maximizeSpendAutoBid.description - schemas.BiddingStrategy.properties.performanceGoalAutoBid.$ref - schemas.BiddingStrategy.properties.performanceGoalAutoBid.description - schemas.BiddingStrategy.properties.youtubeAndPartnersBid.$ref - schemas.BiddingStrategy.properties.youtubeAndPartnersBid.description - schemas.BiddingStrategy.type - schemas.BrowserAssignedTargetingOptionDetails.description - schemas.BrowserAssignedTargetingOptionDetails.id - schemas.BrowserAssignedTargetingOptionDetails.properties.displayName.description - schemas.BrowserAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.BrowserAssignedTargetingOptionDetails.properties.displayName.type - schemas.BrowserAssignedTargetingOptionDetails.properties.negative.description - schemas.BrowserAssignedTargetingOptionDetails.properties.negative.type - schemas.BrowserAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.BrowserAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.BrowserAssignedTargetingOptionDetails.type - schemas.BrowserTargetingOptionDetails.description - schemas.BrowserTargetingOptionDetails.id - schemas.BrowserTargetingOptionDetails.properties.displayName.description - schemas.BrowserTargetingOptionDetails.properties.displayName.readOnly - schemas.BrowserTargetingOptionDetails.properties.displayName.type - schemas.BrowserTargetingOptionDetails.type - schemas.BudgetSummary.description - schemas.BudgetSummary.id - schemas.BudgetSummary.properties.externalBudgetId.description - schemas.BudgetSummary.properties.externalBudgetId.type - schemas.BudgetSummary.properties.preTaxAmountMicros.description - schemas.BudgetSummary.properties.preTaxAmountMicros.format - schemas.BudgetSummary.properties.preTaxAmountMicros.type - schemas.BudgetSummary.properties.prismaCpeCode.$ref - schemas.BudgetSummary.properties.prismaCpeCode.description - schemas.BudgetSummary.properties.taxAmountMicros.description - schemas.BudgetSummary.properties.taxAmountMicros.format - schemas.BudgetSummary.properties.taxAmountMicros.type - schemas.BudgetSummary.properties.totalAmountMicros.description - schemas.BudgetSummary.properties.totalAmountMicros.format - schemas.BudgetSummary.properties.totalAmountMicros.type - schemas.BudgetSummary.type - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.description - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.id - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.properties.createRequests.description - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.properties.createRequests.items.$ref - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.properties.createRequests.type - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.properties.deleteRequests.description - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.properties.deleteRequests.items.$ref - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.properties.deleteRequests.type - schemas.BulkEditAdvertiserAssignedTargetingOptionsRequest.type - schemas.BulkEditAdvertiserAssignedTargetingOptionsResponse.id - schemas.BulkEditAdvertiserAssignedTargetingOptionsResponse.properties.createdAssignedTargetingOptions.description - schemas.BulkEditAdvertiserAssignedTargetingOptionsResponse.properties.createdAssignedTargetingOptions.items.$ref - schemas.BulkEditAdvertiserAssignedTargetingOptionsResponse.properties.createdAssignedTargetingOptions.type - schemas.BulkEditAdvertiserAssignedTargetingOptionsResponse.type - schemas.BulkEditAssignedInventorySourcesRequest.description - schemas.BulkEditAssignedInventorySourcesRequest.id - schemas.BulkEditAssignedInventorySourcesRequest.properties.advertiserId.description - schemas.BulkEditAssignedInventorySourcesRequest.properties.advertiserId.format - schemas.BulkEditAssignedInventorySourcesRequest.properties.advertiserId.type - schemas.BulkEditAssignedInventorySourcesRequest.properties.createdAssignedInventorySources.description - schemas.BulkEditAssignedInventorySourcesRequest.properties.createdAssignedInventorySources.items.$ref - schemas.BulkEditAssignedInventorySourcesRequest.properties.createdAssignedInventorySources.type - schemas.BulkEditAssignedInventorySourcesRequest.properties.deletedAssignedInventorySources.description - schemas.BulkEditAssignedInventorySourcesRequest.properties.deletedAssignedInventorySources.items.format - schemas.BulkEditAssignedInventorySourcesRequest.properties.deletedAssignedInventorySources.items.type - schemas.BulkEditAssignedInventorySourcesRequest.properties.deletedAssignedInventorySources.type - schemas.BulkEditAssignedInventorySourcesRequest.properties.partnerId.description - schemas.BulkEditAssignedInventorySourcesRequest.properties.partnerId.format - schemas.BulkEditAssignedInventorySourcesRequest.properties.partnerId.type - schemas.BulkEditAssignedInventorySourcesRequest.type - schemas.BulkEditAssignedInventorySourcesResponse.description - schemas.BulkEditAssignedInventorySourcesResponse.id - schemas.BulkEditAssignedInventorySourcesResponse.properties.assignedInventorySources.description - schemas.BulkEditAssignedInventorySourcesResponse.properties.assignedInventorySources.items.$ref - schemas.BulkEditAssignedInventorySourcesResponse.properties.assignedInventorySources.type - schemas.BulkEditAssignedInventorySourcesResponse.type - schemas.BulkEditAssignedLocationsRequest.description - schemas.BulkEditAssignedLocationsRequest.id - schemas.BulkEditAssignedLocationsRequest.properties.createdAssignedLocations.description - schemas.BulkEditAssignedLocationsRequest.properties.createdAssignedLocations.items.$ref - schemas.BulkEditAssignedLocationsRequest.properties.createdAssignedLocations.type - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.description - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.items.format - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.items.type - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.type - schemas.BulkEditAssignedLocationsRequest.type - schemas.BulkEditAssignedLocationsResponse.id - schemas.BulkEditAssignedLocationsResponse.properties.assignedLocations.description - schemas.BulkEditAssignedLocationsResponse.properties.assignedLocations.items.$ref - schemas.BulkEditAssignedLocationsResponse.properties.assignedLocations.type - schemas.BulkEditAssignedLocationsResponse.type - schemas.BulkEditAssignedTargetingOptionsRequest.description - schemas.BulkEditAssignedTargetingOptionsRequest.id - schemas.BulkEditAssignedTargetingOptionsRequest.properties.createRequests.description - schemas.BulkEditAssignedTargetingOptionsRequest.properties.createRequests.items.$ref - schemas.BulkEditAssignedTargetingOptionsRequest.properties.createRequests.type - schemas.BulkEditAssignedTargetingOptionsRequest.properties.deleteRequests.description - schemas.BulkEditAssignedTargetingOptionsRequest.properties.deleteRequests.items.$ref - schemas.BulkEditAssignedTargetingOptionsRequest.properties.deleteRequests.type - schemas.BulkEditAssignedTargetingOptionsRequest.properties.lineItemIds.description - schemas.BulkEditAssignedTargetingOptionsRequest.properties.lineItemIds.items.format - schemas.BulkEditAssignedTargetingOptionsRequest.properties.lineItemIds.items.type - schemas.BulkEditAssignedTargetingOptionsRequest.properties.lineItemIds.type - schemas.BulkEditAssignedTargetingOptionsRequest.type - schemas.BulkEditAssignedTargetingOptionsResponse.id - schemas.BulkEditAssignedTargetingOptionsResponse.properties.errors.description - schemas.BulkEditAssignedTargetingOptionsResponse.properties.errors.items.$ref - schemas.BulkEditAssignedTargetingOptionsResponse.properties.errors.type - schemas.BulkEditAssignedTargetingOptionsResponse.properties.failedLineItemIds.description - schemas.BulkEditAssignedTargetingOptionsResponse.properties.failedLineItemIds.items.format - schemas.BulkEditAssignedTargetingOptionsResponse.properties.failedLineItemIds.items.type - schemas.BulkEditAssignedTargetingOptionsResponse.properties.failedLineItemIds.readOnly - schemas.BulkEditAssignedTargetingOptionsResponse.properties.failedLineItemIds.type - schemas.BulkEditAssignedTargetingOptionsResponse.properties.updatedLineItemIds.description - schemas.BulkEditAssignedTargetingOptionsResponse.properties.updatedLineItemIds.items.format - schemas.BulkEditAssignedTargetingOptionsResponse.properties.updatedLineItemIds.items.type - schemas.BulkEditAssignedTargetingOptionsResponse.properties.updatedLineItemIds.readOnly - schemas.BulkEditAssignedTargetingOptionsResponse.properties.updatedLineItemIds.type - schemas.BulkEditAssignedTargetingOptionsResponse.type - schemas.BulkEditAssignedUserRolesRequest.description - schemas.BulkEditAssignedUserRolesRequest.id - schemas.BulkEditAssignedUserRolesRequest.properties.createdAssignedUserRoles.description - schemas.BulkEditAssignedUserRolesRequest.properties.createdAssignedUserRoles.items.$ref - schemas.BulkEditAssignedUserRolesRequest.properties.createdAssignedUserRoles.type - schemas.BulkEditAssignedUserRolesRequest.properties.deletedAssignedUserRoles.description - schemas.BulkEditAssignedUserRolesRequest.properties.deletedAssignedUserRoles.items.type - schemas.BulkEditAssignedUserRolesRequest.properties.deletedAssignedUserRoles.type - schemas.BulkEditAssignedUserRolesRequest.type - schemas.BulkEditAssignedUserRolesResponse.id - schemas.BulkEditAssignedUserRolesResponse.properties.createdAssignedUserRoles.description - schemas.BulkEditAssignedUserRolesResponse.properties.createdAssignedUserRoles.items.$ref - schemas.BulkEditAssignedUserRolesResponse.properties.createdAssignedUserRoles.type - schemas.BulkEditAssignedUserRolesResponse.type - schemas.BulkEditNegativeKeywordsRequest.description - schemas.BulkEditNegativeKeywordsRequest.id - schemas.BulkEditNegativeKeywordsRequest.properties.createdNegativeKeywords.description - schemas.BulkEditNegativeKeywordsRequest.properties.createdNegativeKeywords.items.$ref - schemas.BulkEditNegativeKeywordsRequest.properties.createdNegativeKeywords.type - schemas.BulkEditNegativeKeywordsRequest.properties.deletedNegativeKeywords.description - schemas.BulkEditNegativeKeywordsRequest.properties.deletedNegativeKeywords.items.type - schemas.BulkEditNegativeKeywordsRequest.properties.deletedNegativeKeywords.type - schemas.BulkEditNegativeKeywordsRequest.type - schemas.BulkEditNegativeKeywordsResponse.description - schemas.BulkEditNegativeKeywordsResponse.id - schemas.BulkEditNegativeKeywordsResponse.properties.negativeKeywords.description - schemas.BulkEditNegativeKeywordsResponse.properties.negativeKeywords.items.$ref - schemas.BulkEditNegativeKeywordsResponse.properties.negativeKeywords.type - schemas.BulkEditNegativeKeywordsResponse.type - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.description - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.id - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.properties.createRequests.description - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.properties.createRequests.items.$ref - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.properties.createRequests.type - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.properties.deleteRequests.description - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.properties.deleteRequests.items.$ref - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.properties.deleteRequests.type - schemas.BulkEditPartnerAssignedTargetingOptionsRequest.type - schemas.BulkEditPartnerAssignedTargetingOptionsResponse.id - schemas.BulkEditPartnerAssignedTargetingOptionsResponse.properties.createdAssignedTargetingOptions.description - schemas.BulkEditPartnerAssignedTargetingOptionsResponse.properties.createdAssignedTargetingOptions.items.$ref - schemas.BulkEditPartnerAssignedTargetingOptionsResponse.properties.createdAssignedTargetingOptions.type - schemas.BulkEditPartnerAssignedTargetingOptionsResponse.type - schemas.BulkEditSitesRequest.description - schemas.BulkEditSitesRequest.id - schemas.BulkEditSitesRequest.properties.advertiserId.description - schemas.BulkEditSitesRequest.properties.advertiserId.format - schemas.BulkEditSitesRequest.properties.advertiserId.type - schemas.BulkEditSitesRequest.properties.createdSites.description - schemas.BulkEditSitesRequest.properties.createdSites.items.$ref - schemas.BulkEditSitesRequest.properties.createdSites.type - schemas.BulkEditSitesRequest.properties.deletedSites.description - schemas.BulkEditSitesRequest.properties.deletedSites.items.type - schemas.BulkEditSitesRequest.properties.deletedSites.type - schemas.BulkEditSitesRequest.properties.partnerId.description - schemas.BulkEditSitesRequest.properties.partnerId.format - schemas.BulkEditSitesRequest.properties.partnerId.type - schemas.BulkEditSitesRequest.type - schemas.BulkEditSitesResponse.description - schemas.BulkEditSitesResponse.id - schemas.BulkEditSitesResponse.properties.sites.description - schemas.BulkEditSitesResponse.properties.sites.items.$ref - schemas.BulkEditSitesResponse.properties.sites.type - schemas.BulkEditSitesResponse.type - schemas.BulkListAdGroupAssignedTargetingOptionsResponse.id - schemas.BulkListAdGroupAssignedTargetingOptionsResponse.properties.adGroupAssignedTargetingOptions.description - schemas.BulkListAdGroupAssignedTargetingOptionsResponse.properties.adGroupAssignedTargetingOptions.items.$ref - schemas.BulkListAdGroupAssignedTargetingOptionsResponse.properties.adGroupAssignedTargetingOptions.type - schemas.BulkListAdGroupAssignedTargetingOptionsResponse.properties.nextPageToken.description - schemas.BulkListAdGroupAssignedTargetingOptionsResponse.properties.nextPageToken.type - schemas.BulkListAdGroupAssignedTargetingOptionsResponse.type - schemas.BulkListAdvertiserAssignedTargetingOptionsResponse.id - schemas.BulkListAdvertiserAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.description - schemas.BulkListAdvertiserAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.items.$ref - schemas.BulkListAdvertiserAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.type - schemas.BulkListAdvertiserAssignedTargetingOptionsResponse.properties.nextPageToken.description - schemas.BulkListAdvertiserAssignedTargetingOptionsResponse.properties.nextPageToken.type - schemas.BulkListAdvertiserAssignedTargetingOptionsResponse.type - schemas.BulkListAssignedTargetingOptionsResponse.id - schemas.BulkListAssignedTargetingOptionsResponse.properties.lineItemAssignedTargetingOptions.description - schemas.BulkListAssignedTargetingOptionsResponse.properties.lineItemAssignedTargetingOptions.items.$ref - schemas.BulkListAssignedTargetingOptionsResponse.properties.lineItemAssignedTargetingOptions.type - schemas.BulkListAssignedTargetingOptionsResponse.properties.nextPageToken.description - schemas.BulkListAssignedTargetingOptionsResponse.properties.nextPageToken.type - schemas.BulkListAssignedTargetingOptionsResponse.type - schemas.BulkUpdateLineItemsRequest.description - schemas.BulkUpdateLineItemsRequest.id - schemas.BulkUpdateLineItemsRequest.properties.lineItemIds.description - schemas.BulkUpdateLineItemsRequest.properties.lineItemIds.items.format - schemas.BulkUpdateLineItemsRequest.properties.lineItemIds.items.type - schemas.BulkUpdateLineItemsRequest.properties.lineItemIds.type - schemas.BulkUpdateLineItemsRequest.properties.targetLineItem.$ref - schemas.BulkUpdateLineItemsRequest.properties.targetLineItem.description - schemas.BulkUpdateLineItemsRequest.properties.updateMask.description - schemas.BulkUpdateLineItemsRequest.properties.updateMask.format - schemas.BulkUpdateLineItemsRequest.properties.updateMask.type - schemas.BulkUpdateLineItemsRequest.type - schemas.BulkUpdateLineItemsResponse.description - schemas.BulkUpdateLineItemsResponse.id - schemas.BulkUpdateLineItemsResponse.properties.errors.description - schemas.BulkUpdateLineItemsResponse.properties.errors.items.$ref - schemas.BulkUpdateLineItemsResponse.properties.errors.type - schemas.BulkUpdateLineItemsResponse.properties.failedLineItemIds.description - schemas.BulkUpdateLineItemsResponse.properties.failedLineItemIds.items.format - schemas.BulkUpdateLineItemsResponse.properties.failedLineItemIds.items.type - schemas.BulkUpdateLineItemsResponse.properties.failedLineItemIds.type - schemas.BulkUpdateLineItemsResponse.properties.skippedLineItemIds.description - schemas.BulkUpdateLineItemsResponse.properties.skippedLineItemIds.items.format - schemas.BulkUpdateLineItemsResponse.properties.skippedLineItemIds.items.type - schemas.BulkUpdateLineItemsResponse.properties.skippedLineItemIds.type - schemas.BulkUpdateLineItemsResponse.properties.updatedLineItemIds.description - schemas.BulkUpdateLineItemsResponse.properties.updatedLineItemIds.items.format - schemas.BulkUpdateLineItemsResponse.properties.updatedLineItemIds.items.type - schemas.BulkUpdateLineItemsResponse.properties.updatedLineItemIds.type - schemas.BulkUpdateLineItemsResponse.type - schemas.BumperAd.description - schemas.BumperAd.id - schemas.BumperAd.properties.commonInStreamAttribute.$ref - schemas.BumperAd.properties.commonInStreamAttribute.description - schemas.BumperAd.type - schemas.BusinessChainAssignedTargetingOptionDetails.description - schemas.BusinessChainAssignedTargetingOptionDetails.id - schemas.BusinessChainAssignedTargetingOptionDetails.properties.displayName.description - schemas.BusinessChainAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.BusinessChainAssignedTargetingOptionDetails.properties.displayName.type - schemas.BusinessChainAssignedTargetingOptionDetails.properties.proximityRadiusAmount.description - schemas.BusinessChainAssignedTargetingOptionDetails.properties.proximityRadiusAmount.format - schemas.BusinessChainAssignedTargetingOptionDetails.properties.proximityRadiusAmount.type - schemas.BusinessChainAssignedTargetingOptionDetails.properties.proximityRadiusUnit.description - schemas.BusinessChainAssignedTargetingOptionDetails.properties.proximityRadiusUnit.enum - schemas.BusinessChainAssignedTargetingOptionDetails.properties.proximityRadiusUnit.enumDescriptions - schemas.BusinessChainAssignedTargetingOptionDetails.properties.proximityRadiusUnit.type - schemas.BusinessChainAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.BusinessChainAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.BusinessChainAssignedTargetingOptionDetails.type - schemas.BusinessChainSearchTerms.description - schemas.BusinessChainSearchTerms.id - schemas.BusinessChainSearchTerms.properties.businessChainQuery.description - schemas.BusinessChainSearchTerms.properties.businessChainQuery.type - schemas.BusinessChainSearchTerms.properties.regionQuery.description - schemas.BusinessChainSearchTerms.properties.regionQuery.type - schemas.BusinessChainSearchTerms.type - schemas.BusinessChainTargetingOptionDetails.description - schemas.BusinessChainTargetingOptionDetails.id - schemas.BusinessChainTargetingOptionDetails.properties.businessChain.description - schemas.BusinessChainTargetingOptionDetails.properties.businessChain.readOnly - schemas.BusinessChainTargetingOptionDetails.properties.businessChain.type - schemas.BusinessChainTargetingOptionDetails.properties.geoRegion.description - schemas.BusinessChainTargetingOptionDetails.properties.geoRegion.readOnly - schemas.BusinessChainTargetingOptionDetails.properties.geoRegion.type - schemas.BusinessChainTargetingOptionDetails.properties.geoRegionType.description - schemas.BusinessChainTargetingOptionDetails.properties.geoRegionType.enum - schemas.BusinessChainTargetingOptionDetails.properties.geoRegionType.enumDescriptions - schemas.BusinessChainTargetingOptionDetails.properties.geoRegionType.readOnly - schemas.BusinessChainTargetingOptionDetails.properties.geoRegionType.type - schemas.BusinessChainTargetingOptionDetails.type - schemas.Campaign.description - schemas.Campaign.id - schemas.Campaign.properties.advertiserId.description - schemas.Campaign.properties.advertiserId.format - schemas.Campaign.properties.advertiserId.readOnly - schemas.Campaign.properties.advertiserId.type - schemas.Campaign.properties.campaignBudgets.description - schemas.Campaign.properties.campaignBudgets.items.$ref - schemas.Campaign.properties.campaignBudgets.type - schemas.Campaign.properties.campaignFlight.$ref - schemas.Campaign.properties.campaignFlight.description - schemas.Campaign.properties.campaignGoal.$ref - schemas.Campaign.properties.campaignGoal.description - schemas.Campaign.properties.campaignId.description - schemas.Campaign.properties.campaignId.format - schemas.Campaign.properties.campaignId.readOnly - schemas.Campaign.properties.campaignId.type - schemas.Campaign.properties.displayName.description - schemas.Campaign.properties.displayName.type - schemas.Campaign.properties.entityStatus.description - schemas.Campaign.properties.entityStatus.enum - schemas.Campaign.properties.entityStatus.enumDescriptions - schemas.Campaign.properties.entityStatus.type - schemas.Campaign.properties.frequencyCap.$ref - schemas.Campaign.properties.frequencyCap.description - schemas.Campaign.properties.name.description - schemas.Campaign.properties.name.readOnly - schemas.Campaign.properties.name.type - schemas.Campaign.properties.updateTime.description - schemas.Campaign.properties.updateTime.format - schemas.Campaign.properties.updateTime.readOnly - schemas.Campaign.properties.updateTime.type - schemas.Campaign.type - schemas.CampaignBudget.description - schemas.CampaignBudget.id - schemas.CampaignBudget.properties.budgetAmountMicros.description - schemas.CampaignBudget.properties.budgetAmountMicros.format - schemas.CampaignBudget.properties.budgetAmountMicros.type - schemas.CampaignBudget.properties.budgetId.description - schemas.CampaignBudget.properties.budgetId.format - schemas.CampaignBudget.properties.budgetId.type - schemas.CampaignBudget.properties.budgetUnit.description - schemas.CampaignBudget.properties.budgetUnit.enum - schemas.CampaignBudget.properties.budgetUnit.enumDescriptions - schemas.CampaignBudget.properties.budgetUnit.type - schemas.CampaignBudget.properties.dateRange.$ref - schemas.CampaignBudget.properties.dateRange.description - schemas.CampaignBudget.properties.displayName.description - schemas.CampaignBudget.properties.displayName.type - schemas.CampaignBudget.properties.externalBudgetId.description - schemas.CampaignBudget.properties.externalBudgetId.type - schemas.CampaignBudget.properties.externalBudgetSource.description - schemas.CampaignBudget.properties.externalBudgetSource.enum - schemas.CampaignBudget.properties.externalBudgetSource.enumDescriptions - schemas.CampaignBudget.properties.externalBudgetSource.type - schemas.CampaignBudget.properties.invoiceGroupingId.description - schemas.CampaignBudget.properties.invoiceGroupingId.type - schemas.CampaignBudget.properties.prismaConfig.$ref - schemas.CampaignBudget.properties.prismaConfig.description - schemas.CampaignBudget.type - schemas.CampaignFlight.description - schemas.CampaignFlight.id - schemas.CampaignFlight.properties.plannedDates.$ref - schemas.CampaignFlight.properties.plannedDates.description - schemas.CampaignFlight.properties.plannedSpendAmountMicros.description - schemas.CampaignFlight.properties.plannedSpendAmountMicros.format - schemas.CampaignFlight.properties.plannedSpendAmountMicros.type - schemas.CampaignFlight.type - schemas.CampaignGoal.description - schemas.CampaignGoal.id - schemas.CampaignGoal.properties.campaignGoalType.description - schemas.CampaignGoal.properties.campaignGoalType.enum - schemas.CampaignGoal.properties.campaignGoalType.enumDescriptions - schemas.CampaignGoal.properties.campaignGoalType.type - schemas.CampaignGoal.properties.performanceGoal.$ref - schemas.CampaignGoal.properties.performanceGoal.description - schemas.CampaignGoal.type - schemas.CarrierAndIspAssignedTargetingOptionDetails.description - schemas.CarrierAndIspAssignedTargetingOptionDetails.id - schemas.CarrierAndIspAssignedTargetingOptionDetails.properties.displayName.description - schemas.CarrierAndIspAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.CarrierAndIspAssignedTargetingOptionDetails.properties.displayName.type - schemas.CarrierAndIspAssignedTargetingOptionDetails.properties.negative.description - schemas.CarrierAndIspAssignedTargetingOptionDetails.properties.negative.type - schemas.CarrierAndIspAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.CarrierAndIspAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.CarrierAndIspAssignedTargetingOptionDetails.type - schemas.CarrierAndIspTargetingOptionDetails.description - schemas.CarrierAndIspTargetingOptionDetails.id - schemas.CarrierAndIspTargetingOptionDetails.properties.displayName.description - schemas.CarrierAndIspTargetingOptionDetails.properties.displayName.readOnly - schemas.CarrierAndIspTargetingOptionDetails.properties.displayName.type - schemas.CarrierAndIspTargetingOptionDetails.properties.type.description - schemas.CarrierAndIspTargetingOptionDetails.properties.type.enum - schemas.CarrierAndIspTargetingOptionDetails.properties.type.enumDescriptions - schemas.CarrierAndIspTargetingOptionDetails.properties.type.readOnly - schemas.CarrierAndIspTargetingOptionDetails.properties.type.type - schemas.CarrierAndIspTargetingOptionDetails.type - schemas.CategoryAssignedTargetingOptionDetails.description - schemas.CategoryAssignedTargetingOptionDetails.id - schemas.CategoryAssignedTargetingOptionDetails.properties.displayName.description - schemas.CategoryAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.CategoryAssignedTargetingOptionDetails.properties.displayName.type - schemas.CategoryAssignedTargetingOptionDetails.properties.negative.description - schemas.CategoryAssignedTargetingOptionDetails.properties.negative.type - schemas.CategoryAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.CategoryAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.CategoryAssignedTargetingOptionDetails.type - schemas.CategoryTargetingOptionDetails.description - schemas.CategoryTargetingOptionDetails.id - schemas.CategoryTargetingOptionDetails.properties.displayName.description - schemas.CategoryTargetingOptionDetails.properties.displayName.readOnly - schemas.CategoryTargetingOptionDetails.properties.displayName.type - schemas.CategoryTargetingOptionDetails.type - schemas.Channel.description - schemas.Channel.id - schemas.Channel.properties.advertiserId.description - schemas.Channel.properties.advertiserId.format - schemas.Channel.properties.advertiserId.type - schemas.Channel.properties.channelId.description - schemas.Channel.properties.channelId.format - schemas.Channel.properties.channelId.readOnly - schemas.Channel.properties.channelId.type - schemas.Channel.properties.displayName.description - schemas.Channel.properties.displayName.type - schemas.Channel.properties.name.description - schemas.Channel.properties.name.readOnly - schemas.Channel.properties.name.type - schemas.Channel.properties.negativelyTargetedLineItemCount.description - schemas.Channel.properties.negativelyTargetedLineItemCount.format - schemas.Channel.properties.negativelyTargetedLineItemCount.readOnly - schemas.Channel.properties.negativelyTargetedLineItemCount.type - schemas.Channel.properties.partnerId.description - schemas.Channel.properties.partnerId.format - schemas.Channel.properties.partnerId.type - schemas.Channel.properties.positivelyTargetedLineItemCount.description - schemas.Channel.properties.positivelyTargetedLineItemCount.format - schemas.Channel.properties.positivelyTargetedLineItemCount.readOnly - schemas.Channel.properties.positivelyTargetedLineItemCount.type - schemas.Channel.type - schemas.ChannelAssignedTargetingOptionDetails.description - schemas.ChannelAssignedTargetingOptionDetails.id - schemas.ChannelAssignedTargetingOptionDetails.properties.channelId.description - schemas.ChannelAssignedTargetingOptionDetails.properties.channelId.format - schemas.ChannelAssignedTargetingOptionDetails.properties.channelId.type - schemas.ChannelAssignedTargetingOptionDetails.properties.negative.description - schemas.ChannelAssignedTargetingOptionDetails.properties.negative.type - schemas.ChannelAssignedTargetingOptionDetails.type - schemas.CmHybridConfig.description - schemas.CmHybridConfig.id - schemas.CmHybridConfig.properties.cmAccountId.description - schemas.CmHybridConfig.properties.cmAccountId.format - schemas.CmHybridConfig.properties.cmAccountId.type - schemas.CmHybridConfig.properties.cmAdvertiserIds.description - schemas.CmHybridConfig.properties.cmAdvertiserIds.items.format - schemas.CmHybridConfig.properties.cmAdvertiserIds.items.type - schemas.CmHybridConfig.properties.cmAdvertiserIds.readOnly - schemas.CmHybridConfig.properties.cmAdvertiserIds.type - schemas.CmHybridConfig.properties.cmFloodlightConfigId.description - schemas.CmHybridConfig.properties.cmFloodlightConfigId.format - schemas.CmHybridConfig.properties.cmFloodlightConfigId.type - schemas.CmHybridConfig.properties.cmFloodlightLinkingAuthorized.description - schemas.CmHybridConfig.properties.cmFloodlightLinkingAuthorized.type - schemas.CmHybridConfig.properties.cmSyncableSiteIds.description - schemas.CmHybridConfig.properties.cmSyncableSiteIds.items.format - schemas.CmHybridConfig.properties.cmSyncableSiteIds.items.type - schemas.CmHybridConfig.properties.cmSyncableSiteIds.type - schemas.CmHybridConfig.properties.dv360ToCmCostReportingEnabled.description - schemas.CmHybridConfig.properties.dv360ToCmCostReportingEnabled.type - schemas.CmHybridConfig.properties.dv360ToCmDataSharingEnabled.description - schemas.CmHybridConfig.properties.dv360ToCmDataSharingEnabled.type - schemas.CmHybridConfig.type - schemas.CmTrackingAd.description - schemas.CmTrackingAd.id - schemas.CmTrackingAd.properties.cmAdId.description - schemas.CmTrackingAd.properties.cmAdId.format - schemas.CmTrackingAd.properties.cmAdId.type - schemas.CmTrackingAd.properties.cmCreativeId.description - schemas.CmTrackingAd.properties.cmCreativeId.format - schemas.CmTrackingAd.properties.cmCreativeId.type - schemas.CmTrackingAd.properties.cmPlacementId.description - schemas.CmTrackingAd.properties.cmPlacementId.format - schemas.CmTrackingAd.properties.cmPlacementId.type - schemas.CmTrackingAd.type - schemas.CombinedAudience.description - schemas.CombinedAudience.id - schemas.CombinedAudience.properties.combinedAudienceId.description - schemas.CombinedAudience.properties.combinedAudienceId.format - schemas.CombinedAudience.properties.combinedAudienceId.readOnly - schemas.CombinedAudience.properties.combinedAudienceId.type - schemas.CombinedAudience.properties.displayName.description - schemas.CombinedAudience.properties.displayName.readOnly - schemas.CombinedAudience.properties.displayName.type - schemas.CombinedAudience.properties.name.description - schemas.CombinedAudience.properties.name.readOnly - schemas.CombinedAudience.properties.name.type - schemas.CombinedAudience.type - schemas.CombinedAudienceGroup.description - schemas.CombinedAudienceGroup.id - schemas.CombinedAudienceGroup.properties.settings.description - schemas.CombinedAudienceGroup.properties.settings.items.$ref - schemas.CombinedAudienceGroup.properties.settings.type - schemas.CombinedAudienceGroup.type - schemas.CombinedAudienceTargetingSetting.description - schemas.CombinedAudienceTargetingSetting.id - schemas.CombinedAudienceTargetingSetting.properties.combinedAudienceId.description - schemas.CombinedAudienceTargetingSetting.properties.combinedAudienceId.format - schemas.CombinedAudienceTargetingSetting.properties.combinedAudienceId.type - schemas.CombinedAudienceTargetingSetting.type - schemas.CommonInStreamAttribute.description - schemas.CommonInStreamAttribute.id - schemas.CommonInStreamAttribute.properties.actionButtonLabel.description - schemas.CommonInStreamAttribute.properties.actionButtonLabel.type - schemas.CommonInStreamAttribute.properties.actionHeadline.description - schemas.CommonInStreamAttribute.properties.actionHeadline.type - schemas.CommonInStreamAttribute.properties.companionBanner.$ref - schemas.CommonInStreamAttribute.properties.companionBanner.description - schemas.CommonInStreamAttribute.properties.displayUrl.description - schemas.CommonInStreamAttribute.properties.displayUrl.type - schemas.CommonInStreamAttribute.properties.finalUrl.description - schemas.CommonInStreamAttribute.properties.finalUrl.type - schemas.CommonInStreamAttribute.properties.trackingUrl.description - schemas.CommonInStreamAttribute.properties.trackingUrl.type - schemas.CommonInStreamAttribute.properties.video.$ref - schemas.CommonInStreamAttribute.properties.video.description - schemas.CommonInStreamAttribute.type - schemas.Consent.description - schemas.Consent.id - schemas.Consent.properties.adPersonalization.description - schemas.Consent.properties.adPersonalization.enum - schemas.Consent.properties.adPersonalization.enumDescriptions - schemas.Consent.properties.adPersonalization.type - schemas.Consent.properties.adUserData.description - schemas.Consent.properties.adUserData.enum - schemas.Consent.properties.adUserData.enumDescriptions - schemas.Consent.properties.adUserData.type - schemas.Consent.type - schemas.ContactInfo.description - schemas.ContactInfo.id - schemas.ContactInfo.properties.countryCode.description - schemas.ContactInfo.properties.countryCode.type - schemas.ContactInfo.properties.hashedEmails.description - schemas.ContactInfo.properties.hashedEmails.items.type - schemas.ContactInfo.properties.hashedEmails.type - schemas.ContactInfo.properties.hashedFirstName.description - schemas.ContactInfo.properties.hashedFirstName.type - schemas.ContactInfo.properties.hashedLastName.description - schemas.ContactInfo.properties.hashedLastName.type - schemas.ContactInfo.properties.hashedPhoneNumbers.description - schemas.ContactInfo.properties.hashedPhoneNumbers.items.type - schemas.ContactInfo.properties.hashedPhoneNumbers.type - schemas.ContactInfo.properties.zipCodes.description - schemas.ContactInfo.properties.zipCodes.items.type - schemas.ContactInfo.properties.zipCodes.type - schemas.ContactInfo.type - schemas.ContactInfoList.description - schemas.ContactInfoList.id - schemas.ContactInfoList.properties.consent.$ref - schemas.ContactInfoList.properties.consent.description - schemas.ContactInfoList.properties.contactInfos.description - schemas.ContactInfoList.properties.contactInfos.items.$ref - schemas.ContactInfoList.properties.contactInfos.type - schemas.ContactInfoList.type - schemas.ContentDurationAssignedTargetingOptionDetails.description - schemas.ContentDurationAssignedTargetingOptionDetails.id - schemas.ContentDurationAssignedTargetingOptionDetails.properties.contentDuration.description - schemas.ContentDurationAssignedTargetingOptionDetails.properties.contentDuration.enum - schemas.ContentDurationAssignedTargetingOptionDetails.properties.contentDuration.enumDescriptions - schemas.ContentDurationAssignedTargetingOptionDetails.properties.contentDuration.readOnly - schemas.ContentDurationAssignedTargetingOptionDetails.properties.contentDuration.type - schemas.ContentDurationAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.ContentDurationAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.ContentDurationAssignedTargetingOptionDetails.type - schemas.ContentDurationTargetingOptionDetails.description - schemas.ContentDurationTargetingOptionDetails.id - schemas.ContentDurationTargetingOptionDetails.properties.contentDuration.description - schemas.ContentDurationTargetingOptionDetails.properties.contentDuration.enum - schemas.ContentDurationTargetingOptionDetails.properties.contentDuration.enumDescriptions - schemas.ContentDurationTargetingOptionDetails.properties.contentDuration.readOnly - schemas.ContentDurationTargetingOptionDetails.properties.contentDuration.type - schemas.ContentDurationTargetingOptionDetails.type - schemas.ContentGenreAssignedTargetingOptionDetails.description - schemas.ContentGenreAssignedTargetingOptionDetails.id - schemas.ContentGenreAssignedTargetingOptionDetails.properties.displayName.description - schemas.ContentGenreAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.ContentGenreAssignedTargetingOptionDetails.properties.displayName.type - schemas.ContentGenreAssignedTargetingOptionDetails.properties.negative.description - schemas.ContentGenreAssignedTargetingOptionDetails.properties.negative.type - schemas.ContentGenreAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.ContentGenreAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.ContentGenreAssignedTargetingOptionDetails.type - schemas.ContentGenreTargetingOptionDetails.description - schemas.ContentGenreTargetingOptionDetails.id - schemas.ContentGenreTargetingOptionDetails.properties.displayName.description - schemas.ContentGenreTargetingOptionDetails.properties.displayName.readOnly - schemas.ContentGenreTargetingOptionDetails.properties.displayName.type - schemas.ContentGenreTargetingOptionDetails.type - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.description - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.id - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.adType.description - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.adType.enum - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.adType.enumDescriptions - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.adType.readOnly - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.adType.type - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.contentInstreamPosition.description - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.contentInstreamPosition.enum - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.contentInstreamPosition.enumDescriptions - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.contentInstreamPosition.type - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.type - schemas.ContentInstreamPositionTargetingOptionDetails.description - schemas.ContentInstreamPositionTargetingOptionDetails.id - schemas.ContentInstreamPositionTargetingOptionDetails.properties.contentInstreamPosition.description - schemas.ContentInstreamPositionTargetingOptionDetails.properties.contentInstreamPosition.enum - schemas.ContentInstreamPositionTargetingOptionDetails.properties.contentInstreamPosition.enumDescriptions - schemas.ContentInstreamPositionTargetingOptionDetails.properties.contentInstreamPosition.readOnly - schemas.ContentInstreamPositionTargetingOptionDetails.properties.contentInstreamPosition.type - schemas.ContentInstreamPositionTargetingOptionDetails.type - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.description - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.id - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.adType.description - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.adType.enum - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.adType.enumDescriptions - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.adType.readOnly - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.adType.type - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.contentOutstreamPosition.description - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.contentOutstreamPosition.enum - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.contentOutstreamPosition.enumDescriptions - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.contentOutstreamPosition.type - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.type - schemas.ContentOutstreamPositionTargetingOptionDetails.description - schemas.ContentOutstreamPositionTargetingOptionDetails.id - schemas.ContentOutstreamPositionTargetingOptionDetails.properties.contentOutstreamPosition.description - schemas.ContentOutstreamPositionTargetingOptionDetails.properties.contentOutstreamPosition.enum - schemas.ContentOutstreamPositionTargetingOptionDetails.properties.contentOutstreamPosition.enumDescriptions - schemas.ContentOutstreamPositionTargetingOptionDetails.properties.contentOutstreamPosition.readOnly - schemas.ContentOutstreamPositionTargetingOptionDetails.properties.contentOutstreamPosition.type - schemas.ContentOutstreamPositionTargetingOptionDetails.type - schemas.ContentStreamTypeAssignedTargetingOptionDetails.description - schemas.ContentStreamTypeAssignedTargetingOptionDetails.id - schemas.ContentStreamTypeAssignedTargetingOptionDetails.properties.contentStreamType.description - schemas.ContentStreamTypeAssignedTargetingOptionDetails.properties.contentStreamType.enum - schemas.ContentStreamTypeAssignedTargetingOptionDetails.properties.contentStreamType.enumDescriptions - schemas.ContentStreamTypeAssignedTargetingOptionDetails.properties.contentStreamType.readOnly - schemas.ContentStreamTypeAssignedTargetingOptionDetails.properties.contentStreamType.type - schemas.ContentStreamTypeAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.ContentStreamTypeAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.ContentStreamTypeAssignedTargetingOptionDetails.type - schemas.ContentStreamTypeTargetingOptionDetails.description - schemas.ContentStreamTypeTargetingOptionDetails.id - schemas.ContentStreamTypeTargetingOptionDetails.properties.contentStreamType.description - schemas.ContentStreamTypeTargetingOptionDetails.properties.contentStreamType.enum - schemas.ContentStreamTypeTargetingOptionDetails.properties.contentStreamType.enumDescriptions - schemas.ContentStreamTypeTargetingOptionDetails.properties.contentStreamType.readOnly - schemas.ContentStreamTypeTargetingOptionDetails.properties.contentStreamType.type - schemas.ContentStreamTypeTargetingOptionDetails.type - schemas.ConversionCountingConfig.description - schemas.ConversionCountingConfig.id - schemas.ConversionCountingConfig.properties.floodlightActivityConfigs.description - schemas.ConversionCountingConfig.properties.floodlightActivityConfigs.items.$ref - schemas.ConversionCountingConfig.properties.floodlightActivityConfigs.type - schemas.ConversionCountingConfig.properties.postViewCountPercentageMillis.description - schemas.ConversionCountingConfig.properties.postViewCountPercentageMillis.format - schemas.ConversionCountingConfig.properties.postViewCountPercentageMillis.type - schemas.ConversionCountingConfig.type - schemas.CounterEvent.description - schemas.CounterEvent.id - schemas.CounterEvent.properties.name.description - schemas.CounterEvent.properties.name.type - schemas.CounterEvent.properties.reportingName.description - schemas.CounterEvent.properties.reportingName.type - schemas.CounterEvent.type - schemas.CreateAssetRequest.description - schemas.CreateAssetRequest.id - schemas.CreateAssetRequest.properties.filename.description - schemas.CreateAssetRequest.properties.filename.type - schemas.CreateAssetRequest.type - schemas.CreateAssetResponse.description - schemas.CreateAssetResponse.id - schemas.CreateAssetResponse.properties.asset.$ref - schemas.CreateAssetResponse.properties.asset.description - schemas.CreateAssetResponse.type - schemas.CreateAssignedTargetingOptionsRequest.description - schemas.CreateAssignedTargetingOptionsRequest.id - schemas.CreateAssignedTargetingOptionsRequest.properties.assignedTargetingOptions.description - schemas.CreateAssignedTargetingOptionsRequest.properties.assignedTargetingOptions.items.$ref - schemas.CreateAssignedTargetingOptionsRequest.properties.assignedTargetingOptions.type - schemas.CreateAssignedTargetingOptionsRequest.properties.targetingType.description - schemas.CreateAssignedTargetingOptionsRequest.properties.targetingType.enum - schemas.CreateAssignedTargetingOptionsRequest.properties.targetingType.enumDescriptions - schemas.CreateAssignedTargetingOptionsRequest.properties.targetingType.type - schemas.CreateAssignedTargetingOptionsRequest.type - schemas.CreateSdfDownloadTaskRequest.description - schemas.CreateSdfDownloadTaskRequest.id - schemas.CreateSdfDownloadTaskRequest.properties.advertiserId.description - schemas.CreateSdfDownloadTaskRequest.properties.advertiserId.format - schemas.CreateSdfDownloadTaskRequest.properties.advertiserId.type - schemas.CreateSdfDownloadTaskRequest.properties.idFilter.$ref - schemas.CreateSdfDownloadTaskRequest.properties.idFilter.description - schemas.CreateSdfDownloadTaskRequest.properties.inventorySourceFilter.$ref - schemas.CreateSdfDownloadTaskRequest.properties.inventorySourceFilter.description - schemas.CreateSdfDownloadTaskRequest.properties.parentEntityFilter.$ref - schemas.CreateSdfDownloadTaskRequest.properties.parentEntityFilter.description - schemas.CreateSdfDownloadTaskRequest.properties.partnerId.description - schemas.CreateSdfDownloadTaskRequest.properties.partnerId.format - schemas.CreateSdfDownloadTaskRequest.properties.partnerId.type - schemas.CreateSdfDownloadTaskRequest.properties.version.description - schemas.CreateSdfDownloadTaskRequest.properties.version.enum - schemas.CreateSdfDownloadTaskRequest.properties.version.enumDeprecated - schemas.CreateSdfDownloadTaskRequest.properties.version.enumDescriptions - schemas.CreateSdfDownloadTaskRequest.properties.version.type - schemas.CreateSdfDownloadTaskRequest.type - schemas.Creative.description - schemas.Creative.id - schemas.Creative.properties.additionalDimensions.description - schemas.Creative.properties.additionalDimensions.items.$ref - schemas.Creative.properties.additionalDimensions.type - schemas.Creative.properties.advertiserId.description - schemas.Creative.properties.advertiserId.format - schemas.Creative.properties.advertiserId.readOnly - schemas.Creative.properties.advertiserId.type - schemas.Creative.properties.appendedTag.description - schemas.Creative.properties.appendedTag.type - schemas.Creative.properties.assets.description - schemas.Creative.properties.assets.items.$ref - schemas.Creative.properties.assets.type - schemas.Creative.properties.cmPlacementId.description - schemas.Creative.properties.cmPlacementId.format - schemas.Creative.properties.cmPlacementId.readOnly - schemas.Creative.properties.cmPlacementId.type - schemas.Creative.properties.cmTrackingAd.$ref - schemas.Creative.properties.cmTrackingAd.description - schemas.Creative.properties.companionCreativeIds.description - schemas.Creative.properties.companionCreativeIds.items.format - schemas.Creative.properties.companionCreativeIds.items.type - schemas.Creative.properties.companionCreativeIds.type - schemas.Creative.properties.counterEvents.description - schemas.Creative.properties.counterEvents.items.$ref - schemas.Creative.properties.counterEvents.type - schemas.Creative.properties.createTime.description - schemas.Creative.properties.createTime.format - schemas.Creative.properties.createTime.readOnly - schemas.Creative.properties.createTime.type - schemas.Creative.properties.creativeAttributes.description - schemas.Creative.properties.creativeAttributes.items.enum - schemas.Creative.properties.creativeAttributes.items.enumDescriptions - schemas.Creative.properties.creativeAttributes.items.type - schemas.Creative.properties.creativeAttributes.readOnly - schemas.Creative.properties.creativeAttributes.type - schemas.Creative.properties.creativeId.description - schemas.Creative.properties.creativeId.format - schemas.Creative.properties.creativeId.readOnly - schemas.Creative.properties.creativeId.type - schemas.Creative.properties.creativeType.description - schemas.Creative.properties.creativeType.enum - schemas.Creative.properties.creativeType.enumDescriptions - schemas.Creative.properties.creativeType.type - schemas.Creative.properties.dimensions.$ref - schemas.Creative.properties.dimensions.description - schemas.Creative.properties.displayName.description - schemas.Creative.properties.displayName.type - schemas.Creative.properties.dynamic.description - schemas.Creative.properties.dynamic.readOnly - schemas.Creative.properties.dynamic.type - schemas.Creative.properties.entityStatus.description - schemas.Creative.properties.entityStatus.enum - schemas.Creative.properties.entityStatus.enumDescriptions - schemas.Creative.properties.entityStatus.type - schemas.Creative.properties.exitEvents.description - schemas.Creative.properties.exitEvents.items.$ref - schemas.Creative.properties.exitEvents.type - schemas.Creative.properties.expandOnHover.description - schemas.Creative.properties.expandOnHover.type - schemas.Creative.properties.expandingDirection.description - schemas.Creative.properties.expandingDirection.enum - schemas.Creative.properties.expandingDirection.enumDescriptions - schemas.Creative.properties.expandingDirection.type - schemas.Creative.properties.hostingSource.description - schemas.Creative.properties.hostingSource.enum - schemas.Creative.properties.hostingSource.enumDescriptions - schemas.Creative.properties.hostingSource.type - schemas.Creative.properties.html5Video.description - schemas.Creative.properties.html5Video.readOnly - schemas.Creative.properties.html5Video.type - schemas.Creative.properties.iasCampaignMonitoring.description - schemas.Creative.properties.iasCampaignMonitoring.type - schemas.Creative.properties.integrationCode.description - schemas.Creative.properties.integrationCode.type - schemas.Creative.properties.jsTrackerUrl.description - schemas.Creative.properties.jsTrackerUrl.type - schemas.Creative.properties.lineItemIds.description - schemas.Creative.properties.lineItemIds.items.format - schemas.Creative.properties.lineItemIds.items.type - schemas.Creative.properties.lineItemIds.readOnly - schemas.Creative.properties.lineItemIds.type - schemas.Creative.properties.mediaDuration.description - schemas.Creative.properties.mediaDuration.format - schemas.Creative.properties.mediaDuration.readOnly - schemas.Creative.properties.mediaDuration.type - schemas.Creative.properties.mp3Audio.description - schemas.Creative.properties.mp3Audio.readOnly - schemas.Creative.properties.mp3Audio.type - schemas.Creative.properties.name.description - schemas.Creative.properties.name.readOnly - schemas.Creative.properties.name.type - schemas.Creative.properties.notes.description - schemas.Creative.properties.notes.type - schemas.Creative.properties.obaIcon.$ref - schemas.Creative.properties.obaIcon.description - schemas.Creative.properties.oggAudio.description - schemas.Creative.properties.oggAudio.readOnly - schemas.Creative.properties.oggAudio.type - schemas.Creative.properties.progressOffset.$ref - schemas.Creative.properties.progressOffset.description - schemas.Creative.properties.requireHtml5.description - schemas.Creative.properties.requireHtml5.type - schemas.Creative.properties.requireMraid.description - schemas.Creative.properties.requireMraid.type - schemas.Creative.properties.requirePingForAttribution.description - schemas.Creative.properties.requirePingForAttribution.type - schemas.Creative.properties.reviewStatus.$ref - schemas.Creative.properties.reviewStatus.description - schemas.Creative.properties.reviewStatus.readOnly - schemas.Creative.properties.skipOffset.$ref - schemas.Creative.properties.skipOffset.description - schemas.Creative.properties.skippable.description - schemas.Creative.properties.skippable.type - schemas.Creative.properties.thirdPartyTag.description - schemas.Creative.properties.thirdPartyTag.type - schemas.Creative.properties.thirdPartyUrls.description - schemas.Creative.properties.thirdPartyUrls.items.$ref - schemas.Creative.properties.thirdPartyUrls.type - schemas.Creative.properties.timerEvents.description - schemas.Creative.properties.timerEvents.items.$ref - schemas.Creative.properties.timerEvents.type - schemas.Creative.properties.trackerUrls.description - schemas.Creative.properties.trackerUrls.items.type - schemas.Creative.properties.trackerUrls.type - schemas.Creative.properties.transcodes.description - schemas.Creative.properties.transcodes.items.$ref - schemas.Creative.properties.transcodes.readOnly - schemas.Creative.properties.transcodes.type - schemas.Creative.properties.universalAdId.$ref - schemas.Creative.properties.universalAdId.description - schemas.Creative.properties.updateTime.description - schemas.Creative.properties.updateTime.format - schemas.Creative.properties.updateTime.readOnly - schemas.Creative.properties.updateTime.type - schemas.Creative.properties.vastTagUrl.description - schemas.Creative.properties.vastTagUrl.type - schemas.Creative.properties.vpaid.description - schemas.Creative.properties.vpaid.readOnly - schemas.Creative.properties.vpaid.type - schemas.Creative.type - schemas.CreativeConfig.description - schemas.CreativeConfig.id - schemas.CreativeConfig.properties.creativeType.description - schemas.CreativeConfig.properties.creativeType.enum - schemas.CreativeConfig.properties.creativeType.enumDescriptions - schemas.CreativeConfig.properties.creativeType.type - schemas.CreativeConfig.properties.displayCreativeConfig.$ref - schemas.CreativeConfig.properties.displayCreativeConfig.description - schemas.CreativeConfig.properties.videoCreativeConfig.$ref - schemas.CreativeConfig.properties.videoCreativeConfig.description - schemas.CreativeConfig.type - schemas.CustomBiddingAlgorithm.description - schemas.CustomBiddingAlgorithm.id - schemas.CustomBiddingAlgorithm.properties.advertiserId.description - schemas.CustomBiddingAlgorithm.properties.advertiserId.format - schemas.CustomBiddingAlgorithm.properties.advertiserId.type - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmId.description - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmId.format - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmId.readOnly - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmId.type - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmType.description - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmType.enum - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmType.enumDescriptions - schemas.CustomBiddingAlgorithm.properties.customBiddingAlgorithmType.type - schemas.CustomBiddingAlgorithm.properties.displayName.description - schemas.CustomBiddingAlgorithm.properties.displayName.type - schemas.CustomBiddingAlgorithm.properties.entityStatus.description - schemas.CustomBiddingAlgorithm.properties.entityStatus.enum - schemas.CustomBiddingAlgorithm.properties.entityStatus.enumDescriptions - schemas.CustomBiddingAlgorithm.properties.entityStatus.type - schemas.CustomBiddingAlgorithm.properties.modelDetails.description - schemas.CustomBiddingAlgorithm.properties.modelDetails.items.$ref - schemas.CustomBiddingAlgorithm.properties.modelDetails.readOnly - schemas.CustomBiddingAlgorithm.properties.modelDetails.type - schemas.CustomBiddingAlgorithm.properties.name.description - schemas.CustomBiddingAlgorithm.properties.name.readOnly - schemas.CustomBiddingAlgorithm.properties.name.type - schemas.CustomBiddingAlgorithm.properties.partnerId.description - schemas.CustomBiddingAlgorithm.properties.partnerId.format - schemas.CustomBiddingAlgorithm.properties.partnerId.type - schemas.CustomBiddingAlgorithm.properties.sharedAdvertiserIds.description - schemas.CustomBiddingAlgorithm.properties.sharedAdvertiserIds.items.format - schemas.CustomBiddingAlgorithm.properties.sharedAdvertiserIds.items.type - schemas.CustomBiddingAlgorithm.properties.sharedAdvertiserIds.type - schemas.CustomBiddingAlgorithm.type - schemas.CustomBiddingAlgorithmRules.description - schemas.CustomBiddingAlgorithmRules.id - schemas.CustomBiddingAlgorithmRules.properties.active.description - schemas.CustomBiddingAlgorithmRules.properties.active.readOnly - schemas.CustomBiddingAlgorithmRules.properties.active.type - schemas.CustomBiddingAlgorithmRules.properties.createTime.description - schemas.CustomBiddingAlgorithmRules.properties.createTime.format - schemas.CustomBiddingAlgorithmRules.properties.createTime.readOnly - schemas.CustomBiddingAlgorithmRules.properties.createTime.type - schemas.CustomBiddingAlgorithmRules.properties.customBiddingAlgorithmId.description - schemas.CustomBiddingAlgorithmRules.properties.customBiddingAlgorithmId.format - schemas.CustomBiddingAlgorithmRules.properties.customBiddingAlgorithmId.readOnly - schemas.CustomBiddingAlgorithmRules.properties.customBiddingAlgorithmId.type - schemas.CustomBiddingAlgorithmRules.properties.customBiddingAlgorithmRulesId.description - schemas.CustomBiddingAlgorithmRules.properties.customBiddingAlgorithmRulesId.format - schemas.CustomBiddingAlgorithmRules.properties.customBiddingAlgorithmRulesId.readOnly - schemas.CustomBiddingAlgorithmRules.properties.customBiddingAlgorithmRulesId.type - schemas.CustomBiddingAlgorithmRules.properties.error.$ref - schemas.CustomBiddingAlgorithmRules.properties.error.description - schemas.CustomBiddingAlgorithmRules.properties.error.readOnly - schemas.CustomBiddingAlgorithmRules.properties.name.description - schemas.CustomBiddingAlgorithmRules.properties.name.readOnly - schemas.CustomBiddingAlgorithmRules.properties.name.type - schemas.CustomBiddingAlgorithmRules.properties.rules.$ref - schemas.CustomBiddingAlgorithmRules.properties.rules.description - schemas.CustomBiddingAlgorithmRules.properties.state.description - schemas.CustomBiddingAlgorithmRules.properties.state.enum - schemas.CustomBiddingAlgorithmRules.properties.state.enumDescriptions - schemas.CustomBiddingAlgorithmRules.properties.state.readOnly - schemas.CustomBiddingAlgorithmRules.properties.state.type - schemas.CustomBiddingAlgorithmRules.type - schemas.CustomBiddingAlgorithmRulesError.description - schemas.CustomBiddingAlgorithmRulesError.id - schemas.CustomBiddingAlgorithmRulesError.properties.errorCode.description - schemas.CustomBiddingAlgorithmRulesError.properties.errorCode.enum - schemas.CustomBiddingAlgorithmRulesError.properties.errorCode.enumDescriptions - schemas.CustomBiddingAlgorithmRulesError.properties.errorCode.type - schemas.CustomBiddingAlgorithmRulesError.type - schemas.CustomBiddingAlgorithmRulesRef.description - schemas.CustomBiddingAlgorithmRulesRef.id - schemas.CustomBiddingAlgorithmRulesRef.properties.resourceName.description - schemas.CustomBiddingAlgorithmRulesRef.properties.resourceName.type - schemas.CustomBiddingAlgorithmRulesRef.type - schemas.CustomBiddingModelDetails.description - schemas.CustomBiddingModelDetails.id - schemas.CustomBiddingModelDetails.properties.advertiserId.description - schemas.CustomBiddingModelDetails.properties.advertiserId.format - schemas.CustomBiddingModelDetails.properties.advertiserId.type - schemas.CustomBiddingModelDetails.properties.readinessState.description - schemas.CustomBiddingModelDetails.properties.readinessState.enum - schemas.CustomBiddingModelDetails.properties.readinessState.enumDescriptions - schemas.CustomBiddingModelDetails.properties.readinessState.type - schemas.CustomBiddingModelDetails.properties.suspensionState.description - schemas.CustomBiddingModelDetails.properties.suspensionState.enum - schemas.CustomBiddingModelDetails.properties.suspensionState.enumDescriptions - schemas.CustomBiddingModelDetails.properties.suspensionState.readOnly - schemas.CustomBiddingModelDetails.properties.suspensionState.type - schemas.CustomBiddingModelDetails.type - schemas.CustomBiddingScript.description - schemas.CustomBiddingScript.id - schemas.CustomBiddingScript.properties.active.description - schemas.CustomBiddingScript.properties.active.readOnly - schemas.CustomBiddingScript.properties.active.type - schemas.CustomBiddingScript.properties.createTime.description - schemas.CustomBiddingScript.properties.createTime.format - schemas.CustomBiddingScript.properties.createTime.readOnly - schemas.CustomBiddingScript.properties.createTime.type - schemas.CustomBiddingScript.properties.customBiddingAlgorithmId.description - schemas.CustomBiddingScript.properties.customBiddingAlgorithmId.format - schemas.CustomBiddingScript.properties.customBiddingAlgorithmId.readOnly - schemas.CustomBiddingScript.properties.customBiddingAlgorithmId.type - schemas.CustomBiddingScript.properties.customBiddingScriptId.description - schemas.CustomBiddingScript.properties.customBiddingScriptId.format - schemas.CustomBiddingScript.properties.customBiddingScriptId.readOnly - schemas.CustomBiddingScript.properties.customBiddingScriptId.type - schemas.CustomBiddingScript.properties.errors.description - schemas.CustomBiddingScript.properties.errors.items.$ref - schemas.CustomBiddingScript.properties.errors.readOnly - schemas.CustomBiddingScript.properties.errors.type - schemas.CustomBiddingScript.properties.name.description - schemas.CustomBiddingScript.properties.name.readOnly - schemas.CustomBiddingScript.properties.name.type - schemas.CustomBiddingScript.properties.script.$ref - schemas.CustomBiddingScript.properties.script.description - schemas.CustomBiddingScript.properties.state.description - schemas.CustomBiddingScript.properties.state.enum - schemas.CustomBiddingScript.properties.state.enumDescriptions - schemas.CustomBiddingScript.properties.state.readOnly - schemas.CustomBiddingScript.properties.state.type - schemas.CustomBiddingScript.type - schemas.CustomBiddingScriptRef.description - schemas.CustomBiddingScriptRef.id - schemas.CustomBiddingScriptRef.properties.resourceName.description - schemas.CustomBiddingScriptRef.properties.resourceName.type - schemas.CustomBiddingScriptRef.type - schemas.CustomLabel.description - schemas.CustomLabel.id - schemas.CustomLabel.properties.key.description - schemas.CustomLabel.properties.key.enum - schemas.CustomLabel.properties.key.enumDescriptions - schemas.CustomLabel.properties.key.type - schemas.CustomLabel.properties.value.description - schemas.CustomLabel.properties.value.type - schemas.CustomLabel.type - schemas.CustomList.description - schemas.CustomList.id - schemas.CustomList.properties.customListId.description - schemas.CustomList.properties.customListId.format - schemas.CustomList.properties.customListId.readOnly - schemas.CustomList.properties.customListId.type - schemas.CustomList.properties.displayName.description - schemas.CustomList.properties.displayName.readOnly - schemas.CustomList.properties.displayName.type - schemas.CustomList.properties.name.description - schemas.CustomList.properties.name.readOnly - schemas.CustomList.properties.name.type - schemas.CustomList.type - schemas.CustomListGroup.description - schemas.CustomListGroup.id - schemas.CustomListGroup.properties.settings.description - schemas.CustomListGroup.properties.settings.items.$ref - schemas.CustomListGroup.properties.settings.type - schemas.CustomListGroup.type - schemas.CustomListTargetingSetting.description - schemas.CustomListTargetingSetting.id - schemas.CustomListTargetingSetting.properties.customListId.description - schemas.CustomListTargetingSetting.properties.customListId.format - schemas.CustomListTargetingSetting.properties.customListId.type - schemas.CustomListTargetingSetting.type - schemas.Date.description - schemas.Date.id - schemas.Date.properties.day.description - schemas.Date.properties.day.format - schemas.Date.properties.day.type - schemas.Date.properties.month.description - schemas.Date.properties.month.format - schemas.Date.properties.month.type - schemas.Date.properties.year.description - schemas.Date.properties.year.format - schemas.Date.properties.year.type - schemas.Date.type - schemas.DateRange.description - schemas.DateRange.id - schemas.DateRange.properties.endDate.$ref - schemas.DateRange.properties.endDate.description - schemas.DateRange.properties.startDate.$ref - schemas.DateRange.properties.startDate.description - schemas.DateRange.type - schemas.DayAndTime.description - schemas.DayAndTime.id - schemas.DayAndTime.properties.dayOfWeek.description - schemas.DayAndTime.properties.dayOfWeek.enum - schemas.DayAndTime.properties.dayOfWeek.enumDescriptions - schemas.DayAndTime.properties.dayOfWeek.type - schemas.DayAndTime.properties.hourOfDay.description - schemas.DayAndTime.properties.hourOfDay.format - schemas.DayAndTime.properties.hourOfDay.type - schemas.DayAndTime.properties.timeZoneResolution.description - schemas.DayAndTime.properties.timeZoneResolution.enum - schemas.DayAndTime.properties.timeZoneResolution.enumDescriptions - schemas.DayAndTime.properties.timeZoneResolution.type - schemas.DayAndTime.type - schemas.DayAndTimeAssignedTargetingOptionDetails.description - schemas.DayAndTimeAssignedTargetingOptionDetails.id - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.dayOfWeek.description - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.dayOfWeek.enum - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.dayOfWeek.enumDescriptions - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.dayOfWeek.type - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.endHour.description - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.endHour.format - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.endHour.type - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.startHour.description - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.startHour.format - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.startHour.type - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.timeZoneResolution.description - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.timeZoneResolution.enum - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.timeZoneResolution.enumDescriptions - schemas.DayAndTimeAssignedTargetingOptionDetails.properties.timeZoneResolution.type - schemas.DayAndTimeAssignedTargetingOptionDetails.type - schemas.DeleteAssignedTargetingOptionsRequest.description - schemas.DeleteAssignedTargetingOptionsRequest.id - schemas.DeleteAssignedTargetingOptionsRequest.properties.assignedTargetingOptionIds.description - schemas.DeleteAssignedTargetingOptionsRequest.properties.assignedTargetingOptionIds.items.type - schemas.DeleteAssignedTargetingOptionsRequest.properties.assignedTargetingOptionIds.type - schemas.DeleteAssignedTargetingOptionsRequest.properties.targetingType.description - schemas.DeleteAssignedTargetingOptionsRequest.properties.targetingType.enum - schemas.DeleteAssignedTargetingOptionsRequest.properties.targetingType.enumDescriptions - schemas.DeleteAssignedTargetingOptionsRequest.properties.targetingType.type - schemas.DeleteAssignedTargetingOptionsRequest.type - schemas.DeviceMakeModelAssignedTargetingOptionDetails.description - schemas.DeviceMakeModelAssignedTargetingOptionDetails.id - schemas.DeviceMakeModelAssignedTargetingOptionDetails.properties.displayName.description - schemas.DeviceMakeModelAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.DeviceMakeModelAssignedTargetingOptionDetails.properties.displayName.type - schemas.DeviceMakeModelAssignedTargetingOptionDetails.properties.negative.description - schemas.DeviceMakeModelAssignedTargetingOptionDetails.properties.negative.type - schemas.DeviceMakeModelAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.DeviceMakeModelAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.DeviceMakeModelAssignedTargetingOptionDetails.type - schemas.DeviceMakeModelTargetingOptionDetails.description - schemas.DeviceMakeModelTargetingOptionDetails.id - schemas.DeviceMakeModelTargetingOptionDetails.properties.displayName.description - schemas.DeviceMakeModelTargetingOptionDetails.properties.displayName.readOnly - schemas.DeviceMakeModelTargetingOptionDetails.properties.displayName.type - schemas.DeviceMakeModelTargetingOptionDetails.type - schemas.DeviceTypeAssignedTargetingOptionDetails.description - schemas.DeviceTypeAssignedTargetingOptionDetails.id - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.deviceType.description - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.deviceType.enum - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.deviceType.enumDescriptions - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.deviceType.type - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.youtubeAndPartnersBidMultiplier.description - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.youtubeAndPartnersBidMultiplier.format - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.youtubeAndPartnersBidMultiplier.readOnly - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.youtubeAndPartnersBidMultiplier.type - schemas.DeviceTypeAssignedTargetingOptionDetails.type - schemas.DeviceTypeTargetingOptionDetails.description - schemas.DeviceTypeTargetingOptionDetails.id - schemas.DeviceTypeTargetingOptionDetails.properties.deviceType.description - schemas.DeviceTypeTargetingOptionDetails.properties.deviceType.enum - schemas.DeviceTypeTargetingOptionDetails.properties.deviceType.enumDescriptions - schemas.DeviceTypeTargetingOptionDetails.properties.deviceType.readOnly - schemas.DeviceTypeTargetingOptionDetails.properties.deviceType.type - schemas.DeviceTypeTargetingOptionDetails.type - schemas.DigitalContentLabelAssignedTargetingOptionDetails.description - schemas.DigitalContentLabelAssignedTargetingOptionDetails.id - schemas.DigitalContentLabelAssignedTargetingOptionDetails.properties.excludedContentRatingTier.description - schemas.DigitalContentLabelAssignedTargetingOptionDetails.properties.excludedContentRatingTier.enum - schemas.DigitalContentLabelAssignedTargetingOptionDetails.properties.excludedContentRatingTier.enumDescriptions - schemas.DigitalContentLabelAssignedTargetingOptionDetails.properties.excludedContentRatingTier.type - schemas.DigitalContentLabelAssignedTargetingOptionDetails.type - schemas.DigitalContentLabelTargetingOptionDetails.description - schemas.DigitalContentLabelTargetingOptionDetails.id - schemas.DigitalContentLabelTargetingOptionDetails.properties.contentRatingTier.description - schemas.DigitalContentLabelTargetingOptionDetails.properties.contentRatingTier.enum - schemas.DigitalContentLabelTargetingOptionDetails.properties.contentRatingTier.enumDescriptions - schemas.DigitalContentLabelTargetingOptionDetails.properties.contentRatingTier.readOnly - schemas.DigitalContentLabelTargetingOptionDetails.properties.contentRatingTier.type - schemas.DigitalContentLabelTargetingOptionDetails.type - schemas.Dimensions.description - schemas.Dimensions.id - schemas.Dimensions.properties.heightPixels.description - schemas.Dimensions.properties.heightPixels.format - schemas.Dimensions.properties.heightPixels.type - schemas.Dimensions.properties.widthPixels.description - schemas.Dimensions.properties.widthPixels.format - schemas.Dimensions.properties.widthPixels.type - schemas.Dimensions.type - schemas.DisplayVideoSourceAd.description - schemas.DisplayVideoSourceAd.id - schemas.DisplayVideoSourceAd.properties.creativeId.description - schemas.DisplayVideoSourceAd.properties.creativeId.format - schemas.DisplayVideoSourceAd.properties.creativeId.type - schemas.DisplayVideoSourceAd.type - schemas.DoubleVerify.description - schemas.DoubleVerify.id - schemas.DoubleVerify.properties.appStarRating.$ref - schemas.DoubleVerify.properties.appStarRating.description - schemas.DoubleVerify.properties.avoidedAgeRatings.description - schemas.DoubleVerify.properties.avoidedAgeRatings.items.enum - schemas.DoubleVerify.properties.avoidedAgeRatings.items.enumDescriptions - schemas.DoubleVerify.properties.avoidedAgeRatings.items.type - schemas.DoubleVerify.properties.avoidedAgeRatings.type - schemas.DoubleVerify.properties.brandSafetyCategories.$ref - schemas.DoubleVerify.properties.brandSafetyCategories.description - schemas.DoubleVerify.properties.customSegmentId.description - schemas.DoubleVerify.properties.customSegmentId.format - schemas.DoubleVerify.properties.customSegmentId.type - schemas.DoubleVerify.properties.displayViewability.$ref - schemas.DoubleVerify.properties.displayViewability.description - schemas.DoubleVerify.properties.fraudInvalidTraffic.$ref - schemas.DoubleVerify.properties.fraudInvalidTraffic.description - schemas.DoubleVerify.properties.videoViewability.$ref - schemas.DoubleVerify.properties.videoViewability.description - schemas.DoubleVerify.type - schemas.DoubleVerifyAppStarRating.description - schemas.DoubleVerifyAppStarRating.id - schemas.DoubleVerifyAppStarRating.properties.avoidInsufficientStarRating.description - schemas.DoubleVerifyAppStarRating.properties.avoidInsufficientStarRating.type - schemas.DoubleVerifyAppStarRating.properties.avoidedStarRating.description - schemas.DoubleVerifyAppStarRating.properties.avoidedStarRating.enum - schemas.DoubleVerifyAppStarRating.properties.avoidedStarRating.enumDescriptions - schemas.DoubleVerifyAppStarRating.properties.avoidedStarRating.type - schemas.DoubleVerifyAppStarRating.type - schemas.DoubleVerifyBrandSafetyCategories.description - schemas.DoubleVerifyBrandSafetyCategories.id - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidUnknownBrandSafetyCategory.description - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidUnknownBrandSafetyCategory.type - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedHighSeverityCategories.description - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedHighSeverityCategories.items.enum - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedHighSeverityCategories.items.enumDescriptions - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedHighSeverityCategories.items.type - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedHighSeverityCategories.type - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedMediumSeverityCategories.description - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedMediumSeverityCategories.items.enum - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedMediumSeverityCategories.items.enumDescriptions - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedMediumSeverityCategories.items.type - schemas.DoubleVerifyBrandSafetyCategories.properties.avoidedMediumSeverityCategories.type - schemas.DoubleVerifyBrandSafetyCategories.type - schemas.DoubleVerifyDisplayViewability.description - schemas.DoubleVerifyDisplayViewability.id - schemas.DoubleVerifyDisplayViewability.properties.iab.description - schemas.DoubleVerifyDisplayViewability.properties.iab.enum - schemas.DoubleVerifyDisplayViewability.properties.iab.enumDescriptions - schemas.DoubleVerifyDisplayViewability.properties.iab.type - schemas.DoubleVerifyDisplayViewability.properties.viewableDuring.description - schemas.DoubleVerifyDisplayViewability.properties.viewableDuring.enum - schemas.DoubleVerifyDisplayViewability.properties.viewableDuring.enumDescriptions - schemas.DoubleVerifyDisplayViewability.properties.viewableDuring.type - schemas.DoubleVerifyDisplayViewability.type - schemas.DoubleVerifyFraudInvalidTraffic.description - schemas.DoubleVerifyFraudInvalidTraffic.id - schemas.DoubleVerifyFraudInvalidTraffic.properties.avoidInsufficientOption.description - schemas.DoubleVerifyFraudInvalidTraffic.properties.avoidInsufficientOption.type - schemas.DoubleVerifyFraudInvalidTraffic.properties.avoidedFraudOption.description - schemas.DoubleVerifyFraudInvalidTraffic.properties.avoidedFraudOption.enum - schemas.DoubleVerifyFraudInvalidTraffic.properties.avoidedFraudOption.enumDescriptions - schemas.DoubleVerifyFraudInvalidTraffic.properties.avoidedFraudOption.type - schemas.DoubleVerifyFraudInvalidTraffic.type - schemas.DoubleVerifyVideoViewability.description - schemas.DoubleVerifyVideoViewability.id - schemas.DoubleVerifyVideoViewability.properties.playerImpressionRate.description - schemas.DoubleVerifyVideoViewability.properties.playerImpressionRate.enum - schemas.DoubleVerifyVideoViewability.properties.playerImpressionRate.enumDescriptions - schemas.DoubleVerifyVideoViewability.properties.playerImpressionRate.type - schemas.DoubleVerifyVideoViewability.properties.videoIab.description - schemas.DoubleVerifyVideoViewability.properties.videoIab.enum - schemas.DoubleVerifyVideoViewability.properties.videoIab.enumDescriptions - schemas.DoubleVerifyVideoViewability.properties.videoIab.type - schemas.DoubleVerifyVideoViewability.properties.videoViewableRate.description - schemas.DoubleVerifyVideoViewability.properties.videoViewableRate.enum - schemas.DoubleVerifyVideoViewability.properties.videoViewableRate.enumDescriptions - schemas.DoubleVerifyVideoViewability.properties.videoViewableRate.type - schemas.DoubleVerifyVideoViewability.type - schemas.DuplicateLineItemRequest.description - schemas.DuplicateLineItemRequest.id - schemas.DuplicateLineItemRequest.properties.targetDisplayName.description - schemas.DuplicateLineItemRequest.properties.targetDisplayName.type - schemas.DuplicateLineItemRequest.type - schemas.DuplicateLineItemResponse.id - schemas.DuplicateLineItemResponse.properties.duplicateLineItemId.description - schemas.DuplicateLineItemResponse.properties.duplicateLineItemId.format - schemas.DuplicateLineItemResponse.properties.duplicateLineItemId.type - schemas.DuplicateLineItemResponse.type - schemas.EditCustomerMatchMembersRequest.description - schemas.EditCustomerMatchMembersRequest.id - schemas.EditCustomerMatchMembersRequest.properties.addedContactInfoList.$ref - schemas.EditCustomerMatchMembersRequest.properties.addedContactInfoList.description - schemas.EditCustomerMatchMembersRequest.properties.addedMobileDeviceIdList.$ref - schemas.EditCustomerMatchMembersRequest.properties.addedMobileDeviceIdList.description - schemas.EditCustomerMatchMembersRequest.properties.advertiserId.description - schemas.EditCustomerMatchMembersRequest.properties.advertiserId.format - schemas.EditCustomerMatchMembersRequest.properties.advertiserId.type - schemas.EditCustomerMatchMembersRequest.properties.removedContactInfoList.$ref - schemas.EditCustomerMatchMembersRequest.properties.removedContactInfoList.description - schemas.EditCustomerMatchMembersRequest.properties.removedMobileDeviceIdList.$ref - schemas.EditCustomerMatchMembersRequest.properties.removedMobileDeviceIdList.description - schemas.EditCustomerMatchMembersRequest.type - schemas.EditCustomerMatchMembersResponse.description - schemas.EditCustomerMatchMembersResponse.id - schemas.EditCustomerMatchMembersResponse.properties.firstPartyAndPartnerAudienceId.description - schemas.EditCustomerMatchMembersResponse.properties.firstPartyAndPartnerAudienceId.format - schemas.EditCustomerMatchMembersResponse.properties.firstPartyAndPartnerAudienceId.type - schemas.EditCustomerMatchMembersResponse.type - schemas.EditGuaranteedOrderReadAccessorsRequest.description - schemas.EditGuaranteedOrderReadAccessorsRequest.id - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.addedAdvertisers.description - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.addedAdvertisers.items.format - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.addedAdvertisers.items.type - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.addedAdvertisers.type - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.partnerId.description - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.partnerId.format - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.partnerId.type - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.readAccessInherited.description - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.readAccessInherited.type - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.removedAdvertisers.description - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.removedAdvertisers.items.format - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.removedAdvertisers.items.type - schemas.EditGuaranteedOrderReadAccessorsRequest.properties.removedAdvertisers.type - schemas.EditGuaranteedOrderReadAccessorsRequest.type - schemas.EditGuaranteedOrderReadAccessorsResponse.id - schemas.EditGuaranteedOrderReadAccessorsResponse.properties.readAccessInherited.description - schemas.EditGuaranteedOrderReadAccessorsResponse.properties.readAccessInherited.type - schemas.EditGuaranteedOrderReadAccessorsResponse.properties.readAdvertiserIds.description - schemas.EditGuaranteedOrderReadAccessorsResponse.properties.readAdvertiserIds.items.format - schemas.EditGuaranteedOrderReadAccessorsResponse.properties.readAdvertiserIds.items.type - schemas.EditGuaranteedOrderReadAccessorsResponse.properties.readAdvertiserIds.type - schemas.EditGuaranteedOrderReadAccessorsResponse.type - schemas.EditInventorySourceReadWriteAccessorsRequest.description - schemas.EditInventorySourceReadWriteAccessorsRequest.id - schemas.EditInventorySourceReadWriteAccessorsRequest.properties.advertisersUpdate.$ref - schemas.EditInventorySourceReadWriteAccessorsRequest.properties.advertisersUpdate.description - schemas.EditInventorySourceReadWriteAccessorsRequest.properties.assignPartner.description - schemas.EditInventorySourceReadWriteAccessorsRequest.properties.assignPartner.type - schemas.EditInventorySourceReadWriteAccessorsRequest.properties.partnerId.description - schemas.EditInventorySourceReadWriteAccessorsRequest.properties.partnerId.format - schemas.EditInventorySourceReadWriteAccessorsRequest.properties.partnerId.type - schemas.EditInventorySourceReadWriteAccessorsRequest.type - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.description - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.id - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.properties.addedAdvertisers.description - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.properties.addedAdvertisers.items.format - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.properties.addedAdvertisers.items.type - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.properties.addedAdvertisers.type - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.properties.removedAdvertisers.description - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.properties.removedAdvertisers.items.format - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.properties.removedAdvertisers.items.type - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.properties.removedAdvertisers.type - schemas.EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate.type - schemas.Empty.description - schemas.Empty.id - schemas.Empty.type - schemas.EnvironmentAssignedTargetingOptionDetails.description - schemas.EnvironmentAssignedTargetingOptionDetails.id - schemas.EnvironmentAssignedTargetingOptionDetails.properties.environment.description - schemas.EnvironmentAssignedTargetingOptionDetails.properties.environment.enum - schemas.EnvironmentAssignedTargetingOptionDetails.properties.environment.enumDescriptions - schemas.EnvironmentAssignedTargetingOptionDetails.properties.environment.type - schemas.EnvironmentAssignedTargetingOptionDetails.type - schemas.EnvironmentTargetingOptionDetails.description - schemas.EnvironmentTargetingOptionDetails.id - schemas.EnvironmentTargetingOptionDetails.properties.environment.description - schemas.EnvironmentTargetingOptionDetails.properties.environment.enum - schemas.EnvironmentTargetingOptionDetails.properties.environment.enumDescriptions - schemas.EnvironmentTargetingOptionDetails.properties.environment.readOnly - schemas.EnvironmentTargetingOptionDetails.properties.environment.type - schemas.EnvironmentTargetingOptionDetails.type - schemas.ExchangeAssignedTargetingOptionDetails.description - schemas.ExchangeAssignedTargetingOptionDetails.id - schemas.ExchangeAssignedTargetingOptionDetails.properties.exchange.description - schemas.ExchangeAssignedTargetingOptionDetails.properties.exchange.enum - schemas.ExchangeAssignedTargetingOptionDetails.properties.exchange.enumDescriptions - schemas.ExchangeAssignedTargetingOptionDetails.properties.exchange.type - schemas.ExchangeAssignedTargetingOptionDetails.type - schemas.ExchangeConfig.description - schemas.ExchangeConfig.id - schemas.ExchangeConfig.properties.enabledExchanges.description - schemas.ExchangeConfig.properties.enabledExchanges.items.$ref - schemas.ExchangeConfig.properties.enabledExchanges.type - schemas.ExchangeConfig.type - schemas.ExchangeConfigEnabledExchange.description - schemas.ExchangeConfigEnabledExchange.id - schemas.ExchangeConfigEnabledExchange.properties.exchange.description - schemas.ExchangeConfigEnabledExchange.properties.exchange.enum - schemas.ExchangeConfigEnabledExchange.properties.exchange.enumDescriptions - schemas.ExchangeConfigEnabledExchange.properties.exchange.type - schemas.ExchangeConfigEnabledExchange.properties.googleAdManagerAgencyId.description - schemas.ExchangeConfigEnabledExchange.properties.googleAdManagerAgencyId.readOnly - schemas.ExchangeConfigEnabledExchange.properties.googleAdManagerAgencyId.type - schemas.ExchangeConfigEnabledExchange.properties.googleAdManagerBuyerNetworkId.description - schemas.ExchangeConfigEnabledExchange.properties.googleAdManagerBuyerNetworkId.readOnly - schemas.ExchangeConfigEnabledExchange.properties.googleAdManagerBuyerNetworkId.type - schemas.ExchangeConfigEnabledExchange.properties.seatId.description - schemas.ExchangeConfigEnabledExchange.properties.seatId.readOnly - schemas.ExchangeConfigEnabledExchange.properties.seatId.type - schemas.ExchangeConfigEnabledExchange.type - schemas.ExchangeReviewStatus.description - schemas.ExchangeReviewStatus.id - schemas.ExchangeReviewStatus.properties.exchange.description - schemas.ExchangeReviewStatus.properties.exchange.enum - schemas.ExchangeReviewStatus.properties.exchange.enumDescriptions - schemas.ExchangeReviewStatus.properties.exchange.type - schemas.ExchangeReviewStatus.properties.status.description - schemas.ExchangeReviewStatus.properties.status.enum - schemas.ExchangeReviewStatus.properties.status.enumDescriptions - schemas.ExchangeReviewStatus.properties.status.type - schemas.ExchangeReviewStatus.type - schemas.ExchangeTargetingOptionDetails.description - schemas.ExchangeTargetingOptionDetails.id - schemas.ExchangeTargetingOptionDetails.properties.exchange.description - schemas.ExchangeTargetingOptionDetails.properties.exchange.enum - schemas.ExchangeTargetingOptionDetails.properties.exchange.enumDescriptions - schemas.ExchangeTargetingOptionDetails.properties.exchange.readOnly - schemas.ExchangeTargetingOptionDetails.properties.exchange.type - schemas.ExchangeTargetingOptionDetails.type - schemas.ExitEvent.description - schemas.ExitEvent.id - schemas.ExitEvent.properties.name.description - schemas.ExitEvent.properties.name.type - schemas.ExitEvent.properties.reportingName.description - schemas.ExitEvent.properties.reportingName.type - schemas.ExitEvent.properties.type.description - schemas.ExitEvent.properties.type.enum - schemas.ExitEvent.properties.type.enumDescriptions - schemas.ExitEvent.properties.type.type - schemas.ExitEvent.properties.url.description - schemas.ExitEvent.properties.url.type - schemas.ExitEvent.type - schemas.FirstPartyAndPartnerAudience.description - schemas.FirstPartyAndPartnerAudience.id - schemas.FirstPartyAndPartnerAudience.properties.activeDisplayAudienceSize.description - schemas.FirstPartyAndPartnerAudience.properties.activeDisplayAudienceSize.format - schemas.FirstPartyAndPartnerAudience.properties.activeDisplayAudienceSize.readOnly - schemas.FirstPartyAndPartnerAudience.properties.activeDisplayAudienceSize.type - schemas.FirstPartyAndPartnerAudience.properties.appId.description - schemas.FirstPartyAndPartnerAudience.properties.appId.type - schemas.FirstPartyAndPartnerAudience.properties.audienceSource.description - schemas.FirstPartyAndPartnerAudience.properties.audienceSource.enum - schemas.FirstPartyAndPartnerAudience.properties.audienceSource.enumDescriptions - schemas.FirstPartyAndPartnerAudience.properties.audienceSource.readOnly - schemas.FirstPartyAndPartnerAudience.properties.audienceSource.type - schemas.FirstPartyAndPartnerAudience.properties.audienceType.description - schemas.FirstPartyAndPartnerAudience.properties.audienceType.enum - schemas.FirstPartyAndPartnerAudience.properties.audienceType.enumDeprecated - schemas.FirstPartyAndPartnerAudience.properties.audienceType.enumDescriptions - schemas.FirstPartyAndPartnerAudience.properties.audienceType.readOnly - schemas.FirstPartyAndPartnerAudience.properties.audienceType.type - schemas.FirstPartyAndPartnerAudience.properties.contactInfoList.$ref - schemas.FirstPartyAndPartnerAudience.properties.contactInfoList.description - schemas.FirstPartyAndPartnerAudience.properties.description.description - schemas.FirstPartyAndPartnerAudience.properties.description.readOnly - schemas.FirstPartyAndPartnerAudience.properties.description.type - schemas.FirstPartyAndPartnerAudience.properties.displayAudienceSize.description - schemas.FirstPartyAndPartnerAudience.properties.displayAudienceSize.format - schemas.FirstPartyAndPartnerAudience.properties.displayAudienceSize.readOnly - schemas.FirstPartyAndPartnerAudience.properties.displayAudienceSize.type - schemas.FirstPartyAndPartnerAudience.properties.displayDesktopAudienceSize.description - schemas.FirstPartyAndPartnerAudience.properties.displayDesktopAudienceSize.format - schemas.FirstPartyAndPartnerAudience.properties.displayDesktopAudienceSize.readOnly - schemas.FirstPartyAndPartnerAudience.properties.displayDesktopAudienceSize.type - schemas.FirstPartyAndPartnerAudience.properties.displayMobileAppAudienceSize.description - schemas.FirstPartyAndPartnerAudience.properties.displayMobileAppAudienceSize.format - schemas.FirstPartyAndPartnerAudience.properties.displayMobileAppAudienceSize.readOnly - schemas.FirstPartyAndPartnerAudience.properties.displayMobileAppAudienceSize.type - schemas.FirstPartyAndPartnerAudience.properties.displayMobileWebAudienceSize.description - schemas.FirstPartyAndPartnerAudience.properties.displayMobileWebAudienceSize.format - schemas.FirstPartyAndPartnerAudience.properties.displayMobileWebAudienceSize.readOnly - schemas.FirstPartyAndPartnerAudience.properties.displayMobileWebAudienceSize.type - schemas.FirstPartyAndPartnerAudience.properties.displayName.description - schemas.FirstPartyAndPartnerAudience.properties.displayName.readOnly - schemas.FirstPartyAndPartnerAudience.properties.displayName.type - schemas.FirstPartyAndPartnerAudience.properties.firstPartyAndPartnerAudienceId.description - schemas.FirstPartyAndPartnerAudience.properties.firstPartyAndPartnerAudienceId.format - schemas.FirstPartyAndPartnerAudience.properties.firstPartyAndPartnerAudienceId.type - schemas.FirstPartyAndPartnerAudience.properties.firstPartyAndPartnerAudienceType.description - schemas.FirstPartyAndPartnerAudience.properties.firstPartyAndPartnerAudienceType.enum - schemas.FirstPartyAndPartnerAudience.properties.firstPartyAndPartnerAudienceType.enumDescriptions - schemas.FirstPartyAndPartnerAudience.properties.firstPartyAndPartnerAudienceType.readOnly - schemas.FirstPartyAndPartnerAudience.properties.firstPartyAndPartnerAudienceType.type - schemas.FirstPartyAndPartnerAudience.properties.gmailAudienceSize.description - schemas.FirstPartyAndPartnerAudience.properties.gmailAudienceSize.format - schemas.FirstPartyAndPartnerAudience.properties.gmailAudienceSize.readOnly - schemas.FirstPartyAndPartnerAudience.properties.gmailAudienceSize.type - schemas.FirstPartyAndPartnerAudience.properties.membershipDurationDays.description - schemas.FirstPartyAndPartnerAudience.properties.membershipDurationDays.format - schemas.FirstPartyAndPartnerAudience.properties.membershipDurationDays.readOnly - schemas.FirstPartyAndPartnerAudience.properties.membershipDurationDays.type - schemas.FirstPartyAndPartnerAudience.properties.mobileDeviceIdList.$ref - schemas.FirstPartyAndPartnerAudience.properties.mobileDeviceIdList.description - schemas.FirstPartyAndPartnerAudience.properties.name.description - schemas.FirstPartyAndPartnerAudience.properties.name.readOnly - schemas.FirstPartyAndPartnerAudience.properties.name.type - schemas.FirstPartyAndPartnerAudience.properties.youtubeAudienceSize.description - schemas.FirstPartyAndPartnerAudience.properties.youtubeAudienceSize.format - schemas.FirstPartyAndPartnerAudience.properties.youtubeAudienceSize.readOnly - schemas.FirstPartyAndPartnerAudience.properties.youtubeAudienceSize.type - schemas.FirstPartyAndPartnerAudience.type - schemas.FirstPartyAndPartnerAudienceGroup.description - schemas.FirstPartyAndPartnerAudienceGroup.id - schemas.FirstPartyAndPartnerAudienceGroup.properties.settings.description - schemas.FirstPartyAndPartnerAudienceGroup.properties.settings.items.$ref - schemas.FirstPartyAndPartnerAudienceGroup.properties.settings.type - schemas.FirstPartyAndPartnerAudienceGroup.type - schemas.FirstPartyAndPartnerAudienceTargetingSetting.description - schemas.FirstPartyAndPartnerAudienceTargetingSetting.id - schemas.FirstPartyAndPartnerAudienceTargetingSetting.properties.firstPartyAndPartnerAudienceId.description - schemas.FirstPartyAndPartnerAudienceTargetingSetting.properties.firstPartyAndPartnerAudienceId.format - schemas.FirstPartyAndPartnerAudienceTargetingSetting.properties.firstPartyAndPartnerAudienceId.type - schemas.FirstPartyAndPartnerAudienceTargetingSetting.properties.recency.description - schemas.FirstPartyAndPartnerAudienceTargetingSetting.properties.recency.enum - schemas.FirstPartyAndPartnerAudienceTargetingSetting.properties.recency.enumDescriptions - schemas.FirstPartyAndPartnerAudienceTargetingSetting.properties.recency.type - schemas.FirstPartyAndPartnerAudienceTargetingSetting.type - schemas.FixedBidStrategy.description - schemas.FixedBidStrategy.id - schemas.FixedBidStrategy.properties.bidAmountMicros.description - schemas.FixedBidStrategy.properties.bidAmountMicros.format - schemas.FixedBidStrategy.properties.bidAmountMicros.type - schemas.FixedBidStrategy.type - schemas.FloodlightActivity.description - schemas.FloodlightActivity.id - schemas.FloodlightActivity.properties.advertiserIds.description - schemas.FloodlightActivity.properties.advertiserIds.items.format - schemas.FloodlightActivity.properties.advertiserIds.items.type - schemas.FloodlightActivity.properties.advertiserIds.readOnly - schemas.FloodlightActivity.properties.advertiserIds.type - schemas.FloodlightActivity.properties.displayName.description - schemas.FloodlightActivity.properties.displayName.type - schemas.FloodlightActivity.properties.floodlightActivityId.description - schemas.FloodlightActivity.properties.floodlightActivityId.format - schemas.FloodlightActivity.properties.floodlightActivityId.readOnly - schemas.FloodlightActivity.properties.floodlightActivityId.type - schemas.FloodlightActivity.properties.floodlightGroupId.description - schemas.FloodlightActivity.properties.floodlightGroupId.format - schemas.FloodlightActivity.properties.floodlightGroupId.type - schemas.FloodlightActivity.properties.name.description - schemas.FloodlightActivity.properties.name.readOnly - schemas.FloodlightActivity.properties.name.type - schemas.FloodlightActivity.properties.remarketingConfigs.description - schemas.FloodlightActivity.properties.remarketingConfigs.items.$ref - schemas.FloodlightActivity.properties.remarketingConfigs.readOnly - schemas.FloodlightActivity.properties.remarketingConfigs.type - schemas.FloodlightActivity.properties.servingStatus.description - schemas.FloodlightActivity.properties.servingStatus.enum - schemas.FloodlightActivity.properties.servingStatus.enumDescriptions - schemas.FloodlightActivity.properties.servingStatus.type - schemas.FloodlightActivity.properties.sslRequired.description - schemas.FloodlightActivity.properties.sslRequired.readOnly - schemas.FloodlightActivity.properties.sslRequired.type - schemas.FloodlightActivity.type - schemas.FloodlightGroup.description - schemas.FloodlightGroup.id - schemas.FloodlightGroup.properties.activeViewConfig.$ref - schemas.FloodlightGroup.properties.activeViewConfig.description - schemas.FloodlightGroup.properties.customVariables.additionalProperties.description - schemas.FloodlightGroup.properties.customVariables.additionalProperties.type - schemas.FloodlightGroup.properties.customVariables.description - schemas.FloodlightGroup.properties.customVariables.type - schemas.FloodlightGroup.properties.displayName.description - schemas.FloodlightGroup.properties.displayName.type - schemas.FloodlightGroup.properties.floodlightGroupId.description - schemas.FloodlightGroup.properties.floodlightGroupId.format - schemas.FloodlightGroup.properties.floodlightGroupId.readOnly - schemas.FloodlightGroup.properties.floodlightGroupId.type - schemas.FloodlightGroup.properties.lookbackWindow.$ref - schemas.FloodlightGroup.properties.lookbackWindow.description - schemas.FloodlightGroup.properties.name.description - schemas.FloodlightGroup.properties.name.readOnly - schemas.FloodlightGroup.properties.name.type - schemas.FloodlightGroup.properties.webTagType.description - schemas.FloodlightGroup.properties.webTagType.enum - schemas.FloodlightGroup.properties.webTagType.enumDescriptions - schemas.FloodlightGroup.properties.webTagType.type - schemas.FloodlightGroup.type - schemas.FrequencyCap.description - schemas.FrequencyCap.id - schemas.FrequencyCap.properties.maxImpressions.description - schemas.FrequencyCap.properties.maxImpressions.format - schemas.FrequencyCap.properties.maxImpressions.type - schemas.FrequencyCap.properties.maxViews.description - schemas.FrequencyCap.properties.maxViews.format - schemas.FrequencyCap.properties.maxViews.type - schemas.FrequencyCap.properties.timeUnit.description - schemas.FrequencyCap.properties.timeUnit.enum - schemas.FrequencyCap.properties.timeUnit.enumDeprecated - schemas.FrequencyCap.properties.timeUnit.enumDescriptions - schemas.FrequencyCap.properties.timeUnit.type - schemas.FrequencyCap.properties.timeUnitCount.description - schemas.FrequencyCap.properties.timeUnitCount.format - schemas.FrequencyCap.properties.timeUnitCount.type - schemas.FrequencyCap.properties.unlimited.description - schemas.FrequencyCap.properties.unlimited.type - schemas.FrequencyCap.type - schemas.GenderAssignedTargetingOptionDetails.description - schemas.GenderAssignedTargetingOptionDetails.id - schemas.GenderAssignedTargetingOptionDetails.properties.gender.description - schemas.GenderAssignedTargetingOptionDetails.properties.gender.enum - schemas.GenderAssignedTargetingOptionDetails.properties.gender.enumDescriptions - schemas.GenderAssignedTargetingOptionDetails.properties.gender.type - schemas.GenderAssignedTargetingOptionDetails.type - schemas.GenderTargetingOptionDetails.description - schemas.GenderTargetingOptionDetails.id - schemas.GenderTargetingOptionDetails.properties.gender.description - schemas.GenderTargetingOptionDetails.properties.gender.enum - schemas.GenderTargetingOptionDetails.properties.gender.enumDescriptions - schemas.GenderTargetingOptionDetails.properties.gender.readOnly - schemas.GenderTargetingOptionDetails.properties.gender.type - schemas.GenderTargetingOptionDetails.type - schemas.GenerateDefaultLineItemRequest.description - schemas.GenerateDefaultLineItemRequest.id - schemas.GenerateDefaultLineItemRequest.properties.displayName.description - schemas.GenerateDefaultLineItemRequest.properties.displayName.type - schemas.GenerateDefaultLineItemRequest.properties.insertionOrderId.description - schemas.GenerateDefaultLineItemRequest.properties.insertionOrderId.format - schemas.GenerateDefaultLineItemRequest.properties.insertionOrderId.type - schemas.GenerateDefaultLineItemRequest.properties.lineItemType.description - schemas.GenerateDefaultLineItemRequest.properties.lineItemType.enum - schemas.GenerateDefaultLineItemRequest.properties.lineItemType.enumDescriptions - schemas.GenerateDefaultLineItemRequest.properties.lineItemType.type - schemas.GenerateDefaultLineItemRequest.properties.mobileApp.$ref - schemas.GenerateDefaultLineItemRequest.properties.mobileApp.description - schemas.GenerateDefaultLineItemRequest.type - schemas.GeoRegionAssignedTargetingOptionDetails.description - schemas.GeoRegionAssignedTargetingOptionDetails.id - schemas.GeoRegionAssignedTargetingOptionDetails.properties.displayName.description - schemas.GeoRegionAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.GeoRegionAssignedTargetingOptionDetails.properties.displayName.type - schemas.GeoRegionAssignedTargetingOptionDetails.properties.geoRegionType.description - schemas.GeoRegionAssignedTargetingOptionDetails.properties.geoRegionType.enum - schemas.GeoRegionAssignedTargetingOptionDetails.properties.geoRegionType.enumDescriptions - schemas.GeoRegionAssignedTargetingOptionDetails.properties.geoRegionType.readOnly - schemas.GeoRegionAssignedTargetingOptionDetails.properties.geoRegionType.type - schemas.GeoRegionAssignedTargetingOptionDetails.properties.negative.description - schemas.GeoRegionAssignedTargetingOptionDetails.properties.negative.type - schemas.GeoRegionAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.GeoRegionAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.GeoRegionAssignedTargetingOptionDetails.type - schemas.GeoRegionSearchTerms.description - schemas.GeoRegionSearchTerms.id - schemas.GeoRegionSearchTerms.properties.geoRegionQuery.description - schemas.GeoRegionSearchTerms.properties.geoRegionQuery.type - schemas.GeoRegionSearchTerms.type - schemas.GeoRegionTargetingOptionDetails.description - schemas.GeoRegionTargetingOptionDetails.id - schemas.GeoRegionTargetingOptionDetails.properties.displayName.description - schemas.GeoRegionTargetingOptionDetails.properties.displayName.readOnly - schemas.GeoRegionTargetingOptionDetails.properties.displayName.type - schemas.GeoRegionTargetingOptionDetails.properties.geoRegionType.description - schemas.GeoRegionTargetingOptionDetails.properties.geoRegionType.enum - schemas.GeoRegionTargetingOptionDetails.properties.geoRegionType.enumDescriptions - schemas.GeoRegionTargetingOptionDetails.properties.geoRegionType.readOnly - schemas.GeoRegionTargetingOptionDetails.properties.geoRegionType.type - schemas.GeoRegionTargetingOptionDetails.type - schemas.GoogleAudience.description - schemas.GoogleAudience.id - schemas.GoogleAudience.properties.displayName.description - schemas.GoogleAudience.properties.displayName.readOnly - schemas.GoogleAudience.properties.displayName.type - schemas.GoogleAudience.properties.googleAudienceId.description - schemas.GoogleAudience.properties.googleAudienceId.format - schemas.GoogleAudience.properties.googleAudienceId.readOnly - schemas.GoogleAudience.properties.googleAudienceId.type - schemas.GoogleAudience.properties.googleAudienceType.description - schemas.GoogleAudience.properties.googleAudienceType.enum - schemas.GoogleAudience.properties.googleAudienceType.enumDeprecated - schemas.GoogleAudience.properties.googleAudienceType.enumDescriptions - schemas.GoogleAudience.properties.googleAudienceType.readOnly - schemas.GoogleAudience.properties.googleAudienceType.type - schemas.GoogleAudience.properties.name.description - schemas.GoogleAudience.properties.name.readOnly - schemas.GoogleAudience.properties.name.type - schemas.GoogleAudience.type - schemas.GoogleAudienceGroup.description - schemas.GoogleAudienceGroup.id - schemas.GoogleAudienceGroup.properties.settings.description - schemas.GoogleAudienceGroup.properties.settings.items.$ref - schemas.GoogleAudienceGroup.properties.settings.type - schemas.GoogleAudienceGroup.type - schemas.GoogleAudienceTargetingSetting.description - schemas.GoogleAudienceTargetingSetting.id - schemas.GoogleAudienceTargetingSetting.properties.googleAudienceId.description - schemas.GoogleAudienceTargetingSetting.properties.googleAudienceId.format - schemas.GoogleAudienceTargetingSetting.properties.googleAudienceId.type - schemas.GoogleAudienceTargetingSetting.type - schemas.GuaranteedOrder.description - schemas.GuaranteedOrder.id - schemas.GuaranteedOrder.properties.defaultAdvertiserId.description - schemas.GuaranteedOrder.properties.defaultAdvertiserId.format - schemas.GuaranteedOrder.properties.defaultAdvertiserId.readOnly - schemas.GuaranteedOrder.properties.defaultAdvertiserId.type - schemas.GuaranteedOrder.properties.defaultCampaignId.description - schemas.GuaranteedOrder.properties.defaultCampaignId.format - schemas.GuaranteedOrder.properties.defaultCampaignId.type - schemas.GuaranteedOrder.properties.displayName.description - schemas.GuaranteedOrder.properties.displayName.type - schemas.GuaranteedOrder.properties.exchange.description - schemas.GuaranteedOrder.properties.exchange.enum - schemas.GuaranteedOrder.properties.exchange.enumDescriptions - schemas.GuaranteedOrder.properties.exchange.type - schemas.GuaranteedOrder.properties.guaranteedOrderId.description - schemas.GuaranteedOrder.properties.guaranteedOrderId.readOnly - schemas.GuaranteedOrder.properties.guaranteedOrderId.type - schemas.GuaranteedOrder.properties.legacyGuaranteedOrderId.description - schemas.GuaranteedOrder.properties.legacyGuaranteedOrderId.readOnly - schemas.GuaranteedOrder.properties.legacyGuaranteedOrderId.type - schemas.GuaranteedOrder.properties.name.description - schemas.GuaranteedOrder.properties.name.readOnly - schemas.GuaranteedOrder.properties.name.type - schemas.GuaranteedOrder.properties.publisherName.description - schemas.GuaranteedOrder.properties.publisherName.type - schemas.GuaranteedOrder.properties.readAccessInherited.description - schemas.GuaranteedOrder.properties.readAccessInherited.type - schemas.GuaranteedOrder.properties.readAdvertiserIds.description - schemas.GuaranteedOrder.properties.readAdvertiserIds.items.format - schemas.GuaranteedOrder.properties.readAdvertiserIds.items.type - schemas.GuaranteedOrder.properties.readAdvertiserIds.type - schemas.GuaranteedOrder.properties.readWriteAdvertiserId.description - schemas.GuaranteedOrder.properties.readWriteAdvertiserId.format - schemas.GuaranteedOrder.properties.readWriteAdvertiserId.type - schemas.GuaranteedOrder.properties.readWritePartnerId.description - schemas.GuaranteedOrder.properties.readWritePartnerId.format - schemas.GuaranteedOrder.properties.readWritePartnerId.type - schemas.GuaranteedOrder.properties.status.$ref - schemas.GuaranteedOrder.properties.status.description - schemas.GuaranteedOrder.properties.updateTime.description - schemas.GuaranteedOrder.properties.updateTime.format - schemas.GuaranteedOrder.properties.updateTime.readOnly - schemas.GuaranteedOrder.properties.updateTime.type - schemas.GuaranteedOrder.type - schemas.GuaranteedOrderStatus.description - schemas.GuaranteedOrderStatus.id - schemas.GuaranteedOrderStatus.properties.configStatus.description - schemas.GuaranteedOrderStatus.properties.configStatus.enum - schemas.GuaranteedOrderStatus.properties.configStatus.enumDescriptions - schemas.GuaranteedOrderStatus.properties.configStatus.readOnly - schemas.GuaranteedOrderStatus.properties.configStatus.type - schemas.GuaranteedOrderStatus.properties.entityPauseReason.description - schemas.GuaranteedOrderStatus.properties.entityPauseReason.type - schemas.GuaranteedOrderStatus.properties.entityStatus.description - schemas.GuaranteedOrderStatus.properties.entityStatus.enum - schemas.GuaranteedOrderStatus.properties.entityStatus.enumDescriptions - schemas.GuaranteedOrderStatus.properties.entityStatus.type - schemas.GuaranteedOrderStatus.type - schemas.HouseholdIncomeAssignedTargetingOptionDetails.description - schemas.HouseholdIncomeAssignedTargetingOptionDetails.id - schemas.HouseholdIncomeAssignedTargetingOptionDetails.properties.householdIncome.description - schemas.HouseholdIncomeAssignedTargetingOptionDetails.properties.householdIncome.enum - schemas.HouseholdIncomeAssignedTargetingOptionDetails.properties.householdIncome.enumDescriptions - schemas.HouseholdIncomeAssignedTargetingOptionDetails.properties.householdIncome.type - schemas.HouseholdIncomeAssignedTargetingOptionDetails.type - schemas.HouseholdIncomeTargetingOptionDetails.description - schemas.HouseholdIncomeTargetingOptionDetails.id - schemas.HouseholdIncomeTargetingOptionDetails.properties.householdIncome.description - schemas.HouseholdIncomeTargetingOptionDetails.properties.householdIncome.enum - schemas.HouseholdIncomeTargetingOptionDetails.properties.householdIncome.enumDescriptions - schemas.HouseholdIncomeTargetingOptionDetails.properties.householdIncome.readOnly - schemas.HouseholdIncomeTargetingOptionDetails.properties.householdIncome.type - schemas.HouseholdIncomeTargetingOptionDetails.type - schemas.IdFilter.description - schemas.IdFilter.id - schemas.IdFilter.properties.adGroupAdIds.description - schemas.IdFilter.properties.adGroupAdIds.items.format - schemas.IdFilter.properties.adGroupAdIds.items.type - schemas.IdFilter.properties.adGroupAdIds.type - schemas.IdFilter.properties.adGroupIds.description - schemas.IdFilter.properties.adGroupIds.items.format - schemas.IdFilter.properties.adGroupIds.items.type - schemas.IdFilter.properties.adGroupIds.type - schemas.IdFilter.properties.adGroupQaIds.description - schemas.IdFilter.properties.adGroupQaIds.items.format - schemas.IdFilter.properties.adGroupQaIds.items.type - schemas.IdFilter.properties.adGroupQaIds.type - schemas.IdFilter.properties.campaignIds.description - schemas.IdFilter.properties.campaignIds.items.format - schemas.IdFilter.properties.campaignIds.items.type - schemas.IdFilter.properties.campaignIds.type - schemas.IdFilter.properties.insertionOrderIds.description - schemas.IdFilter.properties.insertionOrderIds.items.format - schemas.IdFilter.properties.insertionOrderIds.items.type - schemas.IdFilter.properties.insertionOrderIds.type - schemas.IdFilter.properties.lineItemIds.description - schemas.IdFilter.properties.lineItemIds.items.format - schemas.IdFilter.properties.lineItemIds.items.type - schemas.IdFilter.properties.lineItemIds.type - schemas.IdFilter.properties.lineItemQaIds.description - schemas.IdFilter.properties.lineItemQaIds.items.format - schemas.IdFilter.properties.lineItemQaIds.items.type - schemas.IdFilter.properties.lineItemQaIds.type - schemas.IdFilter.properties.mediaProductIds.description - schemas.IdFilter.properties.mediaProductIds.items.format - schemas.IdFilter.properties.mediaProductIds.items.type - schemas.IdFilter.properties.mediaProductIds.type - schemas.IdFilter.type - schemas.ImageAsset.description - schemas.ImageAsset.id - schemas.ImageAsset.properties.fileSize.description - schemas.ImageAsset.properties.fileSize.format - schemas.ImageAsset.properties.fileSize.type - schemas.ImageAsset.properties.fullSize.$ref - schemas.ImageAsset.properties.fullSize.description - schemas.ImageAsset.properties.mimeType.description - schemas.ImageAsset.properties.mimeType.type - schemas.ImageAsset.type - schemas.InStreamAd.description - schemas.InStreamAd.id - schemas.InStreamAd.properties.commonInStreamAttribute.$ref - schemas.InStreamAd.properties.commonInStreamAttribute.description - schemas.InStreamAd.properties.customParameters.additionalProperties.type - schemas.InStreamAd.properties.customParameters.description - schemas.InStreamAd.properties.customParameters.type - schemas.InStreamAd.type - schemas.InsertionOrder.description - schemas.InsertionOrder.id - schemas.InsertionOrder.properties.advertiserId.description - schemas.InsertionOrder.properties.advertiserId.format - schemas.InsertionOrder.properties.advertiserId.readOnly - schemas.InsertionOrder.properties.advertiserId.type - schemas.InsertionOrder.properties.bidStrategy.$ref - schemas.InsertionOrder.properties.bidStrategy.description - schemas.InsertionOrder.properties.budget.$ref - schemas.InsertionOrder.properties.budget.description - schemas.InsertionOrder.properties.campaignId.description - schemas.InsertionOrder.properties.campaignId.format - schemas.InsertionOrder.properties.campaignId.type - schemas.InsertionOrder.properties.displayName.description - schemas.InsertionOrder.properties.displayName.type - schemas.InsertionOrder.properties.entityStatus.description - schemas.InsertionOrder.properties.entityStatus.enum - schemas.InsertionOrder.properties.entityStatus.enumDescriptions - schemas.InsertionOrder.properties.entityStatus.type - schemas.InsertionOrder.properties.frequencyCap.$ref - schemas.InsertionOrder.properties.frequencyCap.description - schemas.InsertionOrder.properties.insertionOrderId.description - schemas.InsertionOrder.properties.insertionOrderId.format - schemas.InsertionOrder.properties.insertionOrderId.readOnly - schemas.InsertionOrder.properties.insertionOrderId.type - schemas.InsertionOrder.properties.insertionOrderType.description - schemas.InsertionOrder.properties.insertionOrderType.enum - schemas.InsertionOrder.properties.insertionOrderType.enumDescriptions - schemas.InsertionOrder.properties.insertionOrderType.type - schemas.InsertionOrder.properties.integrationDetails.$ref - schemas.InsertionOrder.properties.integrationDetails.description - schemas.InsertionOrder.properties.kpi.$ref - schemas.InsertionOrder.properties.kpi.description - schemas.InsertionOrder.properties.name.description - schemas.InsertionOrder.properties.name.readOnly - schemas.InsertionOrder.properties.name.type - schemas.InsertionOrder.properties.optimizationObjective.description - schemas.InsertionOrder.properties.optimizationObjective.enum - schemas.InsertionOrder.properties.optimizationObjective.enumDescriptions - schemas.InsertionOrder.properties.optimizationObjective.type - schemas.InsertionOrder.properties.pacing.$ref - schemas.InsertionOrder.properties.pacing.description - schemas.InsertionOrder.properties.partnerCosts.description - schemas.InsertionOrder.properties.partnerCosts.items.$ref - schemas.InsertionOrder.properties.partnerCosts.type - schemas.InsertionOrder.properties.reservationType.description - schemas.InsertionOrder.properties.reservationType.enum - schemas.InsertionOrder.properties.reservationType.enumDescriptions - schemas.InsertionOrder.properties.reservationType.readOnly - schemas.InsertionOrder.properties.reservationType.type - schemas.InsertionOrder.properties.updateTime.description - schemas.InsertionOrder.properties.updateTime.format - schemas.InsertionOrder.properties.updateTime.readOnly - schemas.InsertionOrder.properties.updateTime.type - schemas.InsertionOrder.type - schemas.InsertionOrderBudget.description - schemas.InsertionOrderBudget.id - schemas.InsertionOrderBudget.properties.automationType.description - schemas.InsertionOrderBudget.properties.automationType.enum - schemas.InsertionOrderBudget.properties.automationType.enumDescriptions - schemas.InsertionOrderBudget.properties.automationType.type - schemas.InsertionOrderBudget.properties.budgetSegments.description - schemas.InsertionOrderBudget.properties.budgetSegments.items.$ref - schemas.InsertionOrderBudget.properties.budgetSegments.type - schemas.InsertionOrderBudget.properties.budgetUnit.description - schemas.InsertionOrderBudget.properties.budgetUnit.enum - schemas.InsertionOrderBudget.properties.budgetUnit.enumDescriptions - schemas.InsertionOrderBudget.properties.budgetUnit.type - schemas.InsertionOrderBudget.type - schemas.InsertionOrderBudgetSegment.description - schemas.InsertionOrderBudgetSegment.id - schemas.InsertionOrderBudgetSegment.properties.budgetAmountMicros.description - schemas.InsertionOrderBudgetSegment.properties.budgetAmountMicros.format - schemas.InsertionOrderBudgetSegment.properties.budgetAmountMicros.type - schemas.InsertionOrderBudgetSegment.properties.campaignBudgetId.description - schemas.InsertionOrderBudgetSegment.properties.campaignBudgetId.format - schemas.InsertionOrderBudgetSegment.properties.campaignBudgetId.type - schemas.InsertionOrderBudgetSegment.properties.dateRange.$ref - schemas.InsertionOrderBudgetSegment.properties.dateRange.description - schemas.InsertionOrderBudgetSegment.properties.description.description - schemas.InsertionOrderBudgetSegment.properties.description.type - schemas.InsertionOrderBudgetSegment.type - schemas.IntegralAdScience.description - schemas.IntegralAdScience.id - schemas.IntegralAdScience.properties.customSegmentId.description - schemas.IntegralAdScience.properties.customSegmentId.items.format - schemas.IntegralAdScience.properties.customSegmentId.items.type - schemas.IntegralAdScience.properties.customSegmentId.type - schemas.IntegralAdScience.properties.displayViewability.description - schemas.IntegralAdScience.properties.displayViewability.enum - schemas.IntegralAdScience.properties.displayViewability.enumDescriptions - schemas.IntegralAdScience.properties.displayViewability.type - schemas.IntegralAdScience.properties.excludeUnrateable.description - schemas.IntegralAdScience.properties.excludeUnrateable.type - schemas.IntegralAdScience.properties.excludedAdFraudRisk.description - schemas.IntegralAdScience.properties.excludedAdFraudRisk.enum - schemas.IntegralAdScience.properties.excludedAdFraudRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedAdFraudRisk.type - schemas.IntegralAdScience.properties.excludedAdultRisk.description - schemas.IntegralAdScience.properties.excludedAdultRisk.enum - schemas.IntegralAdScience.properties.excludedAdultRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedAdultRisk.type - schemas.IntegralAdScience.properties.excludedAlcoholRisk.description - schemas.IntegralAdScience.properties.excludedAlcoholRisk.enum - schemas.IntegralAdScience.properties.excludedAlcoholRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedAlcoholRisk.type - schemas.IntegralAdScience.properties.excludedDrugsRisk.description - schemas.IntegralAdScience.properties.excludedDrugsRisk.enum - schemas.IntegralAdScience.properties.excludedDrugsRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedDrugsRisk.type - schemas.IntegralAdScience.properties.excludedGamblingRisk.description - schemas.IntegralAdScience.properties.excludedGamblingRisk.enum - schemas.IntegralAdScience.properties.excludedGamblingRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedGamblingRisk.type - schemas.IntegralAdScience.properties.excludedHateSpeechRisk.description - schemas.IntegralAdScience.properties.excludedHateSpeechRisk.enum - schemas.IntegralAdScience.properties.excludedHateSpeechRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedHateSpeechRisk.type - schemas.IntegralAdScience.properties.excludedIllegalDownloadsRisk.description - schemas.IntegralAdScience.properties.excludedIllegalDownloadsRisk.enum - schemas.IntegralAdScience.properties.excludedIllegalDownloadsRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedIllegalDownloadsRisk.type - schemas.IntegralAdScience.properties.excludedOffensiveLanguageRisk.description - schemas.IntegralAdScience.properties.excludedOffensiveLanguageRisk.enum - schemas.IntegralAdScience.properties.excludedOffensiveLanguageRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedOffensiveLanguageRisk.type - schemas.IntegralAdScience.properties.excludedViolenceRisk.description - schemas.IntegralAdScience.properties.excludedViolenceRisk.enum - schemas.IntegralAdScience.properties.excludedViolenceRisk.enumDescriptions - schemas.IntegralAdScience.properties.excludedViolenceRisk.type - schemas.IntegralAdScience.properties.qualitySyncCustomSegmentId.description - schemas.IntegralAdScience.properties.qualitySyncCustomSegmentId.items.format - schemas.IntegralAdScience.properties.qualitySyncCustomSegmentId.items.type - schemas.IntegralAdScience.properties.qualitySyncCustomSegmentId.type - schemas.IntegralAdScience.properties.traqScoreOption.description - schemas.IntegralAdScience.properties.traqScoreOption.enum - schemas.IntegralAdScience.properties.traqScoreOption.enumDescriptions - schemas.IntegralAdScience.properties.traqScoreOption.type - schemas.IntegralAdScience.properties.videoViewability.description - schemas.IntegralAdScience.properties.videoViewability.enum - schemas.IntegralAdScience.properties.videoViewability.enumDescriptions - schemas.IntegralAdScience.properties.videoViewability.type - schemas.IntegralAdScience.type - schemas.IntegrationDetails.description - schemas.IntegrationDetails.id - schemas.IntegrationDetails.properties.details.description - schemas.IntegrationDetails.properties.details.type - schemas.IntegrationDetails.properties.integrationCode.description - schemas.IntegrationDetails.properties.integrationCode.type - schemas.IntegrationDetails.type - schemas.InventorySource.description - schemas.InventorySource.id - schemas.InventorySource.properties.commitment.description - schemas.InventorySource.properties.commitment.enum - schemas.InventorySource.properties.commitment.enumDescriptions - schemas.InventorySource.properties.commitment.type - schemas.InventorySource.properties.creativeConfigs.description - schemas.InventorySource.properties.creativeConfigs.items.$ref - schemas.InventorySource.properties.creativeConfigs.type - schemas.InventorySource.properties.dealId.description - schemas.InventorySource.properties.dealId.type - schemas.InventorySource.properties.deliveryMethod.description - schemas.InventorySource.properties.deliveryMethod.enum - schemas.InventorySource.properties.deliveryMethod.enumDescriptions - schemas.InventorySource.properties.deliveryMethod.type - schemas.InventorySource.properties.displayName.description - schemas.InventorySource.properties.displayName.type - schemas.InventorySource.properties.exchange.description - schemas.InventorySource.properties.exchange.enum - schemas.InventorySource.properties.exchange.enumDescriptions - schemas.InventorySource.properties.exchange.type - schemas.InventorySource.properties.guaranteedOrderId.description - schemas.InventorySource.properties.guaranteedOrderId.type - schemas.InventorySource.properties.inventorySourceId.description - schemas.InventorySource.properties.inventorySourceId.format - schemas.InventorySource.properties.inventorySourceId.readOnly - schemas.InventorySource.properties.inventorySourceId.type - schemas.InventorySource.properties.inventorySourceProductType.description - schemas.InventorySource.properties.inventorySourceProductType.enum - schemas.InventorySource.properties.inventorySourceProductType.enumDescriptions - schemas.InventorySource.properties.inventorySourceProductType.readOnly - schemas.InventorySource.properties.inventorySourceProductType.type - schemas.InventorySource.properties.inventorySourceType.description - schemas.InventorySource.properties.inventorySourceType.enum - schemas.InventorySource.properties.inventorySourceType.enumDescriptions - schemas.InventorySource.properties.inventorySourceType.type - schemas.InventorySource.properties.name.description - schemas.InventorySource.properties.name.readOnly - schemas.InventorySource.properties.name.type - schemas.InventorySource.properties.publisherName.description - schemas.InventorySource.properties.publisherName.type - schemas.InventorySource.properties.rateDetails.$ref - schemas.InventorySource.properties.rateDetails.description - schemas.InventorySource.properties.readAdvertiserIds.description - schemas.InventorySource.properties.readAdvertiserIds.items.format - schemas.InventorySource.properties.readAdvertiserIds.items.type - schemas.InventorySource.properties.readAdvertiserIds.readOnly - schemas.InventorySource.properties.readAdvertiserIds.type - schemas.InventorySource.properties.readPartnerIds.description - schemas.InventorySource.properties.readPartnerIds.items.format - schemas.InventorySource.properties.readPartnerIds.items.type - schemas.InventorySource.properties.readPartnerIds.readOnly - schemas.InventorySource.properties.readPartnerIds.type - schemas.InventorySource.properties.readWriteAccessors.$ref - schemas.InventorySource.properties.readWriteAccessors.description - schemas.InventorySource.properties.status.$ref - schemas.InventorySource.properties.status.description - schemas.InventorySource.properties.timeRange.$ref - schemas.InventorySource.properties.timeRange.description - schemas.InventorySource.properties.updateTime.description - schemas.InventorySource.properties.updateTime.format - schemas.InventorySource.properties.updateTime.readOnly - schemas.InventorySource.properties.updateTime.type - schemas.InventorySource.type - schemas.InventorySourceAccessors.description - schemas.InventorySourceAccessors.id - schemas.InventorySourceAccessors.properties.advertisers.$ref - schemas.InventorySourceAccessors.properties.advertisers.description - schemas.InventorySourceAccessors.properties.partner.$ref - schemas.InventorySourceAccessors.properties.partner.description - schemas.InventorySourceAccessors.type - schemas.InventorySourceAccessorsAdvertiserAccessors.description - schemas.InventorySourceAccessorsAdvertiserAccessors.id - schemas.InventorySourceAccessorsAdvertiserAccessors.properties.advertiserIds.description - schemas.InventorySourceAccessorsAdvertiserAccessors.properties.advertiserIds.items.format - schemas.InventorySourceAccessorsAdvertiserAccessors.properties.advertiserIds.items.type - schemas.InventorySourceAccessorsAdvertiserAccessors.properties.advertiserIds.type - schemas.InventorySourceAccessorsAdvertiserAccessors.type - schemas.InventorySourceAccessorsPartnerAccessor.description - schemas.InventorySourceAccessorsPartnerAccessor.id - schemas.InventorySourceAccessorsPartnerAccessor.properties.partnerId.description - schemas.InventorySourceAccessorsPartnerAccessor.properties.partnerId.format - schemas.InventorySourceAccessorsPartnerAccessor.properties.partnerId.type - schemas.InventorySourceAccessorsPartnerAccessor.type - schemas.InventorySourceAssignedTargetingOptionDetails.description - schemas.InventorySourceAssignedTargetingOptionDetails.id - schemas.InventorySourceAssignedTargetingOptionDetails.properties.inventorySourceId.description - schemas.InventorySourceAssignedTargetingOptionDetails.properties.inventorySourceId.format - schemas.InventorySourceAssignedTargetingOptionDetails.properties.inventorySourceId.type - schemas.InventorySourceAssignedTargetingOptionDetails.type - schemas.InventorySourceDisplayCreativeConfig.description - schemas.InventorySourceDisplayCreativeConfig.id - schemas.InventorySourceDisplayCreativeConfig.properties.creativeSize.$ref - schemas.InventorySourceDisplayCreativeConfig.properties.creativeSize.description - schemas.InventorySourceDisplayCreativeConfig.type - schemas.InventorySourceFilter.description - schemas.InventorySourceFilter.id - schemas.InventorySourceFilter.properties.inventorySourceIds.description - schemas.InventorySourceFilter.properties.inventorySourceIds.items.format - schemas.InventorySourceFilter.properties.inventorySourceIds.items.type - schemas.InventorySourceFilter.properties.inventorySourceIds.type - schemas.InventorySourceFilter.type - schemas.InventorySourceGroup.description - schemas.InventorySourceGroup.id - schemas.InventorySourceGroup.properties.displayName.description - schemas.InventorySourceGroup.properties.displayName.type - schemas.InventorySourceGroup.properties.inventorySourceGroupId.description - schemas.InventorySourceGroup.properties.inventorySourceGroupId.format - schemas.InventorySourceGroup.properties.inventorySourceGroupId.readOnly - schemas.InventorySourceGroup.properties.inventorySourceGroupId.type - schemas.InventorySourceGroup.properties.name.description - schemas.InventorySourceGroup.properties.name.readOnly - schemas.InventorySourceGroup.properties.name.type - schemas.InventorySourceGroup.type - schemas.InventorySourceGroupAssignedTargetingOptionDetails.description - schemas.InventorySourceGroupAssignedTargetingOptionDetails.id - schemas.InventorySourceGroupAssignedTargetingOptionDetails.properties.inventorySourceGroupId.description - schemas.InventorySourceGroupAssignedTargetingOptionDetails.properties.inventorySourceGroupId.format - schemas.InventorySourceGroupAssignedTargetingOptionDetails.properties.inventorySourceGroupId.type - schemas.InventorySourceGroupAssignedTargetingOptionDetails.type - schemas.InventorySourceStatus.description - schemas.InventorySourceStatus.id - schemas.InventorySourceStatus.properties.configStatus.description - schemas.InventorySourceStatus.properties.configStatus.enum - schemas.InventorySourceStatus.properties.configStatus.enumDescriptions - schemas.InventorySourceStatus.properties.configStatus.readOnly - schemas.InventorySourceStatus.properties.configStatus.type - schemas.InventorySourceStatus.properties.entityPauseReason.description - schemas.InventorySourceStatus.properties.entityPauseReason.type - schemas.InventorySourceStatus.properties.entityStatus.description - schemas.InventorySourceStatus.properties.entityStatus.enum - schemas.InventorySourceStatus.properties.entityStatus.enumDescriptions - schemas.InventorySourceStatus.properties.entityStatus.type - schemas.InventorySourceStatus.properties.sellerPauseReason.description - schemas.InventorySourceStatus.properties.sellerPauseReason.readOnly - schemas.InventorySourceStatus.properties.sellerPauseReason.type - schemas.InventorySourceStatus.properties.sellerStatus.description - schemas.InventorySourceStatus.properties.sellerStatus.enum - schemas.InventorySourceStatus.properties.sellerStatus.enumDescriptions - schemas.InventorySourceStatus.properties.sellerStatus.readOnly - schemas.InventorySourceStatus.properties.sellerStatus.type - schemas.InventorySourceStatus.type - schemas.InventorySourceVideoCreativeConfig.description - schemas.InventorySourceVideoCreativeConfig.id - schemas.InventorySourceVideoCreativeConfig.properties.duration.description - schemas.InventorySourceVideoCreativeConfig.properties.duration.format - schemas.InventorySourceVideoCreativeConfig.properties.duration.type - schemas.InventorySourceVideoCreativeConfig.type - schemas.Invoice.description - schemas.Invoice.id - schemas.Invoice.properties.budgetInvoiceGroupingId.description - schemas.Invoice.properties.budgetInvoiceGroupingId.type - schemas.Invoice.properties.budgetSummaries.description - schemas.Invoice.properties.budgetSummaries.items.$ref - schemas.Invoice.properties.budgetSummaries.type - schemas.Invoice.properties.correctedInvoiceId.description - schemas.Invoice.properties.correctedInvoiceId.type - schemas.Invoice.properties.currencyCode.description - schemas.Invoice.properties.currencyCode.type - schemas.Invoice.properties.displayName.description - schemas.Invoice.properties.displayName.type - schemas.Invoice.properties.dueDate.$ref - schemas.Invoice.properties.dueDate.description - schemas.Invoice.properties.invoiceId.description - schemas.Invoice.properties.invoiceId.type - schemas.Invoice.properties.invoiceType.description - schemas.Invoice.properties.invoiceType.enum - schemas.Invoice.properties.invoiceType.enumDescriptions - schemas.Invoice.properties.invoiceType.type - schemas.Invoice.properties.issueDate.$ref - schemas.Invoice.properties.issueDate.description - schemas.Invoice.properties.name.description - schemas.Invoice.properties.name.type - schemas.Invoice.properties.nonBudgetMicros.description - schemas.Invoice.properties.nonBudgetMicros.format - schemas.Invoice.properties.nonBudgetMicros.type - schemas.Invoice.properties.paymentsAccountId.description - schemas.Invoice.properties.paymentsAccountId.type - schemas.Invoice.properties.paymentsProfileId.description - schemas.Invoice.properties.paymentsProfileId.type - schemas.Invoice.properties.pdfUrl.description - schemas.Invoice.properties.pdfUrl.type - schemas.Invoice.properties.purchaseOrderNumber.description - schemas.Invoice.properties.purchaseOrderNumber.type - schemas.Invoice.properties.replacedInvoiceIds.description - schemas.Invoice.properties.replacedInvoiceIds.items.type - schemas.Invoice.properties.replacedInvoiceIds.type - schemas.Invoice.properties.serviceDateRange.$ref - schemas.Invoice.properties.serviceDateRange.description - schemas.Invoice.properties.subtotalAmountMicros.description - schemas.Invoice.properties.subtotalAmountMicros.format - schemas.Invoice.properties.subtotalAmountMicros.type - schemas.Invoice.properties.totalAmountMicros.description - schemas.Invoice.properties.totalAmountMicros.format - schemas.Invoice.properties.totalAmountMicros.type - schemas.Invoice.properties.totalTaxAmountMicros.description - schemas.Invoice.properties.totalTaxAmountMicros.format - schemas.Invoice.properties.totalTaxAmountMicros.type - schemas.Invoice.type - schemas.KeywordAssignedTargetingOptionDetails.description - schemas.KeywordAssignedTargetingOptionDetails.id - schemas.KeywordAssignedTargetingOptionDetails.properties.keyword.description - schemas.KeywordAssignedTargetingOptionDetails.properties.keyword.type - schemas.KeywordAssignedTargetingOptionDetails.properties.negative.description - schemas.KeywordAssignedTargetingOptionDetails.properties.negative.type - schemas.KeywordAssignedTargetingOptionDetails.type - schemas.Kpi.description - schemas.Kpi.id - schemas.Kpi.properties.kpiAlgorithmId.description - schemas.Kpi.properties.kpiAlgorithmId.format - schemas.Kpi.properties.kpiAlgorithmId.type - schemas.Kpi.properties.kpiAmountMicros.description - schemas.Kpi.properties.kpiAmountMicros.format - schemas.Kpi.properties.kpiAmountMicros.type - schemas.Kpi.properties.kpiPercentageMicros.description - schemas.Kpi.properties.kpiPercentageMicros.format - schemas.Kpi.properties.kpiPercentageMicros.type - schemas.Kpi.properties.kpiString.description - schemas.Kpi.properties.kpiString.type - schemas.Kpi.properties.kpiType.description - schemas.Kpi.properties.kpiType.enum - schemas.Kpi.properties.kpiType.enumDescriptions - schemas.Kpi.properties.kpiType.type - schemas.Kpi.type - schemas.LanguageAssignedTargetingOptionDetails.description - schemas.LanguageAssignedTargetingOptionDetails.id - schemas.LanguageAssignedTargetingOptionDetails.properties.displayName.description - schemas.LanguageAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.LanguageAssignedTargetingOptionDetails.properties.displayName.type - schemas.LanguageAssignedTargetingOptionDetails.properties.negative.description - schemas.LanguageAssignedTargetingOptionDetails.properties.negative.type - schemas.LanguageAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.LanguageAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.LanguageAssignedTargetingOptionDetails.type - schemas.LanguageTargetingOptionDetails.description - schemas.LanguageTargetingOptionDetails.id - schemas.LanguageTargetingOptionDetails.properties.displayName.description - schemas.LanguageTargetingOptionDetails.properties.displayName.readOnly - schemas.LanguageTargetingOptionDetails.properties.displayName.type - schemas.LanguageTargetingOptionDetails.type - schemas.LineItem.description - schemas.LineItem.id - schemas.LineItem.properties.advertiserId.description - schemas.LineItem.properties.advertiserId.format - schemas.LineItem.properties.advertiserId.readOnly - schemas.LineItem.properties.advertiserId.type - schemas.LineItem.properties.bidStrategy.$ref - schemas.LineItem.properties.bidStrategy.description - schemas.LineItem.properties.budget.$ref - schemas.LineItem.properties.budget.description - schemas.LineItem.properties.campaignId.description - schemas.LineItem.properties.campaignId.format - schemas.LineItem.properties.campaignId.readOnly - schemas.LineItem.properties.campaignId.type - schemas.LineItem.properties.conversionCounting.$ref - schemas.LineItem.properties.conversionCounting.description - schemas.LineItem.properties.creativeIds.description - schemas.LineItem.properties.creativeIds.items.format - schemas.LineItem.properties.creativeIds.items.type - schemas.LineItem.properties.creativeIds.type - schemas.LineItem.properties.displayName.description - schemas.LineItem.properties.displayName.type - schemas.LineItem.properties.entityStatus.description - schemas.LineItem.properties.entityStatus.enum - schemas.LineItem.properties.entityStatus.enumDescriptions - schemas.LineItem.properties.entityStatus.type - schemas.LineItem.properties.excludeNewExchanges.description - schemas.LineItem.properties.excludeNewExchanges.type - schemas.LineItem.properties.flight.$ref - schemas.LineItem.properties.flight.description - schemas.LineItem.properties.frequencyCap.$ref - schemas.LineItem.properties.frequencyCap.description - schemas.LineItem.properties.insertionOrderId.description - schemas.LineItem.properties.insertionOrderId.format - schemas.LineItem.properties.insertionOrderId.type - schemas.LineItem.properties.integrationDetails.$ref - schemas.LineItem.properties.integrationDetails.description - schemas.LineItem.properties.lineItemId.description - schemas.LineItem.properties.lineItemId.format - schemas.LineItem.properties.lineItemId.readOnly - schemas.LineItem.properties.lineItemId.type - schemas.LineItem.properties.lineItemType.description - schemas.LineItem.properties.lineItemType.enum - schemas.LineItem.properties.lineItemType.enumDescriptions - schemas.LineItem.properties.lineItemType.type - schemas.LineItem.properties.mobileApp.$ref - schemas.LineItem.properties.mobileApp.description - schemas.LineItem.properties.name.description - schemas.LineItem.properties.name.readOnly - schemas.LineItem.properties.name.type - schemas.LineItem.properties.pacing.$ref - schemas.LineItem.properties.pacing.description - schemas.LineItem.properties.partnerCosts.description - schemas.LineItem.properties.partnerCosts.items.$ref - schemas.LineItem.properties.partnerCosts.type - schemas.LineItem.properties.partnerRevenueModel.$ref - schemas.LineItem.properties.partnerRevenueModel.description - schemas.LineItem.properties.reservationType.description - schemas.LineItem.properties.reservationType.enum - schemas.LineItem.properties.reservationType.enumDescriptions - schemas.LineItem.properties.reservationType.readOnly - schemas.LineItem.properties.reservationType.type - schemas.LineItem.properties.targetingExpansion.$ref - schemas.LineItem.properties.targetingExpansion.description - schemas.LineItem.properties.updateTime.description - schemas.LineItem.properties.updateTime.format - schemas.LineItem.properties.updateTime.readOnly - schemas.LineItem.properties.updateTime.type - schemas.LineItem.properties.warningMessages.description - schemas.LineItem.properties.warningMessages.items.enum - schemas.LineItem.properties.warningMessages.items.enumDescriptions - schemas.LineItem.properties.warningMessages.items.type - schemas.LineItem.properties.warningMessages.readOnly - schemas.LineItem.properties.warningMessages.type - schemas.LineItem.properties.youtubeAndPartnersSettings.$ref - schemas.LineItem.properties.youtubeAndPartnersSettings.description - schemas.LineItem.properties.youtubeAndPartnersSettings.readOnly - schemas.LineItem.type - schemas.LineItemAssignedTargetingOption.description - schemas.LineItemAssignedTargetingOption.id - schemas.LineItemAssignedTargetingOption.properties.assignedTargetingOption.$ref - schemas.LineItemAssignedTargetingOption.properties.assignedTargetingOption.description - schemas.LineItemAssignedTargetingOption.properties.lineItemId.description - schemas.LineItemAssignedTargetingOption.properties.lineItemId.format - schemas.LineItemAssignedTargetingOption.properties.lineItemId.type - schemas.LineItemAssignedTargetingOption.type - schemas.LineItemBudget.description - schemas.LineItemBudget.id - schemas.LineItemBudget.properties.budgetAllocationType.description - schemas.LineItemBudget.properties.budgetAllocationType.enum - schemas.LineItemBudget.properties.budgetAllocationType.enumDescriptions - schemas.LineItemBudget.properties.budgetAllocationType.type - schemas.LineItemBudget.properties.budgetUnit.description - schemas.LineItemBudget.properties.budgetUnit.enum - schemas.LineItemBudget.properties.budgetUnit.enumDescriptions - schemas.LineItemBudget.properties.budgetUnit.readOnly - schemas.LineItemBudget.properties.budgetUnit.type - schemas.LineItemBudget.properties.maxAmount.description - schemas.LineItemBudget.properties.maxAmount.format - schemas.LineItemBudget.properties.maxAmount.type - schemas.LineItemBudget.type - schemas.LineItemFlight.description - schemas.LineItemFlight.id - schemas.LineItemFlight.properties.dateRange.$ref - schemas.LineItemFlight.properties.dateRange.description - schemas.LineItemFlight.properties.flightDateType.description - schemas.LineItemFlight.properties.flightDateType.enum - schemas.LineItemFlight.properties.flightDateType.enumDescriptions - schemas.LineItemFlight.properties.flightDateType.type - schemas.LineItemFlight.type - schemas.ListAdGroupAdsResponse.id - schemas.ListAdGroupAdsResponse.properties.adGroupAds.description - schemas.ListAdGroupAdsResponse.properties.adGroupAds.items.$ref - schemas.ListAdGroupAdsResponse.properties.adGroupAds.type - schemas.ListAdGroupAdsResponse.properties.nextPageToken.description - schemas.ListAdGroupAdsResponse.properties.nextPageToken.type - schemas.ListAdGroupAdsResponse.type - schemas.ListAdGroupAssignedTargetingOptionsResponse.description - schemas.ListAdGroupAssignedTargetingOptionsResponse.id - schemas.ListAdGroupAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.description - schemas.ListAdGroupAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.items.$ref - schemas.ListAdGroupAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.type - schemas.ListAdGroupAssignedTargetingOptionsResponse.properties.nextPageToken.description - schemas.ListAdGroupAssignedTargetingOptionsResponse.properties.nextPageToken.type - schemas.ListAdGroupAssignedTargetingOptionsResponse.type - schemas.ListAdGroupsResponse.id - schemas.ListAdGroupsResponse.properties.adGroups.description - schemas.ListAdGroupsResponse.properties.adGroups.items.$ref - schemas.ListAdGroupsResponse.properties.adGroups.type - schemas.ListAdGroupsResponse.properties.nextPageToken.description - schemas.ListAdGroupsResponse.properties.nextPageToken.type - schemas.ListAdGroupsResponse.type - schemas.ListAdvertiserAssignedTargetingOptionsResponse.description - schemas.ListAdvertiserAssignedTargetingOptionsResponse.id - schemas.ListAdvertiserAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.description - schemas.ListAdvertiserAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.items.$ref - schemas.ListAdvertiserAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.type - schemas.ListAdvertiserAssignedTargetingOptionsResponse.properties.nextPageToken.description - schemas.ListAdvertiserAssignedTargetingOptionsResponse.properties.nextPageToken.type - schemas.ListAdvertiserAssignedTargetingOptionsResponse.type - schemas.ListAdvertisersResponse.id - schemas.ListAdvertisersResponse.properties.advertisers.description - schemas.ListAdvertisersResponse.properties.advertisers.items.$ref - schemas.ListAdvertisersResponse.properties.advertisers.type - schemas.ListAdvertisersResponse.properties.nextPageToken.description - schemas.ListAdvertisersResponse.properties.nextPageToken.type - schemas.ListAdvertisersResponse.type - schemas.ListAssignedInventorySourcesResponse.description - schemas.ListAssignedInventorySourcesResponse.id - schemas.ListAssignedInventorySourcesResponse.properties.assignedInventorySources.description - schemas.ListAssignedInventorySourcesResponse.properties.assignedInventorySources.items.$ref - schemas.ListAssignedInventorySourcesResponse.properties.assignedInventorySources.type - schemas.ListAssignedInventorySourcesResponse.properties.nextPageToken.description - schemas.ListAssignedInventorySourcesResponse.properties.nextPageToken.type - schemas.ListAssignedInventorySourcesResponse.type - schemas.ListAssignedLocationsResponse.description - schemas.ListAssignedLocationsResponse.id - schemas.ListAssignedLocationsResponse.properties.assignedLocations.description - schemas.ListAssignedLocationsResponse.properties.assignedLocations.items.$ref - schemas.ListAssignedLocationsResponse.properties.assignedLocations.type - schemas.ListAssignedLocationsResponse.properties.nextPageToken.description - schemas.ListAssignedLocationsResponse.properties.nextPageToken.type - schemas.ListAssignedLocationsResponse.type - schemas.ListCampaignsResponse.id - schemas.ListCampaignsResponse.properties.campaigns.description - schemas.ListCampaignsResponse.properties.campaigns.items.$ref - schemas.ListCampaignsResponse.properties.campaigns.type - schemas.ListCampaignsResponse.properties.nextPageToken.description - schemas.ListCampaignsResponse.properties.nextPageToken.type - schemas.ListCampaignsResponse.type - schemas.ListChannelsResponse.id - schemas.ListChannelsResponse.properties.channels.description - schemas.ListChannelsResponse.properties.channels.items.$ref - schemas.ListChannelsResponse.properties.channels.type - schemas.ListChannelsResponse.properties.nextPageToken.description - schemas.ListChannelsResponse.properties.nextPageToken.type - schemas.ListChannelsResponse.type - schemas.ListCombinedAudiencesResponse.id - schemas.ListCombinedAudiencesResponse.properties.combinedAudiences.description - schemas.ListCombinedAudiencesResponse.properties.combinedAudiences.items.$ref - schemas.ListCombinedAudiencesResponse.properties.combinedAudiences.type - schemas.ListCombinedAudiencesResponse.properties.nextPageToken.description - schemas.ListCombinedAudiencesResponse.properties.nextPageToken.type - schemas.ListCombinedAudiencesResponse.type - schemas.ListCreativesResponse.id - schemas.ListCreativesResponse.properties.creatives.description - schemas.ListCreativesResponse.properties.creatives.items.$ref - schemas.ListCreativesResponse.properties.creatives.type - schemas.ListCreativesResponse.properties.nextPageToken.description - schemas.ListCreativesResponse.properties.nextPageToken.type - schemas.ListCreativesResponse.type - schemas.ListCustomBiddingAlgorithmRulesResponse.id - schemas.ListCustomBiddingAlgorithmRulesResponse.properties.customBiddingRules.description - schemas.ListCustomBiddingAlgorithmRulesResponse.properties.customBiddingRules.items.$ref - schemas.ListCustomBiddingAlgorithmRulesResponse.properties.customBiddingRules.type - schemas.ListCustomBiddingAlgorithmRulesResponse.properties.nextPageToken.description - schemas.ListCustomBiddingAlgorithmRulesResponse.properties.nextPageToken.type - schemas.ListCustomBiddingAlgorithmRulesResponse.type - schemas.ListCustomBiddingAlgorithmsResponse.id - schemas.ListCustomBiddingAlgorithmsResponse.properties.customBiddingAlgorithms.description - schemas.ListCustomBiddingAlgorithmsResponse.properties.customBiddingAlgorithms.items.$ref - schemas.ListCustomBiddingAlgorithmsResponse.properties.customBiddingAlgorithms.type - schemas.ListCustomBiddingAlgorithmsResponse.properties.nextPageToken.description - schemas.ListCustomBiddingAlgorithmsResponse.properties.nextPageToken.type - schemas.ListCustomBiddingAlgorithmsResponse.type - schemas.ListCustomBiddingScriptsResponse.id - schemas.ListCustomBiddingScriptsResponse.properties.customBiddingScripts.description - schemas.ListCustomBiddingScriptsResponse.properties.customBiddingScripts.items.$ref - schemas.ListCustomBiddingScriptsResponse.properties.customBiddingScripts.type - schemas.ListCustomBiddingScriptsResponse.properties.nextPageToken.description - schemas.ListCustomBiddingScriptsResponse.properties.nextPageToken.type - schemas.ListCustomBiddingScriptsResponse.type - schemas.ListCustomListsResponse.id - schemas.ListCustomListsResponse.properties.customLists.description - schemas.ListCustomListsResponse.properties.customLists.items.$ref - schemas.ListCustomListsResponse.properties.customLists.type - schemas.ListCustomListsResponse.properties.nextPageToken.description - schemas.ListCustomListsResponse.properties.nextPageToken.type - schemas.ListCustomListsResponse.type - schemas.ListFirstPartyAndPartnerAudiencesResponse.id - schemas.ListFirstPartyAndPartnerAudiencesResponse.properties.firstPartyAndPartnerAudiences.description - schemas.ListFirstPartyAndPartnerAudiencesResponse.properties.firstPartyAndPartnerAudiences.items.$ref - schemas.ListFirstPartyAndPartnerAudiencesResponse.properties.firstPartyAndPartnerAudiences.type - schemas.ListFirstPartyAndPartnerAudiencesResponse.properties.nextPageToken.description - schemas.ListFirstPartyAndPartnerAudiencesResponse.properties.nextPageToken.type - schemas.ListFirstPartyAndPartnerAudiencesResponse.type - schemas.ListFloodlightActivitiesResponse.id - schemas.ListFloodlightActivitiesResponse.properties.floodlightActivities.description - schemas.ListFloodlightActivitiesResponse.properties.floodlightActivities.items.$ref - schemas.ListFloodlightActivitiesResponse.properties.floodlightActivities.type - schemas.ListFloodlightActivitiesResponse.properties.nextPageToken.description - schemas.ListFloodlightActivitiesResponse.properties.nextPageToken.type - schemas.ListFloodlightActivitiesResponse.type - schemas.ListGoogleAudiencesResponse.id - schemas.ListGoogleAudiencesResponse.properties.googleAudiences.description - schemas.ListGoogleAudiencesResponse.properties.googleAudiences.items.$ref - schemas.ListGoogleAudiencesResponse.properties.googleAudiences.type - schemas.ListGoogleAudiencesResponse.properties.nextPageToken.description - schemas.ListGoogleAudiencesResponse.properties.nextPageToken.type - schemas.ListGoogleAudiencesResponse.type - schemas.ListGuaranteedOrdersResponse.id - schemas.ListGuaranteedOrdersResponse.properties.guaranteedOrders.description - schemas.ListGuaranteedOrdersResponse.properties.guaranteedOrders.items.$ref - schemas.ListGuaranteedOrdersResponse.properties.guaranteedOrders.type - schemas.ListGuaranteedOrdersResponse.properties.nextPageToken.description - schemas.ListGuaranteedOrdersResponse.properties.nextPageToken.type - schemas.ListGuaranteedOrdersResponse.type - schemas.ListInsertionOrdersResponse.id - schemas.ListInsertionOrdersResponse.properties.insertionOrders.description - schemas.ListInsertionOrdersResponse.properties.insertionOrders.items.$ref - schemas.ListInsertionOrdersResponse.properties.insertionOrders.type - schemas.ListInsertionOrdersResponse.properties.nextPageToken.description - schemas.ListInsertionOrdersResponse.properties.nextPageToken.type - schemas.ListInsertionOrdersResponse.type - schemas.ListInventorySourceGroupsResponse.description - schemas.ListInventorySourceGroupsResponse.id - schemas.ListInventorySourceGroupsResponse.properties.inventorySourceGroups.description - schemas.ListInventorySourceGroupsResponse.properties.inventorySourceGroups.items.$ref - schemas.ListInventorySourceGroupsResponse.properties.inventorySourceGroups.type - schemas.ListInventorySourceGroupsResponse.properties.nextPageToken.description - schemas.ListInventorySourceGroupsResponse.properties.nextPageToken.type - schemas.ListInventorySourceGroupsResponse.type - schemas.ListInventorySourcesResponse.id - schemas.ListInventorySourcesResponse.properties.inventorySources.description - schemas.ListInventorySourcesResponse.properties.inventorySources.items.$ref - schemas.ListInventorySourcesResponse.properties.inventorySources.type - schemas.ListInventorySourcesResponse.properties.nextPageToken.description - schemas.ListInventorySourcesResponse.properties.nextPageToken.type - schemas.ListInventorySourcesResponse.type - schemas.ListInvoicesResponse.id - schemas.ListInvoicesResponse.properties.invoices.description - schemas.ListInvoicesResponse.properties.invoices.items.$ref - schemas.ListInvoicesResponse.properties.invoices.type - schemas.ListInvoicesResponse.properties.nextPageToken.description - schemas.ListInvoicesResponse.properties.nextPageToken.type - schemas.ListInvoicesResponse.type - schemas.ListLineItemAssignedTargetingOptionsResponse.description - schemas.ListLineItemAssignedTargetingOptionsResponse.id - schemas.ListLineItemAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.description - schemas.ListLineItemAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.items.$ref - schemas.ListLineItemAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.type - schemas.ListLineItemAssignedTargetingOptionsResponse.properties.nextPageToken.description - schemas.ListLineItemAssignedTargetingOptionsResponse.properties.nextPageToken.type - schemas.ListLineItemAssignedTargetingOptionsResponse.type - schemas.ListLineItemsResponse.id - schemas.ListLineItemsResponse.properties.lineItems.description - schemas.ListLineItemsResponse.properties.lineItems.items.$ref - schemas.ListLineItemsResponse.properties.lineItems.type - schemas.ListLineItemsResponse.properties.nextPageToken.description - schemas.ListLineItemsResponse.properties.nextPageToken.type - schemas.ListLineItemsResponse.type - schemas.ListLocationListsResponse.id - schemas.ListLocationListsResponse.properties.locationLists.description - schemas.ListLocationListsResponse.properties.locationLists.items.$ref - schemas.ListLocationListsResponse.properties.locationLists.type - schemas.ListLocationListsResponse.properties.nextPageToken.description - schemas.ListLocationListsResponse.properties.nextPageToken.type - schemas.ListLocationListsResponse.type - schemas.ListNegativeKeywordListsResponse.description - schemas.ListNegativeKeywordListsResponse.id - schemas.ListNegativeKeywordListsResponse.properties.negativeKeywordLists.description - schemas.ListNegativeKeywordListsResponse.properties.negativeKeywordLists.items.$ref - schemas.ListNegativeKeywordListsResponse.properties.negativeKeywordLists.type - schemas.ListNegativeKeywordListsResponse.properties.nextPageToken.description - schemas.ListNegativeKeywordListsResponse.properties.nextPageToken.type - schemas.ListNegativeKeywordListsResponse.type - schemas.ListNegativeKeywordsResponse.description - schemas.ListNegativeKeywordsResponse.id - schemas.ListNegativeKeywordsResponse.properties.negativeKeywords.description - schemas.ListNegativeKeywordsResponse.properties.negativeKeywords.items.$ref - schemas.ListNegativeKeywordsResponse.properties.negativeKeywords.type - schemas.ListNegativeKeywordsResponse.properties.nextPageToken.description - schemas.ListNegativeKeywordsResponse.properties.nextPageToken.type - schemas.ListNegativeKeywordsResponse.type - schemas.ListPartnerAssignedTargetingOptionsResponse.id - schemas.ListPartnerAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.description - schemas.ListPartnerAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.items.$ref - schemas.ListPartnerAssignedTargetingOptionsResponse.properties.assignedTargetingOptions.type - schemas.ListPartnerAssignedTargetingOptionsResponse.properties.nextPageToken.description - schemas.ListPartnerAssignedTargetingOptionsResponse.properties.nextPageToken.type - schemas.ListPartnerAssignedTargetingOptionsResponse.type - schemas.ListPartnersResponse.id - schemas.ListPartnersResponse.properties.nextPageToken.description - schemas.ListPartnersResponse.properties.nextPageToken.type - schemas.ListPartnersResponse.properties.partners.description - schemas.ListPartnersResponse.properties.partners.items.$ref - schemas.ListPartnersResponse.properties.partners.type - schemas.ListPartnersResponse.type - schemas.ListSitesResponse.description - schemas.ListSitesResponse.id - schemas.ListSitesResponse.properties.nextPageToken.description - schemas.ListSitesResponse.properties.nextPageToken.type - schemas.ListSitesResponse.properties.sites.description - schemas.ListSitesResponse.properties.sites.items.$ref - schemas.ListSitesResponse.properties.sites.type - schemas.ListSitesResponse.type - schemas.ListTargetingOptionsResponse.description - schemas.ListTargetingOptionsResponse.id - schemas.ListTargetingOptionsResponse.properties.nextPageToken.description - schemas.ListTargetingOptionsResponse.properties.nextPageToken.type - schemas.ListTargetingOptionsResponse.properties.targetingOptions.description - schemas.ListTargetingOptionsResponse.properties.targetingOptions.items.$ref - schemas.ListTargetingOptionsResponse.properties.targetingOptions.type - schemas.ListTargetingOptionsResponse.type - schemas.ListUsersResponse.id - schemas.ListUsersResponse.properties.nextPageToken.description - schemas.ListUsersResponse.properties.nextPageToken.type - schemas.ListUsersResponse.properties.users.description - schemas.ListUsersResponse.properties.users.items.$ref - schemas.ListUsersResponse.properties.users.type - schemas.ListUsersResponse.type - schemas.LocationList.description - schemas.LocationList.id - schemas.LocationList.properties.advertiserId.description - schemas.LocationList.properties.advertiserId.format - schemas.LocationList.properties.advertiserId.type - schemas.LocationList.properties.displayName.description - schemas.LocationList.properties.displayName.type - schemas.LocationList.properties.locationListId.description - schemas.LocationList.properties.locationListId.format - schemas.LocationList.properties.locationListId.readOnly - schemas.LocationList.properties.locationListId.type - schemas.LocationList.properties.locationType.description - schemas.LocationList.properties.locationType.enum - schemas.LocationList.properties.locationType.enumDescriptions - schemas.LocationList.properties.locationType.type - schemas.LocationList.properties.name.description - schemas.LocationList.properties.name.readOnly - schemas.LocationList.properties.name.type - schemas.LocationList.type - schemas.LookbackWindow.description - schemas.LookbackWindow.id - schemas.LookbackWindow.properties.clickDays.description - schemas.LookbackWindow.properties.clickDays.format - schemas.LookbackWindow.properties.clickDays.type - schemas.LookbackWindow.properties.impressionDays.description - schemas.LookbackWindow.properties.impressionDays.format - schemas.LookbackWindow.properties.impressionDays.type - schemas.LookbackWindow.type - schemas.LookupInvoiceCurrencyResponse.id - schemas.LookupInvoiceCurrencyResponse.properties.currencyCode.description - schemas.LookupInvoiceCurrencyResponse.properties.currencyCode.type - schemas.LookupInvoiceCurrencyResponse.type - schemas.MastheadAd.description - schemas.MastheadAd.id - schemas.MastheadAd.properties.autoplayVideoDuration.description - schemas.MastheadAd.properties.autoplayVideoDuration.format - schemas.MastheadAd.properties.autoplayVideoDuration.type - schemas.MastheadAd.properties.autoplayVideoStartMillisecond.description - schemas.MastheadAd.properties.autoplayVideoStartMillisecond.format - schemas.MastheadAd.properties.autoplayVideoStartMillisecond.type - schemas.MastheadAd.properties.callToActionButtonLabel.description - schemas.MastheadAd.properties.callToActionButtonLabel.type - schemas.MastheadAd.properties.callToActionFinalUrl.description - schemas.MastheadAd.properties.callToActionFinalUrl.type - schemas.MastheadAd.properties.callToActionTrackingUrl.description - schemas.MastheadAd.properties.callToActionTrackingUrl.type - schemas.MastheadAd.properties.companionYoutubeVideos.description - schemas.MastheadAd.properties.companionYoutubeVideos.items.$ref - schemas.MastheadAd.properties.companionYoutubeVideos.type - schemas.MastheadAd.properties.description.description - schemas.MastheadAd.properties.description.type - schemas.MastheadAd.properties.headline.description - schemas.MastheadAd.properties.headline.type - schemas.MastheadAd.properties.showChannelArt.description - schemas.MastheadAd.properties.showChannelArt.type - schemas.MastheadAd.properties.video.$ref - schemas.MastheadAd.properties.video.description - schemas.MastheadAd.properties.videoAspectRatio.description - schemas.MastheadAd.properties.videoAspectRatio.enum - schemas.MastheadAd.properties.videoAspectRatio.enumDescriptions - schemas.MastheadAd.properties.videoAspectRatio.type - schemas.MastheadAd.type - schemas.MaximizeSpendBidStrategy.description - schemas.MaximizeSpendBidStrategy.id - schemas.MaximizeSpendBidStrategy.properties.customBiddingAlgorithmId.description - schemas.MaximizeSpendBidStrategy.properties.customBiddingAlgorithmId.format - schemas.MaximizeSpendBidStrategy.properties.customBiddingAlgorithmId.type - schemas.MaximizeSpendBidStrategy.properties.maxAverageCpmBidAmountMicros.description - schemas.MaximizeSpendBidStrategy.properties.maxAverageCpmBidAmountMicros.format - schemas.MaximizeSpendBidStrategy.properties.maxAverageCpmBidAmountMicros.type - schemas.MaximizeSpendBidStrategy.properties.performanceGoalType.description - schemas.MaximizeSpendBidStrategy.properties.performanceGoalType.enum - schemas.MaximizeSpendBidStrategy.properties.performanceGoalType.enumDescriptions - schemas.MaximizeSpendBidStrategy.properties.performanceGoalType.type - schemas.MaximizeSpendBidStrategy.properties.raiseBidForDeals.description - schemas.MaximizeSpendBidStrategy.properties.raiseBidForDeals.type - schemas.MaximizeSpendBidStrategy.type - schemas.MeasurementConfig.description - schemas.MeasurementConfig.id - schemas.MeasurementConfig.properties.dv360ToCmCostReportingEnabled.description - schemas.MeasurementConfig.properties.dv360ToCmCostReportingEnabled.type - schemas.MeasurementConfig.properties.dv360ToCmDataSharingEnabled.description - schemas.MeasurementConfig.properties.dv360ToCmDataSharingEnabled.type - schemas.MeasurementConfig.type - schemas.MobileApp.description - schemas.MobileApp.id - schemas.MobileApp.properties.appId.description - schemas.MobileApp.properties.appId.type - schemas.MobileApp.properties.displayName.description - schemas.MobileApp.properties.displayName.readOnly - schemas.MobileApp.properties.displayName.type - schemas.MobileApp.properties.platform.description - schemas.MobileApp.properties.platform.enum - schemas.MobileApp.properties.platform.enumDescriptions - schemas.MobileApp.properties.platform.readOnly - schemas.MobileApp.properties.platform.type - schemas.MobileApp.properties.publisher.description - schemas.MobileApp.properties.publisher.readOnly - schemas.MobileApp.properties.publisher.type - schemas.MobileApp.type - schemas.MobileDeviceIdList.description - schemas.MobileDeviceIdList.id - schemas.MobileDeviceIdList.properties.consent.$ref - schemas.MobileDeviceIdList.properties.consent.description - schemas.MobileDeviceIdList.properties.mobileDeviceIds.description - schemas.MobileDeviceIdList.properties.mobileDeviceIds.items.type - schemas.MobileDeviceIdList.properties.mobileDeviceIds.type - schemas.MobileDeviceIdList.type - schemas.Money.description - schemas.Money.id - schemas.Money.properties.currencyCode.description - schemas.Money.properties.currencyCode.type - schemas.Money.properties.nanos.description - schemas.Money.properties.nanos.format - schemas.Money.properties.nanos.type - schemas.Money.properties.units.description - schemas.Money.properties.units.format - schemas.Money.properties.units.type - schemas.Money.type - schemas.NativeContentPositionAssignedTargetingOptionDetails.description - schemas.NativeContentPositionAssignedTargetingOptionDetails.id - schemas.NativeContentPositionAssignedTargetingOptionDetails.properties.contentPosition.description - schemas.NativeContentPositionAssignedTargetingOptionDetails.properties.contentPosition.enum - schemas.NativeContentPositionAssignedTargetingOptionDetails.properties.contentPosition.enumDescriptions - schemas.NativeContentPositionAssignedTargetingOptionDetails.properties.contentPosition.type - schemas.NativeContentPositionAssignedTargetingOptionDetails.type - schemas.NativeContentPositionTargetingOptionDetails.description - schemas.NativeContentPositionTargetingOptionDetails.id - schemas.NativeContentPositionTargetingOptionDetails.properties.contentPosition.description - schemas.NativeContentPositionTargetingOptionDetails.properties.contentPosition.enum - schemas.NativeContentPositionTargetingOptionDetails.properties.contentPosition.enumDescriptions - schemas.NativeContentPositionTargetingOptionDetails.properties.contentPosition.readOnly - schemas.NativeContentPositionTargetingOptionDetails.properties.contentPosition.type - schemas.NativeContentPositionTargetingOptionDetails.type - schemas.NegativeKeyword.description - schemas.NegativeKeyword.id - schemas.NegativeKeyword.properties.keywordValue.description - schemas.NegativeKeyword.properties.keywordValue.type - schemas.NegativeKeyword.properties.name.description - schemas.NegativeKeyword.properties.name.readOnly - schemas.NegativeKeyword.properties.name.type - schemas.NegativeKeyword.type - schemas.NegativeKeywordList.description - schemas.NegativeKeywordList.id - schemas.NegativeKeywordList.properties.advertiserId.description - schemas.NegativeKeywordList.properties.advertiserId.format - schemas.NegativeKeywordList.properties.advertiserId.readOnly - schemas.NegativeKeywordList.properties.advertiserId.type - schemas.NegativeKeywordList.properties.displayName.description - schemas.NegativeKeywordList.properties.displayName.type - schemas.NegativeKeywordList.properties.name.description - schemas.NegativeKeywordList.properties.name.readOnly - schemas.NegativeKeywordList.properties.name.type - schemas.NegativeKeywordList.properties.negativeKeywordListId.description - schemas.NegativeKeywordList.properties.negativeKeywordListId.format - schemas.NegativeKeywordList.properties.negativeKeywordListId.readOnly - schemas.NegativeKeywordList.properties.negativeKeywordListId.type - schemas.NegativeKeywordList.properties.targetedLineItemCount.description - schemas.NegativeKeywordList.properties.targetedLineItemCount.format - schemas.NegativeKeywordList.properties.targetedLineItemCount.readOnly - schemas.NegativeKeywordList.properties.targetedLineItemCount.type - schemas.NegativeKeywordList.type - schemas.NegativeKeywordListAssignedTargetingOptionDetails.description - schemas.NegativeKeywordListAssignedTargetingOptionDetails.id - schemas.NegativeKeywordListAssignedTargetingOptionDetails.properties.negativeKeywordListId.description - schemas.NegativeKeywordListAssignedTargetingOptionDetails.properties.negativeKeywordListId.format - schemas.NegativeKeywordListAssignedTargetingOptionDetails.properties.negativeKeywordListId.type - schemas.NegativeKeywordListAssignedTargetingOptionDetails.type - schemas.NonSkippableAd.description - schemas.NonSkippableAd.id - schemas.NonSkippableAd.properties.commonInStreamAttribute.$ref - schemas.NonSkippableAd.properties.commonInStreamAttribute.description - schemas.NonSkippableAd.properties.customParameters.additionalProperties.type - schemas.NonSkippableAd.properties.customParameters.description - schemas.NonSkippableAd.properties.customParameters.type - schemas.NonSkippableAd.type - schemas.ObaIcon.description - schemas.ObaIcon.id - schemas.ObaIcon.properties.clickTrackingUrl.description - schemas.ObaIcon.properties.clickTrackingUrl.type - schemas.ObaIcon.properties.dimensions.$ref - schemas.ObaIcon.properties.dimensions.description - schemas.ObaIcon.properties.landingPageUrl.description - schemas.ObaIcon.properties.landingPageUrl.type - schemas.ObaIcon.properties.position.description - schemas.ObaIcon.properties.position.enum - schemas.ObaIcon.properties.position.enumDescriptions - schemas.ObaIcon.properties.position.type - schemas.ObaIcon.properties.program.description - schemas.ObaIcon.properties.program.type - schemas.ObaIcon.properties.resourceMimeType.description - schemas.ObaIcon.properties.resourceMimeType.type - schemas.ObaIcon.properties.resourceUrl.description - schemas.ObaIcon.properties.resourceUrl.type - schemas.ObaIcon.properties.viewTrackingUrl.description - schemas.ObaIcon.properties.viewTrackingUrl.type - schemas.ObaIcon.type - schemas.OmidAssignedTargetingOptionDetails.description - schemas.OmidAssignedTargetingOptionDetails.id - schemas.OmidAssignedTargetingOptionDetails.properties.omid.description - schemas.OmidAssignedTargetingOptionDetails.properties.omid.enum - schemas.OmidAssignedTargetingOptionDetails.properties.omid.enumDescriptions - schemas.OmidAssignedTargetingOptionDetails.properties.omid.type - schemas.OmidAssignedTargetingOptionDetails.type - schemas.OmidTargetingOptionDetails.description - schemas.OmidTargetingOptionDetails.id - schemas.OmidTargetingOptionDetails.properties.omid.description - schemas.OmidTargetingOptionDetails.properties.omid.enum - schemas.OmidTargetingOptionDetails.properties.omid.enumDescriptions - schemas.OmidTargetingOptionDetails.properties.omid.readOnly - schemas.OmidTargetingOptionDetails.properties.omid.type - schemas.OmidTargetingOptionDetails.type - schemas.OnScreenPositionAssignedTargetingOptionDetails.description - schemas.OnScreenPositionAssignedTargetingOptionDetails.id - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.adType.description - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.adType.enum - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.adType.enumDescriptions - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.adType.readOnly - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.adType.type - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.onScreenPosition.description - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.onScreenPosition.enum - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.onScreenPosition.enumDescriptions - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.onScreenPosition.readOnly - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.onScreenPosition.type - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.OnScreenPositionAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.OnScreenPositionAssignedTargetingOptionDetails.type - schemas.OnScreenPositionTargetingOptionDetails.description - schemas.OnScreenPositionTargetingOptionDetails.id - schemas.OnScreenPositionTargetingOptionDetails.properties.onScreenPosition.description - schemas.OnScreenPositionTargetingOptionDetails.properties.onScreenPosition.enum - schemas.OnScreenPositionTargetingOptionDetails.properties.onScreenPosition.enumDescriptions - schemas.OnScreenPositionTargetingOptionDetails.properties.onScreenPosition.readOnly - schemas.OnScreenPositionTargetingOptionDetails.properties.onScreenPosition.type - schemas.OnScreenPositionTargetingOptionDetails.type - schemas.OperatingSystemAssignedTargetingOptionDetails.description - schemas.OperatingSystemAssignedTargetingOptionDetails.id - schemas.OperatingSystemAssignedTargetingOptionDetails.properties.displayName.description - schemas.OperatingSystemAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.OperatingSystemAssignedTargetingOptionDetails.properties.displayName.type - schemas.OperatingSystemAssignedTargetingOptionDetails.properties.negative.description - schemas.OperatingSystemAssignedTargetingOptionDetails.properties.negative.type - schemas.OperatingSystemAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.OperatingSystemAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.OperatingSystemAssignedTargetingOptionDetails.type - schemas.OperatingSystemTargetingOptionDetails.description - schemas.OperatingSystemTargetingOptionDetails.id - schemas.OperatingSystemTargetingOptionDetails.properties.displayName.description - schemas.OperatingSystemTargetingOptionDetails.properties.displayName.readOnly - schemas.OperatingSystemTargetingOptionDetails.properties.displayName.type - schemas.OperatingSystemTargetingOptionDetails.type - schemas.Pacing.description - schemas.Pacing.id - schemas.Pacing.properties.dailyMaxImpressions.description - schemas.Pacing.properties.dailyMaxImpressions.format - schemas.Pacing.properties.dailyMaxImpressions.type - schemas.Pacing.properties.dailyMaxMicros.description - schemas.Pacing.properties.dailyMaxMicros.format - schemas.Pacing.properties.dailyMaxMicros.type - schemas.Pacing.properties.pacingPeriod.description - schemas.Pacing.properties.pacingPeriod.enum - schemas.Pacing.properties.pacingPeriod.enumDescriptions - schemas.Pacing.properties.pacingPeriod.type - schemas.Pacing.properties.pacingType.description - schemas.Pacing.properties.pacingType.enum - schemas.Pacing.properties.pacingType.enumDescriptions - schemas.Pacing.properties.pacingType.type - schemas.Pacing.type - schemas.ParentEntityFilter.description - schemas.ParentEntityFilter.id - schemas.ParentEntityFilter.properties.fileType.description - schemas.ParentEntityFilter.properties.fileType.items.enum - schemas.ParentEntityFilter.properties.fileType.items.enumDescriptions - schemas.ParentEntityFilter.properties.fileType.items.type - schemas.ParentEntityFilter.properties.fileType.type - schemas.ParentEntityFilter.properties.filterIds.description - schemas.ParentEntityFilter.properties.filterIds.items.format - schemas.ParentEntityFilter.properties.filterIds.items.type - schemas.ParentEntityFilter.properties.filterIds.type - schemas.ParentEntityFilter.properties.filterType.description - schemas.ParentEntityFilter.properties.filterType.enum - schemas.ParentEntityFilter.properties.filterType.enumDescriptions - schemas.ParentEntityFilter.properties.filterType.type - schemas.ParentEntityFilter.type - schemas.ParentalStatusAssignedTargetingOptionDetails.description - schemas.ParentalStatusAssignedTargetingOptionDetails.id - schemas.ParentalStatusAssignedTargetingOptionDetails.properties.parentalStatus.description - schemas.ParentalStatusAssignedTargetingOptionDetails.properties.parentalStatus.enum - schemas.ParentalStatusAssignedTargetingOptionDetails.properties.parentalStatus.enumDescriptions - schemas.ParentalStatusAssignedTargetingOptionDetails.properties.parentalStatus.type - schemas.ParentalStatusAssignedTargetingOptionDetails.type - schemas.ParentalStatusTargetingOptionDetails.description - schemas.ParentalStatusTargetingOptionDetails.id - schemas.ParentalStatusTargetingOptionDetails.properties.parentalStatus.description - schemas.ParentalStatusTargetingOptionDetails.properties.parentalStatus.enum - schemas.ParentalStatusTargetingOptionDetails.properties.parentalStatus.enumDescriptions - schemas.ParentalStatusTargetingOptionDetails.properties.parentalStatus.readOnly - schemas.ParentalStatusTargetingOptionDetails.properties.parentalStatus.type - schemas.ParentalStatusTargetingOptionDetails.type - schemas.Partner.description - schemas.Partner.id - schemas.Partner.properties.adServerConfig.$ref - schemas.Partner.properties.adServerConfig.description - schemas.Partner.properties.billingConfig.$ref - schemas.Partner.properties.billingConfig.description - schemas.Partner.properties.dataAccessConfig.$ref - schemas.Partner.properties.dataAccessConfig.description - schemas.Partner.properties.displayName.description - schemas.Partner.properties.displayName.type - schemas.Partner.properties.entityStatus.description - schemas.Partner.properties.entityStatus.enum - schemas.Partner.properties.entityStatus.enumDescriptions - schemas.Partner.properties.entityStatus.readOnly - schemas.Partner.properties.entityStatus.type - schemas.Partner.properties.exchangeConfig.$ref - schemas.Partner.properties.exchangeConfig.description - schemas.Partner.properties.generalConfig.$ref - schemas.Partner.properties.generalConfig.description - schemas.Partner.properties.name.description - schemas.Partner.properties.name.readOnly - schemas.Partner.properties.name.type - schemas.Partner.properties.partnerId.description - schemas.Partner.properties.partnerId.format - schemas.Partner.properties.partnerId.readOnly - schemas.Partner.properties.partnerId.type - schemas.Partner.properties.updateTime.description - schemas.Partner.properties.updateTime.format - schemas.Partner.properties.updateTime.readOnly - schemas.Partner.properties.updateTime.type - schemas.Partner.type - schemas.PartnerAdServerConfig.description - schemas.PartnerAdServerConfig.id - schemas.PartnerAdServerConfig.properties.measurementConfig.$ref - schemas.PartnerAdServerConfig.properties.measurementConfig.description - schemas.PartnerAdServerConfig.type - schemas.PartnerBillingConfig.description - schemas.PartnerBillingConfig.id - schemas.PartnerBillingConfig.properties.billingProfileId.description - schemas.PartnerBillingConfig.properties.billingProfileId.format - schemas.PartnerBillingConfig.properties.billingProfileId.type - schemas.PartnerBillingConfig.type - schemas.PartnerCost.description - schemas.PartnerCost.id - schemas.PartnerCost.properties.costType.description - schemas.PartnerCost.properties.costType.enum - schemas.PartnerCost.properties.costType.enumDescriptions - schemas.PartnerCost.properties.costType.type - schemas.PartnerCost.properties.feeAmount.description - schemas.PartnerCost.properties.feeAmount.format - schemas.PartnerCost.properties.feeAmount.type - schemas.PartnerCost.properties.feePercentageMillis.description - schemas.PartnerCost.properties.feePercentageMillis.format - schemas.PartnerCost.properties.feePercentageMillis.type - schemas.PartnerCost.properties.feeType.description - schemas.PartnerCost.properties.feeType.enum - schemas.PartnerCost.properties.feeType.enumDescriptions - schemas.PartnerCost.properties.feeType.type - schemas.PartnerCost.properties.invoiceType.description - schemas.PartnerCost.properties.invoiceType.enum - schemas.PartnerCost.properties.invoiceType.enumDescriptions - schemas.PartnerCost.properties.invoiceType.type - schemas.PartnerCost.type - schemas.PartnerDataAccessConfig.description - schemas.PartnerDataAccessConfig.id - schemas.PartnerDataAccessConfig.properties.sdfConfig.$ref - schemas.PartnerDataAccessConfig.properties.sdfConfig.description - schemas.PartnerDataAccessConfig.type - schemas.PartnerGeneralConfig.description - schemas.PartnerGeneralConfig.id - schemas.PartnerGeneralConfig.properties.currencyCode.description - schemas.PartnerGeneralConfig.properties.currencyCode.type - schemas.PartnerGeneralConfig.properties.timeZone.description - schemas.PartnerGeneralConfig.properties.timeZone.type - schemas.PartnerGeneralConfig.type - schemas.PartnerRevenueModel.description - schemas.PartnerRevenueModel.id - schemas.PartnerRevenueModel.properties.markupAmount.description - schemas.PartnerRevenueModel.properties.markupAmount.format - schemas.PartnerRevenueModel.properties.markupAmount.type - schemas.PartnerRevenueModel.properties.markupType.description - schemas.PartnerRevenueModel.properties.markupType.enum - schemas.PartnerRevenueModel.properties.markupType.enumDeprecated - schemas.PartnerRevenueModel.properties.markupType.enumDescriptions - schemas.PartnerRevenueModel.properties.markupType.type - schemas.PartnerRevenueModel.type - schemas.PerformanceGoal.description - schemas.PerformanceGoal.id - schemas.PerformanceGoal.properties.performanceGoalAmountMicros.description - schemas.PerformanceGoal.properties.performanceGoalAmountMicros.format - schemas.PerformanceGoal.properties.performanceGoalAmountMicros.type - schemas.PerformanceGoal.properties.performanceGoalPercentageMicros.description - schemas.PerformanceGoal.properties.performanceGoalPercentageMicros.format - schemas.PerformanceGoal.properties.performanceGoalPercentageMicros.type - schemas.PerformanceGoal.properties.performanceGoalString.description - schemas.PerformanceGoal.properties.performanceGoalString.type - schemas.PerformanceGoal.properties.performanceGoalType.description - schemas.PerformanceGoal.properties.performanceGoalType.enum - schemas.PerformanceGoal.properties.performanceGoalType.enumDescriptions - schemas.PerformanceGoal.properties.performanceGoalType.type - schemas.PerformanceGoal.type - schemas.PerformanceGoalBidStrategy.description - schemas.PerformanceGoalBidStrategy.id - schemas.PerformanceGoalBidStrategy.properties.customBiddingAlgorithmId.description - schemas.PerformanceGoalBidStrategy.properties.customBiddingAlgorithmId.format - schemas.PerformanceGoalBidStrategy.properties.customBiddingAlgorithmId.type - schemas.PerformanceGoalBidStrategy.properties.maxAverageCpmBidAmountMicros.description - schemas.PerformanceGoalBidStrategy.properties.maxAverageCpmBidAmountMicros.format - schemas.PerformanceGoalBidStrategy.properties.maxAverageCpmBidAmountMicros.type - schemas.PerformanceGoalBidStrategy.properties.performanceGoalAmountMicros.description - schemas.PerformanceGoalBidStrategy.properties.performanceGoalAmountMicros.format - schemas.PerformanceGoalBidStrategy.properties.performanceGoalAmountMicros.type - schemas.PerformanceGoalBidStrategy.properties.performanceGoalType.description - schemas.PerformanceGoalBidStrategy.properties.performanceGoalType.enum - schemas.PerformanceGoalBidStrategy.properties.performanceGoalType.enumDescriptions - schemas.PerformanceGoalBidStrategy.properties.performanceGoalType.type - schemas.PerformanceGoalBidStrategy.type - schemas.PoiAssignedTargetingOptionDetails.description - schemas.PoiAssignedTargetingOptionDetails.id - schemas.PoiAssignedTargetingOptionDetails.properties.displayName.description - schemas.PoiAssignedTargetingOptionDetails.properties.displayName.readOnly - schemas.PoiAssignedTargetingOptionDetails.properties.displayName.type - schemas.PoiAssignedTargetingOptionDetails.properties.latitude.description - schemas.PoiAssignedTargetingOptionDetails.properties.latitude.format - schemas.PoiAssignedTargetingOptionDetails.properties.latitude.readOnly - schemas.PoiAssignedTargetingOptionDetails.properties.latitude.type - schemas.PoiAssignedTargetingOptionDetails.properties.longitude.description - schemas.PoiAssignedTargetingOptionDetails.properties.longitude.format - schemas.PoiAssignedTargetingOptionDetails.properties.longitude.readOnly - schemas.PoiAssignedTargetingOptionDetails.properties.longitude.type - schemas.PoiAssignedTargetingOptionDetails.properties.proximityRadiusAmount.description - schemas.PoiAssignedTargetingOptionDetails.properties.proximityRadiusAmount.format - schemas.PoiAssignedTargetingOptionDetails.properties.proximityRadiusAmount.type - schemas.PoiAssignedTargetingOptionDetails.properties.proximityRadiusUnit.description - schemas.PoiAssignedTargetingOptionDetails.properties.proximityRadiusUnit.enum - schemas.PoiAssignedTargetingOptionDetails.properties.proximityRadiusUnit.enumDescriptions - schemas.PoiAssignedTargetingOptionDetails.properties.proximityRadiusUnit.type - schemas.PoiAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.PoiAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.PoiAssignedTargetingOptionDetails.type - schemas.PoiSearchTerms.description - schemas.PoiSearchTerms.id - schemas.PoiSearchTerms.properties.poiQuery.description - schemas.PoiSearchTerms.properties.poiQuery.type - schemas.PoiSearchTerms.type - schemas.PoiTargetingOptionDetails.description - schemas.PoiTargetingOptionDetails.id - schemas.PoiTargetingOptionDetails.properties.displayName.description - schemas.PoiTargetingOptionDetails.properties.displayName.readOnly - schemas.PoiTargetingOptionDetails.properties.displayName.type - schemas.PoiTargetingOptionDetails.properties.latitude.description - schemas.PoiTargetingOptionDetails.properties.latitude.format - schemas.PoiTargetingOptionDetails.properties.latitude.readOnly - schemas.PoiTargetingOptionDetails.properties.latitude.type - schemas.PoiTargetingOptionDetails.properties.longitude.description - schemas.PoiTargetingOptionDetails.properties.longitude.format - schemas.PoiTargetingOptionDetails.properties.longitude.readOnly - schemas.PoiTargetingOptionDetails.properties.longitude.type - schemas.PoiTargetingOptionDetails.type - schemas.PrismaConfig.description - schemas.PrismaConfig.id - schemas.PrismaConfig.properties.prismaCpeCode.$ref - schemas.PrismaConfig.properties.prismaCpeCode.description - schemas.PrismaConfig.properties.prismaType.description - schemas.PrismaConfig.properties.prismaType.enum - schemas.PrismaConfig.properties.prismaType.enumDescriptions - schemas.PrismaConfig.properties.prismaType.type - schemas.PrismaConfig.properties.supplier.description - schemas.PrismaConfig.properties.supplier.type - schemas.PrismaConfig.type - schemas.PrismaCpeCode.description - schemas.PrismaCpeCode.id - schemas.PrismaCpeCode.properties.prismaClientCode.description - schemas.PrismaCpeCode.properties.prismaClientCode.type - schemas.PrismaCpeCode.properties.prismaEstimateCode.description - schemas.PrismaCpeCode.properties.prismaEstimateCode.type - schemas.PrismaCpeCode.properties.prismaProductCode.description - schemas.PrismaCpeCode.properties.prismaProductCode.type - schemas.PrismaCpeCode.type - schemas.ProductFeedData.description - schemas.ProductFeedData.id - schemas.ProductFeedData.properties.isFeedDisabled.description - schemas.ProductFeedData.properties.isFeedDisabled.type - schemas.ProductFeedData.properties.productMatchDimensions.description - schemas.ProductFeedData.properties.productMatchDimensions.items.$ref - schemas.ProductFeedData.properties.productMatchDimensions.type - schemas.ProductFeedData.properties.productMatchType.description - schemas.ProductFeedData.properties.productMatchType.enum - schemas.ProductFeedData.properties.productMatchType.enumDescriptions - schemas.ProductFeedData.properties.productMatchType.type - schemas.ProductFeedData.type - schemas.ProductMatchDimension.description - schemas.ProductMatchDimension.id - schemas.ProductMatchDimension.properties.customLabel.$ref - schemas.ProductMatchDimension.properties.customLabel.description - schemas.ProductMatchDimension.properties.productOfferId.description - schemas.ProductMatchDimension.properties.productOfferId.type - schemas.ProductMatchDimension.type - schemas.ProximityLocationListAssignedTargetingOptionDetails.description - schemas.ProximityLocationListAssignedTargetingOptionDetails.id - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityLocationListId.description - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityLocationListId.format - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityLocationListId.type - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityRadius.description - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityRadius.format - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityRadius.type - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityRadiusUnit.description - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityRadiusUnit.enum - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityRadiusUnit.enumDescriptions - schemas.ProximityLocationListAssignedTargetingOptionDetails.properties.proximityRadiusUnit.type - schemas.ProximityLocationListAssignedTargetingOptionDetails.type - schemas.RateDetails.description - schemas.RateDetails.id - schemas.RateDetails.properties.inventorySourceRateType.description - schemas.RateDetails.properties.inventorySourceRateType.enum - schemas.RateDetails.properties.inventorySourceRateType.enumDescriptions - schemas.RateDetails.properties.inventorySourceRateType.type - schemas.RateDetails.properties.minimumSpend.$ref - schemas.RateDetails.properties.minimumSpend.description - schemas.RateDetails.properties.minimumSpend.readOnly - schemas.RateDetails.properties.rate.$ref - schemas.RateDetails.properties.rate.description - schemas.RateDetails.properties.unitsPurchased.description - schemas.RateDetails.properties.unitsPurchased.format - schemas.RateDetails.properties.unitsPurchased.type - schemas.RateDetails.type - schemas.RegionalLocationListAssignedTargetingOptionDetails.description - schemas.RegionalLocationListAssignedTargetingOptionDetails.id - schemas.RegionalLocationListAssignedTargetingOptionDetails.properties.negative.description - schemas.RegionalLocationListAssignedTargetingOptionDetails.properties.negative.type - schemas.RegionalLocationListAssignedTargetingOptionDetails.properties.regionalLocationListId.description - schemas.RegionalLocationListAssignedTargetingOptionDetails.properties.regionalLocationListId.format - schemas.RegionalLocationListAssignedTargetingOptionDetails.properties.regionalLocationListId.type - schemas.RegionalLocationListAssignedTargetingOptionDetails.type - schemas.RemarketingConfig.description - schemas.RemarketingConfig.id - schemas.RemarketingConfig.properties.advertiserId.description - schemas.RemarketingConfig.properties.advertiserId.format - schemas.RemarketingConfig.properties.advertiserId.readOnly - schemas.RemarketingConfig.properties.advertiserId.type - schemas.RemarketingConfig.properties.remarketingEnabled.description - schemas.RemarketingConfig.properties.remarketingEnabled.readOnly - schemas.RemarketingConfig.properties.remarketingEnabled.type - schemas.RemarketingConfig.type - schemas.ReplaceNegativeKeywordsRequest.description - schemas.ReplaceNegativeKeywordsRequest.id - schemas.ReplaceNegativeKeywordsRequest.properties.newNegativeKeywords.description - schemas.ReplaceNegativeKeywordsRequest.properties.newNegativeKeywords.items.$ref - schemas.ReplaceNegativeKeywordsRequest.properties.newNegativeKeywords.type - schemas.ReplaceNegativeKeywordsRequest.type - schemas.ReplaceNegativeKeywordsResponse.description - schemas.ReplaceNegativeKeywordsResponse.id - schemas.ReplaceNegativeKeywordsResponse.properties.negativeKeywords.description - schemas.ReplaceNegativeKeywordsResponse.properties.negativeKeywords.items.$ref - schemas.ReplaceNegativeKeywordsResponse.properties.negativeKeywords.type - schemas.ReplaceNegativeKeywordsResponse.type - schemas.ReplaceSitesRequest.description - schemas.ReplaceSitesRequest.id - schemas.ReplaceSitesRequest.properties.advertiserId.description - schemas.ReplaceSitesRequest.properties.advertiserId.format - schemas.ReplaceSitesRequest.properties.advertiserId.type - schemas.ReplaceSitesRequest.properties.newSites.description - schemas.ReplaceSitesRequest.properties.newSites.items.$ref - schemas.ReplaceSitesRequest.properties.newSites.type - schemas.ReplaceSitesRequest.properties.partnerId.description - schemas.ReplaceSitesRequest.properties.partnerId.format - schemas.ReplaceSitesRequest.properties.partnerId.type - schemas.ReplaceSitesRequest.type - schemas.ReplaceSitesResponse.description - schemas.ReplaceSitesResponse.id - schemas.ReplaceSitesResponse.properties.sites.description - schemas.ReplaceSitesResponse.properties.sites.items.$ref - schemas.ReplaceSitesResponse.properties.sites.type - schemas.ReplaceSitesResponse.type - schemas.ReviewStatusInfo.description - schemas.ReviewStatusInfo.id - schemas.ReviewStatusInfo.properties.approvalStatus.description - schemas.ReviewStatusInfo.properties.approvalStatus.enum - schemas.ReviewStatusInfo.properties.approvalStatus.enumDescriptions - schemas.ReviewStatusInfo.properties.approvalStatus.type - schemas.ReviewStatusInfo.properties.contentAndPolicyReviewStatus.description - schemas.ReviewStatusInfo.properties.contentAndPolicyReviewStatus.enum - schemas.ReviewStatusInfo.properties.contentAndPolicyReviewStatus.enumDescriptions - schemas.ReviewStatusInfo.properties.contentAndPolicyReviewStatus.type - schemas.ReviewStatusInfo.properties.creativeAndLandingPageReviewStatus.description - schemas.ReviewStatusInfo.properties.creativeAndLandingPageReviewStatus.enum - schemas.ReviewStatusInfo.properties.creativeAndLandingPageReviewStatus.enumDescriptions - schemas.ReviewStatusInfo.properties.creativeAndLandingPageReviewStatus.type - schemas.ReviewStatusInfo.properties.exchangeReviewStatuses.description - schemas.ReviewStatusInfo.properties.exchangeReviewStatuses.items.$ref - schemas.ReviewStatusInfo.properties.exchangeReviewStatuses.type - schemas.ReviewStatusInfo.type - schemas.ScriptError.description - schemas.ScriptError.id - schemas.ScriptError.properties.column.description - schemas.ScriptError.properties.column.format - schemas.ScriptError.properties.column.type - schemas.ScriptError.properties.errorCode.description - schemas.ScriptError.properties.errorCode.enum - schemas.ScriptError.properties.errorCode.enumDescriptions - schemas.ScriptError.properties.errorCode.type - schemas.ScriptError.properties.errorMessage.description - schemas.ScriptError.properties.errorMessage.type - schemas.ScriptError.properties.line.description - schemas.ScriptError.properties.line.format - schemas.ScriptError.properties.line.type - schemas.ScriptError.type - schemas.SdfConfig.description - schemas.SdfConfig.id - schemas.SdfConfig.properties.adminEmail.description - schemas.SdfConfig.properties.adminEmail.type - schemas.SdfConfig.properties.version.description - schemas.SdfConfig.properties.version.enum - schemas.SdfConfig.properties.version.enumDeprecated - schemas.SdfConfig.properties.version.enumDescriptions - schemas.SdfConfig.properties.version.type - schemas.SdfConfig.type - schemas.SdfDownloadTask.description - schemas.SdfDownloadTask.id - schemas.SdfDownloadTask.properties.resourceName.description - schemas.SdfDownloadTask.properties.resourceName.type - schemas.SdfDownloadTask.type - schemas.SdfDownloadTaskMetadata.description - schemas.SdfDownloadTaskMetadata.id - schemas.SdfDownloadTaskMetadata.properties.createTime.description - schemas.SdfDownloadTaskMetadata.properties.createTime.format - schemas.SdfDownloadTaskMetadata.properties.createTime.type - schemas.SdfDownloadTaskMetadata.properties.endTime.description - schemas.SdfDownloadTaskMetadata.properties.endTime.format - schemas.SdfDownloadTaskMetadata.properties.endTime.type - schemas.SdfDownloadTaskMetadata.properties.version.description - schemas.SdfDownloadTaskMetadata.properties.version.enum - schemas.SdfDownloadTaskMetadata.properties.version.enumDeprecated - schemas.SdfDownloadTaskMetadata.properties.version.enumDescriptions - schemas.SdfDownloadTaskMetadata.properties.version.type - schemas.SdfDownloadTaskMetadata.type - schemas.SearchTargetingOptionsRequest.description - schemas.SearchTargetingOptionsRequest.id - schemas.SearchTargetingOptionsRequest.properties.advertiserId.description - schemas.SearchTargetingOptionsRequest.properties.advertiserId.format - schemas.SearchTargetingOptionsRequest.properties.advertiserId.type - schemas.SearchTargetingOptionsRequest.properties.businessChainSearchTerms.$ref - schemas.SearchTargetingOptionsRequest.properties.businessChainSearchTerms.description - schemas.SearchTargetingOptionsRequest.properties.geoRegionSearchTerms.$ref - schemas.SearchTargetingOptionsRequest.properties.geoRegionSearchTerms.description - schemas.SearchTargetingOptionsRequest.properties.pageSize.description - schemas.SearchTargetingOptionsRequest.properties.pageSize.format - schemas.SearchTargetingOptionsRequest.properties.pageSize.type - schemas.SearchTargetingOptionsRequest.properties.pageToken.description - schemas.SearchTargetingOptionsRequest.properties.pageToken.type - schemas.SearchTargetingOptionsRequest.properties.poiSearchTerms.$ref - schemas.SearchTargetingOptionsRequest.properties.poiSearchTerms.description - schemas.SearchTargetingOptionsRequest.type - schemas.SearchTargetingOptionsResponse.description - schemas.SearchTargetingOptionsResponse.id - schemas.SearchTargetingOptionsResponse.properties.nextPageToken.description - schemas.SearchTargetingOptionsResponse.properties.nextPageToken.type - schemas.SearchTargetingOptionsResponse.properties.targetingOptions.description - schemas.SearchTargetingOptionsResponse.properties.targetingOptions.items.$ref - schemas.SearchTargetingOptionsResponse.properties.targetingOptions.type - schemas.SearchTargetingOptionsResponse.type - schemas.SensitiveCategoryAssignedTargetingOptionDetails.description - schemas.SensitiveCategoryAssignedTargetingOptionDetails.id - schemas.SensitiveCategoryAssignedTargetingOptionDetails.properties.excludedSensitiveCategory.description - schemas.SensitiveCategoryAssignedTargetingOptionDetails.properties.excludedSensitiveCategory.enum - schemas.SensitiveCategoryAssignedTargetingOptionDetails.properties.excludedSensitiveCategory.enumDescriptions - schemas.SensitiveCategoryAssignedTargetingOptionDetails.properties.excludedSensitiveCategory.type - schemas.SensitiveCategoryAssignedTargetingOptionDetails.type - schemas.SensitiveCategoryTargetingOptionDetails.description - schemas.SensitiveCategoryTargetingOptionDetails.id - schemas.SensitiveCategoryTargetingOptionDetails.properties.sensitiveCategory.description - schemas.SensitiveCategoryTargetingOptionDetails.properties.sensitiveCategory.enum - schemas.SensitiveCategoryTargetingOptionDetails.properties.sensitiveCategory.enumDescriptions - schemas.SensitiveCategoryTargetingOptionDetails.properties.sensitiveCategory.readOnly - schemas.SensitiveCategoryTargetingOptionDetails.properties.sensitiveCategory.type - schemas.SensitiveCategoryTargetingOptionDetails.type - schemas.SessionPositionAssignedTargetingOptionDetails.description - schemas.SessionPositionAssignedTargetingOptionDetails.id - schemas.SessionPositionAssignedTargetingOptionDetails.properties.sessionPosition.description - schemas.SessionPositionAssignedTargetingOptionDetails.properties.sessionPosition.enum - schemas.SessionPositionAssignedTargetingOptionDetails.properties.sessionPosition.enumDescriptions - schemas.SessionPositionAssignedTargetingOptionDetails.properties.sessionPosition.type - schemas.SessionPositionAssignedTargetingOptionDetails.type - schemas.Site.description - schemas.Site.id - schemas.Site.properties.name.description - schemas.Site.properties.name.readOnly - schemas.Site.properties.name.type - schemas.Site.properties.urlOrAppId.description - schemas.Site.properties.urlOrAppId.type - schemas.Site.type - schemas.SubExchangeAssignedTargetingOptionDetails.description - schemas.SubExchangeAssignedTargetingOptionDetails.id - schemas.SubExchangeAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.SubExchangeAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.SubExchangeAssignedTargetingOptionDetails.type - schemas.SubExchangeTargetingOptionDetails.description - schemas.SubExchangeTargetingOptionDetails.id - schemas.SubExchangeTargetingOptionDetails.properties.displayName.description - schemas.SubExchangeTargetingOptionDetails.properties.displayName.readOnly - schemas.SubExchangeTargetingOptionDetails.properties.displayName.type - schemas.SubExchangeTargetingOptionDetails.type - schemas.TargetFrequency.description - schemas.TargetFrequency.id - schemas.TargetFrequency.properties.targetCount.description - schemas.TargetFrequency.properties.targetCount.format - schemas.TargetFrequency.properties.targetCount.type - schemas.TargetFrequency.properties.timeUnit.description - schemas.TargetFrequency.properties.timeUnit.enum - schemas.TargetFrequency.properties.timeUnit.enumDeprecated - schemas.TargetFrequency.properties.timeUnit.enumDescriptions - schemas.TargetFrequency.properties.timeUnit.type - schemas.TargetFrequency.properties.timeUnitCount.description - schemas.TargetFrequency.properties.timeUnitCount.format - schemas.TargetFrequency.properties.timeUnitCount.type - schemas.TargetFrequency.type - schemas.TargetingExpansionConfig.description - schemas.TargetingExpansionConfig.id - schemas.TargetingExpansionConfig.properties.audienceExpansionLevel.description - schemas.TargetingExpansionConfig.properties.audienceExpansionLevel.enum - schemas.TargetingExpansionConfig.properties.audienceExpansionLevel.enumDescriptions - schemas.TargetingExpansionConfig.properties.audienceExpansionLevel.readOnly - schemas.TargetingExpansionConfig.properties.audienceExpansionLevel.type - schemas.TargetingExpansionConfig.properties.audienceExpansionSeedListExcluded.description - schemas.TargetingExpansionConfig.properties.audienceExpansionSeedListExcluded.readOnly - schemas.TargetingExpansionConfig.properties.audienceExpansionSeedListExcluded.type - schemas.TargetingExpansionConfig.properties.enableOptimizedTargeting.description - schemas.TargetingExpansionConfig.properties.enableOptimizedTargeting.type - schemas.TargetingExpansionConfig.type - schemas.TargetingOption.description - schemas.TargetingOption.id - schemas.TargetingOption.properties.ageRangeDetails.$ref - schemas.TargetingOption.properties.ageRangeDetails.description - schemas.TargetingOption.properties.appCategoryDetails.$ref - schemas.TargetingOption.properties.appCategoryDetails.description - schemas.TargetingOption.properties.audioContentTypeDetails.$ref - schemas.TargetingOption.properties.audioContentTypeDetails.description - schemas.TargetingOption.properties.authorizedSellerStatusDetails.$ref - schemas.TargetingOption.properties.authorizedSellerStatusDetails.description - schemas.TargetingOption.properties.browserDetails.$ref - schemas.TargetingOption.properties.browserDetails.description - schemas.TargetingOption.properties.businessChainDetails.$ref - schemas.TargetingOption.properties.businessChainDetails.description - schemas.TargetingOption.properties.carrierAndIspDetails.$ref - schemas.TargetingOption.properties.carrierAndIspDetails.description - schemas.TargetingOption.properties.categoryDetails.$ref - schemas.TargetingOption.properties.categoryDetails.description - schemas.TargetingOption.properties.contentDurationDetails.$ref - schemas.TargetingOption.properties.contentDurationDetails.description - schemas.TargetingOption.properties.contentGenreDetails.$ref - schemas.TargetingOption.properties.contentGenreDetails.description - schemas.TargetingOption.properties.contentInstreamPositionDetails.$ref - schemas.TargetingOption.properties.contentInstreamPositionDetails.description - schemas.TargetingOption.properties.contentOutstreamPositionDetails.$ref - schemas.TargetingOption.properties.contentOutstreamPositionDetails.description - schemas.TargetingOption.properties.contentStreamTypeDetails.$ref - schemas.TargetingOption.properties.contentStreamTypeDetails.description - schemas.TargetingOption.properties.deviceMakeModelDetails.$ref - schemas.TargetingOption.properties.deviceMakeModelDetails.description - schemas.TargetingOption.properties.deviceTypeDetails.$ref - schemas.TargetingOption.properties.deviceTypeDetails.description - schemas.TargetingOption.properties.digitalContentLabelDetails.$ref - schemas.TargetingOption.properties.digitalContentLabelDetails.description - schemas.TargetingOption.properties.environmentDetails.$ref - schemas.TargetingOption.properties.environmentDetails.description - schemas.TargetingOption.properties.exchangeDetails.$ref - schemas.TargetingOption.properties.exchangeDetails.description - schemas.TargetingOption.properties.genderDetails.$ref - schemas.TargetingOption.properties.genderDetails.description - schemas.TargetingOption.properties.geoRegionDetails.$ref - schemas.TargetingOption.properties.geoRegionDetails.description - schemas.TargetingOption.properties.householdIncomeDetails.$ref - schemas.TargetingOption.properties.householdIncomeDetails.description - schemas.TargetingOption.properties.languageDetails.$ref - schemas.TargetingOption.properties.languageDetails.description - schemas.TargetingOption.properties.name.description - schemas.TargetingOption.properties.name.readOnly - schemas.TargetingOption.properties.name.type - schemas.TargetingOption.properties.nativeContentPositionDetails.$ref - schemas.TargetingOption.properties.nativeContentPositionDetails.description - schemas.TargetingOption.properties.omidDetails.$ref - schemas.TargetingOption.properties.omidDetails.description - schemas.TargetingOption.properties.onScreenPositionDetails.$ref - schemas.TargetingOption.properties.onScreenPositionDetails.description - schemas.TargetingOption.properties.operatingSystemDetails.$ref - schemas.TargetingOption.properties.operatingSystemDetails.description - schemas.TargetingOption.properties.parentalStatusDetails.$ref - schemas.TargetingOption.properties.parentalStatusDetails.description - schemas.TargetingOption.properties.poiDetails.$ref - schemas.TargetingOption.properties.poiDetails.description - schemas.TargetingOption.properties.sensitiveCategoryDetails.$ref - schemas.TargetingOption.properties.sensitiveCategoryDetails.description - schemas.TargetingOption.properties.subExchangeDetails.$ref - schemas.TargetingOption.properties.subExchangeDetails.description - schemas.TargetingOption.properties.targetingOptionId.description - schemas.TargetingOption.properties.targetingOptionId.readOnly - schemas.TargetingOption.properties.targetingOptionId.type - schemas.TargetingOption.properties.targetingType.description - schemas.TargetingOption.properties.targetingType.enum - schemas.TargetingOption.properties.targetingType.enumDescriptions - schemas.TargetingOption.properties.targetingType.readOnly - schemas.TargetingOption.properties.targetingType.type - schemas.TargetingOption.properties.userRewardedContentDetails.$ref - schemas.TargetingOption.properties.userRewardedContentDetails.description - schemas.TargetingOption.properties.videoPlayerSizeDetails.$ref - schemas.TargetingOption.properties.videoPlayerSizeDetails.description - schemas.TargetingOption.properties.viewabilityDetails.$ref - schemas.TargetingOption.properties.viewabilityDetails.description - schemas.TargetingOption.type - schemas.ThirdPartyMeasurementConfigs.description - schemas.ThirdPartyMeasurementConfigs.id - schemas.ThirdPartyMeasurementConfigs.properties.brandLiftVendorConfigs.description - schemas.ThirdPartyMeasurementConfigs.properties.brandLiftVendorConfigs.items.$ref - schemas.ThirdPartyMeasurementConfigs.properties.brandLiftVendorConfigs.type - schemas.ThirdPartyMeasurementConfigs.properties.brandSafetyVendorConfigs.description - schemas.ThirdPartyMeasurementConfigs.properties.brandSafetyVendorConfigs.items.$ref - schemas.ThirdPartyMeasurementConfigs.properties.brandSafetyVendorConfigs.type - schemas.ThirdPartyMeasurementConfigs.properties.reachVendorConfigs.description - schemas.ThirdPartyMeasurementConfigs.properties.reachVendorConfigs.items.$ref - schemas.ThirdPartyMeasurementConfigs.properties.reachVendorConfigs.type - schemas.ThirdPartyMeasurementConfigs.properties.viewabilityVendorConfigs.description - schemas.ThirdPartyMeasurementConfigs.properties.viewabilityVendorConfigs.items.$ref - schemas.ThirdPartyMeasurementConfigs.properties.viewabilityVendorConfigs.type - schemas.ThirdPartyMeasurementConfigs.type - schemas.ThirdPartyOnlyConfig.description - schemas.ThirdPartyOnlyConfig.id - schemas.ThirdPartyOnlyConfig.properties.pixelOrderIdReportingEnabled.description - schemas.ThirdPartyOnlyConfig.properties.pixelOrderIdReportingEnabled.type - schemas.ThirdPartyOnlyConfig.type - schemas.ThirdPartyUrl.description - schemas.ThirdPartyUrl.id - schemas.ThirdPartyUrl.properties.type.description - schemas.ThirdPartyUrl.properties.type.enum - schemas.ThirdPartyUrl.properties.type.enumDescriptions - schemas.ThirdPartyUrl.properties.type.type - schemas.ThirdPartyUrl.properties.url.description - schemas.ThirdPartyUrl.properties.url.type - schemas.ThirdPartyUrl.type - schemas.ThirdPartyVendorConfig.description - schemas.ThirdPartyVendorConfig.id - schemas.ThirdPartyVendorConfig.properties.placementId.description - schemas.ThirdPartyVendorConfig.properties.placementId.type - schemas.ThirdPartyVendorConfig.properties.vendor.description - schemas.ThirdPartyVendorConfig.properties.vendor.enum - schemas.ThirdPartyVendorConfig.properties.vendor.enumDescriptions - schemas.ThirdPartyVendorConfig.properties.vendor.type - schemas.ThirdPartyVendorConfig.type - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.description - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.id - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.properties.adloox.$ref - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.properties.adloox.description - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.properties.doubleVerify.$ref - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.properties.doubleVerify.description - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.properties.integralAdScience.$ref - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.properties.integralAdScience.description - schemas.ThirdPartyVerifierAssignedTargetingOptionDetails.type - schemas.TimeRange.description - schemas.TimeRange.id - schemas.TimeRange.properties.endTime.description - schemas.TimeRange.properties.endTime.format - schemas.TimeRange.properties.endTime.type - schemas.TimeRange.properties.startTime.description - schemas.TimeRange.properties.startTime.format - schemas.TimeRange.properties.startTime.type - schemas.TimeRange.type - schemas.TimerEvent.description - schemas.TimerEvent.id - schemas.TimerEvent.properties.name.description - schemas.TimerEvent.properties.name.type - schemas.TimerEvent.properties.reportingName.description - schemas.TimerEvent.properties.reportingName.type - schemas.TimerEvent.type - schemas.TrackingFloodlightActivityConfig.description - schemas.TrackingFloodlightActivityConfig.id - schemas.TrackingFloodlightActivityConfig.properties.floodlightActivityId.description - schemas.TrackingFloodlightActivityConfig.properties.floodlightActivityId.format - schemas.TrackingFloodlightActivityConfig.properties.floodlightActivityId.type - schemas.TrackingFloodlightActivityConfig.properties.postClickLookbackWindowDays.description - schemas.TrackingFloodlightActivityConfig.properties.postClickLookbackWindowDays.format - schemas.TrackingFloodlightActivityConfig.properties.postClickLookbackWindowDays.type - schemas.TrackingFloodlightActivityConfig.properties.postViewLookbackWindowDays.description - schemas.TrackingFloodlightActivityConfig.properties.postViewLookbackWindowDays.format - schemas.TrackingFloodlightActivityConfig.properties.postViewLookbackWindowDays.type - schemas.TrackingFloodlightActivityConfig.type - schemas.Transcode.description - schemas.Transcode.id - schemas.Transcode.properties.audioBitRateKbps.description - schemas.Transcode.properties.audioBitRateKbps.format - schemas.Transcode.properties.audioBitRateKbps.type - schemas.Transcode.properties.audioSampleRateHz.description - schemas.Transcode.properties.audioSampleRateHz.format - schemas.Transcode.properties.audioSampleRateHz.type - schemas.Transcode.properties.bitRateKbps.description - schemas.Transcode.properties.bitRateKbps.format - schemas.Transcode.properties.bitRateKbps.type - schemas.Transcode.properties.dimensions.$ref - schemas.Transcode.properties.dimensions.description - schemas.Transcode.properties.fileSizeBytes.description - schemas.Transcode.properties.fileSizeBytes.format - schemas.Transcode.properties.fileSizeBytes.type - schemas.Transcode.properties.frameRate.description - schemas.Transcode.properties.frameRate.format - schemas.Transcode.properties.frameRate.type - schemas.Transcode.properties.mimeType.description - schemas.Transcode.properties.mimeType.type - schemas.Transcode.properties.name.description - schemas.Transcode.properties.name.type - schemas.Transcode.properties.transcoded.description - schemas.Transcode.properties.transcoded.type - schemas.Transcode.type - schemas.UniversalAdId.description - schemas.UniversalAdId.id - schemas.UniversalAdId.properties.id.description - schemas.UniversalAdId.properties.id.type - schemas.UniversalAdId.properties.registry.description - schemas.UniversalAdId.properties.registry.enum - schemas.UniversalAdId.properties.registry.enumDescriptions - schemas.UniversalAdId.properties.registry.type - schemas.UniversalAdId.type - schemas.UrlAssignedTargetingOptionDetails.description - schemas.UrlAssignedTargetingOptionDetails.id - schemas.UrlAssignedTargetingOptionDetails.properties.negative.description - schemas.UrlAssignedTargetingOptionDetails.properties.negative.type - schemas.UrlAssignedTargetingOptionDetails.properties.url.description - schemas.UrlAssignedTargetingOptionDetails.properties.url.type - schemas.UrlAssignedTargetingOptionDetails.type - schemas.User.description - schemas.User.id - schemas.User.properties.assignedUserRoles.description - schemas.User.properties.assignedUserRoles.items.$ref - schemas.User.properties.assignedUserRoles.type - schemas.User.properties.displayName.description - schemas.User.properties.displayName.type - schemas.User.properties.email.description - schemas.User.properties.email.type - schemas.User.properties.lastLoginTime.description - schemas.User.properties.lastLoginTime.format - schemas.User.properties.lastLoginTime.readOnly - schemas.User.properties.lastLoginTime.type - schemas.User.properties.name.description - schemas.User.properties.name.readOnly - schemas.User.properties.name.type - schemas.User.properties.userId.description - schemas.User.properties.userId.format - schemas.User.properties.userId.readOnly - schemas.User.properties.userId.type - schemas.User.type - schemas.UserRewardedContentAssignedTargetingOptionDetails.description - schemas.UserRewardedContentAssignedTargetingOptionDetails.id - schemas.UserRewardedContentAssignedTargetingOptionDetails.properties.targetingOptionId.description - schemas.UserRewardedContentAssignedTargetingOptionDetails.properties.targetingOptionId.type - schemas.UserRewardedContentAssignedTargetingOptionDetails.properties.userRewardedContent.description - schemas.UserRewardedContentAssignedTargetingOptionDetails.properties.userRewardedContent.enum - schemas.UserRewardedContentAssignedTargetingOptionDetails.properties.userRewardedContent.enumDescriptions - schemas.UserRewardedContentAssignedTargetingOptionDetails.properties.userRewardedContent.readOnly - schemas.UserRewardedContentAssignedTargetingOptionDetails.properties.userRewardedContent.type - schemas.UserRewardedContentAssignedTargetingOptionDetails.type - schemas.UserRewardedContentTargetingOptionDetails.description - schemas.UserRewardedContentTargetingOptionDetails.id - schemas.UserRewardedContentTargetingOptionDetails.properties.userRewardedContent.description - schemas.UserRewardedContentTargetingOptionDetails.properties.userRewardedContent.enum - schemas.UserRewardedContentTargetingOptionDetails.properties.userRewardedContent.enumDescriptions - schemas.UserRewardedContentTargetingOptionDetails.properties.userRewardedContent.readOnly - schemas.UserRewardedContentTargetingOptionDetails.properties.userRewardedContent.type - schemas.UserRewardedContentTargetingOptionDetails.type - schemas.VideoAdSequenceSettings.description - schemas.VideoAdSequenceSettings.id - schemas.VideoAdSequenceSettings.properties.minimumDuration.description - schemas.VideoAdSequenceSettings.properties.minimumDuration.enum - schemas.VideoAdSequenceSettings.properties.minimumDuration.enumDescriptions - schemas.VideoAdSequenceSettings.properties.minimumDuration.type - schemas.VideoAdSequenceSettings.properties.steps.description - schemas.VideoAdSequenceSettings.properties.steps.items.$ref - schemas.VideoAdSequenceSettings.properties.steps.type - schemas.VideoAdSequenceSettings.type - schemas.VideoAdSequenceStep.description - schemas.VideoAdSequenceStep.id - schemas.VideoAdSequenceStep.properties.adGroupId.description - schemas.VideoAdSequenceStep.properties.adGroupId.format - schemas.VideoAdSequenceStep.properties.adGroupId.type - schemas.VideoAdSequenceStep.properties.interactionType.description - schemas.VideoAdSequenceStep.properties.interactionType.enum - schemas.VideoAdSequenceStep.properties.interactionType.enumDescriptions - schemas.VideoAdSequenceStep.properties.interactionType.type - schemas.VideoAdSequenceStep.properties.previousStepId.description - schemas.VideoAdSequenceStep.properties.previousStepId.format - schemas.VideoAdSequenceStep.properties.previousStepId.type - schemas.VideoAdSequenceStep.properties.stepId.description - schemas.VideoAdSequenceStep.properties.stepId.format - schemas.VideoAdSequenceStep.properties.stepId.type - schemas.VideoAdSequenceStep.type - schemas.VideoDiscoveryAd.description - schemas.VideoDiscoveryAd.id - schemas.VideoDiscoveryAd.properties.description1.description - schemas.VideoDiscoveryAd.properties.description1.type - schemas.VideoDiscoveryAd.properties.description2.description - schemas.VideoDiscoveryAd.properties.description2.type - schemas.VideoDiscoveryAd.properties.headline.description - schemas.VideoDiscoveryAd.properties.headline.type - schemas.VideoDiscoveryAd.properties.thumbnail.description - schemas.VideoDiscoveryAd.properties.thumbnail.enum - schemas.VideoDiscoveryAd.properties.thumbnail.enumDescriptions - schemas.VideoDiscoveryAd.properties.thumbnail.type - schemas.VideoDiscoveryAd.properties.video.$ref - schemas.VideoDiscoveryAd.properties.video.description - schemas.VideoDiscoveryAd.type - schemas.VideoPerformanceAd.description - schemas.VideoPerformanceAd.id - schemas.VideoPerformanceAd.properties.actionButtonLabels.description - schemas.VideoPerformanceAd.properties.actionButtonLabels.items.type - schemas.VideoPerformanceAd.properties.actionButtonLabels.type - schemas.VideoPerformanceAd.properties.companionBanners.description - schemas.VideoPerformanceAd.properties.companionBanners.items.$ref - schemas.VideoPerformanceAd.properties.companionBanners.type - schemas.VideoPerformanceAd.properties.customParameters.additionalProperties.type - schemas.VideoPerformanceAd.properties.customParameters.description - schemas.VideoPerformanceAd.properties.customParameters.type - schemas.VideoPerformanceAd.properties.descriptions.description - schemas.VideoPerformanceAd.properties.descriptions.items.type - schemas.VideoPerformanceAd.properties.descriptions.type - schemas.VideoPerformanceAd.properties.displayUrlBreadcrumb1.description - schemas.VideoPerformanceAd.properties.displayUrlBreadcrumb1.type - schemas.VideoPerformanceAd.properties.displayUrlBreadcrumb2.description - schemas.VideoPerformanceAd.properties.displayUrlBreadcrumb2.type - schemas.VideoPerformanceAd.properties.domain.description - schemas.VideoPerformanceAd.properties.domain.type - schemas.VideoPerformanceAd.properties.finalUrl.description - schemas.VideoPerformanceAd.properties.finalUrl.type - schemas.VideoPerformanceAd.properties.headlines.description - schemas.VideoPerformanceAd.properties.headlines.items.type - schemas.VideoPerformanceAd.properties.headlines.type - schemas.VideoPerformanceAd.properties.longHeadlines.description - schemas.VideoPerformanceAd.properties.longHeadlines.items.type - schemas.VideoPerformanceAd.properties.longHeadlines.type - schemas.VideoPerformanceAd.properties.trackingUrl.description - schemas.VideoPerformanceAd.properties.trackingUrl.type - schemas.VideoPerformanceAd.properties.videos.description - schemas.VideoPerformanceAd.properties.videos.items.$ref - schemas.VideoPerformanceAd.properties.videos.type - schemas.VideoPerformanceAd.type - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.description - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.id - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.properties.videoPlayerSize.description - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.properties.videoPlayerSize.enum - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.properties.videoPlayerSize.enumDescriptions - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.properties.videoPlayerSize.type - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.type - schemas.VideoPlayerSizeTargetingOptionDetails.description - schemas.VideoPlayerSizeTargetingOptionDetails.id - schemas.VideoPlayerSizeTargetingOptionDetails.properties.videoPlayerSize.description - schemas.VideoPlayerSizeTargetingOptionDetails.properties.videoPlayerSize.enum - schemas.VideoPlayerSizeTargetingOptionDetails.properties.videoPlayerSize.enumDescriptions - schemas.VideoPlayerSizeTargetingOptionDetails.properties.videoPlayerSize.readOnly - schemas.VideoPlayerSizeTargetingOptionDetails.properties.videoPlayerSize.type - schemas.VideoPlayerSizeTargetingOptionDetails.type - schemas.ViewabilityAssignedTargetingOptionDetails.description - schemas.ViewabilityAssignedTargetingOptionDetails.id - schemas.ViewabilityAssignedTargetingOptionDetails.properties.viewability.description - schemas.ViewabilityAssignedTargetingOptionDetails.properties.viewability.enum - schemas.ViewabilityAssignedTargetingOptionDetails.properties.viewability.enumDescriptions - schemas.ViewabilityAssignedTargetingOptionDetails.properties.viewability.type - schemas.ViewabilityAssignedTargetingOptionDetails.type - schemas.ViewabilityTargetingOptionDetails.description - schemas.ViewabilityTargetingOptionDetails.id - schemas.ViewabilityTargetingOptionDetails.properties.viewability.description - schemas.ViewabilityTargetingOptionDetails.properties.viewability.enum - schemas.ViewabilityTargetingOptionDetails.properties.viewability.enumDescriptions - schemas.ViewabilityTargetingOptionDetails.properties.viewability.readOnly - schemas.ViewabilityTargetingOptionDetails.properties.viewability.type - schemas.ViewabilityTargetingOptionDetails.type - schemas.YoutubeAndPartnersBiddingStrategy.description - schemas.YoutubeAndPartnersBiddingStrategy.id - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaSource.description - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaSource.enum - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaSource.enumDescriptions - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaSource.readOnly - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaSource.type - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaValue.description - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaValue.format - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaValue.readOnly - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaValue.type - schemas.YoutubeAndPartnersBiddingStrategy.properties.type.description - schemas.YoutubeAndPartnersBiddingStrategy.properties.type.enum - schemas.YoutubeAndPartnersBiddingStrategy.properties.type.enumDescriptions - schemas.YoutubeAndPartnersBiddingStrategy.properties.type.type - schemas.YoutubeAndPartnersBiddingStrategy.properties.value.description - schemas.YoutubeAndPartnersBiddingStrategy.properties.value.format - schemas.YoutubeAndPartnersBiddingStrategy.properties.value.type - schemas.YoutubeAndPartnersBiddingStrategy.type - schemas.YoutubeAndPartnersInventorySourceConfig.description - schemas.YoutubeAndPartnersInventorySourceConfig.id - schemas.YoutubeAndPartnersInventorySourceConfig.properties.includeGoogleTv.description - schemas.YoutubeAndPartnersInventorySourceConfig.properties.includeGoogleTv.type - schemas.YoutubeAndPartnersInventorySourceConfig.properties.includeYoutube.description - schemas.YoutubeAndPartnersInventorySourceConfig.properties.includeYoutube.type - schemas.YoutubeAndPartnersInventorySourceConfig.properties.includeYoutubeVideoPartners.description - schemas.YoutubeAndPartnersInventorySourceConfig.properties.includeYoutubeVideoPartners.type - schemas.YoutubeAndPartnersInventorySourceConfig.type - schemas.YoutubeAndPartnersSettings.description - schemas.YoutubeAndPartnersSettings.id - schemas.YoutubeAndPartnersSettings.properties.contentCategory.description - schemas.YoutubeAndPartnersSettings.properties.contentCategory.enum - schemas.YoutubeAndPartnersSettings.properties.contentCategory.enumDescriptions - schemas.YoutubeAndPartnersSettings.properties.contentCategory.type - schemas.YoutubeAndPartnersSettings.properties.effectiveContentCategory.description - schemas.YoutubeAndPartnersSettings.properties.effectiveContentCategory.enum - schemas.YoutubeAndPartnersSettings.properties.effectiveContentCategory.enumDescriptions - schemas.YoutubeAndPartnersSettings.properties.effectiveContentCategory.readOnly - schemas.YoutubeAndPartnersSettings.properties.effectiveContentCategory.type - schemas.YoutubeAndPartnersSettings.properties.inventorySourceSettings.$ref - schemas.YoutubeAndPartnersSettings.properties.inventorySourceSettings.description - schemas.YoutubeAndPartnersSettings.properties.leadFormId.description - schemas.YoutubeAndPartnersSettings.properties.leadFormId.format - schemas.YoutubeAndPartnersSettings.properties.leadFormId.type - schemas.YoutubeAndPartnersSettings.properties.linkedMerchantId.description - schemas.YoutubeAndPartnersSettings.properties.linkedMerchantId.format - schemas.YoutubeAndPartnersSettings.properties.linkedMerchantId.type - schemas.YoutubeAndPartnersSettings.properties.relatedVideoIds.description - schemas.YoutubeAndPartnersSettings.properties.relatedVideoIds.items.type - schemas.YoutubeAndPartnersSettings.properties.relatedVideoIds.type - schemas.YoutubeAndPartnersSettings.properties.targetFrequency.$ref - schemas.YoutubeAndPartnersSettings.properties.targetFrequency.description - schemas.YoutubeAndPartnersSettings.properties.thirdPartyMeasurementConfigs.$ref - schemas.YoutubeAndPartnersSettings.properties.thirdPartyMeasurementConfigs.description - schemas.YoutubeAndPartnersSettings.properties.videoAdSequenceSettings.$ref - schemas.YoutubeAndPartnersSettings.properties.videoAdSequenceSettings.description - schemas.YoutubeAndPartnersSettings.properties.viewFrequencyCap.$ref - schemas.YoutubeAndPartnersSettings.properties.viewFrequencyCap.description - schemas.YoutubeAndPartnersSettings.type - schemas.YoutubeChannelAssignedTargetingOptionDetails.description - schemas.YoutubeChannelAssignedTargetingOptionDetails.id - schemas.YoutubeChannelAssignedTargetingOptionDetails.properties.channelId.description - schemas.YoutubeChannelAssignedTargetingOptionDetails.properties.channelId.type - schemas.YoutubeChannelAssignedTargetingOptionDetails.properties.negative.description - schemas.YoutubeChannelAssignedTargetingOptionDetails.properties.negative.type - schemas.YoutubeChannelAssignedTargetingOptionDetails.type - schemas.YoutubeVideoAssignedTargetingOptionDetails.description - schemas.YoutubeVideoAssignedTargetingOptionDetails.id - schemas.YoutubeVideoAssignedTargetingOptionDetails.properties.negative.description - schemas.YoutubeVideoAssignedTargetingOptionDetails.properties.negative.type - schemas.YoutubeVideoAssignedTargetingOptionDetails.properties.videoId.description - schemas.YoutubeVideoAssignedTargetingOptionDetails.properties.videoId.type - schemas.YoutubeVideoAssignedTargetingOptionDetails.type - schemas.YoutubeVideoDetails.description - schemas.YoutubeVideoDetails.id - schemas.YoutubeVideoDetails.properties.id.description - schemas.YoutubeVideoDetails.properties.id.type - schemas.YoutubeVideoDetails.properties.unavailableReason.description - schemas.YoutubeVideoDetails.properties.unavailableReason.enum - schemas.YoutubeVideoDetails.properties.unavailableReason.enumDescriptions - schemas.YoutubeVideoDetails.properties.unavailableReason.type - schemas.YoutubeVideoDetails.type --- discovery/displayvideo-v2.json | 204 +- discovery/displayvideo-v3.json | 269 +- discovery/displayvideo-v4.json | 21429 +++++++++++++++++++++++++++- src/apis/displayvideo/v2.ts | 140 +- src/apis/displayvideo/v3.ts | 273 +- src/apis/displayvideo/v4.ts | 23496 ++++++++++++++++++++++++++++++- 6 files changed, 45174 insertions(+), 637 deletions(-) diff --git a/discovery/displayvideo-v2.json b/discovery/displayvideo-v2.json index 839a3c46566..8743510d958 100644 --- a/discovery/displayvideo-v2.json +++ b/discovery/displayvideo-v2.json @@ -4832,7 +4832,7 @@ ] }, "patch": { - "description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.", + "description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v2/customBiddingAlgorithms/{customBiddingAlgorithmsId}", "httpMethod": "PATCH", "id": "displayvideo.customBiddingAlgorithms.patch", @@ -4909,7 +4909,7 @@ "scripts": { "methods": { "create": { - "description": "Creates a new custom bidding script. Returns the newly created script if successful.", + "description": "Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v2/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.scripts.create", @@ -8010,7 +8010,7 @@ } } }, - "revision": "20250124", + "revision": "20250313", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -8587,10 +8587,10 @@ "properties": { "asset": { "$ref": "Asset", - "description": "The associated asset." + "description": "Optional. The associated asset." }, "role": { - "description": "The role of this asset for the creative.", + "description": "Optional. The role of this asset for the creative.", "enum": [ "ASSET_ROLE_UNSPECIFIED", "ASSET_ROLE_MAIN", @@ -8620,24 +8620,24 @@ "The asset is the main asset of the creative.", "The asset is a backup asset of the creative.", "The asset is a polite load asset of the creative.", - "Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.", - "The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in https://play.google.com/store/apps/details?id=com.company.appname the identifier is com.company.appname. Assets of this role are read-only.", - "The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in https://apps.apple.com/us/app/gmail-email-by-google/id422689480 the ID is 422689480. Assets of this role are read-only.", + "The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in `https://play.google.com/store/apps/details?id=com.company.appname` the identifier is com.company.appname. Assets of this role are read-only.", + "The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in `https://apps.apple.com/us/app/gmail-email-by-google/id422689480` the ID is 422689480. Assets of this role are read-only.", "The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.", - "The icon of a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", - "The cover image of a native video creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_VIDEO`", - "The main color to use in a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", - "The accent color to use in a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", - "Whether the creative must use a logo asset. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", - "Whether the creative must use an image asset. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", - "Whether asset enhancements can be applied to the creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" + "The icon of a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", + "The cover image of a native video creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_VIDEO`", + "The main color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "The accent color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether the creative must use a logo asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether the creative must use an image asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether asset enhancements can be applied to the creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" ], "type": "string" } @@ -9081,24 +9081,24 @@ "type": "object" }, "AudienceGroupAssignedTargetingOptionDetails": { - "description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9", + "description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups.", "id": "AudienceGroupAssignedTargetingOptionDetails", "properties": { "excludedGoogleAudienceGroup": { "$ref": "GoogleAudienceGroup", - "description": "The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other." + "description": "Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other." }, "includedCombinedAudienceGroup": { "$ref": "CombinedAudienceGroup", - "description": "The combined audience ids of the included combined audience group. Contains combined audience ids only." + "description": "Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only." }, "includedCustomListGroup": { "$ref": "CustomListGroup", - "description": "The custom list ids of the included custom list group. Contains custom list ids only." + "description": "Optional. The custom list ids of the included custom list group. Contains custom list ids only." }, "includedGoogleAudienceGroup": { "$ref": "GoogleAudienceGroup", - "description": "The Google audience ids of the included Google audience group. Contains Google audience ids only." + "description": "Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only." } }, "type": "object" @@ -9182,12 +9182,12 @@ "id": "AudioVideoOffset", "properties": { "percentage": { - "description": "The offset in percentage of the audio or video duration.", + "description": "Optional. The offset in percentage of the audio or video duration.", "format": "int64", "type": "string" }, "seconds": { - "description": "The offset in seconds from the start of the audio or video.", + "description": "Optional. The offset in seconds from the start of the audio or video.", "format": "int64", "type": "string" } @@ -10026,7 +10026,7 @@ }, "frequencyCap": { "$ref": "FrequencyCap", - "description": "Required. The frequency cap setting of the campaign." + "description": "Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" }, "name": { "description": "Output only. The resource name of the campaign.", @@ -10342,17 +10342,17 @@ "id": "CmTrackingAd", "properties": { "cmAdId": { - "description": "The ad ID of the campaign manager 360 tracking Ad.", + "description": "Optional. The ad ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmCreativeId": { - "description": "The creative ID of the campaign manager 360 tracking Ad.", + "description": "Optional. The creative ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmPlacementId": { - "description": "The placement ID of the campaign manager 360 tracking Ad.", + "description": "Optional. The placement ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" } @@ -10387,7 +10387,7 @@ "id": "CombinedAudienceGroup", "properties": { "settings": { - "description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", + "description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", "items": { "$ref": "CombinedAudienceTargetingSetting" }, @@ -10736,7 +10736,7 @@ "id": "ConversionCountingConfig", "properties": { "floodlightActivityConfigs": { - "description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.", + "description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "items": { "$ref": "TrackingFloodlightActivityConfig" }, @@ -10996,7 +10996,7 @@ "id": "Creative", "properties": { "additionalDimensions": { - "description": "Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", + "description": "Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", "items": { "$ref": "Dimensions" }, @@ -11009,7 +11009,7 @@ "type": "string" }, "appendedTag": { - "description": "Third-party HTML tracking tag to be appended to the creative tag.", + "description": "Optional. Third-party HTML tracking tag to be appended to the creative tag.", "type": "string" }, "assets": { @@ -11027,10 +11027,10 @@ }, "cmTrackingAd": { "$ref": "CmTrackingAd", - "description": "The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." + "description": "Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." }, "companionCreativeIds": { - "description": "The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", + "description": "Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", "items": { "format": "int64", "type": "string" @@ -11038,7 +11038,7 @@ "type": "array" }, "counterEvents": { - "description": "Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", + "description": "Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", "items": { "$ref": "CounterEvent" }, @@ -11112,7 +11112,7 @@ "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", - "Asset based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." + "Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." ], "type": "string" }, @@ -11218,15 +11218,15 @@ "type": "boolean" }, "iasCampaignMonitoring": { - "description": "Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", + "description": "Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", "type": "boolean" }, "integrationCode": { - "description": "ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", + "description": "Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", "type": "string" }, "jsTrackerUrl": { - "description": "JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "description": "Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "type": "string" }, "lineItemIds": { @@ -11255,12 +11255,12 @@ "type": "string" }, "notes": { - "description": "User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", + "description": "Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", "type": "string" }, "obaIcon": { "$ref": "ObaIcon", - "description": "Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO`" + "description": "Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "oggAudio": { "description": "Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", @@ -11269,7 +11269,7 @@ }, "progressOffset": { "$ref": "AudioVideoOffset", - "description": "Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" + "description": "Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "requireHtml5": { "description": "Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", @@ -11290,10 +11290,10 @@ }, "skipOffset": { "$ref": "AudioVideoOffset", - "description": "Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" + "description": "Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "skippable": { - "description": "Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", + "description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", "type": "boolean" }, "thirdPartyTag": { @@ -11301,28 +11301,28 @@ "type": "string" }, "thirdPartyUrls": { - "description": "Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "description": "Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", "items": { "$ref": "ThirdPartyUrl" }, "type": "array" }, "timerEvents": { - "description": "Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", + "description": "Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", "items": { "$ref": "TimerEvent" }, "type": "array" }, "trackerUrls": { - "description": "Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "description": "Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "items": { "type": "string" }, "type": "array" }, "transcodes": { - "description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", + "description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", "items": { "$ref": "Transcode" }, @@ -11391,7 +11391,7 @@ "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", - "Asset based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." + "Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." ], "type": "string" }, @@ -11425,15 +11425,11 @@ "description": "Required. Immutable. The type of custom bidding algorithm.", "enum": [ "CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED", - "SCRIPT_BASED", - "ADS_DATA_HUB_BASED", - "GOAL_BUILDER_BASED" + "SCRIPT_BASED" ], "enumDescriptions": [ "Algorithm type is not specified or is unknown in this version.", - "Algorithm generated through customer-uploaded custom bidding script files.", - "Algorithm created through Ads Data Hub product.", - "Algorithm created through goal builder in DV3 UI." + "Algorithm generated through customer-uploaded custom bidding script files." ], "type": "string" }, @@ -11671,7 +11667,7 @@ "id": "CustomListGroup", "properties": { "settings": { - "description": "Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.", + "description": "Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.", "items": { "$ref": "CustomListTargetingSetting" }, @@ -13396,11 +13392,11 @@ "id": "ExitEvent", "properties": { "name": { - "description": "The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", + "description": "Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", "type": "string" }, "reportingName": { - "description": "The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", + "description": "Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", "type": "string" }, "type": { @@ -13578,6 +13574,15 @@ "TIME_UNIT_HOURS", "TIME_UNIT_MINUTES" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Time unit value is not specified or is unknown in this version.", "The frequency cap will be applied to the whole life time of the line item.", @@ -13590,7 +13595,7 @@ "type": "string" }, "timeUnitCount": { - "description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59", + "description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59", "format": "int32", "type": "integer" }, @@ -13993,7 +13998,7 @@ "id": "GoogleAudienceGroup", "properties": { "settings": { - "description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.", + "description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.", "items": { "$ref": "GoogleAudienceTargetingSetting" }, @@ -14490,7 +14495,7 @@ }, "bidStrategy": { "$ref": "BiddingStrategy", - "description": "The bidding strategy of the insertion order. By default, fixed_bid is set." + "description": "Optional. The bidding strategy of the insertion order. By default, fixed_bid is set." }, "billableOutcome": { "description": "Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value.", @@ -14558,7 +14563,7 @@ "type": "string" }, "insertionOrderType": { - "description": "The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", + "description": "Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", "enum": [ "INSERTION_ORDER_TYPE_UNSPECIFIED", "RTB", @@ -14573,7 +14578,7 @@ }, "integrationDetails": { "$ref": "IntegrationDetails", - "description": "Additional integration details of the insertion order." + "description": "Optional. Additional integration details of the insertion order." }, "name": { "description": "Output only. The resource name of the insertion order.", @@ -14585,7 +14590,7 @@ "description": "Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`." }, "partnerCosts": { - "description": "The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", + "description": "Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", "items": { "$ref": "PartnerCost" }, @@ -14630,7 +14635,7 @@ "id": "InsertionOrderBudget", "properties": { "automationType": { - "description": "The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", + "description": "Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", "enum": [ "INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED", "INSERTION_ORDER_AUTOMATION_TYPE_BUDGET", @@ -14679,7 +14684,7 @@ "type": "string" }, "campaignBudgetId": { - "description": "The budget_id of the campaign budget that this insertion order budget segment is a part of.", + "description": "Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.", "format": "int64", "type": "string" }, @@ -14688,7 +14693,7 @@ "description": "Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." }, "description": { - "description": "The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", + "description": "Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", "type": "string" } }, @@ -15622,7 +15627,7 @@ }, "conversionCounting": { "$ref": "ConversionCountingConfig", - "description": "The conversion tracking setting of the line item." + "description": "The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight)." }, "creativeIds": { "description": "The IDs of the creatives associated with the line item.", @@ -16664,7 +16669,7 @@ "id": "MaximizeSpendBidStrategy", "properties": { "customBiddingAlgorithmId": { - "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", + "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "format": "int64", "type": "string" }, @@ -16916,19 +16921,19 @@ "id": "ObaIcon", "properties": { "clickTrackingUrl": { - "description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", + "description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" }, "dimensions": { "$ref": "Dimensions", - "description": "The dimensions of the OBA icon." + "description": "Optional. The dimensions of the OBA icon." }, "landingPageUrl": { - "description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", + "description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" }, "position": { - "description": "The position of the OBA icon on the creative.", + "description": "Optional. The position of the OBA icon on the creative.", "enum": [ "OBA_ICON_POSITION_UNSPECIFIED", "OBA_ICON_POSITION_UPPER_RIGHT", @@ -16946,19 +16951,19 @@ "type": "string" }, "program": { - "description": "The program of the OBA icon. For example: “AdChoices”.", + "description": "Optional. The program of the OBA icon. For example: “AdChoices”.", "type": "string" }, "resourceMimeType": { - "description": "The MIME type of the OBA icon resource.", + "description": "Optional. The MIME type of the OBA icon resource.", "type": "string" }, "resourceUrl": { - "description": "The URL of the OBA icon resource.", + "description": "Optional. The URL of the OBA icon resource.", "type": "string" }, "viewTrackingUrl": { - "description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", + "description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" } }, @@ -17612,7 +17617,7 @@ "id": "PerformanceGoalBidStrategy", "properties": { "customBiddingAlgorithmId": { - "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", + "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "format": "int64", "type": "string" }, @@ -18562,6 +18567,15 @@ "TIME_UNIT_HOURS", "TIME_UNIT_MINUTES" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Time unit value is not specified or is unknown in this version.", "The frequency cap will be applied to the whole life time of the line item.", @@ -18896,7 +18910,7 @@ "id": "ThirdPartyUrl", "properties": { "type": { - "description": "The type of interaction needs to be tracked by the tracking URL", + "description": "Optional. The type of interaction needs to be tracked by the tracking URL", "enum": [ "THIRD_PARTY_URL_TYPE_UNSPECIFIED", "THIRD_PARTY_URL_TYPE_IMPRESSION", @@ -18936,7 +18950,7 @@ "type": "string" }, "url": { - "description": "Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path", + "description": "Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`", "type": "string" } }, @@ -19061,44 +19075,44 @@ "id": "Transcode", "properties": { "audioBitRateKbps": { - "description": "The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", + "description": "Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", "format": "int64", "type": "string" }, "audioSampleRateHz": { - "description": "The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", + "description": "Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", "format": "int64", "type": "string" }, "bitRateKbps": { - "description": "The transcoding bit rate of the transcoded video, in kilobits per second.", + "description": "Optional. The transcoding bit rate of the transcoded video, in kilobits per second.", "format": "int64", "type": "string" }, "dimensions": { "$ref": "Dimensions", - "description": "The dimensions of the transcoded video." + "description": "Optional. The dimensions of the transcoded video." }, "fileSizeBytes": { - "description": "The size of the transcoded file, in bytes.", + "description": "Optional. The size of the transcoded file, in bytes.", "format": "int64", "type": "string" }, "frameRate": { - "description": "The frame rate of the transcoded video, in frames per second.", + "description": "Optional. The frame rate of the transcoded video, in frames per second.", "format": "float", "type": "number" }, "mimeType": { - "description": "The MIME type of the transcoded file.", + "description": "Optional. The MIME type of the transcoded file.", "type": "string" }, "name": { - "description": "The name of the transcoded file.", + "description": "Optional. The name of the transcoded file.", "type": "string" }, "transcoded": { - "description": "Indicates if the transcoding was successful.", + "description": "Optional. Indicates if the transcoding was successful.", "type": "boolean" } }, @@ -19109,11 +19123,11 @@ "id": "UniversalAdId", "properties": { "id": { - "description": "The unique creative identifier.", + "description": "Optional. The unique creative identifier.", "type": "string" }, "registry": { - "description": "The registry provides unique creative identifiers.", + "description": "Optional. The registry provides unique creative identifiers.", "enum": [ "UNIVERSAL_AD_REGISTRY_UNSPECIFIED", "UNIVERSAL_AD_REGISTRY_OTHER", diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index cb2f83d7aec..1d02b18dc72 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -5668,7 +5668,7 @@ ] }, "patch": { - "description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.", + "description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}", "httpMethod": "PATCH", "id": "displayvideo.customBiddingAlgorithms.patch", @@ -5783,7 +5783,7 @@ "rules": { "methods": { "create": { - "description": "Creates a new rules resource. Returns the newly created rules resource if successful.", + "description": "Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.rules.create", @@ -5929,7 +5929,7 @@ "scripts": { "methods": { "create": { - "description": "Creates a new custom bidding script. Returns the newly created script if successful.", + "description": "Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", "httpMethod": "POST", "id": "displayvideo.customBiddingAlgorithms.scripts.create", @@ -6271,7 +6271,7 @@ "type": "string" }, "pageSize": { - "description": "Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "description": "Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", "format": "int32", "location": "query", "type": "integer" @@ -8613,6 +8613,40 @@ } } }, + "sdfuploadtasks": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", + "flatPath": "v3/sdfuploadtasks/operations/{operationsId}", + "httpMethod": "GET", + "id": "displayvideo.sdfuploadtasks.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^sdfuploadtasks/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/doubleclickbidmanager" + ] + } + } + } + } + }, "targetingTypes": { "resources": { "targetingOptions": { @@ -9222,7 +9256,7 @@ } } }, - "revision": "20250124", + "revision": "20250313", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -10571,7 +10605,7 @@ "Signal value is greater than the comparison value.", "Signal value is less than the second.", "Signal value is greater than or equal to the second.", - "Signal value is less or equals to the comparison value." + "Signal value is less than or equal to the comparison value." ], "type": "string" }, @@ -10706,10 +10740,10 @@ "properties": { "asset": { "$ref": "Asset", - "description": "The associated asset." + "description": "Optional. The associated asset." }, "role": { - "description": "The role of this asset for the creative.", + "description": "Optional. The role of this asset for the creative.", "enum": [ "ASSET_ROLE_UNSPECIFIED", "ASSET_ROLE_MAIN", @@ -10739,24 +10773,24 @@ "The asset is the main asset of the creative.", "The asset is a backup asset of the creative.", "The asset is a polite load asset of the creative.", - "Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", - "The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.", - "The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in https://play.google.com/store/apps/details?id=com.company.appname the identifier is com.company.appname. Assets of this role are read-only.", - "The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in https://apps.apple.com/us/app/gmail-email-by-google/id422689480 the ID is 422689480. Assets of this role are read-only.", + "The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in `https://play.google.com/store/apps/details?id=com.company.appname` the identifier is com.company.appname. Assets of this role are read-only.", + "The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in `https://apps.apple.com/us/app/gmail-email-by-google/id422689480` the ID is 422689480. Assets of this role are read-only.", "The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.", - "The icon of a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", - "The cover image of a native video creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_VIDEO`", - "The main color to use in a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", - "The accent color to use in a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", - "Whether the creative must use a logo asset. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", - "Whether the creative must use an image asset. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", - "Whether asset enhancements can be applied to the creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" + "The icon of a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", + "The cover image of a native video creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_VIDEO`", + "The main color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "The accent color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether the creative must use a logo asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether the creative must use an image asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether asset enhancements can be applied to the creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" ], "type": "string" } @@ -11200,27 +11234,27 @@ "type": "object" }, "AudienceGroupAssignedTargetingOptionDetails": { - "description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9", + "description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups.", "id": "AudienceGroupAssignedTargetingOptionDetails", "properties": { "excludedFirstAndThirdPartyAudienceGroup": { "$ref": "FirstAndThirdPartyAudienceGroup", - "description": "The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other." + "description": "Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other." }, "excludedGoogleAudienceGroup": { "$ref": "GoogleAudienceGroup", - "description": "The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other." + "description": "Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other." }, "includedCombinedAudienceGroup": { "$ref": "CombinedAudienceGroup", - "description": "The combined audience ids of the included combined audience group. Contains combined audience ids only." + "description": "Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only." }, "includedCustomListGroup": { "$ref": "CustomListGroup", - "description": "The custom list ids of the included custom list group. Contains custom list ids only." + "description": "Optional. The custom list ids of the included custom list group. Contains custom list ids only." }, "includedFirstAndThirdPartyAudienceGroups": { - "description": "The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored.", + "description": "Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.", "items": { "$ref": "FirstAndThirdPartyAudienceGroup" }, @@ -11228,7 +11262,7 @@ }, "includedGoogleAudienceGroup": { "$ref": "GoogleAudienceGroup", - "description": "The Google audience ids of the included Google audience group. Contains Google audience ids only." + "description": "Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only." } }, "type": "object" @@ -11312,12 +11346,12 @@ "id": "AudioVideoOffset", "properties": { "percentage": { - "description": "The offset in percentage of the audio or video duration.", + "description": "Optional. The offset in percentage of the audio or video duration.", "format": "int64", "type": "string" }, "seconds": { - "description": "The offset in seconds from the start of the audio or video.", + "description": "Optional. The offset in seconds from the start of the audio or video.", "format": "int64", "type": "string" } @@ -12194,7 +12228,7 @@ }, "frequencyCap": { "$ref": "FrequencyCap", - "description": "Required. The frequency cap setting of the campaign." + "description": "Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" }, "name": { "description": "Output only. The resource name of the campaign.", @@ -12510,17 +12544,17 @@ "id": "CmTrackingAd", "properties": { "cmAdId": { - "description": "The ad ID of the campaign manager 360 tracking Ad.", + "description": "Optional. The ad ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmCreativeId": { - "description": "The creative ID of the campaign manager 360 tracking Ad.", + "description": "Optional. The creative ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmPlacementId": { - "description": "The placement ID of the campaign manager 360 tracking Ad.", + "description": "Optional. The placement ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" } @@ -12555,7 +12589,7 @@ "id": "CombinedAudienceGroup", "properties": { "settings": { - "description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", + "description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", "items": { "$ref": "CombinedAudienceTargetingSetting" }, @@ -12997,7 +13031,7 @@ "id": "ConversionCountingConfig", "properties": { "floodlightActivityConfigs": { - "description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.", + "description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "items": { "$ref": "TrackingFloodlightActivityConfig" }, @@ -13257,7 +13291,7 @@ "id": "Creative", "properties": { "additionalDimensions": { - "description": "Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", + "description": "Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", "items": { "$ref": "Dimensions" }, @@ -13270,7 +13304,7 @@ "type": "string" }, "appendedTag": { - "description": "Third-party HTML tracking tag to be appended to the creative tag.", + "description": "Optional. Third-party HTML tracking tag to be appended to the creative tag.", "type": "string" }, "assets": { @@ -13288,10 +13322,10 @@ }, "cmTrackingAd": { "$ref": "CmTrackingAd", - "description": "The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." + "description": "Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." }, "companionCreativeIds": { - "description": "The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", + "description": "Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", "items": { "format": "int64", "type": "string" @@ -13299,7 +13333,7 @@ "type": "array" }, "counterEvents": { - "description": "Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", + "description": "Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", "items": { "$ref": "CounterEvent" }, @@ -13373,7 +13407,7 @@ "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", - "Asset based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." + "Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." ], "type": "string" }, @@ -13479,15 +13513,15 @@ "type": "boolean" }, "iasCampaignMonitoring": { - "description": "Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", + "description": "Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", "type": "boolean" }, "integrationCode": { - "description": "ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", + "description": "Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", "type": "string" }, "jsTrackerUrl": { - "description": "JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "description": "Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "type": "string" }, "lineItemIds": { @@ -13516,12 +13550,12 @@ "type": "string" }, "notes": { - "description": "User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", + "description": "Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", "type": "string" }, "obaIcon": { "$ref": "ObaIcon", - "description": "Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO`" + "description": "Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "oggAudio": { "description": "Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", @@ -13530,7 +13564,7 @@ }, "progressOffset": { "$ref": "AudioVideoOffset", - "description": "Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" + "description": "Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "requireHtml5": { "description": "Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", @@ -13551,10 +13585,10 @@ }, "skipOffset": { "$ref": "AudioVideoOffset", - "description": "Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" + "description": "Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" }, "skippable": { - "description": "Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", + "description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", "type": "boolean" }, "thirdPartyTag": { @@ -13562,28 +13596,28 @@ "type": "string" }, "thirdPartyUrls": { - "description": "Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "description": "Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", "items": { "$ref": "ThirdPartyUrl" }, "type": "array" }, "timerEvents": { - "description": "Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", + "description": "Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", "items": { "$ref": "TimerEvent" }, "type": "array" }, "trackerUrls": { - "description": "Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "description": "Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", "items": { "type": "string" }, "type": "array" }, "transcodes": { - "description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", + "description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", "items": { "$ref": "Transcode" }, @@ -13652,7 +13686,7 @@ "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", - "Asset based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." + "Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." ], "type": "string" }, @@ -13691,11 +13725,18 @@ "GOAL_BUILDER_BASED", "RULE_BASED" ], + "enumDeprecated": [ + false, + false, + true, + true, + false + ], "enumDescriptions": [ "Algorithm type is not specified or is unknown in this version.", "Algorithm generated through customer-uploaded custom bidding script files.", - "Algorithm created through Ads Data Hub product.", - "Algorithm created through goal builder in DV3 UI.", + "DEPRECATED: ADS_DATA_HUB_BASED has been deprecated. Algorithm created through Ads Data Hub product.", + "DEPRECATED: GOAL_BUILDER_BASED has been deprecated, is not longer supported, and has been replaced by RULE_BASED. Algorithm created through goal builder in DV3 UI. **Existing algorithms of this type have been migrated to `RULE_BASED`.**", "Algorithm based in defined rules. These rules are defined in the API using the AlgorithmRules object. This algorithm type is only available to allowlisted customers. Other customers attempting to use this type will receive an error." ], "type": "string" @@ -14029,7 +14070,7 @@ "id": "CustomListGroup", "properties": { "settings": { - "description": "Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.", + "description": "Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.", "items": { "$ref": "CustomListTargetingSetting" }, @@ -15838,11 +15879,11 @@ "id": "ExitEvent", "properties": { "name": { - "description": "The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", + "description": "Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", "type": "string" }, "reportingName": { - "description": "The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", + "description": "Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", "type": "string" }, "type": { @@ -16003,7 +16044,7 @@ "type": "string" }, "membershipDurationDays": { - "description": "The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", + "description": "The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration).", "format": "int64", "type": "string" }, @@ -16030,7 +16071,7 @@ "id": "FirstAndThirdPartyAudienceGroup", "properties": { "settings": { - "description": "Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.", + "description": "Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed.", "items": { "$ref": "FirstAndThirdPartyAudienceTargetingSetting" }, @@ -16049,7 +16090,7 @@ "type": "string" }, "recency": { - "description": "The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.", + "description": "Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.", "enum": [ "RECENCY_NO_LIMIT", "RECENCY_1_MINUTE", @@ -16273,6 +16314,15 @@ "TIME_UNIT_HOURS", "TIME_UNIT_MINUTES" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Time unit value is not specified or is unknown in this version.", "The frequency cap will be applied to the whole life time of the line item.", @@ -16285,7 +16335,7 @@ "type": "string" }, "timeUnitCount": { - "description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59", + "description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59", "format": "int32", "type": "integer" }, @@ -16688,7 +16738,7 @@ "id": "GoogleAudienceGroup", "properties": { "settings": { - "description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.", + "description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.", "items": { "$ref": "GoogleAudienceTargetingSetting" }, @@ -17201,7 +17251,7 @@ }, "bidStrategy": { "$ref": "BiddingStrategy", - "description": "The bidding strategy of the insertion order. By default, fixed_bid is set." + "description": "Optional. The bidding strategy of the insertion order. By default, fixed_bid is set." }, "budget": { "$ref": "InsertionOrderBudget", @@ -17247,7 +17297,7 @@ "type": "string" }, "insertionOrderType": { - "description": "The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", + "description": "Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", "enum": [ "INSERTION_ORDER_TYPE_UNSPECIFIED", "RTB", @@ -17262,7 +17312,7 @@ }, "integrationDetails": { "$ref": "IntegrationDetails", - "description": "Additional integration details of the insertion order." + "description": "Optional. Additional integration details of the insertion order." }, "kpi": { "$ref": "Kpi", @@ -17274,7 +17324,7 @@ "type": "string" }, "optimizationObjective": { - "description": "Optional. The optimization objective of the insertion order. **This field is only available to allowlisted customers.** If a customer is not allowlisted, this field will be null and attempts to set it will return an error.", + "description": "Optional. Required. The optimization objective of the insertion order.", "enum": [ "OPTIMIZATION_OBJECTIVE_UNSPECIFIED", "CONVERSION", @@ -17298,7 +17348,7 @@ "description": "Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`." }, "partnerCosts": { - "description": "The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", + "description": "Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", "items": { "$ref": "PartnerCost" }, @@ -17339,7 +17389,7 @@ "id": "InsertionOrderBudget", "properties": { "automationType": { - "description": "The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", + "description": "Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", "enum": [ "INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED", "INSERTION_ORDER_AUTOMATION_TYPE_BUDGET", @@ -17388,7 +17438,7 @@ "type": "string" }, "campaignBudgetId": { - "description": "The budget_id of the campaign budget that this insertion order budget segment is a part of.", + "description": "Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.", "format": "int64", "type": "string" }, @@ -17397,7 +17447,7 @@ "description": "Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." }, "description": { - "description": "The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", + "description": "Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", "type": "string" } }, @@ -17563,6 +17613,14 @@ ], "type": "string" }, + "qualitySyncCustomSegmentId": { + "description": "Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, "traqScoreOption": { "description": "True advertising quality (applicable to Display line items only).", "enum": [ @@ -18407,7 +18465,7 @@ }, "conversionCounting": { "$ref": "ConversionCountingConfig", - "description": "The conversion tracking setting of the line item." + "description": "The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight)." }, "creativeIds": { "description": "The IDs of the creatives associated with the line item.", @@ -19446,7 +19504,7 @@ "id": "MaximizeSpendBidStrategy", "properties": { "customBiddingAlgorithmId": { - "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", + "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "format": "int64", "type": "string" }, @@ -19716,19 +19774,19 @@ "id": "ObaIcon", "properties": { "clickTrackingUrl": { - "description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", + "description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" }, "dimensions": { "$ref": "Dimensions", - "description": "The dimensions of the OBA icon." + "description": "Optional. The dimensions of the OBA icon." }, "landingPageUrl": { - "description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", + "description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" }, "position": { - "description": "The position of the OBA icon on the creative.", + "description": "Optional. The position of the OBA icon on the creative.", "enum": [ "OBA_ICON_POSITION_UNSPECIFIED", "OBA_ICON_POSITION_UPPER_RIGHT", @@ -19746,19 +19804,19 @@ "type": "string" }, "program": { - "description": "The program of the OBA icon. For example: “AdChoices”.", + "description": "Optional. The program of the OBA icon. For example: “AdChoices”.", "type": "string" }, "resourceMimeType": { - "description": "The MIME type of the OBA icon resource.", + "description": "Optional. The MIME type of the OBA icon resource.", "type": "string" }, "resourceUrl": { - "description": "The URL of the OBA icon resource.", + "description": "Optional. The URL of the OBA icon resource.", "type": "string" }, "viewTrackingUrl": { - "description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", + "description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", "type": "string" } }, @@ -20432,7 +20490,7 @@ "id": "PerformanceGoalBidStrategy", "properties": { "customBiddingAlgorithmId": { - "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", + "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", "format": "int64", "type": "string" }, @@ -21382,6 +21440,15 @@ "TIME_UNIT_HOURS", "TIME_UNIT_MINUTES" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Time unit value is not specified or is unknown in this version.", "The frequency cap will be applied to the whole life time of the line item.", @@ -21430,7 +21497,7 @@ "type": "boolean" }, "enableOptimizedTargeting": { - "description": "Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`", + "description": "Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`", "type": "boolean" } }, @@ -21743,7 +21810,7 @@ "id": "ThirdPartyUrl", "properties": { "type": { - "description": "The type of interaction needs to be tracked by the tracking URL", + "description": "Optional. The type of interaction needs to be tracked by the tracking URL", "enum": [ "THIRD_PARTY_URL_TYPE_UNSPECIFIED", "THIRD_PARTY_URL_TYPE_IMPRESSION", @@ -21783,7 +21850,7 @@ "type": "string" }, "url": { - "description": "Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path", + "description": "Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`", "type": "string" } }, @@ -21908,44 +21975,44 @@ "id": "Transcode", "properties": { "audioBitRateKbps": { - "description": "The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", + "description": "Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", "format": "int64", "type": "string" }, "audioSampleRateHz": { - "description": "The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", + "description": "Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", "format": "int64", "type": "string" }, "bitRateKbps": { - "description": "The transcoding bit rate of the transcoded video, in kilobits per second.", + "description": "Optional. The transcoding bit rate of the transcoded video, in kilobits per second.", "format": "int64", "type": "string" }, "dimensions": { "$ref": "Dimensions", - "description": "The dimensions of the transcoded video." + "description": "Optional. The dimensions of the transcoded video." }, "fileSizeBytes": { - "description": "The size of the transcoded file, in bytes.", + "description": "Optional. The size of the transcoded file, in bytes.", "format": "int64", "type": "string" }, "frameRate": { - "description": "The frame rate of the transcoded video, in frames per second.", + "description": "Optional. The frame rate of the transcoded video, in frames per second.", "format": "float", "type": "number" }, "mimeType": { - "description": "The MIME type of the transcoded file.", + "description": "Optional. The MIME type of the transcoded file.", "type": "string" }, "name": { - "description": "The name of the transcoded file.", + "description": "Optional. The name of the transcoded file.", "type": "string" }, "transcoded": { - "description": "Indicates if the transcoding was successful.", + "description": "Optional. Indicates if the transcoding was successful.", "type": "boolean" } }, @@ -21956,11 +22023,11 @@ "id": "UniversalAdId", "properties": { "id": { - "description": "The unique creative identifier.", + "description": "Optional. The unique creative identifier.", "type": "string" }, "registry": { - "description": "The registry provides unique creative identifiers.", + "description": "Optional. The registry provides unique creative identifiers.", "enum": [ "UNIVERSAL_AD_REGISTRY_UNSPECIFIED", "UNIVERSAL_AD_REGISTRY_OTHER", diff --git a/discovery/displayvideo-v4.json b/discovery/displayvideo-v4.json index d64932ab9fb..4a1d0d2994c 100644 --- a/discovery/displayvideo-v4.json +++ b/discovery/displayvideo-v4.json @@ -5,6 +5,12 @@ "https://www.googleapis.com/auth/display-video": { "description": "Create, see, edit, and permanently delete your Display & Video 360 entities and reports" }, + "https://www.googleapis.com/auth/display-video-mediaplanning": { + "description": "Create, see, and edit Display & Video 360 Campaign entities and see billing invoices" + }, + "https://www.googleapis.com/auth/display-video-user-management": { + "description": "Private Service: https://www.googleapis.com/auth/display-video-user-management" + }, "https://www.googleapis.com/auth/doubleclickbidmanager": { "description": "View and manage your reports in DoubleClick Bid Manager" } @@ -108,184 +114,21383 @@ }, "protocol": "rest", "resources": { - "media": { + "advertisers": { "methods": { - "download": { - "description": "Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.", - "flatPath": "download/{downloadId}", + "audit": { + "description": "Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.", + "flatPath": "v4/advertisers/{advertisersId}:audit", "httpMethod": "GET", - "id": "displayvideo.media.download", + "id": "displayvideo.advertisers.audit", "parameterOrder": [ - "resourceName" + "advertiserId" ], "parameters": { - "resourceName": { - "description": "Name of the media that is being downloaded. See ReadRequest.resource_name.", + "advertiserId": { + "description": "Required. The ID of the advertiser to audit.", + "format": "int64", "location": "path", - "pattern": "^.*$", + "pattern": "^[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "download/{+resourceName}", + "path": "v4/advertisers/{+advertiserId}:audit", "response": { - "$ref": "GoogleBytestreamMedia" + "$ref": "AuditAdvertiserResponse" }, "scopes": [ - "https://www.googleapis.com/auth/display-video", - "https://www.googleapis.com/auth/doubleclickbidmanager" - ], - "supportsMediaDownload": true + "https://www.googleapis.com/auth/display-video" + ] }, - "upload": { - "description": "Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.", - "flatPath": "media/{mediaId}", + "create": { + "description": "Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", + "flatPath": "v4/advertisers", "httpMethod": "POST", - "id": "displayvideo.media.upload", - "mediaUpload": { - "accept": [ - "*/*" - ], - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/media/{+resourceName}" - } + "id": "displayvideo.advertisers.create", + "parameterOrder": [], + "parameters": {}, + "path": "v4/advertisers", + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.", + "flatPath": "v4/advertisers/{advertisersId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.delete", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser we need to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" } }, + "path": "v4/advertisers/{+advertiserId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "editAssignedTargetingOptions": { + "description": "Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .", + "flatPath": "v4/advertisers/{advertisersId}:editAssignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.advertisers.editAssignedTargetingOptions", "parameterOrder": [ - "resourceName" + "advertiserId" ], "parameters": { - "resourceName": { - "description": "Name of the media that is being downloaded. See ReadRequest.resource_name.", + "advertiserId": { + "description": "Required. The ID of the advertiser.", + "format": "int64", "location": "path", - "pattern": "^.*$", + "pattern": "^[^/]+$", "required": true, "type": "string" } }, - "path": "media/{+resourceName}", + "path": "v4/advertisers/{+advertiserId}:editAssignedTargetingOptions", "request": { - "$ref": "GoogleBytestreamMedia" + "$ref": "BulkEditAdvertiserAssignedTargetingOptionsRequest" }, "response": { - "$ref": "GoogleBytestreamMedia" + "$ref": "BulkEditAdvertiserAssignedTargetingOptionsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/display-video", - "https://www.googleapis.com/auth/doubleclickbidmanager" + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an advertiser.", + "flatPath": "v4/advertisers/{advertisersId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.get", + "parameterOrder": [ + "advertiserId" ], - "supportsMediaUpload": true + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}", + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.", + "flatPath": "v4/advertisers", + "httpMethod": "GET", + "id": "displayvideo.advertisers.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers", + "response": { + "$ref": "ListAdvertisersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "listAssignedTargetingOptions": { + "description": "Lists assigned targeting options of an advertiser across targeting types.", + "flatPath": "v4/advertisers/{advertisersId}:listAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.listAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType=\"TARGETING_TYPE_CHANNEL\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}:listAssignedTargetingOptions", + "response": { + "$ref": "BulkListAdvertiserAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing advertiser. Returns the updated advertiser if successful.", + "flatPath": "v4/advertisers/{advertisersId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.patch", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}", + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] } - } - }, - "sdfdownloadtasks": { + }, "resources": { - "operations": { + "adGroupAds": { "methods": { "get": { - "description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", - "flatPath": "v4/sdfdownloadtasks/operations/{operationsId}", + "description": "Gets an ad group ad.", + "flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "GET", - "id": "displayvideo.sdfdownloadtasks.operations.get", + "id": "displayvideo.advertisers.adGroupAds.get", "parameterOrder": [ - "name" + "advertiserId", + "adGroupAdId" ], "parameters": { - "name": { - "description": "The name of the operation resource.", + "adGroupAdId": { + "description": "Required. The ID of the ad group ad to fetch.", + "format": "int64", "location": "path", - "pattern": "^sdfdownloadtasks/operations/[^/]+$", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser this ad group ad belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", "required": true, "type": "string" } }, - "path": "v4/{+name}", + "path": "v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}", "response": { - "$ref": "Operation" + "$ref": "AdGroupAd" }, "scopes": [ - "https://www.googleapis.com/auth/display-video", - "https://www.googleapis.com/auth/doubleclickbidmanager" + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists ad group ads.", + "flatPath": "v4/advertisers/{advertisersId}/adGroupAds", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroupAds.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the ad groups belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId=\"1234\"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupId=\"12345\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroupAds", + "response": { + "$ref": "ListAdGroupAdsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" ] } } - } - } - } - }, - "revision": "20240201", - "rootUrl": "https://displayvideo.googleapis.com/", - "schemas": { - "GoogleBytestreamMedia": { - "description": "Media resource.", - "id": "GoogleBytestreamMedia", - "properties": { - "resourceName": { - "description": "Name of the media resource.", - "type": "string" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" + "adGroups": { + "methods": { + "bulkListAssignedTargetingOptions": { + "description": "Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.", + "flatPath": "v4/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "adGroupIds": { + "description": "Required. The IDs of the ad groups to list assigned targeting options for.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser the line items belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType=\"TARGETING_TYPE_YOUTUBE_VIDEO\" OR targetingType=\"TARGETING_TYPE_YOUTUBE_CHANNEL\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions", + "response": { + "$ref": "BulkListAdGroupAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an ad group.", + "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.get", + "parameterOrder": [ + "advertiserId", + "adGroupId" + ], + "parameters": { + "adGroupId": { + "description": "Required. The ID of the ad group to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser this ad group belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}", + "response": { + "$ref": "AdGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists ad groups.", + "flatPath": "v4/advertisers/{advertisersId}/adGroups", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the ad groups belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"AD_GROUP_FORMAT_IN_STREAM\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroups", + "response": { + "$ref": "ListAdGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } }, - "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" + "resources": { + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "get": { + "description": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.", + "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "advertiserId", + "adGroupId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "adGroupId": { + "description": "Required. The ID of the ad group the assigned targeting option belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser the ad group belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.", + "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "advertiserId", + "adGroupId", + "targetingType" + ], + "parameters": { + "adGroupId": { + "description": "Required. The ID of the ad group to list assigned targeting options for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser the ad group belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "response": { + "$ref": "ListAdGroupAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + } + } }, - "response": { + "assets": { + "methods": { + "upload": { + "description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", + "flatPath": "v4/advertisers/{advertisersId}/assets", + "httpMethod": "POST", + "id": "displayvideo.advertisers.assets.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v4/advertisers/{+advertiserId}/assets" + } + } + }, + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this asset belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/assets", + "request": { + "$ref": "CreateAssetRequest" + }, + "response": { + "$ref": "CreateAssetResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ], + "supportsMediaUpload": true + } + } + }, + "campaigns": { + "methods": { + "create": { + "description": "Creates a new campaign. Returns the newly created campaign if successful.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns", + "httpMethod": "POST", + "id": "displayvideo.advertisers.campaigns.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/campaigns", + "request": { + "$ref": "Campaign" + }, + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "delete": { + "description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.campaigns.delete", + "parameterOrder": [ + "advertiserId", + "campaignId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser this campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "campaignId": { + "description": "The ID of the campaign we need to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "get": { + "description": "Gets a campaign.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.get", + "parameterOrder": [ + "advertiserId", + "campaignId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "campaignId": { + "description": "Required. The ID of the campaign to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "list": { + "description": "Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser to list campaigns for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/campaigns", + "response": { + "$ref": "ListCampaignsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "patch": { + "description": "Updates an existing campaign. Returns the updated campaign if successful.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.campaigns.patch", + "parameterOrder": [ + "advertiserId", + "campaignId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "campaignId": { + "description": "Output only. The unique ID of the campaign. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", + "request": { + "$ref": "Campaign" + }, + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + } + } + }, + "channels": { + "methods": { + "create": { + "description": "Creates a new channel. Returns the newly created channel if successful.", + "flatPath": "v4/advertisers/{advertisersId}/channels", + "httpMethod": "POST", + "id": "displayvideo.advertisers.channels.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the created channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the created channel.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/channels", + "request": { + "$ref": "Channel" + }, + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a channel for a partner or advertiser.", + "flatPath": "v4/advertisers/{advertisersId}/channels/{channelsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.channels.get", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the fetched channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the channel to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the fetched channel.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/channels/{+channelId}", + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists channels for a partner or advertiser.", + "flatPath": "v4/advertisers/{advertisersId}/channels", + "httpMethod": "GET", + "id": "displayvideo.advertisers.channels.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the channels.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the channels.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/channels", + "response": { + "$ref": "ListChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a channel. Returns the updated channel if successful.", + "flatPath": "v4/advertisers/{advertisersId}/channels/{channelId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.channels.patch", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the created channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Output only. The unique ID of the channel. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the created channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/channels/{channelId}", + "request": { + "$ref": "Channel" + }, + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "sites": { + "methods": { + "bulkEdit": { + "description": "Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.", + "flatPath": "v4/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.advertisers.channels.sites.bulkEdit", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit", + "request": { + "$ref": "BulkEditSitesRequest" + }, + "response": { + "$ref": "BulkEditSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a site in a channel.", + "flatPath": "v4/advertisers/{advertiserId}/channels/{channelsId}/sites", + "httpMethod": "POST", + "id": "displayvideo.advertisers.channels.sites.create", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel in which the site will be created.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/channels/{+channelId}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a site from a channel.", + "flatPath": "v4/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.channels.sites.delete", + "parameterOrder": [ + "advertiserId", + "channelId", + "urlOrAppId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the site belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "urlOrAppId": { + "description": "Required. The URL or app ID of the site to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists sites in a channel.", + "flatPath": "v4/advertisers/{advertisersId}/channels/{channelsId}/sites", + "httpMethod": "GET", + "id": "displayvideo.advertisers.channels.sites.list", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the requested sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/channels/{+channelId}/sites", + "response": { + "$ref": "ListSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "replace": { + "description": "Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", + "flatPath": "v4/advertisers/{advertiserId}/channels/{channelsId}/sites:replace", + "httpMethod": "POST", + "id": "displayvideo.advertisers.channels.sites.replace", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel whose sites will be replaced.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace", + "request": { + "$ref": "ReplaceSitesRequest" + }, + "response": { + "$ref": "ReplaceSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "creatives": { + "methods": { + "create": { + "description": "Creates a new creative. Returns the newly created creative if successful. A [\"Standard\" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.", + "flatPath": "v4/advertisers/{advertisersId}/creatives", + "httpMethod": "POST", + "id": "displayvideo.advertisers.creatives.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the creative belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/creatives", + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A [\"Standard\" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.", + "flatPath": "v4/advertisers/{advertisersId}/creatives/{creativesId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.creatives.delete", + "parameterOrder": [ + "advertiserId", + "creativeId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser this creative belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "creativeId": { + "description": "The ID of the creative to be deleted.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/creatives/{+creativeId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a creative.", + "flatPath": "v4/advertisers/{advertisersId}/creatives/{creativesId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.creatives.get", + "parameterOrder": [ + "advertiserId", + "creativeId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this creative belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "creativeId": { + "description": "Required. The ID of the creative to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/creatives/{+creativeId}", + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", + "flatPath": "v4/advertisers/{advertisersId}/creatives", + "httpMethod": "GET", + "id": "displayvideo.advertisers.creatives.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to list creatives for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType=\"CREATIVE_TYPE_NATIVE\"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus=\"ENTITY_STATUS_ACTIVE\" AND (dimensions=\"300x400\" OR dimensions=\"50x100\")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic=\"true\" AND minDuration=\"5.2s\" AND (exchangeReviewStatus=\"EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED\" OR exchangeReviewStatus=\"EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED\")` * All video creatives that are associated with line item ID 1 or 2: `creativeType=\"CREATIVE_TYPE_VIDEO\" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `createTime desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/creatives", + "response": { + "$ref": "ListCreativesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing creative. Returns the updated creative if successful. A [\"Standard\" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.", + "flatPath": "v4/advertisers/{advertisersId}/creatives/{creativesId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.creatives.patch", + "parameterOrder": [ + "advertiserId", + "creativeId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the creative belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "creativeId": { + "description": "Output only. The unique ID of the creative. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/creatives/{+creativeId}", + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "insertionOrders": { + "methods": { + "create": { + "description": "Creates a new insertion order. Returns the newly created insertion order if successful.", + "flatPath": "v4/advertisers/{advertisersId}/insertionOrders", + "httpMethod": "POST", + "id": "displayvideo.advertisers.insertionOrders.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the insertion order belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/insertionOrders", + "request": { + "$ref": "InsertionOrder" + }, + "response": { + "$ref": "InsertionOrder" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.", + "flatPath": "v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.insertionOrders.delete", + "parameterOrder": [ + "advertiserId", + "insertionOrderId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser this insertion order belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "insertionOrderId": { + "description": "The ID of the insertion order to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.", + "flatPath": "v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.insertionOrders.get", + "parameterOrder": [ + "advertiserId", + "insertionOrderId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this insertion order belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "insertionOrderId": { + "description": "Required. The ID of the insertion order to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}", + "response": { + "$ref": "InsertionOrder" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", + "flatPath": "v4/advertisers/{advertisersId}/insertionOrders", + "httpMethod": "GET", + "id": "displayvideo.advertisers.insertionOrders.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to list insertion orders for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * \"updateTime\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/insertionOrders", + "response": { + "$ref": "ListInsertionOrdersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing insertion order. Returns the updated insertion order if successful.", + "flatPath": "v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.insertionOrders.patch", + "parameterOrder": [ + "advertiserId", + "insertionOrderId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the insertion order belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "insertionOrderId": { + "description": "Output only. The unique ID of the insertion order. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}", + "request": { + "$ref": "InsertionOrder" + }, + "response": { + "$ref": "InsertionOrder" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "invoices": { + "methods": { + "list": { + "description": "Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a \"Partner\" invoice level are not retrievable through this method.", + "flatPath": "v4/advertisers/{advertisersId}/invoices", + "httpMethod": "GET", + "id": "displayvideo.advertisers.invoices.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to list invoices for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "issueMonth": { + "description": "The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.", + "location": "query", + "type": "string" + }, + "loiSapinInvoiceType": { + "description": "Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.", + "enum": [ + "LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED", + "LOI_SAPIN_INVOICE_TYPE_MEDIA", + "LOI_SAPIN_INVOICE_TYPE_PLATFORM" + ], + "enumDescriptions": [ + "Value is not specified.", + "Invoices with Media cost.", + "Invoices with Platform fee." + ], + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/invoices", + "response": { + "$ref": "ListInvoicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "lookupInvoiceCurrency": { + "description": "Retrieves the invoice currency used by an advertiser in a given month.", + "flatPath": "v4/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency", + "httpMethod": "GET", + "id": "displayvideo.advertisers.invoices.lookupInvoiceCurrency", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to lookup currency for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "invoiceMonth": { + "description": "Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency", + "response": { + "$ref": "LookupInvoiceCurrencyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + } + } + }, + "lineItems": { + "methods": { + "bulkEditAssignedTargetingOptions": { + "description": "Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line items belong to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions", + "request": { + "$ref": "BulkEditAssignedTargetingOptionsRequest" + }, + "response": { + "$ref": "BulkEditAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "bulkListAssignedTargetingOptions": { + "description": "Lists assigned targeting options for multiple line items across targeting types.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line items belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR targetingType=\"TARGETING_TYPE_CHANNEL\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "lineItemIds": { + "description": "Required. The IDs of the line items to list assigned targeting options for.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions", + "response": { + "$ref": "BulkListAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "bulkUpdate": { + "description": "Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems:bulkUpdate", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.bulkUpdate", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems:bulkUpdate", + "request": { + "$ref": "BulkUpdateLineItemsRequest" + }, + "response": { + "$ref": "BulkUpdateLineItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems", + "request": { + "$ref": "LineItem" + }, + "response": { + "$ref": "LineItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.lineItems.delete", + "parameterOrder": [ + "advertiserId", + "lineItemId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser this line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "The ID of the line item to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "duplicate": { + "description": "Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.duplicate", + "parameterOrder": [ + "advertiserId", + "lineItemId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item to duplicate.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate", + "request": { + "$ref": "DuplicateLineItemRequest" + }, + "response": { + "$ref": "DuplicateLineItemResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "generateDefault": { + "description": "Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems:generateDefault", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.generateDefault", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems:generateDefault", + "request": { + "$ref": "GenerateDefaultLineItemRequest" + }, + "response": { + "$ref": "LineItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a line item.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.get", + "parameterOrder": [ + "advertiserId", + "lineItemId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}", + "response": { + "$ref": "LineItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to list line items for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems", + "response": { + "$ref": "ListLineItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.lineItems.patch", + "parameterOrder": [ + "advertiserId", + "lineItemId" + ], + "parameters": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Output only. The unique ID of the line item. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}", + "request": { + "$ref": "LineItem" + }, + "response": { + "$ref": "LineItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "create": { + "description": "Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item the assigned targeting option will belong to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "request": { + "$ref": "AssignedTargetingOption" + }, + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. The ID of the assigned targeting option to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item the assigned targeting option belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a single targeting option assigned to a line item.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item the assigned targeting option belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the targeting options assigned to a line item.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item to list assigned targeting options for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "response": { + "$ref": "ListLineItemAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + } + } + }, + "locationLists": { + "methods": { + "create": { + "description": "Creates a new location list. Returns the newly created location list if successful.", + "flatPath": "v4/advertisers/{advertisersId}/locationLists", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/locationLists", + "request": { + "$ref": "LocationList" + }, + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a location list.", + "flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.locationLists.get", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched location list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/locationLists/{+locationListId}", + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists location lists based on a given advertiser id.", + "flatPath": "v4/advertisers/{advertisersId}/locationLists", + "httpMethod": "GET", + "id": "displayvideo.advertisers.locationLists.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"` * All proximity location list: `locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/locationLists", + "response": { + "$ref": "ListLocationListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a location list. Returns the updated location list if successful.", + "flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.locationLists.patch", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location lists belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Output only. The unique ID of the location list. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/locationLists/{locationListId}", + "request": { + "$ref": "LocationList" + }, + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "assignedLocations": { + "methods": { + "bulkEdit": { + "description": "Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.", + "flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.assignedLocations.bulkEdit", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to which these assignments are assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit", + "request": { + "$ref": "BulkEditAssignedLocationsRequest" + }, + "response": { + "$ref": "BulkEditAssignedLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates an assignment between a location and a location list.", + "flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.assignedLocations.create", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list for which the assignment will be created.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "request": { + "$ref": "AssignedLocation" + }, + "response": { + "$ref": "AssignedLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes the assignment between a location and a location list.", + "flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.locationLists.assignedLocations.delete", + "parameterOrder": [ + "advertiserId", + "locationListId", + "assignedLocationId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "assignedLocationId": { + "description": "Required. The ID of the assigned location to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to which this assignment is assigned.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists locations assigned to a location list.", + "flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "httpMethod": "GET", + "id": "displayvideo.advertisers.locationLists.assignedLocations.list", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to which these assignments are assigned.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `assignedLocationId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "response": { + "$ref": "ListAssignedLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "negativeKeywordLists": { + "methods": { + "create": { + "description": "Creates a new negative keyword list. Returns the newly created negative keyword list if successful.", + "flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists", + "httpMethod": "POST", + "id": "displayvideo.advertisers.negativeKeywordLists.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the negative keyword list will belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/negativeKeywordLists", + "request": { + "$ref": "NegativeKeywordList" + }, + "response": { + "$ref": "NegativeKeywordList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.", + "flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.negativeKeywordLists.delete", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the negative keyword list to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a negative keyword list given an advertiser ID and a negative keyword list ID.", + "flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.negativeKeywordLists.get", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the negative keyword list to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}", + "response": { + "$ref": "NegativeKeywordList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists negative keyword lists based on a given advertiser id.", + "flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists", + "httpMethod": "GET", + "id": "displayvideo.advertisers.negativeKeywordLists.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/negativeKeywordLists", + "response": { + "$ref": "ListNegativeKeywordListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a negative keyword list. Returns the updated negative keyword list if successful.", + "flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.negativeKeywordLists.patch", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the negative keyword list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Output only. The unique ID of the negative keyword list. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}", + "request": { + "$ref": "NegativeKeywordList" + }, + "response": { + "$ref": "NegativeKeywordList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "negativeKeywords": { + "methods": { + "bulkEdit": { + "description": "Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.", + "flatPath": "v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list to which the negative keywords belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit", + "request": { + "$ref": "BulkEditNegativeKeywordsRequest" + }, + "response": { + "$ref": "BulkEditNegativeKeywordsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a negative keyword in a negative keyword list.", + "flatPath": "v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords", + "httpMethod": "POST", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list in which the negative keyword will be created.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords", + "request": { + "$ref": "NegativeKeyword" + }, + "response": { + "$ref": "NegativeKeyword" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a negative keyword from a negative keyword list.", + "flatPath": "v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId", + "keywordValue" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "keywordValue": { + "description": "Required. The keyword value of the negative keyword to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list to which the negative keyword belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists negative keywords in a negative keyword list.", + "flatPath": "v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords", + "httpMethod": "GET", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains \"google\": `keywordValue : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list to which the requested negative keywords belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `keywordValue desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords", + "response": { + "$ref": "ListNegativeKeywordsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "replace": { + "description": "Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.", + "flatPath": "v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace", + "httpMethod": "POST", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list to which the negative keywords belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace", + "request": { + "$ref": "ReplaceNegativeKeywordsRequest" + }, + "response": { + "$ref": "ReplaceNegativeKeywordsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "create": { + "description": "Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.", + "flatPath": "v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create", + "parameterOrder": [ + "advertiserId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "request": { + "$ref": "AssignedTargetingOption" + }, + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an assigned targeting option from an advertiser.", + "flatPath": "v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete", + "parameterOrder": [ + "advertiserId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. The ID of the assigned targeting option to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a single targeting option assigned to an advertiser.", + "flatPath": "v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "advertiserId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the targeting options assigned to an advertiser.", + "flatPath": "v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "advertiserId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId=\"123456\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "response": { + "$ref": "ListAdvertiserAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + } + } + }, + "combinedAudiences": { + "methods": { + "get": { + "description": "Gets a combined audience.", + "flatPath": "v4/combinedAudiences/{combinedAudiencesId}", + "httpMethod": "GET", + "id": "displayvideo.combinedAudiences.get", + "parameterOrder": [ + "combinedAudienceId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched combined audience.", + "format": "int64", + "location": "query", + "type": "string" + }, + "combinedAudienceId": { + "description": "Required. The ID of the combined audience to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the fetched combined audience.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/combinedAudiences/{+combinedAudienceId}", + "response": { + "$ref": "CombinedAudience" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists combined audiences. The order is defined by the order_by parameter.", + "flatPath": "v4/combinedAudiences", + "httpMethod": "GET", + "id": "displayvideo.combinedAudiences.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched combined audiences.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains \"Google\": `displayName : \"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the fetched combined audiences.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/combinedAudiences", + "response": { + "$ref": "ListCombinedAudiencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "customBiddingAlgorithms": { + "methods": { + "create": { + "description": "Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.", + "flatPath": "v4/customBiddingAlgorithms", + "httpMethod": "POST", + "id": "displayvideo.customBiddingAlgorithms.create", + "parameterOrder": [], + "parameters": {}, + "path": "v4/customBiddingAlgorithms", + "request": { + "$ref": "CustomBiddingAlgorithm" + }, + "response": { + "$ref": "CustomBiddingAlgorithm" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a custom bidding algorithm.", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.get", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}", + "response": { + "$ref": "CustomBiddingAlgorithm" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.", + "flatPath": "v4/customBiddingAlgorithms", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the DV360 advertiser that has access to the custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains \"politics\": `displayName:\"politics\"`. * All custom bidding algorithms for which the type is \"SCRIPT_BASED\": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms", + "response": { + "$ref": "ListCustomBiddingAlgorithmsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}", + "httpMethod": "PATCH", + "id": "displayvideo.customBiddingAlgorithms.patch", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "customBiddingAlgorithmId": { + "description": "Output only. The unique ID of the custom bidding algorithm. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}", + "request": { + "$ref": "CustomBiddingAlgorithm" + }, + "response": { + "$ref": "CustomBiddingAlgorithm" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "uploadRules": { + "description": "Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.uploadRules", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules", + "response": { + "$ref": "CustomBiddingAlgorithmRulesRef" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "uploadScript": { + "description": "Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.uploadScript", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm owns the script.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript", + "response": { + "$ref": "CustomBiddingScriptRef" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "rules": { + "methods": { + "create": { + "description": "Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", + "httpMethod": "POST", + "id": "displayvideo.customBiddingAlgorithms.rules.create", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules", + "request": { + "$ref": "CustomBiddingAlgorithmRules" + }, + "response": { + "$ref": "CustomBiddingAlgorithmRules" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Retrieves a rules resource.", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.rules.get", + "parameterOrder": [ + "customBiddingAlgorithmId", + "customBiddingAlgorithmRulesId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "customBiddingAlgorithmRulesId": { + "description": "Required. The ID of the rules resource to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}", + "response": { + "$ref": "CustomBiddingAlgorithmRules" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.rules.list", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix \"desc\" should be removed. Example: `createTime`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules", + "response": { + "$ref": "ListCustomBiddingAlgorithmRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "scripts": { + "methods": { + "create": { + "description": "Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", + "httpMethod": "POST", + "id": "displayvideo.customBiddingAlgorithms.scripts.create", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the script.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts", + "request": { + "$ref": "CustomBiddingScript" + }, + "response": { + "$ref": "CustomBiddingScript" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a custom bidding script.", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.scripts.get", + "parameterOrder": [ + "customBiddingAlgorithmId", + "customBiddingScriptId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm owns the script.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "customBiddingScriptId": { + "description": "Required. The ID of the custom bidding script to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}", + "response": { + "$ref": "CustomBiddingScript" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.", + "flatPath": "v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.scripts.list", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm owns the script.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix \"desc\" should be removed. Example: `createTime`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts", + "response": { + "$ref": "ListCustomBiddingScriptsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "customLists": { + "methods": { + "get": { + "description": "Gets a custom list.", + "flatPath": "v4/customLists/{customListsId}", + "httpMethod": "GET", + "id": "displayvideo.customLists.get", + "parameterOrder": [ + "customListId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the DV360 advertiser that has access to the fetched custom lists.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customListId": { + "description": "Required. The ID of the custom list to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/customLists/{+customListId}", + "response": { + "$ref": "CustomList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists custom lists. The order is defined by the order_by parameter.", + "flatPath": "v4/customLists", + "httpMethod": "GET", + "id": "displayvideo.customLists.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the DV360 advertiser that has access to the fetched custom lists.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/customLists", + "response": { + "$ref": "ListCustomListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "firstPartyAndPartnerAudiences": { + "methods": { + "create": { + "description": "Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", + "flatPath": "v4/firstPartyAndPartnerAudiences", + "httpMethod": "POST", + "id": "displayvideo.firstPartyAndPartnerAudiences.create", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/firstPartyAndPartnerAudiences", + "request": { + "$ref": "FirstPartyAndPartnerAudience" + }, + "response": { + "$ref": "FirstPartyAndPartnerAudience" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "editCustomerMatchMembers": { + "description": "Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", + "flatPath": "v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}:editCustomerMatchMembers", + "httpMethod": "POST", + "id": "displayvideo.firstPartyAndPartnerAudiences.editCustomerMatchMembers", + "parameterOrder": [ + "firstPartyAndPartnerAudienceId" + ], + "parameters": { + "firstPartyAndPartnerAudienceId": { + "description": "Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}:editCustomerMatchMembers", + "request": { + "$ref": "EditCustomerMatchMembersRequest" + }, + "response": { + "$ref": "EditCustomerMatchMembersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a first party or partner audience.", + "flatPath": "v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}", + "httpMethod": "GET", + "id": "displayvideo.firstPartyAndPartnerAudiences.get", + "parameterOrder": [ + "firstPartyAndPartnerAudienceId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched first party and partner audience.", + "format": "int64", + "location": "query", + "type": "string" + }, + "firstPartyAndPartnerAudienceId": { + "description": "Required. The ID of the first party and partner audience to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the fetched first party and partner audience.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}", + "response": { + "$ref": "FirstPartyAndPartnerAudience" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists first party and partner audiences. The order is defined by the order_by parameter.", + "flatPath": "v4/firstPartyAndPartnerAudiences", + "httpMethod": "GET", + "id": "displayvideo.firstPartyAndPartnerAudiences.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched first party and partner audiences.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first party and partner audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the fetched first party and partner audiences.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/firstPartyAndPartnerAudiences", + "response": { + "$ref": "ListFirstPartyAndPartnerAudiencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", + "flatPath": "v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}", + "httpMethod": "PATCH", + "id": "displayvideo.firstPartyAndPartnerAudiences.patch", + "parameterOrder": [ + "firstPartyAndPartnerAudienceId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.", + "format": "int64", + "location": "query", + "type": "string" + }, + "firstPartyAndPartnerAudienceId": { + "description": "Identifier. The unique ID of the first party and partner audience. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}", + "request": { + "$ref": "FirstPartyAndPartnerAudience" + }, + "response": { + "$ref": "FirstPartyAndPartnerAudience" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "floodlightGroups": { + "methods": { + "get": { + "description": "Gets a Floodlight group.", + "flatPath": "v4/floodlightGroups/{floodlightGroupsId}", + "httpMethod": "GET", + "id": "displayvideo.floodlightGroups.get", + "parameterOrder": [ + "floodlightGroupId" + ], + "parameters": { + "floodlightGroupId": { + "description": "Required. The ID of the Floodlight group to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The partner context by which the Floodlight group is being accessed.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/floodlightGroups/{+floodlightGroupId}", + "response": { + "$ref": "FloodlightGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing Floodlight group. Returns the updated Floodlight group if successful.", + "flatPath": "v4/floodlightGroups/{floodlightGroupId}", + "httpMethod": "PATCH", + "id": "displayvideo.floodlightGroups.patch", + "parameterOrder": [ + "floodlightGroupId" + ], + "parameters": { + "floodlightGroupId": { + "description": "Output only. The unique ID of the Floodlight group. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The partner context by which the Floodlight group is being accessed.", + "format": "int64", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/floodlightGroups/{floodlightGroupId}", + "request": { + "$ref": "FloodlightGroup" + }, + "response": { + "$ref": "FloodlightGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "floodlightActivities": { + "methods": { + "get": { + "description": "Gets a Floodlight activity.", + "flatPath": "v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}", + "httpMethod": "GET", + "id": "displayvideo.floodlightGroups.floodlightActivities.get", + "parameterOrder": [ + "floodlightGroupId", + "floodlightActivityId" + ], + "parameters": { + "floodlightActivityId": { + "description": "Required. The ID of the Floodlight activity to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "floodlightGroupId": { + "description": "Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner through which the Floodlight activity is being accessed.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}", + "response": { + "$ref": "FloodlightActivity" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists Floodlight activities in a Floodlight group.", + "flatPath": "v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities", + "httpMethod": "GET", + "id": "displayvideo.floodlightGroups.floodlightActivities.list", + "parameterOrder": [ + "floodlightGroupId" + ], + "parameters": { + "floodlightGroupId": { + "description": "Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFloodlightActivities` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner through which the Floodlight activities are being accessed.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities", + "response": { + "$ref": "ListFloodlightActivitiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "googleAudiences": { + "methods": { + "get": { + "description": "Gets a Google audience.", + "flatPath": "v4/googleAudiences/{googleAudiencesId}", + "httpMethod": "GET", + "id": "displayvideo.googleAudiences.get", + "parameterOrder": [ + "googleAudienceId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched Google audience.", + "format": "int64", + "location": "query", + "type": "string" + }, + "googleAudienceId": { + "description": "Required. The ID of the Google audience to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the fetched Google audience.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/googleAudiences/{+googleAudienceId}", + "response": { + "$ref": "GoogleAudience" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists Google audiences. The order is defined by the order_by parameter.", + "flatPath": "v4/googleAudiences", + "httpMethod": "GET", + "id": "displayvideo.googleAudiences.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched Google audiences.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the fetched Google audiences.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/googleAudiences", + "response": { + "$ref": "ListGoogleAudiencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "guaranteedOrders": { + "methods": { + "create": { + "description": "Creates a new guaranteed order. Returns the newly created guaranteed order if successful.", + "flatPath": "v4/guaranteedOrders", + "httpMethod": "POST", + "id": "displayvideo.guaranteedOrders.create", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that the request is being made within.", + "format": "int64", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that the request is being made within.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/guaranteedOrders", + "request": { + "$ref": "GuaranteedOrder" + }, + "response": { + "$ref": "GuaranteedOrder" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "editGuaranteedOrderReadAccessors": { + "description": "Edits read advertisers of a guaranteed order.", + "flatPath": "v4/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors", + "httpMethod": "POST", + "id": "displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors", + "parameterOrder": [ + "guaranteedOrderId" + ], + "parameters": { + "guaranteedOrderId": { + "description": "Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors", + "request": { + "$ref": "EditGuaranteedOrderReadAccessorsRequest" + }, + "response": { + "$ref": "EditGuaranteedOrderReadAccessorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a guaranteed order.", + "flatPath": "v4/guaranteedOrders/{guaranteedOrdersId}", + "httpMethod": "GET", + "id": "displayvideo.guaranteedOrders.get", + "parameterOrder": [ + "guaranteedOrderId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the guaranteed order.", + "format": "int64", + "location": "query", + "type": "string" + }, + "guaranteedOrderId": { + "description": "Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the guaranteed order.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/guaranteedOrders/{+guaranteedOrderId}", + "response": { + "$ref": "GuaranteedOrder" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.", + "flatPath": "v4/guaranteedOrders", + "httpMethod": "GET", + "id": "displayvideo.guaranteedOrders.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the guaranteed order.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus=\"ENTITY_STATUS_ACTIVE\"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the guaranteed order.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/guaranteedOrders", + "response": { + "$ref": "ListGuaranteedOrdersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing guaranteed order. Returns the updated guaranteed order if successful.", + "flatPath": "v4/guaranteedOrders/{guaranteedOrdersId}", + "httpMethod": "PATCH", + "id": "displayvideo.guaranteedOrders.patch", + "parameterOrder": [ + "guaranteedOrderId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that the request is being made within.", + "format": "int64", + "location": "query", + "type": "string" + }, + "guaranteedOrderId": { + "description": "Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that the request is being made within.", + "format": "int64", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/guaranteedOrders/{+guaranteedOrderId}", + "request": { + "$ref": "GuaranteedOrder" + }, + "response": { + "$ref": "GuaranteedOrder" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "inventorySourceGroups": { + "methods": { + "create": { + "description": "Creates a new inventory source group. Returns the newly created inventory source group if successful.", + "flatPath": "v4/inventorySourceGroups", + "httpMethod": "POST", + "id": "displayvideo.inventorySourceGroups.create", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySourceGroups", + "request": { + "$ref": "InventorySourceGroup" + }, + "response": { + "$ref": "InventorySourceGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an inventory source group.", + "flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}", + "httpMethod": "DELETE", + "id": "displayvideo.inventorySourceGroups.delete", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the inventory source group. Only this partner has write access to this group.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySourceGroups/{+inventorySourceGroupId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an inventory source group.", + "flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}", + "httpMethod": "GET", + "id": "displayvideo.inventorySourceGroups.get", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySourceGroups/{+inventorySourceGroupId}", + "response": { + "$ref": "InventorySourceGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.", + "flatPath": "v4/inventorySourceGroups", + "httpMethod": "GET", + "id": "displayvideo.inventorySourceGroups.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySourceGroups", + "response": { + "$ref": "ListInventorySourceGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an inventory source group. Returns the updated inventory source group if successful.", + "flatPath": "v4/inventorySourceGroups/{inventorySourceGroupId}", + "httpMethod": "PATCH", + "id": "displayvideo.inventorySourceGroups.patch", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Output only. The unique ID of the inventory source group. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the inventory source group. Only this partner has write access to this group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySourceGroups/{inventorySourceGroupId}", + "request": { + "$ref": "InventorySourceGroup" + }, + "response": { + "$ref": "InventorySourceGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "assignedInventorySources": { + "methods": { + "bulkEdit": { + "description": "Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.", + "flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which the assignments are assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit", + "request": { + "$ref": "BulkEditAssignedInventorySourcesRequest" + }, + "response": { + "$ref": "BulkEditAssignedInventorySourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates an assignment between an inventory source and an inventory source group.", + "flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources", + "httpMethod": "POST", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.create", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which the assignment will be assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources", + "request": { + "$ref": "AssignedInventorySource" + }, + "response": { + "$ref": "AssignedInventorySource" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes the assignment between an inventory source and an inventory source group.", + "flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}", + "httpMethod": "DELETE", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.delete", + "parameterOrder": [ + "inventorySourceGroupId", + "assignedInventorySourceId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.", + "format": "int64", + "location": "query", + "type": "string" + }, + "assignedInventorySourceId": { + "description": "Required. The ID of the assigned inventory source to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which this assignment is assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists inventory sources assigned to an inventory source group.", + "flatPath": "v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources", + "httpMethod": "GET", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.list", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which these assignments are assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `assignedInventorySourceId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources", + "response": { + "$ref": "ListAssignedInventorySourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "inventorySources": { + "methods": { + "create": { + "description": "Creates a new inventory source. Returns the newly created inventory source if successful.", + "flatPath": "v4/inventorySources", + "httpMethod": "POST", + "id": "displayvideo.inventorySources.create", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that the request is being made within.", + "format": "int64", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that the request is being made within.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySources", + "request": { + "$ref": "InventorySource" + }, + "response": { + "$ref": "InventorySource" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "editInventorySourceReadWriteAccessors": { + "description": "Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.", + "flatPath": "v4/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors", + "httpMethod": "POST", + "id": "displayvideo.inventorySources.editInventorySourceReadWriteAccessors", + "parameterOrder": [ + "inventorySourceId" + ], + "parameters": { + "inventorySourceId": { + "description": "Required. The ID of inventory source to update.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors", + "request": { + "$ref": "EditInventorySourceReadWriteAccessorsRequest" + }, + "response": { + "$ref": "InventorySourceAccessors" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an inventory source.", + "flatPath": "v4/inventorySources/{inventorySourcesId}", + "httpMethod": "GET", + "id": "displayvideo.inventorySources.get", + "parameterOrder": [ + "inventorySourceId" + ], + "parameters": { + "advertiserId": { + "description": "Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceId": { + "description": "Required. The ID of the inventory source to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySources/{+inventorySourceId}", + "response": { + "$ref": "InventorySource" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.", + "flatPath": "v4/inventorySources", + "httpMethod": "GET", + "id": "displayvideo.inventorySources.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the inventory source.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus=\"ENTITY_STATUS_ACTIVE\"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the inventory source.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySources", + "response": { + "$ref": "ListInventorySourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing inventory source. Returns the updated inventory source if successful.", + "flatPath": "v4/inventorySources/{inventorySourcesId}", + "httpMethod": "PATCH", + "id": "displayvideo.inventorySources.patch", + "parameterOrder": [ + "inventorySourceId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that the request is being made within.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceId": { + "description": "Output only. The unique ID of the inventory source. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that the request is being made within.", + "format": "int64", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/inventorySources/{+inventorySourceId}", + "request": { + "$ref": "InventorySource" + }, + "response": { + "$ref": "InventorySource" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "media": { + "methods": { + "download": { + "description": "Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.", + "flatPath": "download/{downloadId}", + "httpMethod": "GET", + "id": "displayvideo.media.download", + "parameterOrder": [ + "resourceName" + ], + "parameters": { + "resourceName": { + "description": "Name of the media that is being downloaded. See ReadRequest.resource_name.", + "location": "path", + "pattern": "^.*$", + "required": true, + "type": "string" + } + }, + "path": "download/{+resourceName}", + "response": { + "$ref": "GoogleBytestreamMedia" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/doubleclickbidmanager" + ], + "supportsMediaDownload": true + }, + "upload": { + "description": "Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.", + "flatPath": "media/{mediaId}", + "httpMethod": "POST", + "id": "displayvideo.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/media/{+resourceName}" + } + } + }, + "parameterOrder": [ + "resourceName" + ], + "parameters": { + "resourceName": { + "description": "Name of the media that is being downloaded. See ReadRequest.resource_name.", + "location": "path", + "pattern": "^.*$", + "required": true, + "type": "string" + } + }, + "path": "media/{+resourceName}", + "request": { + "$ref": "GoogleBytestreamMedia" + }, + "response": { + "$ref": "GoogleBytestreamMedia" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/doubleclickbidmanager" + ], + "supportsMediaUpload": true + } + } + }, + "partners": { + "methods": { + "editAssignedTargetingOptions": { + "description": "Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .", + "flatPath": "v4/partners/{partnersId}:editAssignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.partners.editAssignedTargetingOptions", + "parameterOrder": [ + "partnerId" + ], + "parameters": { + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}:editAssignedTargetingOptions", + "request": { + "$ref": "BulkEditPartnerAssignedTargetingOptionsRequest" + }, + "response": { + "$ref": "BulkEditPartnerAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a partner.", + "flatPath": "v4/partners/{partnersId}", + "httpMethod": "GET", + "id": "displayvideo.partners.get", + "parameterOrder": [ + "partnerId" + ], + "parameters": { + "partnerId": { + "description": "Required. The ID of the partner to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}", + "response": { + "$ref": "Partner" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists partners that are accessible to the current user. The order is defined by the order_by parameter.", + "flatPath": "v4/partners", + "httpMethod": "GET", + "id": "displayvideo.partners.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/partners", + "response": { + "$ref": "ListPartnersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "channels": { + "methods": { + "create": { + "description": "Creates a new channel. Returns the newly created channel if successful.", + "flatPath": "v4/partners/{partnersId}/channels", + "httpMethod": "POST", + "id": "displayvideo.partners.channels.create", + "parameterOrder": [ + "partnerId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the created channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the created channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/channels", + "request": { + "$ref": "Channel" + }, + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a channel for a partner or advertiser.", + "flatPath": "v4/partners/{partnersId}/channels/{channelsId}", + "httpMethod": "GET", + "id": "displayvideo.partners.channels.get", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the fetched channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the channel to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the fetched channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/channels/{+channelId}", + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists channels for a partner or advertiser.", + "flatPath": "v4/partners/{partnersId}/channels", + "httpMethod": "GET", + "id": "displayvideo.partners.channels.list", + "parameterOrder": [ + "partnerId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the channels.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the channels.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/channels", + "response": { + "$ref": "ListChannelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a channel. Returns the updated channel if successful.", + "flatPath": "v4/partners/{partnersId}/channels/{channelId}", + "httpMethod": "PATCH", + "id": "displayvideo.partners.channels.patch", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the created channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Output only. The unique ID of the channel. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the created channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/channels/{channelId}", + "request": { + "$ref": "Channel" + }, + "response": { + "$ref": "Channel" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "sites": { + "methods": { + "bulkEdit": { + "description": "Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.", + "flatPath": "v4/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.partners.channels.sites.bulkEdit", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "channelId": { + "description": "Required. The ID of the parent channel to which the sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit", + "request": { + "$ref": "BulkEditSitesRequest" + }, + "response": { + "$ref": "BulkEditSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a site in a channel.", + "flatPath": "v4/partners/{partnerId}/channels/{channelsId}/sites", + "httpMethod": "POST", + "id": "displayvideo.partners.channels.sites.create", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel in which the site will be created.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{partnerId}/channels/{+channelId}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes a site from a channel.", + "flatPath": "v4/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}", + "httpMethod": "DELETE", + "id": "displayvideo.partners.channels.sites.delete", + "parameterOrder": [ + "partnerId", + "channelId", + "urlOrAppId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the site belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "urlOrAppId": { + "description": "Required. The URL or app ID of the site to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists sites in a channel.", + "flatPath": "v4/partners/{partnersId}/channels/{channelsId}/sites", + "httpMethod": "GET", + "id": "displayvideo.partners.channels.sites.list", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the requested sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/channels/{+channelId}/sites", + "response": { + "$ref": "ListSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "replace": { + "description": "Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", + "flatPath": "v4/partners/{partnerId}/channels/{channelsId}/sites:replace", + "httpMethod": "POST", + "id": "displayvideo.partners.channels.sites.replace", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "channelId": { + "description": "Required. The ID of the parent channel whose sites will be replaced.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{partnerId}/channels/{+channelId}/sites:replace", + "request": { + "$ref": "ReplaceSitesRequest" + }, + "response": { + "$ref": "ReplaceSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "create": { + "description": "Assigns a targeting option to a partner. Returns the assigned targeting option if successful.", + "flatPath": "v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.create", + "parameterOrder": [ + "partnerId", + "targetingType" + ], + "parameters": { + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "request": { + "$ref": "AssignedTargetingOption" + }, + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an assigned targeting option from a partner.", + "flatPath": "v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "DELETE", + "id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.delete", + "parameterOrder": [ + "partnerId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "assignedTargetingOptionId": { + "description": "Required. The ID of the assigned targeting option to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a single targeting option assigned to a partner.", + "flatPath": "v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "partnerId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the targeting options assigned to a partner.", + "flatPath": "v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "partnerId", + "targetingType" + ], + "parameters": { + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId=\"123456\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "response": { + "$ref": "ListPartnerAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + } + } + }, + "sdfdownloadtasks": { + "methods": { + "create": { + "description": "Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.", + "flatPath": "v4/sdfdownloadtasks", + "httpMethod": "POST", + "id": "displayvideo.sdfdownloadtasks.create", + "parameterOrder": [], + "parameters": {}, + "path": "v4/sdfdownloadtasks", + "request": { + "$ref": "CreateSdfDownloadTaskRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", + "flatPath": "v4/sdfdownloadtasks/operations/{operationsId}", + "httpMethod": "GET", + "id": "displayvideo.sdfdownloadtasks.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^sdfdownloadtasks/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/doubleclickbidmanager" + ] + } + } + } + } + }, + "sdfuploadtasks": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", + "flatPath": "v4/sdfuploadtasks/operations/{operationsId}", + "httpMethod": "GET", + "id": "displayvideo.sdfuploadtasks.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^sdfuploadtasks/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/doubleclickbidmanager" + ] + } + } + } + } + }, + "targetingTypes": { + "resources": { + "targetingOptions": { + "methods": { + "get": { + "description": "Gets a single targeting option.", + "flatPath": "v4/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.targetingTypes.targetingOptions.get", + "parameterOrder": [ + "targetingType", + "targetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The Advertiser this request is being made in the context of.", + "format": "int64", + "location": "query", + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The ID of the of targeting option to retrieve.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}", + "response": { + "$ref": "TargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists targeting options of a given type.", + "flatPath": "v4/targetingTypes/{targetingTypesId}/targetingOptions", + "httpMethod": "GET", + "id": "displayvideo.targetingTypes.targetingOptions.list", + "parameterOrder": [ + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The Advertiser this request is being made in the context of.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_COUNTRY\" OR geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_STATE\"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type=\"CARRIER_AND_ISP_TYPE_CARRIER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "targetingType": { + "description": "Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/targetingTypes/{+targetingType}/targetingOptions", + "response": { + "$ref": "ListTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "search": { + "description": "Searches for targeting options of a given type based on the given search terms.", + "flatPath": "v4/targetingTypes/{targetingTypesId}/targetingOptions:search", + "httpMethod": "POST", + "id": "displayvideo.targetingTypes.targetingOptions.search", + "parameterOrder": [ + "targetingType" + ], + "parameters": { + "targetingType": { + "description": "Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/targetingTypes/{+targetingType}/targetingOptions:search", + "request": { + "$ref": "SearchTargetingOptionsRequest" + }, + "response": { + "$ref": "SearchTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "users": { + "methods": { + "bulkEditAssignedUserRoles": { + "description": "Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v4/users/{usersId}:bulkEditAssignedUserRoles", + "httpMethod": "POST", + "id": "displayvideo.users.bulkEditAssignedUserRoles", + "parameterOrder": [ + "userId" + ], + "parameters": { + "userId": { + "description": "Required. The ID of the user to which the assigned user roles belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/users/{+userId}:bulkEditAssignedUserRoles", + "request": { + "$ref": "BulkEditAssignedUserRolesRequest" + }, + "response": { + "$ref": "BulkEditAssignedUserRolesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "create": { + "description": "Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v4/users", + "httpMethod": "POST", + "id": "displayvideo.users.create", + "parameterOrder": [], + "parameters": {}, + "path": "v4/users", + "request": { + "$ref": "User" + }, + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "delete": { + "description": "Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v4/users/{usersId}", + "httpMethod": "DELETE", + "id": "displayvideo.users.delete", + "parameterOrder": [ + "userId" + ], + "parameters": { + "userId": { + "description": "Required. The ID of the user to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/users/{+userId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "get": { + "description": "Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v4/users/{usersId}", + "httpMethod": "GET", + "id": "displayvideo.users.get", + "parameterOrder": [ + "userId" + ], + "parameters": { + "userId": { + "description": "Required. The ID of the user to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/users/{+userId}", + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "list": { + "description": "Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v4/users", + "httpMethod": "GET", + "id": "displayvideo.users.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing \"foo\": `displayName:\"foo\"` * The user with `email` containing \"bar\": `email:\"bar\"` * All users with standard user roles: `assignedUserRole.userRole=\"STANDARD\"` * All users with user roles for partner 123: `assignedUserRole.partnerId=\"123\"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId=\"123\"` * All users with partner level user roles: `entityType=\"PARTNER\"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId=\"123\"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>=\"2023-01-01T00:00:00Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/users", + "response": { + "$ref": "ListUsersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "patch": { + "description": "Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v4/users/{usersId}", + "httpMethod": "PATCH", + "id": "displayvideo.users.patch", + "parameterOrder": [ + "userId" + ], + "parameters": { + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "userId": { + "description": "Output only. The unique ID of the user. Assigned by the system.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/users/{+userId}", + "request": { + "$ref": "User" + }, + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + } + } + } + }, + "revision": "20250313", + "rootUrl": "https://displayvideo.googleapis.com/", + "schemas": { + "ActiveViewVideoViewabilityMetricConfig": { + "description": "Configuration for custom Active View video viewability metrics.", + "id": "ActiveViewVideoViewabilityMetricConfig", + "properties": { + "displayName": { + "description": "Required. The display name of the custom metric.", + "type": "string" + }, + "minimumDuration": { + "description": "The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).", + "enum": [ + "VIDEO_DURATION_UNSPECIFIED", + "VIDEO_DURATION_SECONDS_NONE", + "VIDEO_DURATION_SECONDS_0", + "VIDEO_DURATION_SECONDS_1", + "VIDEO_DURATION_SECONDS_2", + "VIDEO_DURATION_SECONDS_3", + "VIDEO_DURATION_SECONDS_4", + "VIDEO_DURATION_SECONDS_5", + "VIDEO_DURATION_SECONDS_6", + "VIDEO_DURATION_SECONDS_7", + "VIDEO_DURATION_SECONDS_8", + "VIDEO_DURATION_SECONDS_9", + "VIDEO_DURATION_SECONDS_10", + "VIDEO_DURATION_SECONDS_11", + "VIDEO_DURATION_SECONDS_12", + "VIDEO_DURATION_SECONDS_13", + "VIDEO_DURATION_SECONDS_14", + "VIDEO_DURATION_SECONDS_15", + "VIDEO_DURATION_SECONDS_30", + "VIDEO_DURATION_SECONDS_45", + "VIDEO_DURATION_SECONDS_60" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "No duration value.", + "0 seconds.", + "1 second.", + "2 seconds.", + "3 seconds.", + "4 seconds.", + "5 seconds.", + "6 seconds.", + "7 seconds.", + "8 seconds.", + "9 seconds.", + "10 seconds.", + "11 seconds.", + "12 seconds.", + "13 seconds.", + "14 seconds.", + "15 seconds.", + "30 seconds.", + "45 seconds.", + "60 seconds." + ], + "type": "string" + }, + "minimumQuartile": { + "description": "The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).", + "enum": [ + "VIDEO_DURATION_QUARTILE_UNSPECIFIED", + "VIDEO_DURATION_QUARTILE_NONE", + "VIDEO_DURATION_QUARTILE_FIRST", + "VIDEO_DURATION_QUARTILE_SECOND", + "VIDEO_DURATION_QUARTILE_THIRD", + "VIDEO_DURATION_QUARTILE_FOURTH" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "No quartile value.", + "First quartile.", + "Second quartile (midpoint).", + "Third quartile.", + "Fourth quartile (completion)." + ], + "type": "string" + }, + "minimumViewability": { + "description": "Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.", + "enum": [ + "VIEWABILITY_PERCENT_UNSPECIFIED", + "VIEWABILITY_PERCENT_0", + "VIEWABILITY_PERCENT_25", + "VIEWABILITY_PERCENT_50", + "VIEWABILITY_PERCENT_75", + "VIEWABILITY_PERCENT_100" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "0% viewable.", + "25% viewable.", + "50% viewable.", + "75% viewable.", + "100% viewable." + ], + "type": "string" + }, + "minimumVolume": { + "description": "Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.", + "enum": [ + "VIDEO_VOLUME_PERCENT_UNSPECIFIED", + "VIDEO_VOLUME_PERCENT_0", + "VIDEO_VOLUME_PERCENT_10" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "0% volume.", + "10% volume." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdGroup": { + "description": "A single ad group associated with a line item.", + "id": "AdGroup", + "properties": { + "adGroupFormat": { + "description": "The format of the ads in the ad group.", + "enum": [ + "AD_GROUP_FORMAT_UNSPECIFIED", + "AD_GROUP_FORMAT_IN_STREAM", + "AD_GROUP_FORMAT_VIDEO_DISCOVERY", + "AD_GROUP_FORMAT_BUMPER", + "AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM", + "AD_GROUP_FORMAT_AUDIO", + "AD_GROUP_FORMAT_RESPONSIVE", + "AD_GROUP_FORMAT_REACH", + "AD_GROUP_FORMAT_MASTHEAD" + ], + "enumDescriptions": [ + "Format value is not specified or is unknown in this version.", + "In-stream ads.", + "In-feed ads.", + "Bumper ads.", + "Non-skippable in-stream ads.", + "Non-skippable in-stream audio ads.", + "Responsive ads.", + "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", + "Masthead Ad that is surfaced on the top slot on the YouTube homepage." + ], + "type": "string" + }, + "adGroupId": { + "description": "The unique ID of the ad group. Assigned by the system.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "The unique ID of the advertiser the ad group belongs to.", + "format": "int64", + "type": "string" + }, + "bidStrategy": { + "$ref": "BiddingStrategy", + "description": "The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy." + }, + "displayName": { + "description": "The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "lineItemId": { + "description": "The unique ID of the line item that the ad group belongs to.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "The resource name of the ad group.", + "type": "string" + }, + "productFeedData": { + "$ref": "ProductFeedData", + "description": "The settings of the product feed in this ad group." + }, + "targetingExpansion": { + "$ref": "TargetingExpansionConfig", + "description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group." + } + }, + "type": "object" + }, + "AdGroupAd": { + "description": "A single ad associated with an ad group.", + "id": "AdGroupAd", + "properties": { + "adGroupAdId": { + "description": "The unique ID of the ad. Assigned by the system.", + "format": "int64", + "type": "string" + }, + "adGroupId": { + "description": "The unique ID of the ad group that the ad belongs to.", + "format": "int64", + "type": "string" + }, + "adUrls": { + "description": "List of URLs used by the ad.", + "items": { + "$ref": "AdUrl" + }, + "type": "array" + }, + "advertiserId": { + "description": "The unique ID of the advertiser the ad belongs to.", + "format": "int64", + "type": "string" + }, + "audioAd": { + "$ref": "AudioAd", + "description": "Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives." + }, + "bumperAd": { + "$ref": "BumperAd", + "description": "Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach." + }, + "displayName": { + "description": "The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "type": "string" + }, + "displayVideoSourceAd": { + "$ref": "DisplayVideoSourceAd", + "description": "Details of an ad sourced from a Display & Video 360 creative." + }, + "entityStatus": { + "description": "The entity status of the ad.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "inStreamAd": { + "$ref": "InStreamAd", + "description": "Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives." + }, + "mastheadAd": { + "$ref": "MastheadAd", + "description": "Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826)." + }, + "name": { + "description": "The resource name of the ad.", + "type": "string" + }, + "nonSkippableAd": { + "$ref": "NonSkippableAd", + "description": "Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives." + }, + "videoDiscoverAd": { + "$ref": "VideoDiscoveryAd", + "description": "Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery." + }, + "videoPerformanceAd": { + "$ref": "VideoPerformanceAd", + "description": "Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product." + } + }, + "type": "object" + }, + "AdGroupAssignedTargetingOption": { + "description": "Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.", + "id": "AdGroupAssignedTargetingOption", + "properties": { + "adGroupId": { + "description": "The ID of the ad group the assigned targeting option is assigned to.", + "format": "int64", + "type": "string" + }, + "assignedTargetingOption": { + "$ref": "AssignedTargetingOption", + "description": "The assigned targeting option resource." + } + }, + "type": "object" + }, + "AdUrl": { + "description": "Additional URLs related to the ad, including beacons.", + "id": "AdUrl", + "properties": { + "type": { + "description": "The type of the Ad URL.", + "enum": [ + "AD_URL_TYPE_UNSPECIFIED", + "AD_URL_TYPE_BEACON_IMPRESSION", + "AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION", + "AD_URL_TYPE_BEACON_CLICK", + "AD_URL_TYPE_BEACON_SKIP" + ], + "enumDescriptions": [ + "Unknown or unspecified.", + "A 1x1 tracking pixel to ping when an impression of a creative is delivered.", + "Expandable DCM impression beacon. At serving time, it is expanded to several beacons.", + "Tracking URL to ping when the click event is triggered.", + "Tracking URL to ping when the skip event is triggered." + ], + "type": "string" + }, + "url": { + "description": "The URL string value.", + "type": "string" + } + }, + "type": "object" + }, + "Adloox": { + "description": "Details of Adloox brand safety settings.", + "id": "Adloox", + "properties": { + "adultExplicitSexualContent": { + "description": "Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "armsAmmunitionContent": { + "description": "Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": { + "description": "Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "deathInjuryMilitaryConflictContent": { + "description": "Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "debatedSensitiveSocialIssueContent": { + "description": "Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "displayIabViewability": { + "description": "Optional. IAB viewability threshold for display ads.", + "enum": [ + "DISPLAY_IAB_VIEWABILITY_UNSPECIFIED", + "DISPLAY_IAB_VIEWABILITY_10", + "DISPLAY_IAB_VIEWABILITY_20", + "DISPLAY_IAB_VIEWABILITY_35", + "DISPLAY_IAB_VIEWABILITY_50", + "DISPLAY_IAB_VIEWABILITY_75" + ], + "enumDescriptions": [ + "Default value when not specified or is unknown in this version.", + "10%+ in view (IAB display viewability standard).", + "20%+ in view (IAB display viewability standard).", + "35%+ in view (IAB display viewability standard).", + "50%+ in view (IAB display viewability standard).", + "75%+ in view (IAB display viewability standard)." + ], + "type": "string" + }, + "excludedAdlooxCategories": { + "description": "Adloox categories to exclude.", + "items": { + "enum": [ + "ADLOOX_UNSPECIFIED", + "ADULT_CONTENT_HARD", + "ADULT_CONTENT_SOFT", + "ILLEGAL_CONTENT", + "BORDERLINE_CONTENT", + "DISCRIMINATORY_CONTENT", + "VIOLENT_CONTENT_WEAPONS", + "LOW_VIEWABILITY_DOMAINS", + "FRAUD" + ], + "enumDescriptions": [ + "Default value when a Adloox category is not specified or is unknown in this version.", + "Adult content (hard).", + "Adult content (soft).", + "Illegal content.", + "Borderline content.", + "Discriminatory content.", + "Violent content & weapons.", + "Low viewability domains.", + "Fraud." + ], + "type": "string" + }, + "type": "array" + }, + "excludedFraudIvtMfaCategories": { + "description": "Optional. Adloox's fraud IVT MFA categories to exclude.", + "items": { + "enum": [ + "FRAUD_IVT_MFA_CATEGORY_UNSPECIFIED", + "FRAUD_IVT_MFA" + ], + "enumDescriptions": [ + "Default value when a Adloox Fraud, IVT, MFA category is not specified or is unknown in this version.", + "FRAUD, IVT, MFA." + ], + "type": "string" + }, + "type": "array" + }, + "hateSpeechActsAggressionContent": { + "description": "Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": { + "description": "Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "misinformationContent": { + "description": "Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "obscenityProfanityContent": { + "description": "Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "onlinePiracyContent": { + "description": "Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "spamHarmfulContent": { + "description": "Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "terrorismContent": { + "description": "Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.", + "enum": [ + "GARM_RISK_EXCLUSION_UNSPECIFIED", + "GARM_RISK_EXCLUSION_FLOOR", + "GARM_RISK_EXCLUSION_HIGH", + "GARM_RISK_EXCLUSION_MEDIUM", + "GARM_RISK_EXCLUSION_LOW" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any GARM risk exclusion option.", + "Exclude floor risk.", + "Exclude high and floor risk.", + "Exclude medium, high, and floor risk.", + "Exclude all levels of risk (low, medium, high and floor)." + ], + "type": "string" + }, + "videoIabViewability": { + "description": "Optional. IAB viewability threshold for video ads.", + "enum": [ + "VIDEO_IAB_VIEWABILITY_UNSPECIFIED", + "VIDEO_IAB_VIEWABILITY_10", + "VIDEO_IAB_VIEWABILITY_20", + "VIDEO_IAB_VIEWABILITY_35", + "VIDEO_IAB_VIEWABILITY_50", + "VIDEO_IAB_VIEWABILITY_75" + ], + "enumDescriptions": [ + "Default value when not specified or is unknown in this version.", + "10%+ in view (IAB video viewability standard).", + "20%+ in view (IAB video viewability standard).", + "35%+ in view (IAB video viewability standard).", + "50%+ in view (IAB video viewability standard).", + "75%+ in view (IAB video viewability standard)." + ], + "type": "string" + } + }, + "type": "object" + }, + "Advertiser": { + "description": "A single advertiser in Display & Video 360 (DV360).", + "id": "Advertiser", + "properties": { + "adServerConfig": { + "$ref": "AdvertiserAdServerConfig", + "description": "Required. Immutable. Ad server related settings of the advertiser." + }, + "advertiserId": { + "description": "Output only. The unique ID of the advertiser. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "billingConfig": { + "$ref": "AdvertiserBillingConfig", + "description": "Required. Billing related settings of the advertiser." + }, + "creativeConfig": { + "$ref": "AdvertiserCreativeConfig", + "description": "Required. Creative related settings of the advertiser." + }, + "dataAccessConfig": { + "$ref": "AdvertiserDataAccessConfig", + "description": "Settings that control how advertiser data may be accessed." + }, + "displayName": { + "description": "Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "generalConfig": { + "$ref": "AdvertiserGeneralConfig", + "description": "Required. General settings of the advertiser." + }, + "integrationDetails": { + "$ref": "IntegrationDetails", + "description": "Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided." + }, + "name": { + "description": "Output only. The resource name of the advertiser.", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "Required. Immutable. The unique ID of the partner that the advertiser belongs to.", + "format": "int64", + "type": "string" + }, + "prismaEnabled": { + "description": "Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.", + "type": "boolean" + }, + "servingConfig": { + "$ref": "AdvertiserTargetingConfig", + "description": "Targeting settings related to ad serving of the advertiser." + }, + "updateTime": { + "description": "Output only. The timestamp when the advertiser was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserAdServerConfig": { + "description": "Ad server related settings of an advertiser.", + "id": "AdvertiserAdServerConfig", + "properties": { + "cmHybridConfig": { + "$ref": "CmHybridConfig", + "description": "The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers." + }, + "thirdPartyOnlyConfig": { + "$ref": "ThirdPartyOnlyConfig", + "description": "The configuration for advertisers that use third-party ad servers only." + } + }, + "type": "object" + }, + "AdvertiserBillingConfig": { + "description": "Billing related settings of an advertiser.", + "id": "AdvertiserBillingConfig", + "properties": { + "billingProfileId": { + "description": "Required. The ID of a billing profile assigned to the advertiser.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserCreativeConfig": { + "description": "Creatives related settings of an advertiser.", + "id": "AdvertiserCreativeConfig", + "properties": { + "dynamicCreativeEnabled": { + "description": "Whether or not the advertiser is enabled for dynamic creatives.", + "type": "boolean" + }, + "iasClientId": { + "description": "An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS \"Campaign Monitor\" tag containing this ID to the creative tag.", + "format": "int64", + "type": "string" + }, + "obaComplianceDisabled": { + "description": "Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).", + "type": "boolean" + }, + "videoCreativeDataSharingAuthorized": { + "description": "By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.", + "type": "boolean" + } + }, + "type": "object" + }, + "AdvertiserDataAccessConfig": { + "description": "Settings that control how advertiser related data may be accessed.", + "id": "AdvertiserDataAccessConfig", + "properties": { + "sdfConfig": { + "$ref": "AdvertiserSdfConfig", + "description": "Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used." + } + }, + "type": "object" + }, + "AdvertiserGeneralConfig": { + "description": "General settings of an advertiser.", + "id": "AdvertiserGeneralConfig", + "properties": { + "currencyCode": { + "description": "Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand", + "type": "string" + }, + "domainUrl": { + "description": "Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com", + "type": "string" + }, + "timeZone": { + "description": "Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserSdfConfig": { + "description": "Structured Data Files (SDF) settings of an advertiser.", + "id": "AdvertiserSdfConfig", + "properties": { + "overridePartnerSdfConfig": { + "description": "Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.", + "type": "boolean" + }, + "sdfConfig": { + "$ref": "SdfConfig", + "description": "The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`." + } + }, + "type": "object" + }, + "AdvertiserTargetingConfig": { + "description": "Targeting settings related to ad serving of an advertiser.", + "id": "AdvertiserTargetingConfig", + "properties": { + "exemptTvFromViewabilityTargeting": { + "description": "Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.", + "type": "boolean" + } + }, + "type": "object" + }, + "AgeRangeAssignedTargetingOptionDetails": { + "description": "Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`.", + "id": "AgeRangeAssignedTargetingOptionDetails", + "properties": { + "ageRange": { + "description": "Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.", + "enum": [ + "AGE_RANGE_UNSPECIFIED", + "AGE_RANGE_18_24", + "AGE_RANGE_25_34", + "AGE_RANGE_35_44", + "AGE_RANGE_45_54", + "AGE_RANGE_55_64", + "AGE_RANGE_65_PLUS", + "AGE_RANGE_UNKNOWN", + "AGE_RANGE_18_20", + "AGE_RANGE_21_24", + "AGE_RANGE_25_29", + "AGE_RANGE_30_34", + "AGE_RANGE_35_39", + "AGE_RANGE_40_44", + "AGE_RANGE_45_49", + "AGE_RANGE_50_54", + "AGE_RANGE_55_59", + "AGE_RANGE_60_64" + ], + "enumDescriptions": [ + "Default value when age range is not specified in this version. This enum is a placeholder for default value and does not represent a real age range option.", + "The age range of the audience is 18 to 24.", + "The age range of the audience is 25 to 34.", + "The age range of the audience is 35 to 44.", + "The age range of the audience is 45 to 54.", + "The age range of the audience is 55 to 64.", + "The age range of the audience is 65 and up.", + "The age range of the audience is unknown.", + "The age range of the audience is 18 to 20, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 21 to 24, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 25 to 29, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 30 to 34, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 35 to 39, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 40 to 44, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 45 to 49, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 50 to 54, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 55 to 59, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 60 to 64, only supported for the AdGroup of YouTube Programmatic Reservation line item." + ], + "type": "string" + } + }, + "type": "object" + }, + "AgeRangeTargetingOptionDetails": { + "description": "Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`.", + "id": "AgeRangeTargetingOptionDetails", + "properties": { + "ageRange": { + "description": "Output only. The age range of an audience.", + "enum": [ + "AGE_RANGE_UNSPECIFIED", + "AGE_RANGE_18_24", + "AGE_RANGE_25_34", + "AGE_RANGE_35_44", + "AGE_RANGE_45_54", + "AGE_RANGE_55_64", + "AGE_RANGE_65_PLUS", + "AGE_RANGE_UNKNOWN", + "AGE_RANGE_18_20", + "AGE_RANGE_21_24", + "AGE_RANGE_25_29", + "AGE_RANGE_30_34", + "AGE_RANGE_35_39", + "AGE_RANGE_40_44", + "AGE_RANGE_45_49", + "AGE_RANGE_50_54", + "AGE_RANGE_55_59", + "AGE_RANGE_60_64" + ], + "enumDescriptions": [ + "Default value when age range is not specified in this version. This enum is a placeholder for default value and does not represent a real age range option.", + "The age range of the audience is 18 to 24.", + "The age range of the audience is 25 to 34.", + "The age range of the audience is 35 to 44.", + "The age range of the audience is 45 to 54.", + "The age range of the audience is 55 to 64.", + "The age range of the audience is 65 and up.", + "The age range of the audience is unknown.", + "The age range of the audience is 18 to 20, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 21 to 24, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 25 to 29, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 30 to 34, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 35 to 39, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 40 to 44, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 45 to 49, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 50 to 54, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 55 to 59, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 60 to 64, only supported for the AdGroup of YouTube Programmatic Reservation line item." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AlgorithmRules": { + "description": "Rule-based algorithm.", + "id": "AlgorithmRules", + "properties": { + "impressionSignalRuleset": { + "$ref": "AlgorithmRulesRuleset", + "description": "Rules for the impression signals." + } + }, + "type": "object" + }, + "AlgorithmRulesComparisonValue": { + "description": "A value to compare the signal to.", + "id": "AlgorithmRulesComparisonValue", + "properties": { + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "creativeDimensionValue": { + "$ref": "Dimensions", + "description": "Creative dimension value." + }, + "dayAndTimeValue": { + "$ref": "DayAndTime", + "description": "Day and time value. Only `TIME_ZONE_RESOLUTION_END_USER` is supported." + }, + "deviceTypeValue": { + "description": "Device type value.", + "enum": [ + "RULE_DEVICE_TYPE_UNSPECIFIED", + "RULE_DEVICE_TYPE_COMPUTER", + "RULE_DEVICE_TYPE_CONNECTED_TV", + "RULE_DEVICE_TYPE_SMART_PHONE", + "RULE_DEVICE_TYPE_TABLET", + "RULE_DEVICE_TYPE_CONNECTED_DEVICE", + "RULE_DEVICE_TYPE_SET_TOP_BOX" + ], + "enumDescriptions": [ + "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet.", + "Connected device.", + "Set top box." + ], + "type": "string" + }, + "doubleValue": { + "description": "Double value.", + "format": "double", + "type": "number" + }, + "environmentValue": { + "description": "Environment value.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_WEB_OPTIMIZED", + "ENVIRONMENT_WEB_NOT_OPTIMIZED", + "ENVIRONMENT_APP" + ], + "enumDescriptions": [ + "Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", + "Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", + "Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", + "Target inventory displayed in apps." + ], + "type": "string" + }, + "exchangeValue": { + "description": "Exchange value.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK", + "EXCHANGE_DRAX", + "EXCHANGE_APPLOVIN_GBID", + "EXCHANGE_FYBER_GBID", + "EXCHANGE_UNITY_GBID", + "EXCHANGE_CHARTBOOST_GBID", + "EXCHANGE_ADMOST_GBID", + "EXCHANGE_TOPON_GBID", + "EXCHANGE_NETFLIX", + "EXCHANGE_CORE", + "EXCHANGE_TUBI" + ], + "enumDescriptions": [ + "Exchange is not specified or is unknown in this version.", + "Google Ad Manager.", + "AppNexus.", + "BrightRoll Exchange for Video from Yahoo!.", + "Adform.", + "Admeta.", + "Admixer.", + "AdsMogo.", + "AdsWizz.", + "BidSwitch.", + "BrightRoll Exchange for Display from Yahoo!.", + "Cadreon.", + "Dailymotion.", + "Five.", + "Fluct.", + "FreeWheel SSP.", + "Geniee.", + "GumGum.", + "i-mobile.", + "iBILLBOARD.", + "Improve Digital.", + "Index Exchange.", + "Kargo.", + "MicroAd.", + "MoPub.", + "Nend.", + "ONE by AOL: Display Market Place.", + "ONE by AOL: Mobile.", + "ONE by AOL: Video.", + "Ooyala.", + "OpenX.", + "Permodo.", + "Platform One.", + "PlatformId.", + "PubMatic.", + "PulsePoint.", + "RevenueMax.", + "Rubicon.", + "SmartClip.", + "SmartRTB+.", + "SmartstreamTv.", + "Sovrn.", + "SpotXchange.", + "Ströer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack.", + "Drax.", + "AppLovin MAX.", + "DT Fairbid.", + "Unity LevelPlay.", + "Chartboost Mediation.", + "AdMost.", + "TopOn.", + "Netflix.", + "Core.", + "Tubi." + ], + "type": "string" + }, + "int64Value": { + "description": "Integer value.", + "format": "int64", + "type": "string" + }, + "onScreenPositionValue": { + "description": "Ad position value.", + "enum": [ + "ON_SCREEN_POSITION_UNSPECIFIED", + "ON_SCREEN_POSITION_UNKNOWN", + "ON_SCREEN_POSITION_ABOVE_THE_FOLD", + "ON_SCREEN_POSITION_BELOW_THE_FOLD" + ], + "enumDescriptions": [ + "On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", + "The ad position is unknown on the screen.", + "The ad is located above the fold.", + "The ad is located below the fold." + ], + "type": "string" + }, + "stringValue": { + "description": "String value.", + "type": "string" + } + }, + "type": "object" + }, + "AlgorithmRulesRule": { + "description": "Set of conditions. The return value of the rule is either: * The return value for single met condition or * The defined default return value if no conditions are met.", + "id": "AlgorithmRulesRule", + "properties": { + "conditions": { + "description": "List of conditions in this rule. The criteria among conditions should be mutually exclusive.", + "items": { + "$ref": "AlgorithmRulesRuleCondition" + }, + "type": "array" + }, + "defaultReturnValue": { + "$ref": "AlgorithmRulesSignalValue", + "description": "The default return value applied when none of the conditions are met." + } + }, + "type": "object" + }, + "AlgorithmRulesRuleCondition": { + "description": "Set of signal comparisons. Equivalent of an `if` statement.", + "id": "AlgorithmRulesRuleCondition", + "properties": { + "returnValue": { + "$ref": "AlgorithmRulesSignalValue", + "description": "The value returned if the `signalComparisons` condition evaluates to `TRUE`." + }, + "signalComparisons": { + "description": "List of comparisons that build `if` statement condition. The comparisons are combined into a single condition with `AND` logical operators.", + "items": { + "$ref": "AlgorithmRulesSignalComparison" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlgorithmRulesRuleset": { + "description": "A ruleset consisting of a list of rules and how to aggregate the resulting values.", + "id": "AlgorithmRulesRuleset", + "properties": { + "aggregationType": { + "description": "How to aggregate values of evaluated rules.", + "enum": [ + "RULE_AGGREGATION_TYPE_UNSPECIFIED", + "SUM_OF_VALUES", + "PRODUCT_OF_VALUES", + "MAXIMUM_VALUE" + ], + "enumDescriptions": [ + "Unknown aggregation type.", + "The sum of rule values.", + "The product of rule values.", + "The maximum rule value." + ], + "type": "string" + }, + "maxValue": { + "description": "Maximum value the ruleset can evaluate to.", + "format": "double", + "type": "number" + }, + "rules": { + "description": "List of rules to generate the impression value.", + "items": { + "$ref": "AlgorithmRulesRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlgorithmRulesSignal": { + "description": "Signal used to evaluate rules.", + "id": "AlgorithmRulesSignal", + "properties": { + "impressionSignal": { + "description": "Signal based on impressions.", + "enum": [ + "IMPRESSION_SIGNAL_UNSPECIFIED", + "DAY_AND_TIME", + "DEVICE_TYPE", + "AD_POSITION", + "OPERATING_SYSTEM_ID", + "MOBILE_MODEL_ID", + "EXCHANGE", + "ENVIRONMENT", + "COUNTRY_ID", + "CITY_ID", + "BROWSER_ID", + "CREATIVE_DIMENSION" + ], + "enumDescriptions": [ + "Unknown signal.", + "The day of the week and hour of day the impression was made using browser's local time zone. Value is stored in the dayAndTimeValue field of the comparison value.", + "Device type. Value is stored in the deviceTypeValue field of the comparison value.", + "Ad position. Value is stored in the onScreenPositionValue field of the comparison value.", + "The operating system identifier. Value is stored in the int64Value field of the comparison value.", + "The mobile model identifier. Value is stored in the int64Value field of the comparison value.", + "Exchange. Value is stored in the exchangeValue field of the comparison value.", + "Serving environment. Value is stored in the environmentValue field of the comparison value.", + "The country or region identifier. Value is stored in the int64Value field of the comparison value.", + "The city identifier. Value is stored in the int64Value field of the comparison value.", + "The browser identifier. Value is stored in the int64Value field of the comparison value.", + "Creative height and width in pixels. Value is stored in the creativeDimensionValue field of the comparison value." + ], + "type": "string" + } + }, + "type": "object" + }, + "AlgorithmRulesSignalComparison": { + "description": "A single comparison. The comparison compares the `signal` to the `comparisonValue`. The comparison of `siteId==123` is represented with the following field values: * `signal` has an `impressionSignal` of `SITE_ID`. * `comparisonOperator` is set to `EQUAL`. * `comparisonValue` is set to 123.", + "id": "AlgorithmRulesSignalComparison", + "properties": { + "comparisonOperator": { + "description": "Operator used to compare the two values. In the resulting experession, the `signal` will be the first value and the `comparisonValue will be the second.", + "enum": [ + "COMPARISON_OPERATOR_UNSPECIFIED", + "EQUAL", + "GREATER_THAN", + "LESS_THAN", + "GREATER_THAN_OR_EQUAL_TO", + "LESS_THAN_OR_EQUAL_TO" + ], + "enumDescriptions": [ + "Unknown operator.", + "Values are equal.", + "Signal value is greater than the comparison value.", + "Signal value is less than the second.", + "Signal value is greater than or equal to the second.", + "Signal value is less than or equal to the comparison value." + ], + "type": "string" + }, + "comparisonValue": { + "$ref": "AlgorithmRulesComparisonValue", + "description": "Value to compare signal to." + }, + "signal": { + "$ref": "AlgorithmRulesSignal", + "description": "Signal to compare." + } + }, + "type": "object" + }, + "AlgorithmRulesSignalValue": { + "description": "Adjusted value of the signal used for rule evaluation.", + "id": "AlgorithmRulesSignalValue", + "properties": { + "number": { + "description": "Value to use as result.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "AppAssignedTargetingOptionDetails": { + "description": "Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`.", + "id": "AppAssignedTargetingOptionDetails", + "properties": { + "appId": { + "description": "Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.", + "type": "string" + }, + "appPlatform": { + "description": "Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.", + "enum": [ + "APP_PLATFORM_UNSPECIFIED", + "APP_PLATFORM_IOS", + "APP_PLATFORM_ANDROID", + "APP_PLATFORM_ROKU", + "APP_PLATFORM_AMAZON_FIRETV", + "APP_PLATFORM_PLAYSTATION", + "APP_PLATFORM_APPLE_TV", + "APP_PLATFORM_XBOX", + "APP_PLATFORM_SAMSUNG_TV", + "APP_PLATFORM_ANDROID_TV", + "APP_PLATFORM_GENERIC_CTV", + "APP_PLATFORM_LG_TV", + "APP_PLATFORM_VIZIO_TV" + ], + "enumDescriptions": [ + "Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option.", + "The app platform is iOS.", + "The app platform is Android.", + "The app platform is Roku.", + "The app platform is Amazon FireTV.", + "The app platform is Playstation.", + "The app platform is Apple TV.", + "The app platform is Xbox.", + "The app platform is Samsung TV.", + "The app platform is Android TV.", + "The app platform is a CTV platform that is not explicitly listed elsewhere.", + "The app platform is LG TV.", + "The app platform is VIZIO TV." + ], + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the app.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + } + }, + "type": "object" + }, + "AppCategoryAssignedTargetingOptionDetails": { + "description": "Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.", + "id": "AppCategoryAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the app category.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.", + "type": "string" + } + }, + "type": "object" + }, + "AppCategoryTargetingOptionDetails": { + "description": "Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.", + "id": "AppCategoryTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The name of the app collection.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Asset": { + "description": "A single asset.", + "id": "Asset", + "properties": { + "content": { + "description": "The asset content. For uploaded assets, the content is the serving path.", + "type": "string" + }, + "mediaId": { + "description": "Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AssetAssociation": { + "description": "Asset association for the creative.", + "id": "AssetAssociation", + "properties": { + "asset": { + "$ref": "Asset", + "description": "Optional. The associated asset." + }, + "role": { + "description": "Optional. The role of this asset for the creative.", + "enum": [ + "ASSET_ROLE_UNSPECIFIED", + "ASSET_ROLE_MAIN", + "ASSET_ROLE_BACKUP", + "ASSET_ROLE_POLITE_LOAD", + "ASSET_ROLE_HEADLINE", + "ASSET_ROLE_LONG_HEADLINE", + "ASSET_ROLE_BODY", + "ASSET_ROLE_LONG_BODY", + "ASSET_ROLE_CAPTION_URL", + "ASSET_ROLE_CALL_TO_ACTION", + "ASSET_ROLE_ADVERTISER_NAME", + "ASSET_ROLE_PRICE", + "ASSET_ROLE_ANDROID_APP_ID", + "ASSET_ROLE_IOS_APP_ID", + "ASSET_ROLE_RATING", + "ASSET_ROLE_ICON", + "ASSET_ROLE_COVER_IMAGE", + "ASSET_ROLE_BACKGROUND_COLOR", + "ASSET_ROLE_ACCENT_COLOR", + "ASSET_ROLE_REQUIRE_LOGO", + "ASSET_ROLE_REQUIRE_IMAGE", + "ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS" + ], + "enumDescriptions": [ + "Asset role is not specified or is unknown in this version.", + "The asset is the main asset of the creative.", + "The asset is a backup asset of the creative.", + "The asset is a polite load asset of the creative.", + "Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.", + "The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in `https://play.google.com/store/apps/details?id=com.company.appname` the identifier is com.company.appname. Assets of this role are read-only.", + "The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in `https://apps.apple.com/us/app/gmail-email-by-google/id422689480` the ID is 422689480. Assets of this role are read-only.", + "The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.", + "The icon of a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", + "The cover image of a native video creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_VIDEO`", + "The main color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "The accent color to use in a creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether the creative must use a logo asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether the creative must use an image asset. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`", + "Whether asset enhancements can be applied to the creative. This role is only supported and required in the following creative_type: * `CREATIVE_TYPE_ASSET_BASED_CREATIVE`" + ], + "type": "string" + } + }, + "type": "object" + }, + "AssignedInventorySource": { + "description": "An assignment between a targetable inventory source and an inventory source group.", + "id": "AssignedInventorySource", + "properties": { + "assignedInventorySourceId": { + "description": "Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "inventorySourceId": { + "description": "Required. The ID of the inventory source entity being targeted.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the assigned inventory source.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AssignedLocation": { + "description": "An assignment between a location list and a relevant targeting option.", + "id": "AssignedLocation", + "properties": { + "assignedLocationId": { + "description": "Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the assigned location.", + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The ID of the targeting option assigned to the location list.", + "type": "string" + } + }, + "type": "object" + }, + "AssignedTargetingOption": { + "description": "A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.", + "id": "AssignedTargetingOption", + "properties": { + "ageRangeDetails": { + "$ref": "AgeRangeAssignedTargetingOptionDetails", + "description": "Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`." + }, + "appCategoryDetails": { + "$ref": "AppCategoryAssignedTargetingOptionDetails", + "description": "App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`." + }, + "appDetails": { + "$ref": "AppAssignedTargetingOptionDetails", + "description": "App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`." + }, + "assignedTargetingOptionId": { + "description": "Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.", + "readOnly": true, + "type": "string" + }, + "assignedTargetingOptionIdAlias": { + "description": "Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`", + "readOnly": true, + "type": "string" + }, + "audienceGroupDetails": { + "$ref": "AudienceGroupAssignedTargetingOptionDetails", + "description": "Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource." + }, + "audioContentTypeDetails": { + "$ref": "AudioContentTypeAssignedTargetingOptionDetails", + "description": "Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`." + }, + "authorizedSellerStatusDetails": { + "$ref": "AuthorizedSellerStatusAssignedTargetingOptionDetails", + "description": "Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default." + }, + "browserDetails": { + "$ref": "BrowserAssignedTargetingOptionDetails", + "description": "Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`." + }, + "businessChainDetails": { + "$ref": "BusinessChainAssignedTargetingOptionDetails", + "description": "Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`." + }, + "carrierAndIspDetails": { + "$ref": "CarrierAndIspAssignedTargetingOptionDetails", + "description": "Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`." + }, + "categoryDetails": { + "$ref": "CategoryAssignedTargetingOptionDetails", + "description": "Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence." + }, + "channelDetails": { + "$ref": "ChannelAssignedTargetingOptionDetails", + "description": "Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`." + }, + "contentDurationDetails": { + "$ref": "ContentDurationAssignedTargetingOptionDetails", + "description": "Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`." + }, + "contentGenreDetails": { + "$ref": "ContentGenreAssignedTargetingOptionDetails", + "description": "Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`." + }, + "contentInstreamPositionDetails": { + "$ref": "ContentInstreamPositionAssignedTargetingOptionDetails", + "description": "Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`." + }, + "contentOutstreamPositionDetails": { + "$ref": "ContentOutstreamPositionAssignedTargetingOptionDetails", + "description": "Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`." + }, + "contentStreamTypeDetails": { + "$ref": "ContentStreamTypeAssignedTargetingOptionDetails", + "description": "Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`." + }, + "dayAndTimeDetails": { + "$ref": "DayAndTimeAssignedTargetingOptionDetails", + "description": "Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`." + }, + "deviceMakeModelDetails": { + "$ref": "DeviceMakeModelAssignedTargetingOptionDetails", + "description": "Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`." + }, + "deviceTypeDetails": { + "$ref": "DeviceTypeAssignedTargetingOptionDetails", + "description": "Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`." + }, + "digitalContentLabelExclusionDetails": { + "$ref": "DigitalContentLabelAssignedTargetingOptionDetails", + "description": "Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded." + }, + "environmentDetails": { + "$ref": "EnvironmentAssignedTargetingOptionDetails", + "description": "Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`." + }, + "exchangeDetails": { + "$ref": "ExchangeAssignedTargetingOptionDetails", + "description": "Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`." + }, + "genderDetails": { + "$ref": "GenderAssignedTargetingOptionDetails", + "description": "Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`." + }, + "geoRegionDetails": { + "$ref": "GeoRegionAssignedTargetingOptionDetails", + "description": "Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`." + }, + "householdIncomeDetails": { + "$ref": "HouseholdIncomeAssignedTargetingOptionDetails", + "description": "Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`." + }, + "inheritance": { + "description": "Output only. The inheritance status of the assigned targeting option.", + "enum": [ + "INHERITANCE_UNSPECIFIED", + "NOT_INHERITED", + "INHERITED_FROM_PARTNER", + "INHERITED_FROM_ADVERTISER" + ], + "enumDescriptions": [ + "The inheritance is unspecified or unknown.", + "The assigned targeting option is not inherited from higher level entity.", + "The assigned targeting option is inherited from partner targeting settings.", + "The assigned targeting option is inherited from advertiser targeting settings." + ], + "readOnly": true, + "type": "string" + }, + "inventorySourceDetails": { + "$ref": "InventorySourceAssignedTargetingOptionDetails", + "description": "Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`." + }, + "inventorySourceGroupDetails": { + "$ref": "InventorySourceGroupAssignedTargetingOptionDetails", + "description": "Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`." + }, + "keywordDetails": { + "$ref": "KeywordAssignedTargetingOptionDetails", + "description": "Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned." + }, + "languageDetails": { + "$ref": "LanguageAssignedTargetingOptionDetails", + "description": "Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`." + }, + "name": { + "description": "Output only. The resource name for this assigned targeting option.", + "readOnly": true, + "type": "string" + }, + "nativeContentPositionDetails": { + "$ref": "NativeContentPositionAssignedTargetingOptionDetails", + "description": "Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`." + }, + "negativeKeywordListDetails": { + "$ref": "NegativeKeywordListAssignedTargetingOptionDetails", + "description": "Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource." + }, + "omidDetails": { + "$ref": "OmidAssignedTargetingOptionDetails", + "description": "Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`." + }, + "onScreenPositionDetails": { + "$ref": "OnScreenPositionAssignedTargetingOptionDetails", + "description": "On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`." + }, + "operatingSystemDetails": { + "$ref": "OperatingSystemAssignedTargetingOptionDetails", + "description": "Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`." + }, + "parentalStatusDetails": { + "$ref": "ParentalStatusAssignedTargetingOptionDetails", + "description": "Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`." + }, + "poiDetails": { + "$ref": "PoiAssignedTargetingOptionDetails", + "description": "POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`." + }, + "proximityLocationListDetails": { + "$ref": "ProximityLocationListAssignedTargetingOptionDetails", + "description": "Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`." + }, + "regionalLocationListDetails": { + "$ref": "RegionalLocationListAssignedTargetingOptionDetails", + "description": "Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`." + }, + "sensitiveCategoryExclusionDetails": { + "$ref": "SensitiveCategoryAssignedTargetingOptionDetails", + "description": "Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them." + }, + "sessionPositionDetails": { + "$ref": "SessionPositionAssignedTargetingOptionDetails", + "description": "Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`." + }, + "subExchangeDetails": { + "$ref": "SubExchangeAssignedTargetingOptionDetails", + "description": "Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`." + }, + "targetingType": { + "description": "Output only. Identifies the type of this assigned targeting option.", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "readOnly": true, + "type": "string" + }, + "thirdPartyVerifierDetails": { + "$ref": "ThirdPartyVerifierAssignedTargetingOptionDetails", + "description": "Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`." + }, + "urlDetails": { + "$ref": "UrlAssignedTargetingOptionDetails", + "description": "URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`." + }, + "userRewardedContentDetails": { + "$ref": "UserRewardedContentAssignedTargetingOptionDetails", + "description": "User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`." + }, + "videoPlayerSizeDetails": { + "$ref": "VideoPlayerSizeAssignedTargetingOptionDetails", + "description": "Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`." + }, + "viewabilityDetails": { + "$ref": "ViewabilityAssignedTargetingOptionDetails", + "description": "Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource." + }, + "youtubeChannelDetails": { + "$ref": "YoutubeChannelAssignedTargetingOptionDetails", + "description": "YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`." + }, + "youtubeVideoDetails": { + "$ref": "YoutubeVideoAssignedTargetingOptionDetails", + "description": "YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`." + } + }, + "type": "object" + }, + "AssignedUserRole": { + "description": "A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.", + "id": "AssignedUserRole", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that the assigend user role applies to.", + "format": "int64", + "type": "string" + }, + "assignedUserRoleId": { + "description": "Output only. The ID of the assigned user role.", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that the assigned user role applies to.", + "format": "int64", + "type": "string" + }, + "userRole": { + "description": "Required. The user role to assign to a user for the entity.", + "enum": [ + "USER_ROLE_UNSPECIFIED", + "ADMIN", + "ADMIN_PARTNER_CLIENT", + "STANDARD", + "STANDARD_PLANNER", + "STANDARD_PLANNER_LIMITED", + "STANDARD_PARTNER_CLIENT", + "READ_ONLY", + "REPORTING_ONLY", + "LIMITED_REPORTING_ONLY", + "CREATIVE", + "CREATIVE_ADMIN" + ], + "enumDescriptions": [ + "Default value when the user role is not specified or is unknown in this version.", + "The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can view and edit billing information, create or modify users, and enable or disable exchanges. This role can only be assigned for a partner entity.", + "The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can create and modify other `ADMIN_PARTNER_CLIENT` users and view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for a partner entity.", + "The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create and modify users or view billing information.", + "The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity, including all cost data. They can create and modify planning-related features, including plans and inventory.", + "The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity. They can create or modify planning-related features, including plans and inventory. They have no access to cost data and cannot start, accept, or negotiate deals.", + "The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create or modify other users or view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for an advertiser entity.", + "The user can only build reports and view data for the entity.", + "The user can only create and manage reports.", + "The user can only create and manage the following client-safe reports: General, Audience Performance, Cross-Partner, Keyword, Order ID, Category, and Third-Party Data Provider.", + "The user can view media plan information they need to collaborate, but can't view cost-related data or Marketplace.", + "The user can view media plan information they need to collaborate, but can't view cost-related data or Marketplace. In addition, they can add other creative admins or creative users to the entity." + ], + "type": "string" + } + }, + "type": "object" + }, + "AudienceGroupAssignedTargetingOptionDetails": { + "description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups.", + "id": "AudienceGroupAssignedTargetingOptionDetails", + "properties": { + "excludedFirstPartyAndPartnerAudienceGroup": { + "$ref": "FirstPartyAndPartnerAudienceGroup", + "description": "Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other." + }, + "excludedGoogleAudienceGroup": { + "$ref": "GoogleAudienceGroup", + "description": "Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other." + }, + "includedCombinedAudienceGroup": { + "$ref": "CombinedAudienceGroup", + "description": "Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only." + }, + "includedCustomListGroup": { + "$ref": "CustomListGroup", + "description": "Optional. The custom list ids of the included custom list group. Contains custom list ids only." + }, + "includedFirstPartyAndPartnerAudienceGroups": { + "description": "Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.", + "items": { + "$ref": "FirstPartyAndPartnerAudienceGroup" + }, + "type": "array" + }, + "includedGoogleAudienceGroup": { + "$ref": "GoogleAudienceGroup", + "description": "Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only." + } + }, + "type": "object" + }, + "AudioAd": { + "description": "Details for an audio ad.", + "id": "AudioAd", + "properties": { + "displayUrl": { + "description": "The webpage address that appears with the ad.", + "type": "string" + }, + "finalUrl": { + "description": "The URL address of the webpage that people reach after they click the ad.", + "type": "string" + }, + "trackingUrl": { + "description": "The URL address loaded in the background for tracking purposes.", + "type": "string" + }, + "video": { + "$ref": "YoutubeVideoDetails", + "description": "The YouTube video of the ad." + } + }, + "type": "object" + }, + "AudioContentTypeAssignedTargetingOptionDetails": { + "description": "Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect.", + "id": "AudioContentTypeAssignedTargetingOptionDetails", + "properties": { + "audioContentType": { + "description": "Required. The audio content type.", + "enum": [ + "AUDIO_CONTENT_TYPE_UNSPECIFIED", + "AUDIO_CONTENT_TYPE_UNKNOWN", + "AUDIO_CONTENT_TYPE_MUSIC", + "AUDIO_CONTENT_TYPE_BROADCAST", + "AUDIO_CONTENT_TYPE_PODCAST" + ], + "enumDescriptions": [ + "Audio content type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", + "The audio content type is unknown.", + "The audio content type is music.", + "The audio content type is broadcast.", + "The audio content type is podcast." + ], + "type": "string" + } + }, + "type": "object" + }, + "AudioContentTypeTargetingOptionDetails": { + "description": "Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.", + "id": "AudioContentTypeTargetingOptionDetails", + "properties": { + "audioContentType": { + "description": "Output only. The audio content type.", + "enum": [ + "AUDIO_CONTENT_TYPE_UNSPECIFIED", + "AUDIO_CONTENT_TYPE_UNKNOWN", + "AUDIO_CONTENT_TYPE_MUSIC", + "AUDIO_CONTENT_TYPE_BROADCAST", + "AUDIO_CONTENT_TYPE_PODCAST" + ], + "enumDescriptions": [ + "Audio content type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", + "The audio content type is unknown.", + "The audio content type is music.", + "The audio content type is broadcast.", + "The audio content type is podcast." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AudioVideoOffset": { + "description": "The length an audio or a video has been played.", + "id": "AudioVideoOffset", + "properties": { + "percentage": { + "description": "Optional. The offset in percentage of the audio or video duration.", + "format": "int64", + "type": "string" + }, + "seconds": { + "description": "Optional. The offset in seconds from the start of the audio or video.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AuditAdvertiserResponse": { + "description": "Response message for AdvertiserService.AuditAdvertiser.", + "id": "AuditAdvertiserResponse", + "properties": { + "adGroupCriteriaCount": { + "description": "The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 4500000 ad group targeting options per advertiser. Qualifying Targeting types: * Channels, URLs, apps, and collections * Demographic * Google Audiences, including Affinity, Custom Affinity, and In-market audiences * Inventory source * Keyword * Mobile app category * User lists * Video targeting * Viewability", + "format": "int64", + "type": "string" + }, + "campaignCriteriaCount": { + "description": "The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 900000 campaign targeting options per advertiser. Qualifying Targeting types: * Position * Browser * Connection speed * Day and time * Device and operating system * Digital content label * Sensitive categories * Environment * Geography, including business chains and proximity * ISP * Language * Third-party verification", + "format": "int64", + "type": "string" + }, + "channelsCount": { + "description": "The number of channels created under this advertiser. These channels count towards the limit of 1000 channels per advertiser.", + "format": "int64", + "type": "string" + }, + "negativeKeywordListsCount": { + "description": "The number of negative keyword lists created under this advertiser. These negative keyword lists count towards the limit of 20 negative keyword lists per advertiser.", + "format": "int64", + "type": "string" + }, + "negativelyTargetedChannelsCount": { + "description": "The number of negatively targeted channels created under this advertiser. These negatively targeted channels count towards the limit of 5 negatively targeted channels per advertiser.", + "format": "int64", + "type": "string" + }, + "usedCampaignsCount": { + "description": "The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser.", + "format": "int64", + "type": "string" + }, + "usedInsertionOrdersCount": { + "description": "The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser.", + "format": "int64", + "type": "string" + }, + "usedLineItemsCount": { + "description": "The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AuthorizedSellerStatusAssignedTargetingOptionDetails": { + "description": "Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the \"Authorized Direct Sellers and Resellers\" option.", + "id": "AuthorizedSellerStatusAssignedTargetingOptionDetails", + "properties": { + "authorizedSellerStatus": { + "description": "Output only. The authorized seller status to target.", + "enum": [ + "AUTHORIZED_SELLER_STATUS_UNSPECIFIED", + "AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY", + "AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS" + ], + "enumDescriptions": [ + "Default value when authorized seller status is not specified in this version. This enum is a placeholder for the default value, or \"Authorized Direct Sellers and Resellers\" in the UI.", + "Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file. This value is equivalent to \"Authorized Direct Sellers\" in the UI.", + "All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers. This value is equivalent to \"Authorized and Non-Participating Publishers\" in the UI." + ], + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.", + "type": "string" + } + }, + "type": "object" + }, + "AuthorizedSellerStatusTargetingOptionDetails": { + "description": "Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.", + "id": "AuthorizedSellerStatusTargetingOptionDetails", + "properties": { + "authorizedSellerStatus": { + "description": "Output only. The authorized seller status.", + "enum": [ + "AUTHORIZED_SELLER_STATUS_UNSPECIFIED", + "AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY", + "AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS" + ], + "enumDescriptions": [ + "Default value when authorized seller status is not specified in this version. This enum is a placeholder for the default value, or \"Authorized Direct Sellers and Resellers\" in the UI.", + "Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file. This value is equivalent to \"Authorized Direct Sellers\" in the UI.", + "All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers. This value is equivalent to \"Authorized and Non-Participating Publishers\" in the UI." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BiddingStrategy": { + "description": "Settings that control the bid strategy. Bid strategy determines the bid price.", + "id": "BiddingStrategy", + "properties": { + "fixedBid": { + "$ref": "FixedBidStrategy", + "description": "A strategy that uses a fixed bid price." + }, + "maximizeSpendAutoBid": { + "$ref": "MaximizeSpendBidStrategy", + "description": "A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`." + }, + "performanceGoalAutoBid": { + "$ref": "PerformanceGoalBidStrategy", + "description": "A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity." + }, + "youtubeAndPartnersBid": { + "$ref": "YoutubeAndPartnersBiddingStrategy", + "description": "A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity." + } + }, + "type": "object" + }, + "BrowserAssignedTargetingOptionDetails": { + "description": "Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`.", + "id": "BrowserAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the browser.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.", + "type": "string" + } + }, + "type": "object" + }, + "BrowserTargetingOptionDetails": { + "description": "Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`.", + "id": "BrowserTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the browser.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BudgetSummary": { + "description": "Summarized information of an individual campaign budget.", + "id": "BudgetSummary", + "properties": { + "externalBudgetId": { + "description": "Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty.", + "type": "string" + }, + "preTaxAmountMicros": { + "description": "The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "prismaCpeCode": { + "$ref": "PrismaCpeCode", + "description": "Relevant client, product, and estimate codes from the Mediaocean Prisma tool. Only applicable for campaign budgets with an external_budget_source of EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN." + }, + "taxAmountMicros": { + "description": "The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "totalAmountMicros": { + "description": "The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BulkEditAdvertiserAssignedTargetingOptionsRequest": { + "description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.", + "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", + "properties": { + "createRequests": { + "description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", + "items": { + "$ref": "CreateAssignedTargetingOptionsRequest" + }, + "type": "array" + }, + "deleteRequests": { + "description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", + "items": { + "$ref": "DeleteAssignedTargetingOptionsRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAdvertiserAssignedTargetingOptionsResponse": { + "id": "BulkEditAdvertiserAssignedTargetingOptionsResponse", + "properties": { + "createdAssignedTargetingOptions": { + "description": "The list of assigned targeting options that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedInventorySourcesRequest": { + "description": "Request message for AssignedInventorySourceService.BulkEdit.", + "id": "BulkEditAssignedInventorySourcesRequest", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources.", + "format": "int64", + "type": "string" + }, + "createdAssignedInventorySources": { + "description": "The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources.", + "items": { + "$ref": "AssignedInventorySource" + }, + "type": "array" + }, + "deletedAssignedInventorySources": { + "description": "The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "partnerId": { + "description": "The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BulkEditAssignedInventorySourcesResponse": { + "description": "Response message for AssignedInventorySourceService.BulkEdit.", + "id": "BulkEditAssignedInventorySourcesResponse", + "properties": { + "assignedInventorySources": { + "description": "The list of assigned inventory sources that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "AssignedInventorySource" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedLocationsRequest": { + "description": "Request message for AssignedLocationService.BulkEditAssignedLocations.", + "id": "BulkEditAssignedLocationsRequest", + "properties": { + "createdAssignedLocations": { + "description": "The assigned locations to create in bulk, specified as a list of AssignedLocation resources.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + }, + "deletedAssignedLocations": { + "description": "The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedLocationsResponse": { + "id": "BulkEditAssignedLocationsResponse", + "properties": { + "assignedLocations": { + "description": "The list of assigned locations that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedTargetingOptionsRequest": { + "description": "Request message for BulkEditLineItemsAssignedTargetingOptions.", + "id": "BulkEditAssignedTargetingOptionsRequest", + "properties": { + "createRequests": { + "description": "The assigned targeting options to create in batch, specified as a list of CreateAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "items": { + "$ref": "CreateAssignedTargetingOptionsRequest" + }, + "type": "array" + }, + "deleteRequests": { + "description": "The assigned targeting options to delete in batch, specified as a list of DeleteAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "items": { + "$ref": "DeleteAssignedTargetingOptionsRequest" + }, + "type": "array" + }, + "lineItemIds": { + "description": "Required. The ID of the line items whose targeting is being updated.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedTargetingOptionsResponse": { + "id": "BulkEditAssignedTargetingOptionsResponse", + "properties": { + "errors": { + "description": "The error information for each line item that failed to update.", + "items": { + "$ref": "Status" + }, + "type": "array" + }, + "failedLineItemIds": { + "description": "Output only. The IDs of the line items which failed.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "updatedLineItemIds": { + "description": "Output only. The IDs of the line items which successfully updated.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedUserRolesRequest": { + "description": "Request message for BulkEditAssignedUserRoles.", + "id": "BulkEditAssignedUserRolesRequest", + "properties": { + "createdAssignedUserRoles": { + "description": "The assigned user roles to create in batch, specified as a list of AssignedUserRoles.", + "items": { + "$ref": "AssignedUserRole" + }, + "type": "array" + }, + "deletedAssignedUserRoles": { + "description": "The assigned user roles to delete in batch, specified as a list of assigned_user_role_ids. The format of assigned_user_role_id is `entityType-entityid`, for example `partner-123`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedUserRolesResponse": { + "id": "BulkEditAssignedUserRolesResponse", + "properties": { + "createdAssignedUserRoles": { + "description": "The list of assigned user roles that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "AssignedUserRole" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditNegativeKeywordsRequest": { + "description": "Request message for NegativeKeywordService.BulkEditNegativeKeywords.", + "id": "BulkEditNegativeKeywordsRequest", + "properties": { + "createdNegativeKeywords": { + "description": "The negative keywords to create in batch, specified as a list of NegativeKeywords.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + }, + "deletedNegativeKeywords": { + "description": "The negative keywords to delete in batch, specified as a list of keyword_values.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditNegativeKeywordsResponse": { + "description": "Response message for NegativeKeywordService.BulkEditNegativeKeywords.", + "id": "BulkEditNegativeKeywordsResponse", + "properties": { + "negativeKeywords": { + "description": "The list of negative keywords that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditPartnerAssignedTargetingOptionsRequest": { + "description": "Request message for BulkEditPartnerAssignedTargetingOptions.", + "id": "BulkEditPartnerAssignedTargetingOptionsRequest", + "properties": { + "createRequests": { + "description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "items": { + "$ref": "CreateAssignedTargetingOptionsRequest" + }, + "type": "array" + }, + "deleteRequests": { + "description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "items": { + "$ref": "DeleteAssignedTargetingOptionsRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditPartnerAssignedTargetingOptionsResponse": { + "id": "BulkEditPartnerAssignedTargetingOptionsResponse", + "properties": { + "createdAssignedTargetingOptions": { + "description": "The list of assigned targeting options that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditSitesRequest": { + "description": "Request message for SiteService.BulkEditSites.", + "id": "BulkEditSitesRequest", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "type": "string" + }, + "createdSites": { + "description": "The sites to create in batch, specified as a list of Sites.", + "items": { + "$ref": "Site" + }, + "type": "array" + }, + "deletedSites": { + "description": "The sites to delete in batch, specified as a list of site url_or_app_ids.", + "items": { + "type": "string" + }, + "type": "array" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BulkEditSitesResponse": { + "description": "Response message for SiteService.BulkEditSites.", + "id": "BulkEditSitesResponse", + "properties": { + "sites": { + "description": "The list of sites that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkListAdGroupAssignedTargetingOptionsResponse": { + "id": "BulkListAdGroupAssignedTargetingOptionsResponse", + "properties": { + "adGroupAssignedTargetingOptions": { + "description": "The list of wrapper objects, each providing an assigned targeting option and the ad group it is assigned to. This list will be absent if empty.", + "items": { + "$ref": "AdGroupAssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return.", + "type": "string" + } + }, + "type": "object" + }, + "BulkListAdvertiserAssignedTargetingOptionsResponse": { + "id": "BulkListAdvertiserAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "BulkListAssignedTargetingOptionsResponse": { + "id": "BulkListAssignedTargetingOptionsResponse", + "properties": { + "lineItemAssignedTargetingOptions": { + "description": "The list of wrapper objects, each providing an assigned targeting option and the line item it is assigned to. This list will be absent if empty.", + "items": { + "$ref": "LineItemAssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more line_item_assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "BulkUpdateLineItemsRequest": { + "description": "Request message for LineItemService.BulkUpdateLineItems.", + "id": "BulkUpdateLineItemsRequest", + "properties": { + "lineItemIds": { + "description": "Required. IDs of line items to update.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "targetLineItem": { + "$ref": "LineItem", + "description": "Required. A line item object containing the fields to be updated and the new values to assign to all line items specified in line_item_ids.\"" + }, + "updateMask": { + "description": "Required. A field mask identifying which fields to update. Only the following fields are currently supported: * entityStatus", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "BulkUpdateLineItemsResponse": { + "description": "Response message for LineItemService.BulkUpdateLineItems.", + "id": "BulkUpdateLineItemsResponse", + "properties": { + "errors": { + "description": "Errors returned by line items that failed to update.", + "items": { + "$ref": "Status" + }, + "type": "array" + }, + "failedLineItemIds": { + "description": "The IDs of line items that failed to update.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "skippedLineItemIds": { + "description": "The IDs of line items that are skipped for updates. For example, unnecessary mutates that will result in effectively no changes to line items will be skipped and corresponding line item IDs can be tracked here.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "updatedLineItemIds": { + "description": "The IDs of successfully updated line items.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BumperAd": { + "description": "Details for a bumper ad.", + "id": "BumperAd", + "properties": { + "commonInStreamAttribute": { + "$ref": "CommonInStreamAttribute", + "description": "Common ad attributes." + } + }, + "type": "object" + }, + "BusinessChainAssignedTargetingOptionDetails": { + "description": "Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.", + "id": "BusinessChainAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of a business chain, e.g. \"KFC\", \"Chase Bank\".", + "readOnly": true, + "type": "string" + }, + "proximityRadiusAmount": { + "description": "Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.", + "format": "double", + "type": "number" + }, + "proximityRadiusUnit": { + "description": "Required. The unit of distance by which the targeting radius is measured.", + "enum": [ + "DISTANCE_UNIT_UNSPECIFIED", + "DISTANCE_UNIT_MILES", + "DISTANCE_UNIT_KILOMETERS" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Miles.", + "Kilometers." + ], + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.", + "type": "string" + } + }, + "type": "object" + }, + "BusinessChainSearchTerms": { + "description": "Search terms for Business Chain targeting options. At least one of the field should be populated.", + "id": "BusinessChainSearchTerms", + "properties": { + "businessChainQuery": { + "description": "The search query for the desired business chain. The query must be the full name of the business, e.g. \"KFC\", \"mercedes-benz\".", + "type": "string" + }, + "regionQuery": { + "description": "The search query for the desired geo region, e.g. \"Seattle\", \"United State\".", + "type": "string" + } + }, + "type": "object" + }, + "BusinessChainTargetingOptionDetails": { + "description": "Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.", + "id": "BusinessChainTargetingOptionDetails", + "properties": { + "businessChain": { + "description": "Output only. The display name of the business chain, e.g. \"KFC\", \"Chase Bank\".", + "readOnly": true, + "type": "string" + }, + "geoRegion": { + "description": "Output only. The display name of the geographic region, e.g. \"Ontario, Canada\".", + "readOnly": true, + "type": "string" + }, + "geoRegionType": { + "description": "Output only. The type of the geographic region.", + "enum": [ + "GEO_REGION_TYPE_UNKNOWN", + "GEO_REGION_TYPE_OTHER", + "GEO_REGION_TYPE_COUNTRY", + "GEO_REGION_TYPE_REGION", + "GEO_REGION_TYPE_TERRITORY", + "GEO_REGION_TYPE_PROVINCE", + "GEO_REGION_TYPE_STATE", + "GEO_REGION_TYPE_PREFECTURE", + "GEO_REGION_TYPE_GOVERNORATE", + "GEO_REGION_TYPE_CANTON", + "GEO_REGION_TYPE_UNION_TERRITORY", + "GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY", + "GEO_REGION_TYPE_DMA_REGION", + "GEO_REGION_TYPE_METRO", + "GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT", + "GEO_REGION_TYPE_COUNTY", + "GEO_REGION_TYPE_MUNICIPALITY", + "GEO_REGION_TYPE_CITY", + "GEO_REGION_TYPE_POSTAL_CODE", + "GEO_REGION_TYPE_DEPARTMENT", + "GEO_REGION_TYPE_AIRPORT", + "GEO_REGION_TYPE_TV_REGION", + "GEO_REGION_TYPE_OKRUG", + "GEO_REGION_TYPE_BOROUGH", + "GEO_REGION_TYPE_CITY_REGION", + "GEO_REGION_TYPE_ARRONDISSEMENT", + "GEO_REGION_TYPE_NEIGHBORHOOD", + "GEO_REGION_TYPE_UNIVERSITY", + "GEO_REGION_TYPE_DISTRICT", + "GEO_REGION_TYPE_NATIONAL_PARK", + "GEO_REGION_TYPE_BARRIO", + "GEO_REGION_TYPE_SUB_WARD", + "GEO_REGION_TYPE_MUNICIPALITY_DISTRICT", + "GEO_REGION_TYPE_SUB_DISTRICT", + "GEO_REGION_TYPE_QUARTER", + "GEO_REGION_TYPE_DIVISION", + "GEO_REGION_TYPE_COMMUNE", + "GEO_REGION_TYPE_COLLOQUIAL_AREA" + ], + "enumDescriptions": [ + "The geographic region type is unknown.", + "The geographic region type is other.", + "The geographic region is a country.", + "The geographic region type is region.", + "The geographic region is a territory.", + "The geographic region is a province.", + "The geographic region is a state.", + "The geographic region is a prefecture.", + "The geographic region is a governorate.", + "The geographic region is a canton.", + "The geographic region is a union territory.", + "The geographic region is an autonomous community.", + "The geographic region is a designated market area (DMA) region.", + "The geographic region type is metro.", + "The geographic region is a congressional district.", + "The geographic region is a county.", + "The geographic region is a municipality.", + "The geographic region is a city.", + "The geographic region targeting type is postal code.", + "The geographic region targeting type is department.", + "The geographic region is an airport.", + "The geographic region is a TV region.", + "The geographic region is an okrug.", + "The geographic region is a borough.", + "The geographic region is a city region.", + "The geographic region is an arrondissement.", + "The geographic region is a neighborhood.", + "The geographic region is a university.", + "The geographic region is a district.", + "The geographic region is a national park.", + "The geographic region is a barrio.", + "The geographic region is a sub ward.", + "The geographic region is a municipality district.", + "The geographic region is a sub district.", + "The geographic region is a quarter.", + "The geographic region is a division.", + "The geographic region is a commune.", + "The geographic region is a colloquial area." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Campaign": { + "description": "A single campaign.", + "id": "Campaign", + "properties": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the campaign belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "campaignBudgets": { + "description": "The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.", + "items": { + "$ref": "CampaignBudget" + }, + "type": "array" + }, + "campaignFlight": { + "$ref": "CampaignFlight", + "description": "Required. The planned spend and duration of the campaign." + }, + "campaignGoal": { + "$ref": "CampaignGoal", + "description": "Required. The goal of the campaign." + }, + "campaignId": { + "description": "Output only. The unique ID of the campaign. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "frequencyCap": { + "$ref": "FrequencyCap", + "description": "Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)" + }, + "name": { + "description": "Output only. The resource name of the campaign.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the campaign was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CampaignBudget": { + "description": "Settings that control how the campaign budget is allocated.", + "id": "CampaignBudget", + "properties": { + "budgetAmountMicros": { + "description": "Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "budgetId": { + "description": "The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.", + "format": "int64", + "type": "string" + }, + "budgetUnit": { + "description": "Required. Immutable. Specifies whether the budget is measured in currency or impressions.", + "enum": [ + "BUDGET_UNIT_UNSPECIFIED", + "BUDGET_UNIT_CURRENCY", + "BUDGET_UNIT_IMPRESSIONS" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Budgeting in currency amounts.", + "Budgeting in impression amounts." + ], + "type": "string" + }, + "dateRange": { + "$ref": "DateRange", + "description": "Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037." + }, + "displayName": { + "description": "Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "externalBudgetId": { + "description": "Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to \"Budget level PO\", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.", + "type": "string" + }, + "externalBudgetSource": { + "description": "Required. The external source of the budget.", + "enum": [ + "EXTERNAL_BUDGET_SOURCE_UNSPECIFIED", + "EXTERNAL_BUDGET_SOURCE_NONE", + "EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN" + ], + "enumDescriptions": [ + "External budget source value is not specified or unknown in this version.", + "Budget has no external source.", + "Budget source is Mediaocean." + ], + "type": "string" + }, + "invoiceGroupingId": { + "description": "Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to \"Budget invoice grouping ID\", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.", + "type": "string" + }, + "prismaConfig": { + "$ref": "PrismaConfig", + "description": "Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers." + } + }, + "type": "object" + }, + "CampaignFlight": { + "description": "Settings that track the planned spend and duration of a campaign.", + "id": "CampaignFlight", + "properties": { + "plannedDates": { + "$ref": "DateRange", + "description": "Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037." + }, + "plannedSpendAmountMicros": { + "description": "The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CampaignGoal": { + "description": "Settings that control the goal of a campaign.", + "id": "CampaignGoal", + "properties": { + "campaignGoalType": { + "description": "Required. The type of the campaign goal.", + "enum": [ + "CAMPAIGN_GOAL_TYPE_UNSPECIFIED", + "CAMPAIGN_GOAL_TYPE_APP_INSTALL", + "CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS", + "CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION", + "CAMPAIGN_GOAL_TYPE_ONLINE_ACTION" + ], + "enumDescriptions": [ + "Goal value is not specified or unknown in this version.", + "Drive app installs or engagements.", + "Raise awareness of a brand or product.", + "Drive offline or in-store sales.", + "Drive online action or visits." + ], + "type": "string" + }, + "performanceGoal": { + "$ref": "PerformanceGoal", + "description": "Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER`" + } + }, + "type": "object" + }, + "CarrierAndIspAssignedTargetingOptionDetails": { + "description": "Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.", + "id": "CarrierAndIspAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the carrier or ISP.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.", + "type": "string" + } + }, + "type": "object" + }, + "CarrierAndIspTargetingOptionDetails": { + "description": "Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.", + "id": "CarrierAndIspTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the carrier or ISP.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type indicating if it's carrier or ISP.", + "enum": [ + "CARRIER_AND_ISP_TYPE_UNSPECIFIED", + "CARRIER_AND_ISP_TYPE_ISP", + "CARRIER_AND_ISP_TYPE_CARRIER" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Indicates this targeting resource refers to an ISP.", + "Indicates this targeting resource refers to a mobile carrier." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CategoryAssignedTargetingOptionDetails": { + "description": "Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`.", + "id": "CategoryAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the category.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.", + "type": "string" + } + }, + "type": "object" + }, + "CategoryTargetingOptionDetails": { + "description": "Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`.", + "id": "CategoryTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the category.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Channel": { + "description": "A single channel. Channels are custom groups of related websites and apps.", + "id": "Channel", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that owns the channel.", + "format": "int64", + "type": "string" + }, + "channelId": { + "description": "Output only. The unique ID of the channel. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the channel.", + "readOnly": true, + "type": "string" + }, + "negativelyTargetedLineItemCount": { + "description": "Output only. Number of line items that are directly targeting this channel negatively.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the channel.", + "format": "int64", + "type": "string" + }, + "positivelyTargetedLineItemCount": { + "description": "Output only. Number of line items that are directly targeting this channel positively.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ChannelAssignedTargetingOptionDetails": { + "description": "Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`.", + "id": "ChannelAssignedTargetingOptionDetails", + "properties": { + "channelId": { + "description": "Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.", + "format": "int64", + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.", + "type": "boolean" + } + }, + "type": "object" + }, + "CmHybridConfig": { + "description": "Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.", + "id": "CmHybridConfig", + "properties": { + "cmAccountId": { + "description": "Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.", + "format": "int64", + "type": "string" + }, + "cmAdvertiserIds": { + "description": "Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "cmFloodlightConfigId": { + "description": "Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.", + "format": "int64", + "type": "string" + }, + "cmFloodlightLinkingAuthorized": { + "description": "Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.", + "type": "boolean" + }, + "cmSyncableSiteIds": { + "description": "A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "dv360ToCmCostReportingEnabled": { + "description": "Whether or not to report DV360 cost to CM360.", + "type": "boolean" + }, + "dv360ToCmDataSharingEnabled": { + "description": "Whether or not to include DV360 data in CM360 data transfer reports.", + "type": "boolean" + } + }, + "type": "object" + }, + "CmTrackingAd": { + "description": "A Campaign Manager 360 tracking ad.", + "id": "CmTrackingAd", + "properties": { + "cmAdId": { + "description": "Optional. The ad ID of the campaign manager 360 tracking Ad.", + "format": "int64", + "type": "string" + }, + "cmCreativeId": { + "description": "Optional. The creative ID of the campaign manager 360 tracking Ad.", + "format": "int64", + "type": "string" + }, + "cmPlacementId": { + "description": "Optional. The placement ID of the campaign manager 360 tracking Ad.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CombinedAudience": { + "description": "Describes a combined audience resource.", + "id": "CombinedAudience", + "properties": { + "combinedAudienceId": { + "description": "Output only. The unique ID of the combined audience. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the combined audience. .", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the combined audience.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CombinedAudienceGroup": { + "description": "Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other.", + "id": "CombinedAudienceGroup", + "properties": { + "settings": { + "description": "Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.", + "items": { + "$ref": "CombinedAudienceTargetingSetting" + }, + "type": "array" + } + }, + "type": "object" + }, + "CombinedAudienceTargetingSetting": { + "description": "Details of combined audience targeting setting.", + "id": "CombinedAudienceTargetingSetting", + "properties": { + "combinedAudienceId": { + "description": "Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CommonInStreamAttribute": { + "description": "Common attributes for in-stream, non-skippable and bumper ads.", + "id": "CommonInStreamAttribute", + "properties": { + "actionButtonLabel": { + "description": "The text on the call-to-action button.", + "type": "string" + }, + "actionHeadline": { + "description": "The headline of the call-to-action banner.", + "type": "string" + }, + "companionBanner": { + "$ref": "ImageAsset", + "description": "The image which shows next to the video ad." + }, + "displayUrl": { + "description": "The webpage address that appears with the ad.", + "type": "string" + }, + "finalUrl": { + "description": "The URL address of the webpage that people reach after they click the ad.", + "type": "string" + }, + "trackingUrl": { + "description": "The URL address loaded in the background for tracking purposes.", + "type": "string" + }, + "video": { + "$ref": "YoutubeVideoDetails", + "description": "The YouTube video of the ad." + } + }, + "type": "object" + }, + "Consent": { + "description": "User consent status.", + "id": "Consent", + "properties": { + "adPersonalization": { + "description": "Represents consent for ad personalization.", + "enum": [ + "CONSENT_STATUS_UNSPECIFIED", + "CONSENT_STATUS_GRANTED", + "CONSENT_STATUS_DENIED" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Consent is granted.", + "Consent is denied." + ], + "type": "string" + }, + "adUserData": { + "description": "Represents consent for ad user data.", + "enum": [ + "CONSENT_STATUS_UNSPECIFIED", + "CONSENT_STATUS_GRANTED", + "CONSENT_STATUS_DENIED" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Consent is granted.", + "Consent is denied." + ], + "type": "string" + } + }, + "type": "object" + }, + "ContactInfo": { + "description": "Contact information defining a Customer Match audience member.", + "id": "ContactInfo", + "properties": { + "countryCode": { + "description": "Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes", + "type": "string" + }, + "hashedEmails": { + "description": "A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.", + "items": { + "type": "string" + }, + "type": "array" + }, + "hashedFirstName": { + "description": "SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes", + "type": "string" + }, + "hashedLastName": { + "description": "SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes", + "type": "string" + }, + "hashedPhoneNumbers": { + "description": "A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.", + "items": { + "type": "string" + }, + "type": "array" + }, + "zipCodes": { + "description": "A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ContactInfoList": { + "description": "Wrapper message for a list of contact information defining Customer Match audience members.", + "id": "ContactInfoList", + "properties": { + "consent": { + "$ref": "Consent", + "description": "Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error." + }, + "contactInfos": { + "description": "A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.", + "items": { + "$ref": "ContactInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "ContentDurationAssignedTargetingOptionDetails": { + "description": "Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect.", + "id": "ContentDurationAssignedTargetingOptionDetails", + "properties": { + "contentDuration": { + "description": "Output only. The content duration.", + "enum": [ + "CONTENT_DURATION_UNSPECIFIED", + "CONTENT_DURATION_UNKNOWN", + "CONTENT_DURATION_0_TO_1_MIN", + "CONTENT_DURATION_1_TO_5_MIN", + "CONTENT_DURATION_5_TO_15_MIN", + "CONTENT_DURATION_15_TO_30_MIN", + "CONTENT_DURATION_30_TO_60_MIN", + "CONTENT_DURATION_OVER_60_MIN" + ], + "enumDescriptions": [ + "Content duration is not specified in this version. This enum is a place holder for a default value and does not represent a real content duration.", + "The content duration is unknown.", + "Content is 0-1 minute long.", + "Content is 1-5 minutes long.", + "Content is 5-15 minutes long.", + "Content is 15-30 minutes long.", + "Content is 30-60 minutes long.", + "Content is over 60 minutes long." + ], + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.", + "type": "string" + } + }, + "type": "object" + }, + "ContentDurationTargetingOptionDetails": { + "description": "Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.", + "id": "ContentDurationTargetingOptionDetails", + "properties": { + "contentDuration": { + "description": "Output only. The content duration.", + "enum": [ + "CONTENT_DURATION_UNSPECIFIED", + "CONTENT_DURATION_UNKNOWN", + "CONTENT_DURATION_0_TO_1_MIN", + "CONTENT_DURATION_1_TO_5_MIN", + "CONTENT_DURATION_5_TO_15_MIN", + "CONTENT_DURATION_15_TO_30_MIN", + "CONTENT_DURATION_30_TO_60_MIN", + "CONTENT_DURATION_OVER_60_MIN" + ], + "enumDescriptions": [ + "Content duration is not specified in this version. This enum is a place holder for a default value and does not represent a real content duration.", + "The content duration is unknown.", + "Content is 0-1 minute long.", + "Content is 1-5 minutes long.", + "Content is 5-15 minutes long.", + "Content is 15-30 minutes long.", + "Content is 30-60 minutes long.", + "Content is over 60 minutes long." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ContentGenreAssignedTargetingOptionDetails": { + "description": "Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect.", + "id": "ContentGenreAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the content genre.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.", + "type": "string" + } + }, + "type": "object" + }, + "ContentGenreTargetingOptionDetails": { + "description": "Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.", + "id": "ContentGenreTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the content genre", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ContentInstreamPositionAssignedTargetingOptionDetails": { + "description": "Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.", + "id": "ContentInstreamPositionAssignedTargetingOptionDetails", + "properties": { + "adType": { + "description": "Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.", + "enum": [ + "AD_TYPE_UNSPECIFIED", + "AD_TYPE_DISPLAY", + "AD_TYPE_VIDEO", + "AD_TYPE_AUDIO" + ], + "enumDescriptions": [ + "Ad type is not specified or is unknown in this version.", + "Display creatives, e.g. image and HTML5.", + "Video creatives, e.g. video ads that play during streaming content in video players.", + "Audio creatives, e.g. audio ads that play during audio content." + ], + "readOnly": true, + "type": "string" + }, + "contentInstreamPosition": { + "description": "Required. The content instream position for video or audio ads.", + "enum": [ + "CONTENT_INSTREAM_POSITION_UNSPECIFIED", + "CONTENT_INSTREAM_POSITION_PRE_ROLL", + "CONTENT_INSTREAM_POSITION_MID_ROLL", + "CONTENT_INSTREAM_POSITION_POST_ROLL", + "CONTENT_INSTREAM_POSITION_UNKNOWN" + ], + "enumDescriptions": [ + "Content instream position is not specified in this version. This enum is a place holder for a default value and does not represent a real in stream ad position.", + "Ads that play before streaming content.", + "Ads that play between the beginning and end of streaming content.", + "Ads that play at the end of streaming content.", + "Ads instream position is unknown." + ], + "type": "string" + } + }, + "type": "object" + }, + "ContentInstreamPositionTargetingOptionDetails": { + "description": "Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.", + "id": "ContentInstreamPositionTargetingOptionDetails", + "properties": { + "contentInstreamPosition": { + "description": "Output only. The content instream position.", + "enum": [ + "CONTENT_INSTREAM_POSITION_UNSPECIFIED", + "CONTENT_INSTREAM_POSITION_PRE_ROLL", + "CONTENT_INSTREAM_POSITION_MID_ROLL", + "CONTENT_INSTREAM_POSITION_POST_ROLL", + "CONTENT_INSTREAM_POSITION_UNKNOWN" + ], + "enumDescriptions": [ + "Content instream position is not specified in this version. This enum is a place holder for a default value and does not represent a real in stream ad position.", + "Ads that play before streaming content.", + "Ads that play between the beginning and end of streaming content.", + "Ads that play at the end of streaming content.", + "Ads instream position is unknown." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ContentOutstreamPositionAssignedTargetingOptionDetails": { + "description": "Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.", + "id": "ContentOutstreamPositionAssignedTargetingOptionDetails", + "properties": { + "adType": { + "description": "Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.", + "enum": [ + "AD_TYPE_UNSPECIFIED", + "AD_TYPE_DISPLAY", + "AD_TYPE_VIDEO", + "AD_TYPE_AUDIO" + ], + "enumDescriptions": [ + "Ad type is not specified or is unknown in this version.", + "Display creatives, e.g. image and HTML5.", + "Video creatives, e.g. video ads that play during streaming content in video players.", + "Audio creatives, e.g. audio ads that play during audio content." + ], + "readOnly": true, + "type": "string" + }, + "contentOutstreamPosition": { + "description": "Required. The content outstream position.", + "enum": [ + "CONTENT_OUTSTREAM_POSITION_UNSPECIFIED", + "CONTENT_OUTSTREAM_POSITION_UNKNOWN", + "CONTENT_OUTSTREAM_POSITION_IN_ARTICLE", + "CONTENT_OUTSTREAM_POSITION_IN_BANNER", + "CONTENT_OUTSTREAM_POSITION_IN_FEED", + "CONTENT_OUTSTREAM_POSITION_INTERSTITIAL" + ], + "enumDescriptions": [ + "Content outstream position is not specified in this version. This enum is a place holder for a default value and does not represent a real content outstream position.", + "The ad position is unknown in the content outstream.", + "Ads that appear between the paragraphs of your pages.", + "Ads that display on the top and the sides of a page.", + "Ads that appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", + "Ads shown before or between content loads." + ], + "type": "string" + } + }, + "type": "object" + }, + "ContentOutstreamPositionTargetingOptionDetails": { + "description": "Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.", + "id": "ContentOutstreamPositionTargetingOptionDetails", + "properties": { + "contentOutstreamPosition": { + "description": "Output only. The content outstream position.", + "enum": [ + "CONTENT_OUTSTREAM_POSITION_UNSPECIFIED", + "CONTENT_OUTSTREAM_POSITION_UNKNOWN", + "CONTENT_OUTSTREAM_POSITION_IN_ARTICLE", + "CONTENT_OUTSTREAM_POSITION_IN_BANNER", + "CONTENT_OUTSTREAM_POSITION_IN_FEED", + "CONTENT_OUTSTREAM_POSITION_INTERSTITIAL" + ], + "enumDescriptions": [ + "Content outstream position is not specified in this version. This enum is a place holder for a default value and does not represent a real content outstream position.", + "The ad position is unknown in the content outstream.", + "Ads that appear between the paragraphs of your pages.", + "Ads that display on the top and the sides of a page.", + "Ads that appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", + "Ads shown before or between content loads." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ContentStreamTypeAssignedTargetingOptionDetails": { + "description": "Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect.", + "id": "ContentStreamTypeAssignedTargetingOptionDetails", + "properties": { + "contentStreamType": { + "description": "Output only. The content stream type.", + "enum": [ + "CONTENT_STREAM_TYPE_UNSPECIFIED", + "CONTENT_LIVE_STREAM", + "CONTENT_ON_DEMAND" + ], + "enumDescriptions": [ + "Content stream type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", + "The content is being live-streamed.", + "The content is viewed on-demand." + ], + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.", + "type": "string" + } + }, + "type": "object" + }, + "ContentStreamTypeTargetingOptionDetails": { + "description": "Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.", + "id": "ContentStreamTypeTargetingOptionDetails", + "properties": { + "contentStreamType": { + "description": "Output only. The content stream type.", + "enum": [ + "CONTENT_STREAM_TYPE_UNSPECIFIED", + "CONTENT_LIVE_STREAM", + "CONTENT_ON_DEMAND" + ], + "enumDescriptions": [ + "Content stream type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", + "The content is being live-streamed.", + "The content is viewed on-demand." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ConversionCountingConfig": { + "description": "Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting.", + "id": "ConversionCountingConfig", + "properties": { + "floodlightActivityConfigs": { + "description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", + "items": { + "$ref": "TrackingFloodlightActivityConfig" + }, + "type": "array" + }, + "postViewCountPercentageMillis": { + "description": "The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CounterEvent": { + "description": "Counter event of the creative.", + "id": "CounterEvent", + "properties": { + "name": { + "description": "Required. The name of the counter event.", + "type": "string" + }, + "reportingName": { + "description": "Required. The name used to identify this counter event in reports.", + "type": "string" + } + }, + "type": "object" + }, + "CreateAssetRequest": { + "description": "A request message for CreateAsset.", + "id": "CreateAssetRequest", + "properties": { + "filename": { + "description": "Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "CreateAssetResponse": { + "description": "A response message for CreateAsset.", + "id": "CreateAssetResponse", + "properties": { + "asset": { + "$ref": "Asset", + "description": "The uploaded asset, if successful." + } + }, + "type": "object" + }, + "CreateAssignedTargetingOptionsRequest": { + "description": "A request listing which assigned targeting options of a given targeting type should be created and added.", + "id": "CreateAssignedTargetingOptionsRequest", + "properties": { + "assignedTargetingOptions": { + "description": "Required. The assigned targeting options to create and add.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option.", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "type": "string" + } + }, + "type": "object" + }, + "CreateSdfDownloadTaskRequest": { + "description": "Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].", + "id": "CreateSdfDownloadTaskRequest", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser to download SDF for.", + "format": "int64", + "type": "string" + }, + "idFilter": { + "$ref": "IdFilter", + "description": "Filters on entities by their entity IDs." + }, + "inventorySourceFilter": { + "$ref": "InventorySourceFilter", + "description": "Filters on Inventory Sources by their IDs." + }, + "parentEntityFilter": { + "$ref": "ParentEntityFilter", + "description": "Filters on selected file types. The entities in each file are filtered by a chosen set of filter entities. The filter entities must be the same type as, or a parent type of, the selected file types." + }, + "partnerId": { + "description": "The ID of the partner to download SDF for.", + "format": "int64", + "type": "string" + }, + "version": { + "description": "Required. The SDF version of the downloaded file. If set to `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the advertiser or partner identified by `root_id`. An advertiser inherits its SDF version from its partner unless configured otherwise.", + "enum": [ + "SDF_VERSION_UNSPECIFIED", + "SDF_VERSION_3_1", + "SDF_VERSION_4", + "SDF_VERSION_4_1", + "SDF_VERSION_4_2", + "SDF_VERSION_5", + "SDF_VERSION_5_1", + "SDF_VERSION_5_2", + "SDF_VERSION_5_3", + "SDF_VERSION_5_4", + "SDF_VERSION_5_5", + "SDF_VERSION_6", + "SDF_VERSION_7", + "SDF_VERSION_7_1", + "SDF_VERSION_8" + ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "SDF version value is not specified or is unknown in this version.", + "SDF version 3.1", + "SDF version 4", + "SDF version 4.1", + "SDF version 4.2", + "SDF version 5.", + "SDF version 5.1", + "SDF version 5.2", + "SDF version 5.3", + "SDF version 5.4", + "SDF version 5.5", + "SDF version 6", + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", + "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version." + ], + "type": "string" + } + }, + "type": "object" + }, + "Creative": { + "description": "A single Creative.", + "id": "Creative", + "properties": { + "additionalDimensions": { + "description": "Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", + "items": { + "$ref": "Dimensions" + }, + "type": "array" + }, + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the creative belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "appendedTag": { + "description": "Optional. Third-party HTML tracking tag to be appended to the creative tag.", + "type": "string" + }, + "assets": { + "description": "Required. Assets associated to this creative.", + "items": { + "$ref": "AssetAssociation" + }, + "type": "array" + }, + "cmPlacementId": { + "description": "Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "cmTrackingAd": { + "$ref": "CmTrackingAd", + "description": "Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." + }, + "companionCreativeIds": { + "description": "Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "counterEvents": { + "description": "Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.", + "items": { + "$ref": "CounterEvent" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The timestamp when the creative was created. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creativeAttributes": { + "description": "Output only. A list of attributes of the creative that is generated by the system.", + "items": { + "enum": [ + "CREATIVE_ATTRIBUTE_UNSPECIFIED", + "CREATIVE_ATTRIBUTE_VAST", + "CREATIVE_ATTRIBUTE_VPAID_LINEAR", + "CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR" + ], + "enumDescriptions": [ + "The creative attribute is not specified or is unknown in this version.", + "The creative is a VAST creative.", + "The creative is a linear VPAID creative.", + "The creative is a non-linear VPAID creative." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "creativeId": { + "description": "Output only. The unique ID of the creative. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "creativeType": { + "description": "Required. Immutable. The type of the creative.", + "enum": [ + "CREATIVE_TYPE_UNSPECIFIED", + "CREATIVE_TYPE_STANDARD", + "CREATIVE_TYPE_EXPANDABLE", + "CREATIVE_TYPE_VIDEO", + "CREATIVE_TYPE_NATIVE", + "CREATIVE_TYPE_TEMPLATED_APP_INSTALL", + "CREATIVE_TYPE_NATIVE_SITE_SQUARE", + "CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL", + "CREATIVE_TYPE_LIGHTBOX", + "CREATIVE_TYPE_NATIVE_APP_INSTALL", + "CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE", + "CREATIVE_TYPE_AUDIO", + "CREATIVE_TYPE_PUBLISHER_HOSTED", + "CREATIVE_TYPE_NATIVE_VIDEO", + "CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO", + "CREATIVE_TYPE_ASSET_BASED_CREATIVE" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Standard display creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", + "Expandable creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_THIRD_PARTY`", + "Video creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", + "Native creative rendered by publishers with assets from advertiser. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Templated app install mobile creative (banner). Create and update methods are **not** supported for this creative type.", + "Square native creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Interstitial creative including both display and video. Create and update methods are **not** supported for this creative type.", + "Responsive and expandable Lightbox creative. Create and update methods are **not** supported for this creative type.", + "Native app install creative. Create and update methods are **not** supported for this creative type.", + "Square native app install creative. Create and update methods are **not** supported for this creative type.", + "Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", + "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", + "Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." + ], + "type": "string" + }, + "dimensions": { + "$ref": "Dimensions", + "description": "Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`" + }, + "displayName": { + "description": "Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "dynamic": { + "description": "Output only. Indicates whether the creative is dynamic.", + "readOnly": true, + "type": "boolean" + }, + "entityStatus": { + "description": "Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "exitEvents": { + "description": "Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called \"clickTag\". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.", + "items": { + "$ref": "ExitEvent" + }, + "type": "array" + }, + "expandOnHover": { + "description": "Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`", + "type": "boolean" + }, + "expandingDirection": { + "description": "Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`", + "enum": [ + "EXPANDING_DIRECTION_UNSPECIFIED", + "EXPANDING_DIRECTION_NONE", + "EXPANDING_DIRECTION_UP", + "EXPANDING_DIRECTION_DOWN", + "EXPANDING_DIRECTION_LEFT", + "EXPANDING_DIRECTION_RIGHT", + "EXPANDING_DIRECTION_UP_AND_LEFT", + "EXPANDING_DIRECTION_UP_AND_RIGHT", + "EXPANDING_DIRECTION_DOWN_AND_LEFT", + "EXPANDING_DIRECTION_DOWN_AND_RIGHT", + "EXPANDING_DIRECTION_UP_OR_DOWN", + "EXPANDING_DIRECTION_LEFT_OR_RIGHT", + "EXPANDING_DIRECTION_ANY_DIAGONAL" + ], + "enumDescriptions": [ + "The expanding direction is not specified.", + "Does not expand in any direction.", + "Expands up.", + "Expands down.", + "Expands left.", + "Expands right.", + "Expands up and to the left side.", + "Expands up and to the right side.", + "Expands down and to the left side.", + "Expands down and to the right side.", + "Expands either up or down.", + "Expands to either the left or the right side.", + "Can expand in any diagonal direction." + ], + "type": "string" + }, + "hostingSource": { + "description": "Required. Indicates where the creative is hosted.", + "enum": [ + "HOSTING_SOURCE_UNSPECIFIED", + "HOSTING_SOURCE_CM", + "HOSTING_SOURCE_THIRD_PARTY", + "HOSTING_SOURCE_HOSTED", + "HOSTING_SOURCE_RICH_MEDIA" + ], + "enumDescriptions": [ + "Hosting source is not specified or is unknown in this version.", + "A creative synced from Campaign Manager 360. Create and update methods are **not** supported for this hosting type.", + "A creative hosted by a third-party ad server (3PAS). Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", + "A creative created in DV360 and hosted by Campaign Manager 360. Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", + "A rich media creative created in Studio and hosted by Campaign Manager 360. Create and update methods are **not** supported for this hosting type." + ], + "type": "string" + }, + "html5Video": { + "description": "Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`", + "readOnly": true, + "type": "boolean" + }, + "iasCampaignMonitoring": { + "description": "Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.", + "type": "boolean" + }, + "integrationCode": { + "description": "Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.", + "type": "string" + }, + "jsTrackerUrl": { + "description": "Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "type": "string" + }, + "lineItemIds": { + "description": "Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "mediaDuration": { + "description": "Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "mp3Audio": { + "description": "Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "Output only. The resource name of the creative.", + "readOnly": true, + "type": "string" + }, + "notes": { + "description": "Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.", + "type": "string" + }, + "obaIcon": { + "$ref": "ObaIcon", + "description": "Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`" + }, + "oggAudio": { + "description": "Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", + "readOnly": true, + "type": "boolean" + }, + "progressOffset": { + "$ref": "AudioVideoOffset", + "description": "Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" + }, + "requireHtml5": { + "description": "Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", + "type": "boolean" + }, + "requireMraid": { + "description": "Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", + "type": "boolean" + }, + "requirePingForAttribution": { + "description": "Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", + "type": "boolean" + }, + "reviewStatus": { + "$ref": "ReviewStatusInfo", + "description": "Output only. The current status of the creative review process.", + "readOnly": true + }, + "skipOffset": { + "$ref": "AudioVideoOffset", + "description": "Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" + }, + "skippable": { + "description": "Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`", + "type": "boolean" + }, + "thirdPartyTag": { + "description": "Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`", + "type": "string" + }, + "thirdPartyUrls": { + "description": "Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "items": { + "$ref": "ThirdPartyUrl" + }, + "type": "array" + }, + "timerEvents": { + "description": "Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.", + "items": { + "$ref": "TimerEvent" + }, + "type": "array" + }, + "trackerUrls": { + "description": "Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "items": { + "type": "string" + }, + "type": "array" + }, + "transcodes": { + "description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`", + "items": { + "$ref": "Transcode" + }, + "readOnly": true, + "type": "array" + }, + "universalAdId": { + "$ref": "UniversalAdId", + "description": "Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`" + }, + "updateTime": { + "description": "Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vastTagUrl": { + "description": "Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", + "type": "string" + }, + "vpaid": { + "description": "Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "CreativeConfig": { + "description": "Creative requirements configuration for the inventory source.", + "id": "CreativeConfig", + "properties": { + "creativeType": { + "description": "The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", + "enum": [ + "CREATIVE_TYPE_UNSPECIFIED", + "CREATIVE_TYPE_STANDARD", + "CREATIVE_TYPE_EXPANDABLE", + "CREATIVE_TYPE_VIDEO", + "CREATIVE_TYPE_NATIVE", + "CREATIVE_TYPE_TEMPLATED_APP_INSTALL", + "CREATIVE_TYPE_NATIVE_SITE_SQUARE", + "CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL", + "CREATIVE_TYPE_LIGHTBOX", + "CREATIVE_TYPE_NATIVE_APP_INSTALL", + "CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE", + "CREATIVE_TYPE_AUDIO", + "CREATIVE_TYPE_PUBLISHER_HOSTED", + "CREATIVE_TYPE_NATIVE_VIDEO", + "CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO", + "CREATIVE_TYPE_ASSET_BASED_CREATIVE" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Standard display creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", + "Expandable creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_THIRD_PARTY`", + "Video creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", + "Native creative rendered by publishers with assets from advertiser. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Templated app install mobile creative (banner). Create and update methods are **not** supported for this creative type.", + "Square native creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Interstitial creative including both display and video. Create and update methods are **not** supported for this creative type.", + "Responsive and expandable Lightbox creative. Create and update methods are **not** supported for this creative type.", + "Native app install creative. Create and update methods are **not** supported for this creative type.", + "Square native app install creative. Create and update methods are **not** supported for this creative type.", + "Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", + "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", + "Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." + ], + "type": "string" + }, + "displayCreativeConfig": { + "$ref": "InventorySourceDisplayCreativeConfig", + "description": "The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`." + }, + "videoCreativeConfig": { + "$ref": "InventorySourceVideoCreativeConfig", + "description": "The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`." + } + }, + "type": "object" + }, + "CustomBiddingAlgorithm": { + "description": "A single custom bidding algorithm.", + "id": "CustomBiddingAlgorithm", + "properties": { + "advertiserId": { + "description": "Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.", + "format": "int64", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Output only. The unique ID of the custom bidding algorithm. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "customBiddingAlgorithmType": { + "description": "Required. Immutable. The type of custom bidding algorithm.", + "enum": [ + "CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED", + "SCRIPT_BASED", + "RULE_BASED" + ], + "enumDescriptions": [ + "Algorithm type is not specified or is unknown in this version.", + "Algorithm generated through customer-uploaded custom bidding script files.", + "Algorithm based in defined rules. These rules are defined in the API using the AlgorithmRules object. This algorithm type is only available to allowlisted customers. Other customers attempting to use this type will receive an error." + ], + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "modelDetails": { + "description": "Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).", + "items": { + "$ref": "CustomBiddingModelDetails" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The resource name of the custom bidding algorithm.", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "Immutable. The unique ID of the partner that owns the custom bidding algorithm.", + "format": "int64", + "type": "string" + }, + "sharedAdvertiserIds": { + "description": "The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomBiddingAlgorithmRules": { + "description": "A single custom bidding algorithm rules.", + "id": "CustomBiddingAlgorithmRules", + "properties": { + "active": { + "description": "Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. The time when the rules resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "customBiddingAlgorithmRulesId": { + "description": "Output only. The unique ID of the rules resource.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "CustomBiddingAlgorithmRulesError", + "description": "Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.", + "readOnly": true + }, + "name": { + "description": "Output only. The resource name of the rules resource.", + "readOnly": true, + "type": "string" + }, + "rules": { + "$ref": "CustomBiddingAlgorithmRulesRef", + "description": "Required. Immutable. The reference to the uploaded AlgorithmRules file." + }, + "state": { + "description": "Output only. The state of the rules resource.", + "enum": [ + "STATE_UNSPECIFIED", + "ACCEPTED", + "REJECTED" + ], + "enumDescriptions": [ + "The rules state are unspecified or unknown in this version.", + "The rules have been accepted for scoring impressions.", + "The rules have been rejected by backend pipelines. They may have errors." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingAlgorithmRulesError": { + "description": "An error message for a CustomBiddingAlgorithmRules resource.", + "id": "CustomBiddingAlgorithmRulesError", + "properties": { + "errorCode": { + "description": "The type of error.", + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "SYNTAX_ERROR", + "CONSTRAINT_VIOLATION_ERROR", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "The error is not specified or is unknown in this version.", + "The rules have a syntax error.", + "The rules have a constraint violation error.", + "Internal errors were thrown while processing the rules." + ], + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingAlgorithmRulesRef": { + "description": "The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules.", + "id": "CustomBiddingAlgorithmRulesRef", + "properties": { + "resourceName": { + "description": "A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.", + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingModelDetails": { + "description": "The details of a custom bidding algorithm model for a single shared advertiser.", + "id": "CustomBiddingModelDetails", + "properties": { + "advertiserId": { + "description": "The unique ID of the relevant advertiser.", + "format": "int64", + "type": "string" + }, + "readinessState": { + "description": "The readiness state of custom bidding model.", + "enum": [ + "READINESS_STATE_UNSPECIFIED", + "READINESS_STATE_ACTIVE", + "READINESS_STATE_INSUFFICIENT_DATA", + "READINESS_STATE_TRAINING", + "READINESS_STATE_NO_VALID_SCRIPT", + "READINESS_STATE_EVALUATION_FAILURE" + ], + "enumDescriptions": [ + "State is not specified or is unknown in this version.", + "The model is trained and ready for serving.", + "There is not enough data to train the serving model.", + "The model is training and not ready for serving.", + "A valid custom bidding script has not been provided with which to train the model. This state will only be applied to algorithms whose `custom_bidding_algorithm_type` is `SCRIPT_BASED`.", + "A valid script was provided but failed evaluation. This is applicable for scripts that could not be evaluated in the alloted time." + ], + "type": "string" + }, + "suspensionState": { + "description": "Output only. The suspension state of custom bidding model.", + "enum": [ + "SUSPENSION_STATE_UNSPECIFIED", + "SUSPENSION_STATE_ENABLED", + "SUSPENSION_STATE_DORMANT", + "SUSPENSION_STATE_SUSPENDED" + ], + "enumDescriptions": [ + "State is not specified or is unknown in this version.", + "Model is enabled, either recently used, currently used or scheduled to be used. The algorithm is actively scoring impressions for this advertiser.", + "Model has not been used recently. Although the model still acts as `ENABLED`, it will eventually be suspended if not used.", + "Model is suspended from scoring impressions and cannot serve. If the algorithm is assigned to a line item under this advertiser or otherwise updated, it will switch back to the `ENABLED` state and require time to prepare the serving model again." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingScript": { + "description": "A single custom bidding script.", + "id": "CustomBiddingScript", + "properties": { + "active": { + "description": "Output only. Whether the script is currently being used for scoring by the parent algorithm.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. The time when the script was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Output only. The unique ID of the custom bidding algorithm the script belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "customBiddingScriptId": { + "description": "Output only. The unique ID of the custom bidding script.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.", + "items": { + "$ref": "ScriptError" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The resource name of the custom bidding script.", + "readOnly": true, + "type": "string" + }, + "script": { + "$ref": "CustomBiddingScriptRef", + "description": "The reference to the uploaded script file." + }, + "state": { + "description": "Output only. The state of the custom bidding script.", + "enum": [ + "STATE_UNSPECIFIED", + "ACCEPTED", + "REJECTED", + "PENDING" + ], + "enumDescriptions": [ + "The script state is not specified or is unknown in this version.", + "The script has been accepted for scoring impressions.", + "The script has been rejected by backend pipelines. It may have errors.", + "The script is being processed for backend pipelines." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingScriptRef": { + "description": "The reference to the uploaded custom bidding script file.", + "id": "CustomBiddingScriptRef", + "properties": { + "resourceName": { + "description": "A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.", + "type": "string" + } + }, + "type": "object" + }, + "CustomLabel": { + "description": "The key and value of a custom label.", + "id": "CustomLabel", + "properties": { + "key": { + "description": "The key of the label.", + "enum": [ + "CUSTOM_LABEL_KEY_UNSPECIFIED", + "CUSTOM_LABEL_KEY_0", + "CUSTOM_LABEL_KEY_1", + "CUSTOM_LABEL_KEY_2", + "CUSTOM_LABEL_KEY_3", + "CUSTOM_LABEL_KEY_4" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "Key index 0.", + "Key index 1.", + "Key index 2.", + "Key index 3.", + "Key index 4." + ], + "type": "string" + }, + "value": { + "description": "The value of the label.", + "type": "string" + } + }, + "type": "object" + }, + "CustomList": { + "description": "Describes a custom list entity, such as a custom affinity or custom intent audience list.", + "id": "CustomList", + "properties": { + "customListId": { + "description": "Output only. The unique ID of the custom list. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the custom list. .", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the custom list.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CustomListGroup": { + "description": "Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other.", + "id": "CustomListGroup", + "properties": { + "settings": { + "description": "Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.", + "items": { + "$ref": "CustomListTargetingSetting" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomListTargetingSetting": { + "description": "Details of custom list targeting setting.", + "id": "CustomListTargetingSetting", + "properties": { + "customListId": { + "description": "Required. Custom id of custom list targeting setting. This id is custom_list_id.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DateRange": { + "description": "A date range.", + "id": "DateRange", + "properties": { + "endDate": { + "$ref": "Date", + "description": "The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`." + }, + "startDate": { + "$ref": "Date", + "description": "The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`." + } + }, + "type": "object" + }, + "DayAndTime": { + "description": "Representation of time defined by day of the week and hour of the day.", + "id": "DayAndTime", + "properties": { + "dayOfWeek": { + "description": "Required. 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" + }, + "hourOfDay": { + "description": "Required. Hour of the day.", + "format": "int32", + "type": "integer" + }, + "timeZoneResolution": { + "description": "Required. The mechanism used to determine the relevant timezone.", + "enum": [ + "TIME_ZONE_RESOLUTION_UNSPECIFIED", + "TIME_ZONE_RESOLUTION_END_USER", + "TIME_ZONE_RESOLUTION_ADVERTISER" + ], + "enumDescriptions": [ + "Time zone resolution is either unspecific or unknown.", + "Times are resolved in the time zone of the user that saw the ad.", + "Times are resolved in the time zone of the advertiser that served the ad." + ], + "type": "string" + } + }, + "type": "object" + }, + "DayAndTimeAssignedTargetingOptionDetails": { + "description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.", + "id": "DayAndTimeAssignedTargetingOptionDetails", + "properties": { + "dayOfWeek": { + "description": "Required. The day of the week for this day and time targeting setting.", + "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" + }, + "endHour": { + "description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).", + "format": "int32", + "type": "integer" + }, + "startHour": { + "description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).", + "format": "int32", + "type": "integer" + }, + "timeZoneResolution": { + "description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting.", + "enum": [ + "TIME_ZONE_RESOLUTION_UNSPECIFIED", + "TIME_ZONE_RESOLUTION_END_USER", + "TIME_ZONE_RESOLUTION_ADVERTISER" + ], + "enumDescriptions": [ + "Time zone resolution is either unspecific or unknown.", + "Times are resolved in the time zone of the user that saw the ad.", + "Times are resolved in the time zone of the advertiser that served the ad." + ], + "type": "string" + } + }, + "type": "object" + }, + "DeleteAssignedTargetingOptionsRequest": { + "description": "A request listing which assigned targeting options of a given targeting type should be deleted.", + "id": "DeleteAssignedTargetingOptionsRequest", + "properties": { + "assignedTargetingOptionIds": { + "description": "Required. The assigned targeting option IDs to delete.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option.", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "type": "string" + } + }, + "type": "object" + }, + "DeviceMakeModelAssignedTargetingOptionDetails": { + "description": "Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", + "id": "DeviceMakeModelAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the device make and model.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", + "type": "string" + } + }, + "type": "object" + }, + "DeviceMakeModelTargetingOptionDetails": { + "description": "Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", + "id": "DeviceMakeModelTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the device make and model.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DeviceTypeAssignedTargetingOptionDetails": { + "description": "Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.", + "id": "DeviceTypeAssignedTargetingOptionDetails", + "properties": { + "deviceType": { + "description": "Required. The display name of the device type.", + "enum": [ + "DEVICE_TYPE_UNSPECIFIED", + "DEVICE_TYPE_COMPUTER", + "DEVICE_TYPE_CONNECTED_TV", + "DEVICE_TYPE_SMART_PHONE", + "DEVICE_TYPE_TABLET", + "DEVICE_TYPE_CONNECTED_DEVICE" + ], + "enumDescriptions": [ + "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet.", + "Connected device." + ], + "type": "string" + }, + "youtubeAndPartnersBidMultiplier": { + "description": "Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "DeviceTypeTargetingOptionDetails": { + "description": "Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.", + "id": "DeviceTypeTargetingOptionDetails", + "properties": { + "deviceType": { + "description": "Output only. The device type that is used to be targeted.", + "enum": [ + "DEVICE_TYPE_UNSPECIFIED", + "DEVICE_TYPE_COMPUTER", + "DEVICE_TYPE_CONNECTED_TV", + "DEVICE_TYPE_SMART_PHONE", + "DEVICE_TYPE_TABLET", + "DEVICE_TYPE_CONNECTED_DEVICE" + ], + "enumDescriptions": [ + "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet.", + "Connected device." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DigitalContentLabelAssignedTargetingOptionDetails": { + "description": "Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.", + "id": "DigitalContentLabelAssignedTargetingOptionDetails", + "properties": { + "excludedContentRatingTier": { + "description": "Required. The display name of the digital content label rating tier to be EXCLUDED.", + "enum": [ + "CONTENT_RATING_TIER_UNSPECIFIED", + "CONTENT_RATING_TIER_UNRATED", + "CONTENT_RATING_TIER_GENERAL", + "CONTENT_RATING_TIER_PARENTAL_GUIDANCE", + "CONTENT_RATING_TIER_TEENS", + "CONTENT_RATING_TIER_MATURE", + "CONTENT_RATING_TIER_FAMILIES" + ], + "enumDescriptions": [ + "Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", + "Content that has not been labeled.", + "Content suitable for general audiences.", + "Content suitable for most audiences with parental guidance.", + "Content suitable for teen and older audiences.", + "Content suitable only for mature audiences.", + "Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." + ], + "type": "string" + } + }, + "type": "object" + }, + "DigitalContentLabelTargetingOptionDetails": { + "description": "Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.", + "id": "DigitalContentLabelTargetingOptionDetails", + "properties": { + "contentRatingTier": { + "description": "Output only. An enum for the content label brand safety tiers.", + "enum": [ + "CONTENT_RATING_TIER_UNSPECIFIED", + "CONTENT_RATING_TIER_UNRATED", + "CONTENT_RATING_TIER_GENERAL", + "CONTENT_RATING_TIER_PARENTAL_GUIDANCE", + "CONTENT_RATING_TIER_TEENS", + "CONTENT_RATING_TIER_MATURE", + "CONTENT_RATING_TIER_FAMILIES" + ], + "enumDescriptions": [ + "Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", + "Content that has not been labeled.", + "Content suitable for general audiences.", + "Content suitable for most audiences with parental guidance.", + "Content suitable for teen and older audiences.", + "Content suitable only for mature audiences.", + "Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Dimensions": { + "description": "Dimensions.", + "id": "Dimensions", + "properties": { + "heightPixels": { + "description": "The height in pixels.", + "format": "int32", + "type": "integer" + }, + "widthPixels": { + "description": "The width in pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DisplayVideoSourceAd": { + "description": "The ad sourced from a DV360 creative.", + "id": "DisplayVideoSourceAd", + "properties": { + "creativeId": { + "description": "The ID of the source creative.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DoubleVerify": { + "description": "Details of DoubleVerify settings.", + "id": "DoubleVerify", + "properties": { + "appStarRating": { + "$ref": "DoubleVerifyAppStarRating", + "description": "Avoid bidding on apps with the star ratings." + }, + "avoidedAgeRatings": { + "description": "Avoid bidding on apps with the age rating.", + "items": { + "enum": [ + "AGE_RATING_UNSPECIFIED", + "APP_AGE_RATE_UNKNOWN", + "APP_AGE_RATE_4_PLUS", + "APP_AGE_RATE_9_PLUS", + "APP_AGE_RATE_12_PLUS", + "APP_AGE_RATE_17_PLUS", + "APP_AGE_RATE_18_PLUS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any age rating options.", + "Apps with unknown age rating.", + "Apps rated for Everyone (4+).", + "Apps rated for Everyone (9+).", + "Apps rated for Teens (12+).", + "Apps rated for Mature (17+).", + "Apps rated for Adults Only (18+)." + ], + "type": "string" + }, + "type": "array" + }, + "brandSafetyCategories": { + "$ref": "DoubleVerifyBrandSafetyCategories", + "description": "DV Brand Safety Controls." + }, + "customSegmentId": { + "description": "The custom segment ID provided by DoubleVerify. The ID must start with \"51\" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic", + "format": "int64", + "type": "string" + }, + "displayViewability": { + "$ref": "DoubleVerifyDisplayViewability", + "description": "Display viewability settings (applicable to display line items only)." + }, + "fraudInvalidTraffic": { + "$ref": "DoubleVerifyFraudInvalidTraffic", + "description": "Avoid Sites and Apps with historical Fraud & IVT Rates." + }, + "videoViewability": { + "$ref": "DoubleVerifyVideoViewability", + "description": "Video viewability settings (applicable to video line items only)." + } + }, + "type": "object" + }, + "DoubleVerifyAppStarRating": { + "description": "Details of DoubleVerify star ratings settings.", + "id": "DoubleVerifyAppStarRating", + "properties": { + "avoidInsufficientStarRating": { + "description": "Avoid bidding on apps with insufficient star ratings.", + "type": "boolean" + }, + "avoidedStarRating": { + "description": "Avoid bidding on apps with the star ratings.", + "enum": [ + "APP_STAR_RATE_UNSPECIFIED", + "APP_STAR_RATE_1_POINT_5_LESS", + "APP_STAR_RATE_2_LESS", + "APP_STAR_RATE_2_POINT_5_LESS", + "APP_STAR_RATE_3_LESS", + "APP_STAR_RATE_3_POINT_5_LESS", + "APP_STAR_RATE_4_LESS", + "APP_STAR_RATE_4_POINT_5_LESS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any app star rating options.", + "Official Apps with rating < 1.5 Stars.", + "Official Apps with rating < 2 Stars.", + "Official Apps with rating < 2.5 Stars.", + "Official Apps with rating < 3 Stars.", + "Official Apps with rating < 3.5 Stars.", + "Official Apps with rating < 4 Stars.", + "Official Apps with rating < 4.5 Stars." + ], + "type": "string" + } + }, + "type": "object" + }, + "DoubleVerifyBrandSafetyCategories": { + "description": "Settings for brand safety controls.", + "id": "DoubleVerifyBrandSafetyCategories", + "properties": { + "avoidUnknownBrandSafetyCategory": { + "description": "Unknown or unrateable.", + "type": "boolean" + }, + "avoidedHighSeverityCategories": { + "description": "Brand safety high severity avoidance categories.", + "items": { + "enum": [ + "HIGHER_SEVERITY_UNSPECIFIED", + "ADULT_CONTENT_PORNOGRAPHY", + "COPYRIGHT_INFRINGEMENT", + "SUBSTANCE_ABUSE", + "GRAPHIC_VIOLENCE_WEAPONS", + "HATE_PROFANITY", + "CRIMINAL_SKILLS", + "NUISANCE_INCENTIVIZED_MALWARE_CLUTTER" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any high severity categories.", + "Adult Content: Pornography, Mature Topics & Nudity.", + "Copyright Infringement.", + "Drugs/Alcohol/Controlled Substances: Substance Abuse.", + "Extreme Graphic/Explicit Violence/Weapons.", + "Hate/Profanity.", + "Illegal Activities: Criminal Skills.", + "Incentivized/Malware/Clutter." + ], + "type": "string" + }, + "type": "array" + }, + "avoidedMediumSeverityCategories": { + "description": "Brand safety medium severity avoidance categories.", + "items": { + "enum": [ + "MEDIUM_SEVERITY_UNSPECIFIED", + "AD_SERVERS", + "ADULT_CONTENT_SWIMSUIT", + "ALTERNATIVE_LIFESTYLES", + "CELEBRITY_GOSSIP", + "GAMBLING", + "OCCULT", + "SEX_EDUCATION", + "DISASTER_AVIATION", + "DISASTER_MAN_MADE", + "DISASTER_NATURAL", + "DISASTER_TERRORIST_EVENTS", + "DISASTER_VEHICLE", + "ALCOHOL", + "SMOKING", + "NEGATIVE_NEWS_FINANCIAL", + "NON_ENGLISH", + "PARKING_PAGE", + "UNMODERATED_UGC", + "INFLAMMATORY_POLITICS_AND_NEWS", + "NEGATIVE_NEWS_PHARMACEUTICAL" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any medium severity categories.", + "Ad Servers.", + "Adult Content: Swimsuit.", + "Controversial Subjects: Alternative Lifestyles.", + "Controversial Subjects: Celebrity Gossip.", + "Controversial Subjects: Gambling.", + "Controversial Subjects: Occult.", + "Controversial Subjects: Sex Education.", + "Disaster: Aviation.", + "Disaster: Man-made.", + "Disaster: Natural.", + "Disaster: Terrorist Events.", + "Disaster: Vehicle.", + "Drugs/Alcohol/Controlled Substances: Alcohol.", + "Drugs/Alcohol/Controlled Substances: Smoking.", + "Negative News: Financial.", + "Non-Std Content: Non-English.", + "Non-Std Content: Parking Page.", + "Unmoderated UGC: Forums, Images & Video.", + "Controversial Subjects: Inflammatory Politics and News.", + "Negative News: Pharmaceutical." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DoubleVerifyDisplayViewability": { + "description": "Details of DoubleVerify display viewability settings.", + "id": "DoubleVerifyDisplayViewability", + "properties": { + "iab": { + "description": "Target web and app inventory to maximize IAB viewable rate.", + "enum": [ + "IAB_VIEWED_RATE_UNSPECIFIED", + "IAB_VIEWED_RATE_80_PERCENT_HIGHER", + "IAB_VIEWED_RATE_75_PERCENT_HIGHER", + "IAB_VIEWED_RATE_70_PERCENT_HIGHER", + "IAB_VIEWED_RATE_65_PERCENT_HIGHER", + "IAB_VIEWED_RATE_60_PERCENT_HIGHER", + "IAB_VIEWED_RATE_55_PERCENT_HIGHER", + "IAB_VIEWED_RATE_50_PERCENT_HIGHER", + "IAB_VIEWED_RATE_40_PERCENT_HIGHER", + "IAB_VIEWED_RATE_30_PERCENT_HIGHER" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any IAB viewed rate options.", + "Target web and app inventory to maximize IAB viewable rate 80% or higher.", + "Target web and app inventory to maximize IAB viewable rate 75% or higher.", + "Target web and app inventory to maximize IAB viewable rate 70% or higher.", + "Target web and app inventory to maximize IAB viewable rate 65% or higher.", + "Target web and app inventory to maximize IAB viewable rate 60% or higher.", + "Target web and app inventory to maximize IAB viewable rate 55% or higher.", + "Target web and app inventory to maximize IAB viewable rate 50% or higher.", + "Target web and app inventory to maximize IAB viewable rate 40% or higher.", + "Target web and app inventory to maximize IAB viewable rate 30% or higher." + ], + "type": "string" + }, + "viewableDuring": { + "description": "Target web and app inventory to maximize 100% viewable duration.", + "enum": [ + "AVERAGE_VIEW_DURATION_UNSPECIFIED", + "AVERAGE_VIEW_DURATION_5_SEC", + "AVERAGE_VIEW_DURATION_10_SEC", + "AVERAGE_VIEW_DURATION_15_SEC" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any average view duration options.", + "Target web and app inventory to maximize 100% viewable duration 5 seconds or more.", + "Target web and app inventory to maximize 100% viewable duration 10 seconds or more.", + "Target web and app inventory to maximize 100% viewable duration 15 seconds or more." + ], + "type": "string" + } + }, + "type": "object" + }, + "DoubleVerifyFraudInvalidTraffic": { + "description": "DoubleVerify Fraud & Invalid Traffic settings.", + "id": "DoubleVerifyFraudInvalidTraffic", + "properties": { + "avoidInsufficientOption": { + "description": "Insufficient Historical Fraud & IVT Stats.", + "type": "boolean" + }, + "avoidedFraudOption": { + "description": "Avoid Sites and Apps with historical Fraud & IVT.", + "enum": [ + "FRAUD_UNSPECIFIED", + "AD_IMPRESSION_FRAUD_100", + "AD_IMPRESSION_FRAUD_50", + "AD_IMPRESSION_FRAUD_25", + "AD_IMPRESSION_FRAUD_10", + "AD_IMPRESSION_FRAUD_8", + "AD_IMPRESSION_FRAUD_6", + "AD_IMPRESSION_FRAUD_4", + "AD_IMPRESSION_FRAUD_2" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any fraud and invalid traffic options.", + "100% Fraud & IVT.", + "50% or Higher Fraud & IVT.", + "25% or Higher Fraud & IVT.", + "10% or Higher Fraud & IVT.", + "8% or Higher Fraud & IVT.", + "6% or Higher Fraud & IVT.", + "4% or Higher Fraud & IVT.", + "2% or Higher Fraud & IVT." + ], + "type": "string" + } + }, + "type": "object" + }, + "DoubleVerifyVideoViewability": { + "description": "Details of DoubleVerify video viewability settings.", + "id": "DoubleVerifyVideoViewability", + "properties": { + "playerImpressionRate": { + "description": "Target inventory to maximize impressions with 400x300 or greater player size.", + "enum": [ + "PLAYER_SIZE_400X300_UNSPECIFIED", + "PLAYER_SIZE_400X300_95", + "PLAYER_SIZE_400X300_70", + "PLAYER_SIZE_400X300_25", + "PLAYER_SIZE_400X300_5" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any impressions options.", + "Sites with 95%+ of impressions.", + "Sites with 70%+ of impressions.", + "Sites with 25%+ of impressions.", + "Sites with 5%+ of impressions." + ], + "type": "string" + }, + "videoIab": { + "description": "Target web inventory to maximize IAB viewable rate.", + "enum": [ + "VIDEO_IAB_UNSPECIFIED", + "IAB_VIEWABILITY_80_PERCENT_HIGHER", + "IAB_VIEWABILITY_75_PERCENT_HIGHER", + "IAB_VIEWABILITY_70_PERCENT_HIGHER", + "IAB_VIEWABILITY_65_PERCENT_HIHGER", + "IAB_VIEWABILITY_60_PERCENT_HIGHER", + "IAB_VIEWABILITY_55_PERCENT_HIHGER", + "IAB_VIEWABILITY_50_PERCENT_HIGHER", + "IAB_VIEWABILITY_40_PERCENT_HIHGER", + "IAB_VIEWABILITY_30_PERCENT_HIHGER" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any video IAB viewable rate options.", + "Target web and app inventory to maximize IAB viewable rate 80% or higher.", + "Target web and app inventory to maximize IAB viewable rate 75% or higher.", + "Target web and app inventory to maximize IAB viewable rate 70% or higher.", + "Target web and app inventory to maximize IAB viewable rate 65% or higher.", + "Target web and app inventory to maximize IAB viewable rate 60% or higher.", + "Target web and app inventory to maximize IAB viewable rate 55% or higher.", + "Target web and app inventory to maximize IAB viewable rate 50% or higher.", + "Target web and app inventory to maximize IAB viewable rate 40% or higher.", + "Target web and app inventory to maximize IAB viewable rate 30% or higher." + ], + "type": "string" + }, + "videoViewableRate": { + "description": "Target web inventory to maximize fully viewable rate.", + "enum": [ + "VIDEO_VIEWABLE_RATE_UNSPECIFIED", + "VIEWED_PERFORMANCE_40_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_35_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_30_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_25_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_20_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_10_PERCENT_HIGHER" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any video viewable rate options.", + "Target web inventory to maximize fully viewable rate 40% or higher.", + "Target web inventory to maximize fully viewable rate 35% or higher.", + "Target web inventory to maximize fully viewable rate 30% or higher.", + "Target web inventory to maximize fully viewable rate 25% or higher.", + "Target web inventory to maximize fully viewable rate 20% or higher.", + "Target web inventory to maximize fully viewable rate 10% or higher." + ], + "type": "string" + } + }, + "type": "object" + }, + "DuplicateLineItemRequest": { + "description": "Request message for LineItemService.DuplicateLineItem.", + "id": "DuplicateLineItemRequest", + "properties": { + "targetDisplayName": { + "description": "The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "DuplicateLineItemResponse": { + "id": "DuplicateLineItemResponse", + "properties": { + "duplicateLineItemId": { + "description": "The ID of the created line item.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EditCustomerMatchMembersRequest": { + "description": "Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", + "id": "EditCustomerMatchMembersRequest", + "properties": { + "addedContactInfoList": { + "$ref": "ContactInfoList", + "description": "Input only. A list of contact information to define the members to be added." + }, + "addedMobileDeviceIdList": { + "$ref": "MobileDeviceIdList", + "description": "Input only. A list of mobile device IDs to define the members to be added." + }, + "advertiserId": { + "description": "Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.", + "format": "int64", + "type": "string" + }, + "removedContactInfoList": { + "$ref": "ContactInfoList", + "description": "Input only. A list of contact information to define the members to be removed." + }, + "removedMobileDeviceIdList": { + "$ref": "MobileDeviceIdList", + "description": "Input only. A list of mobile device IDs to define the members to be removed." + } + }, + "type": "object" + }, + "EditCustomerMatchMembersResponse": { + "description": "The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", + "id": "EditCustomerMatchMembersResponse", + "properties": { + "firstPartyAndPartnerAudienceId": { + "description": "Required. The ID of the updated Customer Match FirstPartyAndPartnerAudience.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EditGuaranteedOrderReadAccessorsRequest": { + "description": "Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors.", + "id": "EditGuaranteedOrderReadAccessorsRequest", + "properties": { + "addedAdvertisers": { + "description": "The advertisers to add as read accessors to the guaranteed order.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "partnerId": { + "description": "Required. The partner context in which the change is being made.", + "format": "int64", + "type": "string" + }, + "readAccessInherited": { + "description": "Whether to give all advertisers of the read/write accessor partner read access to the guaranteed order. Only applicable if read_write_partner_id is set in the guaranteed order.", + "type": "boolean" + }, + "removedAdvertisers": { + "description": "The advertisers to remove as read accessors to the guaranteed order.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EditGuaranteedOrderReadAccessorsResponse": { + "id": "EditGuaranteedOrderReadAccessorsResponse", + "properties": { + "readAccessInherited": { + "description": "Whether all advertisers of read_write_partner_id have read access to the guaranteed order.", + "type": "boolean" + }, + "readAdvertiserIds": { + "description": "The IDs of advertisers with read access to the guaranteed order.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EditInventorySourceReadWriteAccessorsRequest": { + "description": "Request message for InventorySourceService.EditInventorySourceReadWriteAccessors.", + "id": "EditInventorySourceReadWriteAccessorsRequest", + "properties": { + "advertisersUpdate": { + "$ref": "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate", + "description": "The advertisers to add or remove from the list of advertisers that have read/write access to the inventory source. This change will remove an existing partner read/write accessor." + }, + "assignPartner": { + "description": "Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors.", + "type": "boolean" + }, + "partnerId": { + "description": "Required. The partner context by which the accessors change is being made.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate": { + "description": "Update to the list of advertisers with read/write access to the inventory source.", + "id": "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate", + "properties": { + "addedAdvertisers": { + "description": "The advertisers to add.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "removedAdvertisers": { + "description": "The advertisers to remove.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "EnvironmentAssignedTargetingOptionDetails": { + "description": "Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`.", + "id": "EnvironmentAssignedTargetingOptionDetails", + "properties": { + "environment": { + "description": "Required. The serving environment.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_WEB_OPTIMIZED", + "ENVIRONMENT_WEB_NOT_OPTIMIZED", + "ENVIRONMENT_APP" + ], + "enumDescriptions": [ + "Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", + "Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", + "Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", + "Target inventory displayed in apps." + ], + "type": "string" + } + }, + "type": "object" + }, + "EnvironmentTargetingOptionDetails": { + "description": "Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`.", + "id": "EnvironmentTargetingOptionDetails", + "properties": { + "environment": { + "description": "Output only. The serving environment.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_WEB_OPTIMIZED", + "ENVIRONMENT_WEB_NOT_OPTIMIZED", + "ENVIRONMENT_APP" + ], + "enumDescriptions": [ + "Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", + "Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", + "Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", + "Target inventory displayed in apps." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ExchangeAssignedTargetingOptionDetails": { + "description": "Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`.", + "id": "ExchangeAssignedTargetingOptionDetails", + "properties": { + "exchange": { + "description": "Required. The enum value for the exchange.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK", + "EXCHANGE_DRAX", + "EXCHANGE_APPLOVIN_GBID", + "EXCHANGE_FYBER_GBID", + "EXCHANGE_UNITY_GBID", + "EXCHANGE_CHARTBOOST_GBID", + "EXCHANGE_ADMOST_GBID", + "EXCHANGE_TOPON_GBID", + "EXCHANGE_NETFLIX", + "EXCHANGE_CORE", + "EXCHANGE_TUBI" + ], + "enumDescriptions": [ + "Exchange is not specified or is unknown in this version.", + "Google Ad Manager.", + "AppNexus.", + "BrightRoll Exchange for Video from Yahoo!.", + "Adform.", + "Admeta.", + "Admixer.", + "AdsMogo.", + "AdsWizz.", + "BidSwitch.", + "BrightRoll Exchange for Display from Yahoo!.", + "Cadreon.", + "Dailymotion.", + "Five.", + "Fluct.", + "FreeWheel SSP.", + "Geniee.", + "GumGum.", + "i-mobile.", + "iBILLBOARD.", + "Improve Digital.", + "Index Exchange.", + "Kargo.", + "MicroAd.", + "MoPub.", + "Nend.", + "ONE by AOL: Display Market Place.", + "ONE by AOL: Mobile.", + "ONE by AOL: Video.", + "Ooyala.", + "OpenX.", + "Permodo.", + "Platform One.", + "PlatformId.", + "PubMatic.", + "PulsePoint.", + "RevenueMax.", + "Rubicon.", + "SmartClip.", + "SmartRTB+.", + "SmartstreamTv.", + "Sovrn.", + "SpotXchange.", + "Ströer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack.", + "Drax.", + "AppLovin MAX.", + "DT Fairbid.", + "Unity LevelPlay.", + "Chartboost Mediation.", + "AdMost.", + "TopOn.", + "Netflix.", + "Core.", + "Tubi." + ], + "type": "string" + } + }, + "type": "object" + }, + "ExchangeConfig": { + "description": "Settings that control which exchanges are enabled for a partner.", + "id": "ExchangeConfig", + "properties": { + "enabledExchanges": { + "description": "All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored.", + "items": { + "$ref": "ExchangeConfigEnabledExchange" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExchangeConfigEnabledExchange": { + "description": "An enabled exchange in the partner.", + "id": "ExchangeConfigEnabledExchange", + "properties": { + "exchange": { + "description": "The enabled exchange.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK", + "EXCHANGE_DRAX", + "EXCHANGE_APPLOVIN_GBID", + "EXCHANGE_FYBER_GBID", + "EXCHANGE_UNITY_GBID", + "EXCHANGE_CHARTBOOST_GBID", + "EXCHANGE_ADMOST_GBID", + "EXCHANGE_TOPON_GBID", + "EXCHANGE_NETFLIX", + "EXCHANGE_CORE", + "EXCHANGE_TUBI" + ], + "enumDescriptions": [ + "Exchange is not specified or is unknown in this version.", + "Google Ad Manager.", + "AppNexus.", + "BrightRoll Exchange for Video from Yahoo!.", + "Adform.", + "Admeta.", + "Admixer.", + "AdsMogo.", + "AdsWizz.", + "BidSwitch.", + "BrightRoll Exchange for Display from Yahoo!.", + "Cadreon.", + "Dailymotion.", + "Five.", + "Fluct.", + "FreeWheel SSP.", + "Geniee.", + "GumGum.", + "i-mobile.", + "iBILLBOARD.", + "Improve Digital.", + "Index Exchange.", + "Kargo.", + "MicroAd.", + "MoPub.", + "Nend.", + "ONE by AOL: Display Market Place.", + "ONE by AOL: Mobile.", + "ONE by AOL: Video.", + "Ooyala.", + "OpenX.", + "Permodo.", + "Platform One.", + "PlatformId.", + "PubMatic.", + "PulsePoint.", + "RevenueMax.", + "Rubicon.", + "SmartClip.", + "SmartRTB+.", + "SmartstreamTv.", + "Sovrn.", + "SpotXchange.", + "Ströer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack.", + "Drax.", + "AppLovin MAX.", + "DT Fairbid.", + "Unity LevelPlay.", + "Chartboost Mediation.", + "AdMost.", + "TopOn.", + "Netflix.", + "Core.", + "Tubi." + ], + "type": "string" + }, + "googleAdManagerAgencyId": { + "description": "Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.", + "readOnly": true, + "type": "string" + }, + "googleAdManagerBuyerNetworkId": { + "description": "Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.", + "readOnly": true, + "type": "string" + }, + "seatId": { + "description": "Output only. Seat ID of the enabled exchange.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ExchangeReviewStatus": { + "description": "Exchange review status for the creative.", + "id": "ExchangeReviewStatus", + "properties": { + "exchange": { + "description": "The exchange reviewing the creative.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK", + "EXCHANGE_DRAX", + "EXCHANGE_APPLOVIN_GBID", + "EXCHANGE_FYBER_GBID", + "EXCHANGE_UNITY_GBID", + "EXCHANGE_CHARTBOOST_GBID", + "EXCHANGE_ADMOST_GBID", + "EXCHANGE_TOPON_GBID", + "EXCHANGE_NETFLIX", + "EXCHANGE_CORE", + "EXCHANGE_TUBI" + ], + "enumDescriptions": [ + "Exchange is not specified or is unknown in this version.", + "Google Ad Manager.", + "AppNexus.", + "BrightRoll Exchange for Video from Yahoo!.", + "Adform.", + "Admeta.", + "Admixer.", + "AdsMogo.", + "AdsWizz.", + "BidSwitch.", + "BrightRoll Exchange for Display from Yahoo!.", + "Cadreon.", + "Dailymotion.", + "Five.", + "Fluct.", + "FreeWheel SSP.", + "Geniee.", + "GumGum.", + "i-mobile.", + "iBILLBOARD.", + "Improve Digital.", + "Index Exchange.", + "Kargo.", + "MicroAd.", + "MoPub.", + "Nend.", + "ONE by AOL: Display Market Place.", + "ONE by AOL: Mobile.", + "ONE by AOL: Video.", + "Ooyala.", + "OpenX.", + "Permodo.", + "Platform One.", + "PlatformId.", + "PubMatic.", + "PulsePoint.", + "RevenueMax.", + "Rubicon.", + "SmartClip.", + "SmartRTB+.", + "SmartstreamTv.", + "Sovrn.", + "SpotXchange.", + "Ströer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack.", + "Drax.", + "AppLovin MAX.", + "DT Fairbid.", + "Unity LevelPlay.", + "Chartboost Mediation.", + "AdMost.", + "TopOn.", + "Netflix.", + "Core.", + "Tubi." + ], + "type": "string" + }, + "status": { + "description": "Status of the exchange review.", + "enum": [ + "REVIEW_STATUS_UNSPECIFIED", + "REVIEW_STATUS_APPROVED", + "REVIEW_STATUS_REJECTED", + "REVIEW_STATUS_PENDING" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The creative is approved.", + "The creative is rejected.", + "The creative is pending review." + ], + "type": "string" + } + }, + "type": "object" + }, + "ExchangeTargetingOptionDetails": { + "description": "Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`.", + "id": "ExchangeTargetingOptionDetails", + "properties": { + "exchange": { + "description": "Output only. The type of exchange.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK", + "EXCHANGE_DRAX", + "EXCHANGE_APPLOVIN_GBID", + "EXCHANGE_FYBER_GBID", + "EXCHANGE_UNITY_GBID", + "EXCHANGE_CHARTBOOST_GBID", + "EXCHANGE_ADMOST_GBID", + "EXCHANGE_TOPON_GBID", + "EXCHANGE_NETFLIX", + "EXCHANGE_CORE", + "EXCHANGE_TUBI" + ], + "enumDescriptions": [ + "Exchange is not specified or is unknown in this version.", + "Google Ad Manager.", + "AppNexus.", + "BrightRoll Exchange for Video from Yahoo!.", + "Adform.", + "Admeta.", + "Admixer.", + "AdsMogo.", + "AdsWizz.", + "BidSwitch.", + "BrightRoll Exchange for Display from Yahoo!.", + "Cadreon.", + "Dailymotion.", + "Five.", + "Fluct.", + "FreeWheel SSP.", + "Geniee.", + "GumGum.", + "i-mobile.", + "iBILLBOARD.", + "Improve Digital.", + "Index Exchange.", + "Kargo.", + "MicroAd.", + "MoPub.", + "Nend.", + "ONE by AOL: Display Market Place.", + "ONE by AOL: Mobile.", + "ONE by AOL: Video.", + "Ooyala.", + "OpenX.", + "Permodo.", + "Platform One.", + "PlatformId.", + "PubMatic.", + "PulsePoint.", + "RevenueMax.", + "Rubicon.", + "SmartClip.", + "SmartRTB+.", + "SmartstreamTv.", + "Sovrn.", + "SpotXchange.", + "Ströer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack.", + "Drax.", + "AppLovin MAX.", + "DT Fairbid.", + "Unity LevelPlay.", + "Chartboost Mediation.", + "AdMost.", + "TopOn.", + "Netflix.", + "Core.", + "Tubi." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ExitEvent": { + "description": "Exit event of the creative.", + "id": "ExitEvent", + "properties": { + "name": { + "description": "Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.", + "type": "string" + }, + "reportingName": { + "description": "Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only.", + "type": "string" + }, + "type": { + "description": "Required. The type of the exit event.", + "enum": [ + "EXIT_EVENT_TYPE_UNSPECIFIED", + "EXIT_EVENT_TYPE_DEFAULT", + "EXIT_EVENT_TYPE_BACKUP" + ], + "enumDescriptions": [ + "Exit event type is not specified or is unknown in this version.", + "The exit event is the default one.", + "The exit event is a backup exit event. There could be multiple backup exit events in a creative." + ], + "type": "string" + }, + "url": { + "description": "Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP`", + "type": "string" + } + }, + "type": "object" + }, + "FirstPartyAndPartnerAudience": { + "description": "Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers.", + "id": "FirstPartyAndPartnerAudience", + "properties": { + "activeDisplayAudienceSize": { + "description": "Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "appId": { + "description": "Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`", + "type": "string" + }, + "audienceSource": { + "description": "Output only. The source of the audience.", + "enum": [ + "AUDIENCE_SOURCE_UNSPECIFIED", + "DISPLAY_VIDEO_360", + "CAMPAIGN_MANAGER", + "AD_MANAGER", + "SEARCH_ADS_360", + "YOUTUBE", + "ADS_DATA_HUB" + ], + "enumDescriptions": [ + "Default value when audience source is not specified or is unknown.", + "Originated from Display & Video 360.", + "Originated from Campaign Manager 360.", + "Originated from Google Ad Manager.", + "Originated from Search Ads 360.", + "Originated from Youtube.", + "Originated from Ads Data Hub." + ], + "readOnly": true, + "type": "string" + }, + "audienceType": { + "description": "Output only. The type of the audience.", + "enum": [ + "AUDIENCE_TYPE_UNSPECIFIED", + "CUSTOMER_MATCH_CONTACT_INFO", + "CUSTOMER_MATCH_DEVICE_ID", + "CUSTOMER_MATCH_USER_ID", + "ACTIVITY_BASED", + "FREQUENCY_CAP", + "TAG_BASED", + "YOUTUBE_USERS", + "THIRD_PARTY", + "COMMERCE", + "LINEAR" + ], + "enumDeprecated": [ + false, + false, + false, + false, + true, + true, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown.", + "Audience was generated through matching customers to known contact information.", + "Audience was generated through matching customers to known Mobile device IDs.", + "Audience was generated through matching customers to known User IDs.", + "Audience was created based on campaign activity.", + "Audience was created based on excluding the number of impressions they were served.", + "Audience was created based on custom variables attached to pixel.", + "Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.", + "Audience has been licensed for use from a third party.", + "Audience provided by commerce partners for a fee.", + "Audience for Linear TV content." + ], + "readOnly": true, + "type": "string" + }, + "contactInfoList": { + "$ref": "ContactInfoList", + "description": "Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`" + }, + "description": { + "description": "Output only. The user-provided description of the audience. Only applicable to first party audiences.", + "readOnly": true, + "type": "string" + }, + "displayAudienceSize": { + "description": "Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayDesktopAudienceSize": { + "description": "Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayMobileAppAudienceSize": { + "description": "Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayMobileWebAudienceSize": { + "description": "Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the first party and partner audience.", + "readOnly": true, + "type": "string" + }, + "firstPartyAndPartnerAudienceId": { + "description": "Identifier. The unique ID of the first party and partner audience. Assigned by the system.", + "format": "int64", + "type": "string" + }, + "firstPartyAndPartnerAudienceType": { + "description": "Output only. Whether the audience is a first party and partner audience.", + "enum": [ + "FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED", + "TYPE_FIRST_PARTY", + "TYPE_PARTNER" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown.", + "Audience that is created via usage of client data.", + "Audience that is provided by Third Party data providers." + ], + "readOnly": true, + "type": "string" + }, + "gmailAudienceSize": { + "description": "Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "membershipDurationDays": { + "description": "Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration).", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "mobileDeviceIdList": { + "$ref": "MobileDeviceIdList", + "description": "Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`" + }, + "name": { + "description": "Output only. The resource name of the first party and partner audience.", + "readOnly": true, + "type": "string" + }, + "youtubeAudienceSize": { + "description": "Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FirstPartyAndPartnerAudienceGroup": { + "description": "Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.", + "id": "FirstPartyAndPartnerAudienceGroup", + "properties": { + "settings": { + "description": "Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.", + "items": { + "$ref": "FirstPartyAndPartnerAudienceTargetingSetting" + }, + "type": "array" + } + }, + "type": "object" + }, + "FirstPartyAndPartnerAudienceTargetingSetting": { + "description": "Details of first party and partner audience targeting setting.", + "id": "FirstPartyAndPartnerAudienceTargetingSetting", + "properties": { + "firstPartyAndPartnerAudienceId": { + "description": "Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.", + "format": "int64", + "type": "string" + }, + "recency": { + "description": "Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.", + "enum": [ + "RECENCY_NO_LIMIT", + "RECENCY_1_MINUTE", + "RECENCY_5_MINUTES", + "RECENCY_10_MINUTES", + "RECENCY_15_MINUTES", + "RECENCY_30_MINUTES", + "RECENCY_1_HOUR", + "RECENCY_2_HOURS", + "RECENCY_3_HOURS", + "RECENCY_6_HOURS", + "RECENCY_12_HOURS", + "RECENCY_1_DAY", + "RECENCY_2_DAYS", + "RECENCY_3_DAYS", + "RECENCY_5_DAYS", + "RECENCY_7_DAYS", + "RECENCY_10_DAYS", + "RECENCY_14_DAYS", + "RECENCY_15_DAYS", + "RECENCY_21_DAYS", + "RECENCY_28_DAYS", + "RECENCY_30_DAYS", + "RECENCY_40_DAYS", + "RECENCY_45_DAYS", + "RECENCY_60_DAYS", + "RECENCY_90_DAYS", + "RECENCY_120_DAYS", + "RECENCY_180_DAYS", + "RECENCY_270_DAYS", + "RECENCY_365_DAYS" + ], + "enumDescriptions": [ + "No limit of recency.", + "Recency is 1 minute.", + "Recency is 5 minutes.", + "Recency is 10 minutes.", + "Recency is 15 minutes.", + "Recency is 30 minutes.", + "Recency is 1 hour.", + "Recency is 2 hours.", + "Recency is 3 hours.", + "Recency is 6 hours.", + "Recency is 12 hours.", + "Recency is 1 day.", + "Recency is 2 days.", + "Recency is 3 days.", + "Recency is 5 days.", + "Recency is 7 days.", + "Recency is 10 days.", + "Recency is 14 days.", + "Recency is 15 days.", + "Recency is 21 days.", + "Recency is 28 days.", + "Recency is 30 days.", + "Recency is 40 days.", + "Recency is 45 days.", + "Recency is 60 days.", + "Recency is 90 days.", + "Recency is 120 days.", + "Recency is 180 days.", + "Recency is 270 days.", + "Recency is 365 days." + ], + "type": "string" + } + }, + "type": "object" + }, + "FixedBidStrategy": { + "description": "A strategy that uses a fixed bidding price.", + "id": "FixedBidStrategy", + "properties": { + "bidAmountMicros": { + "description": "The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "FloodlightActivity": { + "description": "A single Floodlight activity.", + "id": "FloodlightActivity", + "properties": { + "advertiserIds": { + "description": "Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the Floodlight activity.", + "type": "string" + }, + "floodlightActivityId": { + "description": "Output only. The unique ID of the Floodlight activity. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "floodlightGroupId": { + "description": "Required. Immutable. The ID of the parent Floodlight group.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the Floodlight activity.", + "readOnly": true, + "type": "string" + }, + "remarketingConfigs": { + "description": "Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser.", + "items": { + "$ref": "RemarketingConfig" + }, + "readOnly": true, + "type": "array" + }, + "servingStatus": { + "description": "Optional. Whether the Floodlight activity is served.", + "enum": [ + "FLOODLIGHT_ACTIVITY_SERVING_STATUS_UNSPECIFIED", + "FLOODLIGHT_ACTIVITY_SERVING_STATUS_ENABLED", + "FLOODLIGHT_ACTIVITY_SERVING_STATUS_DISABLED" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Enabled.", + "Disabled." + ], + "type": "string" + }, + "sslRequired": { + "description": "Output only. Whether tags are required to be compliant.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "FloodlightGroup": { + "description": "A single Floodlight group.", + "id": "FloodlightGroup", + "properties": { + "activeViewConfig": { + "$ref": "ActiveViewVideoViewabilityMetricConfig", + "description": "The Active View video viewability metric configuration for the Floodlight group." + }, + "customVariables": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { \"U1\": value { number_value: 123.4 }, \"U2\": value { string_value: \"MyVariable2\" }, \"U3\": value { string_value: \"MyVariable3\" } } }` Acceptable values for keys are \"U1\" through \"U100\", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `\"<>`.", + "type": "object" + }, + "displayName": { + "description": "Required. The display name of the Floodlight group.", + "type": "string" + }, + "floodlightGroupId": { + "description": "Output only. The unique ID of the Floodlight group. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "lookbackWindow": { + "$ref": "LookbackWindow", + "description": "Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive." + }, + "name": { + "description": "Output only. The resource name of the Floodlight group.", + "readOnly": true, + "type": "string" + }, + "webTagType": { + "description": "Required. The web tag type enabled for the Floodlight group.", + "enum": [ + "WEB_TAG_TYPE_UNSPECIFIED", + "WEB_TAG_TYPE_NONE", + "WEB_TAG_TYPE_IMAGE", + "WEB_TAG_TYPE_DYNAMIC" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "No tag type.", + "Image tag.", + "Dynamic tag." + ], + "type": "string" + } + }, + "type": "object" + }, + "FrequencyCap": { + "description": "Settings that control the number of times a user may be shown with the same ad during a given time period.", + "id": "FrequencyCap", + "properties": { + "maxImpressions": { + "description": "The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.", + "format": "int32", + "type": "integer" + }, + "maxViews": { + "description": "Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.", + "format": "int32", + "type": "integer" + }, + "timeUnit": { + "description": "The time unit in which the frequency cap will be applied. Required when unlimited is `false`.", + "enum": [ + "TIME_UNIT_UNSPECIFIED", + "TIME_UNIT_LIFETIME", + "TIME_UNIT_MONTHS", + "TIME_UNIT_WEEKS", + "TIME_UNIT_DAYS", + "TIME_UNIT_HOURS", + "TIME_UNIT_MINUTES" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Time unit value is not specified or is unknown in this version.", + "The frequency cap will be applied to the whole life time of the line item.", + "The frequency cap will be applied to a number of months.", + "The frequency cap will be applied to a number of weeks.", + "The frequency cap will be applied to a number of days.", + "The frequency cap will be applied to a number of hours.", + "The frequency cap will be applied to a number of minutes." + ], + "type": "string" + }, + "timeUnitCount": { + "description": "The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59", + "format": "int32", + "type": "integer" + }, + "unlimited": { + "description": "Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.", + "type": "boolean" + } + }, + "type": "object" + }, + "GenderAssignedTargetingOptionDetails": { + "description": "Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`.", + "id": "GenderAssignedTargetingOptionDetails", + "properties": { + "gender": { + "description": "Required. The gender of the audience.", + "enum": [ + "GENDER_UNSPECIFIED", + "GENDER_MALE", + "GENDER_FEMALE", + "GENDER_UNKNOWN" + ], + "enumDescriptions": [ + "Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.", + "The audience gender is male.", + "The audience gender is female.", + "The audience gender is unknown." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenderTargetingOptionDetails": { + "description": "Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`.", + "id": "GenderTargetingOptionDetails", + "properties": { + "gender": { + "description": "Output only. The gender of an audience.", + "enum": [ + "GENDER_UNSPECIFIED", + "GENDER_MALE", + "GENDER_FEMALE", + "GENDER_UNKNOWN" + ], + "enumDescriptions": [ + "Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.", + "The audience gender is male.", + "The audience gender is female.", + "The audience gender is unknown." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GenerateDefaultLineItemRequest": { + "description": "Request message for LineItemService.GenerateDefaultLineItem.", + "id": "GenerateDefaultLineItemRequest", + "properties": { + "displayName": { + "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "insertionOrderId": { + "description": "Required. The unique ID of the insertion order that the line item belongs to.", + "format": "int64", + "type": "string" + }, + "lineItemType": { + "description": "Required. The type of the line item.", + "enum": [ + "LINE_ITEM_TYPE_UNSPECIFIED", + "LINE_ITEM_TYPE_DISPLAY_DEFAULT", + "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL", + "LINE_ITEM_TYPE_VIDEO_DEFAULT", + "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL", + "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY", + "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY", + "LINE_ITEM_TYPE_AUDIO_DEFAULT", + "LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", + "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", + "LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", + "Image, HTML5, native, or rich media ads.", + "Display ads that drive installs of an app.", + "Video ads sold on a CPM basis for a variety of environments.", + "Video ads that drive installs of an app.", + "Display ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "RTB Audio ads sold for a variety of environments.", + "Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertion_order_type `OVER_THE_TOP`.", + "YouTube video ads that promote conversions. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that show a story in a particular sequence using a mix of formats. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube audio ads. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", + "Default YouTube video ads. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV youTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV youTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.", + "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", + "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." + ], + "type": "string" + }, + "mobileApp": { + "$ref": "MobileApp", + "description": "The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`." + } + }, + "type": "object" + }, + "GeoRegionAssignedTargetingOptionDetails": { + "description": "Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`.", + "id": "GeoRegionAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the geographic region (e.g., \"Ontario, Canada\").", + "readOnly": true, + "type": "string" + }, + "geoRegionType": { + "description": "Output only. The type of geographic region targeting.", + "enum": [ + "GEO_REGION_TYPE_UNKNOWN", + "GEO_REGION_TYPE_OTHER", + "GEO_REGION_TYPE_COUNTRY", + "GEO_REGION_TYPE_REGION", + "GEO_REGION_TYPE_TERRITORY", + "GEO_REGION_TYPE_PROVINCE", + "GEO_REGION_TYPE_STATE", + "GEO_REGION_TYPE_PREFECTURE", + "GEO_REGION_TYPE_GOVERNORATE", + "GEO_REGION_TYPE_CANTON", + "GEO_REGION_TYPE_UNION_TERRITORY", + "GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY", + "GEO_REGION_TYPE_DMA_REGION", + "GEO_REGION_TYPE_METRO", + "GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT", + "GEO_REGION_TYPE_COUNTY", + "GEO_REGION_TYPE_MUNICIPALITY", + "GEO_REGION_TYPE_CITY", + "GEO_REGION_TYPE_POSTAL_CODE", + "GEO_REGION_TYPE_DEPARTMENT", + "GEO_REGION_TYPE_AIRPORT", + "GEO_REGION_TYPE_TV_REGION", + "GEO_REGION_TYPE_OKRUG", + "GEO_REGION_TYPE_BOROUGH", + "GEO_REGION_TYPE_CITY_REGION", + "GEO_REGION_TYPE_ARRONDISSEMENT", + "GEO_REGION_TYPE_NEIGHBORHOOD", + "GEO_REGION_TYPE_UNIVERSITY", + "GEO_REGION_TYPE_DISTRICT", + "GEO_REGION_TYPE_NATIONAL_PARK", + "GEO_REGION_TYPE_BARRIO", + "GEO_REGION_TYPE_SUB_WARD", + "GEO_REGION_TYPE_MUNICIPALITY_DISTRICT", + "GEO_REGION_TYPE_SUB_DISTRICT", + "GEO_REGION_TYPE_QUARTER", + "GEO_REGION_TYPE_DIVISION", + "GEO_REGION_TYPE_COMMUNE", + "GEO_REGION_TYPE_COLLOQUIAL_AREA" + ], + "enumDescriptions": [ + "The geographic region type is unknown.", + "The geographic region type is other.", + "The geographic region is a country.", + "The geographic region type is region.", + "The geographic region is a territory.", + "The geographic region is a province.", + "The geographic region is a state.", + "The geographic region is a prefecture.", + "The geographic region is a governorate.", + "The geographic region is a canton.", + "The geographic region is a union territory.", + "The geographic region is an autonomous community.", + "The geographic region is a designated market area (DMA) region.", + "The geographic region type is metro.", + "The geographic region is a congressional district.", + "The geographic region is a county.", + "The geographic region is a municipality.", + "The geographic region is a city.", + "The geographic region targeting type is postal code.", + "The geographic region targeting type is department.", + "The geographic region is an airport.", + "The geographic region is a TV region.", + "The geographic region is an okrug.", + "The geographic region is a borough.", + "The geographic region is a city region.", + "The geographic region is an arrondissement.", + "The geographic region is a neighborhood.", + "The geographic region is a university.", + "The geographic region is a district.", + "The geographic region is a national park.", + "The geographic region is a barrio.", + "The geographic region is a sub ward.", + "The geographic region is a municipality district.", + "The geographic region is a sub district.", + "The geographic region is a quarter.", + "The geographic region is a division.", + "The geographic region is a commune.", + "The geographic region is a colloquial area." + ], + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.", + "type": "string" + } + }, + "type": "object" + }, + "GeoRegionSearchTerms": { + "description": "Search terms for geo region targeting options.", + "id": "GeoRegionSearchTerms", + "properties": { + "geoRegionQuery": { + "description": "The search query for the desired geo region. The query can be a prefix, e.g. \"New Yor\", \"Seattle\", \"USA\", etc.", + "type": "string" + } + }, + "type": "object" + }, + "GeoRegionTargetingOptionDetails": { + "description": "Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`.", + "id": "GeoRegionTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the geographic region (e.g., \"Ontario, Canada\").", + "readOnly": true, + "type": "string" + }, + "geoRegionType": { + "description": "Output only. The type of geographic region targeting.", + "enum": [ + "GEO_REGION_TYPE_UNKNOWN", + "GEO_REGION_TYPE_OTHER", + "GEO_REGION_TYPE_COUNTRY", + "GEO_REGION_TYPE_REGION", + "GEO_REGION_TYPE_TERRITORY", + "GEO_REGION_TYPE_PROVINCE", + "GEO_REGION_TYPE_STATE", + "GEO_REGION_TYPE_PREFECTURE", + "GEO_REGION_TYPE_GOVERNORATE", + "GEO_REGION_TYPE_CANTON", + "GEO_REGION_TYPE_UNION_TERRITORY", + "GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY", + "GEO_REGION_TYPE_DMA_REGION", + "GEO_REGION_TYPE_METRO", + "GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT", + "GEO_REGION_TYPE_COUNTY", + "GEO_REGION_TYPE_MUNICIPALITY", + "GEO_REGION_TYPE_CITY", + "GEO_REGION_TYPE_POSTAL_CODE", + "GEO_REGION_TYPE_DEPARTMENT", + "GEO_REGION_TYPE_AIRPORT", + "GEO_REGION_TYPE_TV_REGION", + "GEO_REGION_TYPE_OKRUG", + "GEO_REGION_TYPE_BOROUGH", + "GEO_REGION_TYPE_CITY_REGION", + "GEO_REGION_TYPE_ARRONDISSEMENT", + "GEO_REGION_TYPE_NEIGHBORHOOD", + "GEO_REGION_TYPE_UNIVERSITY", + "GEO_REGION_TYPE_DISTRICT", + "GEO_REGION_TYPE_NATIONAL_PARK", + "GEO_REGION_TYPE_BARRIO", + "GEO_REGION_TYPE_SUB_WARD", + "GEO_REGION_TYPE_MUNICIPALITY_DISTRICT", + "GEO_REGION_TYPE_SUB_DISTRICT", + "GEO_REGION_TYPE_QUARTER", + "GEO_REGION_TYPE_DIVISION", + "GEO_REGION_TYPE_COMMUNE", + "GEO_REGION_TYPE_COLLOQUIAL_AREA" + ], + "enumDescriptions": [ + "The geographic region type is unknown.", + "The geographic region type is other.", + "The geographic region is a country.", + "The geographic region type is region.", + "The geographic region is a territory.", + "The geographic region is a province.", + "The geographic region is a state.", + "The geographic region is a prefecture.", + "The geographic region is a governorate.", + "The geographic region is a canton.", + "The geographic region is a union territory.", + "The geographic region is an autonomous community.", + "The geographic region is a designated market area (DMA) region.", + "The geographic region type is metro.", + "The geographic region is a congressional district.", + "The geographic region is a county.", + "The geographic region is a municipality.", + "The geographic region is a city.", + "The geographic region targeting type is postal code.", + "The geographic region targeting type is department.", + "The geographic region is an airport.", + "The geographic region is a TV region.", + "The geographic region is an okrug.", + "The geographic region is a borough.", + "The geographic region is a city region.", + "The geographic region is an arrondissement.", + "The geographic region is a neighborhood.", + "The geographic region is a university.", + "The geographic region is a district.", + "The geographic region is a national park.", + "The geographic region is a barrio.", + "The geographic region is a sub ward.", + "The geographic region is a municipality district.", + "The geographic region is a sub district.", + "The geographic region is a quarter.", + "The geographic region is a division.", + "The geographic region is a commune.", + "The geographic region is a colloquial area." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAudience": { + "description": "Describes a Google audience resource. Includes Google audience lists.", + "id": "GoogleAudience", + "properties": { + "displayName": { + "description": "Output only. The display name of the Google audience. .", + "readOnly": true, + "type": "string" + }, + "googleAudienceId": { + "description": "Output only. The unique ID of the Google audience. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "googleAudienceType": { + "description": "Output only. The type of Google audience. .", + "enum": [ + "GOOGLE_AUDIENCE_TYPE_UNSPECIFIED", + "GOOGLE_AUDIENCE_TYPE_AFFINITY", + "GOOGLE_AUDIENCE_TYPE_IN_MARKET", + "GOOGLE_AUDIENCE_TYPE_INSTALLED_APPS", + "GOOGLE_AUDIENCE_TYPE_NEW_MOBILE_DEVICES", + "GOOGLE_AUDIENCE_TYPE_LIFE_EVENT", + "GOOGLE_AUDIENCE_TYPE_EXTENDED_DEMOGRAPHIC" + ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + false, + false + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown.", + "Affinity type Google audience.", + "In-Market type Google audience.", + "Installed-Apps type Google audience.", + "New-Mobile-Devices type Google audience.", + "Life-Event type Google audience.", + "Extended-Demographic type Google audience." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the google audience.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAudienceGroup": { + "description": "Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other.", + "id": "GoogleAudienceGroup", + "properties": { + "settings": { + "description": "Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.", + "items": { + "$ref": "GoogleAudienceTargetingSetting" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAudienceTargetingSetting": { + "description": "Details of Google audience targeting setting.", + "id": "GoogleAudienceTargetingSetting", + "properties": { + "googleAudienceId": { + "description": "Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleBytestreamMedia": { + "description": "Media resource.", + "id": "GoogleBytestreamMedia", + "properties": { + "resourceName": { + "description": "Name of the media resource.", + "type": "string" + } + }, + "type": "object" + }, + "GuaranteedOrder": { + "description": "A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.", + "id": "GuaranteedOrder", + "properties": { + "defaultAdvertiserId": { + "description": "Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "defaultCampaignId": { + "description": "The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.", + "format": "int64", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "exchange": { + "description": "Required. Immutable. The exchange where the guaranteed order originated.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK", + "EXCHANGE_DRAX", + "EXCHANGE_APPLOVIN_GBID", + "EXCHANGE_FYBER_GBID", + "EXCHANGE_UNITY_GBID", + "EXCHANGE_CHARTBOOST_GBID", + "EXCHANGE_ADMOST_GBID", + "EXCHANGE_TOPON_GBID", + "EXCHANGE_NETFLIX", + "EXCHANGE_CORE", + "EXCHANGE_TUBI" + ], + "enumDescriptions": [ + "Exchange is not specified or is unknown in this version.", + "Google Ad Manager.", + "AppNexus.", + "BrightRoll Exchange for Video from Yahoo!.", + "Adform.", + "Admeta.", + "Admixer.", + "AdsMogo.", + "AdsWizz.", + "BidSwitch.", + "BrightRoll Exchange for Display from Yahoo!.", + "Cadreon.", + "Dailymotion.", + "Five.", + "Fluct.", + "FreeWheel SSP.", + "Geniee.", + "GumGum.", + "i-mobile.", + "iBILLBOARD.", + "Improve Digital.", + "Index Exchange.", + "Kargo.", + "MicroAd.", + "MoPub.", + "Nend.", + "ONE by AOL: Display Market Place.", + "ONE by AOL: Mobile.", + "ONE by AOL: Video.", + "Ooyala.", + "OpenX.", + "Permodo.", + "Platform One.", + "PlatformId.", + "PubMatic.", + "PulsePoint.", + "RevenueMax.", + "Rubicon.", + "SmartClip.", + "SmartRTB+.", + "SmartstreamTv.", + "Sovrn.", + "SpotXchange.", + "Ströer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack.", + "Drax.", + "AppLovin MAX.", + "DT Fairbid.", + "Unity LevelPlay.", + "Chartboost Mediation.", + "AdMost.", + "TopOn.", + "Netflix.", + "Core.", + "Tubi." + ], + "type": "string" + }, + "guaranteedOrderId": { + "description": "Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.", + "readOnly": true, + "type": "string" + }, + "legacyGuaranteedOrderId": { + "description": "Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the guaranteed order.", + "readOnly": true, + "type": "string" + }, + "publisherName": { + "description": "Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "readAccessInherited": { + "description": "Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.", + "type": "boolean" + }, + "readAdvertiserIds": { + "description": "The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "readWriteAdvertiserId": { + "description": "The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.", + "format": "int64", + "type": "string" + }, + "readWritePartnerId": { + "description": "The partner with read/write access to the guaranteed order.", + "format": "int64", + "type": "string" + }, + "status": { + "$ref": "GuaranteedOrderStatus", + "description": "The status settings of the guaranteed order." + }, + "updateTime": { + "description": "Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GuaranteedOrderStatus": { + "description": "The status settings of the guaranteed order.", + "id": "GuaranteedOrderStatus", + "properties": { + "configStatus": { + "description": "Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.", + "enum": [ + "GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED", + "PENDING", + "COMPLETED" + ], + "enumDescriptions": [ + "The approval status is not specified or is unknown in this version.", + "The beginning state of a guaranteed order. The guaranteed order in this state needs to be configured before it can serve.", + "The state after the buyer configures a guaranteed order." + ], + "readOnly": true, + "type": "string" + }, + "entityPauseReason": { + "description": "The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.", + "type": "string" + }, + "entityStatus": { + "description": "Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + } + }, + "type": "object" + }, + "HouseholdIncomeAssignedTargetingOptionDetails": { + "description": "Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.", + "id": "HouseholdIncomeAssignedTargetingOptionDetails", + "properties": { + "householdIncome": { + "description": "Required. The household income of the audience.", + "enum": [ + "HOUSEHOLD_INCOME_UNSPECIFIED", + "HOUSEHOLD_INCOME_UNKNOWN", + "HOUSEHOLD_INCOME_LOWER_50_PERCENT", + "HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT", + "HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT", + "HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT", + "HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT", + "HOUSEHOLD_INCOME_TOP_10_PERCENT" + ], + "enumDescriptions": [ + "Default value when household income is not specified in this version. This enum is a placeholder for default value and does not represent a real household income option.", + "The household income of the audience is unknown.", + "The audience is in the lower 50% of U.S. household incomes.", + "The audience is in the top 41-50% of U.S. household incomes.", + "The audience is in the top 31-40% of U.S. household incomes.", + "The audience is in the top 21-30% of U.S. household incomes.", + "The audience is in the top 11-20% of U.S. household incomes.", + "The audience is in the top 10% of U.S. household incomes." + ], + "type": "string" + } + }, + "type": "object" + }, + "HouseholdIncomeTargetingOptionDetails": { + "description": "Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.", + "id": "HouseholdIncomeTargetingOptionDetails", + "properties": { + "householdIncome": { + "description": "Output only. The household income of an audience.", + "enum": [ + "HOUSEHOLD_INCOME_UNSPECIFIED", + "HOUSEHOLD_INCOME_UNKNOWN", + "HOUSEHOLD_INCOME_LOWER_50_PERCENT", + "HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT", + "HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT", + "HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT", + "HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT", + "HOUSEHOLD_INCOME_TOP_10_PERCENT" + ], + "enumDescriptions": [ + "Default value when household income is not specified in this version. This enum is a placeholder for default value and does not represent a real household income option.", + "The household income of the audience is unknown.", + "The audience is in the lower 50% of U.S. household incomes.", + "The audience is in the top 41-50% of U.S. household incomes.", + "The audience is in the top 31-40% of U.S. household incomes.", + "The audience is in the top 21-30% of U.S. household incomes.", + "The audience is in the top 11-20% of U.S. household incomes.", + "The audience is in the top 10% of U.S. household incomes." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "IdFilter": { + "description": "A filtering option that filters entities by their entity IDs.", + "id": "IdFilter", + "properties": { + "adGroupAdIds": { + "description": "YouTube Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "adGroupIds": { + "description": "YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "adGroupQaIds": { + "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" + }, + "type": "array" + }, + "campaignIds": { + "description": "Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "insertionOrderIds": { + "description": "Insertion Orders to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "lineItemIds": { + "description": "Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "lineItemQaIds": { + "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" + }, + "type": "array" + }, + "mediaProductIds": { + "description": "Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ImageAsset": { + "description": "Meta data of an image asset.", + "id": "ImageAsset", + "properties": { + "fileSize": { + "description": "File size of the image asset in bytes.", + "format": "int64", + "type": "string" + }, + "fullSize": { + "$ref": "Dimensions", + "description": "Metadata for this image at its original size." + }, + "mimeType": { + "description": "MIME type of the image asset.", + "type": "string" + } + }, + "type": "object" + }, + "InStreamAd": { + "description": "Details for an in-stream ad.", + "id": "InStreamAd", + "properties": { + "commonInStreamAttribute": { + "$ref": "CommonInStreamAttribute", + "description": "Common ad attributes." + }, + "customParameters": { + "additionalProperties": { + "type": "string" + }, + "description": "The custom parameters to pass custom values to tracking URL template.", + "type": "object" + } + }, + "type": "object" + }, + "InsertionOrder": { + "description": "A single insertion order.", + "id": "InsertionOrder", + "properties": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the insertion order belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "bidStrategy": { + "$ref": "BiddingStrategy", + "description": "Optional. The bidding strategy of the insertion order. By default, fixed_bid is set." + }, + "budget": { + "$ref": "InsertionOrderBudget", + "description": "Required. The budget allocation settings of the insertion order." + }, + "campaignId": { + "description": "Required. Immutable. The unique ID of the campaign that the insertion order belongs to.", + "format": "int64", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "frequencyCap": { + "$ref": "FrequencyCap", + "description": "Required. The frequency capping setting of the insertion order." + }, + "insertionOrderId": { + "description": "Output only. The unique ID of the insertion order. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "insertionOrderType": { + "description": "Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", + "enum": [ + "INSERTION_ORDER_TYPE_UNSPECIFIED", + "RTB", + "OVER_THE_TOP" + ], + "enumDescriptions": [ + "Insertion order type is not specified or is unknown.", + "Real-time bidding.", + "Over-the-top." + ], + "type": "string" + }, + "integrationDetails": { + "$ref": "IntegrationDetails", + "description": "Optional. Additional integration details of the insertion order." + }, + "kpi": { + "$ref": "Kpi", + "description": "Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the \"Goal\" in the Display & Video 360 interface." + }, + "name": { + "description": "Output only. The resource name of the insertion order.", + "readOnly": true, + "type": "string" + }, + "optimizationObjective": { + "description": "Optional. Required. The optimization objective of the insertion order.", + "enum": [ + "OPTIMIZATION_OBJECTIVE_UNSPECIFIED", + "CONVERSION", + "CLICK", + "BRAND_AWARENESS", + "CUSTOM", + "NO_OBJECTIVE" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Prioritize impressions that increase sales and conversions.", + "Prioritize impressions that increase website traffic, apps, app stores.", + "Prioritize impressions of specific quality.", + "Objective is defined by the assigned custom bidding algorithm.", + "Objective is not defined. Any KPI or bidding strategy can be used." + ], + "type": "string" + }, + "pacing": { + "$ref": "Pacing", + "description": "Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`." + }, + "partnerCosts": { + "description": "Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", + "items": { + "$ref": "PartnerCost" + }, + "type": "array" + }, + "reservationType": { + "description": "Output only. The reservation type of the insertion order.", + "enum": [ + "RESERVATION_TYPE_UNSPECIFIED", + "RESERVATION_TYPE_NOT_GUARANTEED", + "RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED", + "RESERVATION_TYPE_TAG_GUARANTEED", + "RESERVATION_TYPE_PETRA_VIRAL", + "RESERVATION_TYPE_INSTANT_RESERVE" + ], + "enumDescriptions": [ + "Reservation type value is not specified or is unknown in this version.", + "Not created through a guaranteed inventory source.", + "Created through a programmatic guaranteed inventory source.", + "Created through a tag guaranteed inventory source.", + "Created through a Petra inventory source. Only applicable to YouTube and Partners line items.", + "Created with an instant quote. Only applicable to YouTube and partners line items." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the insertion order was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InsertionOrderBudget": { + "description": "Settings that control how insertion order budget is allocated.", + "id": "InsertionOrderBudget", + "properties": { + "automationType": { + "description": "Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.", + "enum": [ + "INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED", + "INSERTION_ORDER_AUTOMATION_TYPE_BUDGET", + "INSERTION_ORDER_AUTOMATION_TYPE_NONE", + "INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET" + ], + "enumDescriptions": [ + "Insertion order automation option is not specified or is unknown in this version.", + "Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.", + "No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.", + "Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi." + ], + "type": "string" + }, + "budgetSegments": { + "description": "Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.", + "items": { + "$ref": "InsertionOrderBudgetSegment" + }, + "type": "array" + }, + "budgetUnit": { + "description": "Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.", + "enum": [ + "BUDGET_UNIT_UNSPECIFIED", + "BUDGET_UNIT_CURRENCY", + "BUDGET_UNIT_IMPRESSIONS" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Budgeting in currency amounts.", + "Budgeting in impression amounts." + ], + "type": "string" + } + }, + "type": "object" + }, + "InsertionOrderBudgetSegment": { + "description": "Settings that control the budget of a single budget segment.", + "id": "InsertionOrderBudgetSegment", + "properties": { + "budgetAmountMicros": { + "description": "Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "campaignBudgetId": { + "description": "Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of.", + "format": "int64", + "type": "string" + }, + "dateRange": { + "$ref": "DateRange", + "description": "Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." + }, + "description": { + "description": "Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded.", + "type": "string" + } + }, + "type": "object" + }, + "IntegralAdScience": { + "description": "Details of Integral Ad Science settings.", + "id": "IntegralAdScience", + "properties": { + "customSegmentId": { + "description": "The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "displayViewability": { + "description": "Display Viewability section (applicable to display line items only).", + "enum": [ + "PERFORMANCE_VIEWABILITY_UNSPECIFIED", + "PERFORMANCE_VIEWABILITY_40", + "PERFORMANCE_VIEWABILITY_50", + "PERFORMANCE_VIEWABILITY_60", + "PERFORMANCE_VIEWABILITY_70" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any display viewability options.", + "Target 40% Viewability or Higher.", + "Target 50% Viewability or Higher.", + "Target 60% Viewability or Higher.", + "Target 70% Viewability or Higher." + ], + "type": "string" + }, + "excludeUnrateable": { + "description": "Brand Safety - **Unrateable**.", + "type": "boolean" + }, + "excludedAdFraudRisk": { + "description": "Ad Fraud settings.", + "enum": [ + "SUSPICIOUS_ACTIVITY_UNSPECIFIED", + "SUSPICIOUS_ACTIVITY_HR", + "SUSPICIOUS_ACTIVITY_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any ad fraud prevention options.", + "Ad Fraud - Exclude High Risk.", + "Ad Fraud - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "excludedAdultRisk": { + "description": "Brand Safety - **Adult content**.", + "enum": [ + "ADULT_UNSPECIFIED", + "ADULT_HR", + "ADULT_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any adult options.", + "Adult - Exclude High Risk.", + "Adult - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "excludedAlcoholRisk": { + "description": "Brand Safety - **Alcohol**.", + "enum": [ + "ALCOHOL_UNSPECIFIED", + "ALCOHOL_HR", + "ALCOHOL_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any alcohol options.", + "Alcohol - Exclude High Risk.", + "Alcohol - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "excludedDrugsRisk": { + "description": "Brand Safety - **Drugs**.", + "enum": [ + "DRUGS_UNSPECIFIED", + "DRUGS_HR", + "DRUGS_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any drugs options.", + "Drugs - Exclude High Risk.", + "Drugs - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "excludedGamblingRisk": { + "description": "Brand Safety - **Gambling**.", + "enum": [ + "GAMBLING_UNSPECIFIED", + "GAMBLING_HR", + "GAMBLING_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any gambling options.", + "Gambling - Exclude High Risk.", + "Gambling - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "excludedHateSpeechRisk": { + "description": "Brand Safety - **Hate speech**.", + "enum": [ + "HATE_SPEECH_UNSPECIFIED", + "HATE_SPEECH_HR", + "HATE_SPEECH_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any hate speech options.", + "Hate Speech - Exclude High Risk.", + "Hate Speech - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "excludedIllegalDownloadsRisk": { + "description": "Brand Safety - **Illegal downloads**.", + "enum": [ + "ILLEGAL_DOWNLOADS_UNSPECIFIED", + "ILLEGAL_DOWNLOADS_HR", + "ILLEGAL_DOWNLOADS_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any illegal downloads options.", + "Illegal Downloads - Exclude High Risk.", + "Illegal Downloads - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "excludedOffensiveLanguageRisk": { + "description": "Brand Safety - **Offensive language**.", + "enum": [ + "OFFENSIVE_LANGUAGE_UNSPECIFIED", + "OFFENSIVE_LANGUAGE_HR", + "OFFENSIVE_LANGUAGE_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any language options.", + "Offensive Language - Exclude High Risk.", + "Offensive Language - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "excludedViolenceRisk": { + "description": "Brand Safety - **Violence**.", + "enum": [ + "VIOLENCE_UNSPECIFIED", + "VIOLENCE_HR", + "VIOLENCE_HMR" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any violence options.", + "Violence - Exclude High Risk.", + "Violence - Exclude High and Moderate Risk." + ], + "type": "string" + }, + "qualitySyncCustomSegmentId": { + "description": "Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "traqScoreOption": { + "description": "True advertising quality (applicable to Display line items only).", + "enum": [ + "TRAQ_UNSPECIFIED", + "TRAQ_250", + "TRAQ_500", + "TRAQ_600", + "TRAQ_700", + "TRAQ_750", + "TRAQ_875", + "TRAQ_1000" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any true advertising quality scores.", + "TRAQ score 250-1000.", + "TRAQ score 500-1000.", + "TRAQ score 600-1000.", + "TRAQ score 700-1000.", + "TRAQ score 750-1000.", + "TRAQ score 875-1000.", + "TRAQ score 1000." + ], + "type": "string" + }, + "videoViewability": { + "description": "Video Viewability Section (applicable to video line items only).", + "enum": [ + "VIDEO_VIEWABILITY_UNSPECIFIED", + "VIDEO_VIEWABILITY_40", + "VIDEO_VIEWABILITY_50", + "VIDEO_VIEWABILITY_60", + "VIDEO_VIEWABILITY_70" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any video viewability options.", + "40%+ in view (IAB video viewability standard).", + "50%+ in view (IAB video viewability standard).", + "60%+ in view (IAB video viewability standard).", + "70%+ in view (IAB video viewability standard)." + ], + "type": "string" + } + }, + "type": "object" + }, + "IntegrationDetails": { + "description": "Integration details of an entry.", + "id": "IntegrationDetails", + "properties": { + "details": { + "description": "Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.", + "type": "string" + }, + "integrationCode": { + "description": "An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.", + "type": "string" + } + }, + "type": "object" + }, + "InventorySource": { + "description": "An inventory source.", + "id": "InventorySource", + "properties": { + "commitment": { + "description": "Whether the inventory source has a guaranteed or non-guaranteed delivery.", + "enum": [ + "INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED", + "INVENTORY_SOURCE_COMMITMENT_GUARANTEED", + "INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED" + ], + "enumDescriptions": [ + "The commitment is not specified or is unknown in this version.", + "The commitment is guaranteed delivery.", + "The commitment is non-guaranteed delivery." + ], + "type": "string" + }, + "creativeConfigs": { + "description": "The creative requirements of the inventory source. Not applicable for auction packages.", + "items": { + "$ref": "CreativeConfig" + }, + "type": "array" + }, + "dealId": { + "description": "The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.", + "type": "string" + }, + "deliveryMethod": { + "description": "The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.", + "enum": [ + "INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED", + "INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC", + "INVENTORY_SOURCE_DELIVERY_METHOD_TAG" + ], + "enumDescriptions": [ + "The delivery method is not specified or is unknown in this version.", + "The delivery method is programmatic.", + "The delivery method is tag." + ], + "type": "string" + }, + "displayName": { + "description": "The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "exchange": { + "description": "The exchange to which the inventory source belongs.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK", + "EXCHANGE_DRAX", + "EXCHANGE_APPLOVIN_GBID", + "EXCHANGE_FYBER_GBID", + "EXCHANGE_UNITY_GBID", + "EXCHANGE_CHARTBOOST_GBID", + "EXCHANGE_ADMOST_GBID", + "EXCHANGE_TOPON_GBID", + "EXCHANGE_NETFLIX", + "EXCHANGE_CORE", + "EXCHANGE_TUBI" + ], + "enumDescriptions": [ + "Exchange is not specified or is unknown in this version.", + "Google Ad Manager.", + "AppNexus.", + "BrightRoll Exchange for Video from Yahoo!.", + "Adform.", + "Admeta.", + "Admixer.", + "AdsMogo.", + "AdsWizz.", + "BidSwitch.", + "BrightRoll Exchange for Display from Yahoo!.", + "Cadreon.", + "Dailymotion.", + "Five.", + "Fluct.", + "FreeWheel SSP.", + "Geniee.", + "GumGum.", + "i-mobile.", + "iBILLBOARD.", + "Improve Digital.", + "Index Exchange.", + "Kargo.", + "MicroAd.", + "MoPub.", + "Nend.", + "ONE by AOL: Display Market Place.", + "ONE by AOL: Mobile.", + "ONE by AOL: Video.", + "Ooyala.", + "OpenX.", + "Permodo.", + "Platform One.", + "PlatformId.", + "PubMatic.", + "PulsePoint.", + "RevenueMax.", + "Rubicon.", + "SmartClip.", + "SmartRTB+.", + "SmartstreamTv.", + "Sovrn.", + "SpotXchange.", + "Ströer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack.", + "Drax.", + "AppLovin MAX.", + "DT Fairbid.", + "Unity LevelPlay.", + "Chartboost Mediation.", + "AdMost.", + "TopOn.", + "Netflix.", + "Core.", + "Tubi." + ], + "type": "string" + }, + "guaranteedOrderId": { + "description": "Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.", + "type": "string" + }, + "inventorySourceId": { + "description": "Output only. The unique ID of the inventory source. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "inventorySourceProductType": { + "description": "Output only. The product type of the inventory source, denoting the way through which it sells inventory.", + "enum": [ + "INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED", + "PREFERRED_DEAL", + "PRIVATE_AUCTION", + "PROGRAMMATIC_GUARANTEED", + "TAG_GUARANTEED", + "YOUTUBE_RESERVE", + "INSTANT_RESERVE", + "GUARANTEED_PACKAGE", + "PROGRAMMATIC_TV", + "AUCTION_PACKAGE" + ], + "enumDescriptions": [ + "The product type is not specified or is unknown in this version. Modifying inventory sources of this product type are not supported via API.", + "The inventory source sells inventory through Preferred Deal.", + "The inventory source sells inventory through Private Auction.", + "The inventory source sells inventory through Programmatic Guaranteed.", + "The inventory source sells inventory through Tag Guaranteed.", + "The inventory source sells inventory through YouTube Reserve.", + "The inventory source sells inventory through Instant Reserve. Modifying inventory sources of this product type are not supported via API.", + "The inventory source sells inventory through Guaranteed Package. Modifying inventory sources of this product type are not supported via API.", + "The inventory source sells inventory through Programmtic TV. Modifying inventory sources of this product type are not supported via API.", + "The inventory source sells inventory through Auction Package. Modifying inventory sources of this product type are not supported via API." + ], + "readOnly": true, + "type": "string" + }, + "inventorySourceType": { + "description": "Denotes the type of the inventory source.", + "enum": [ + "INVENTORY_SOURCE_TYPE_UNSPECIFIED", + "INVENTORY_SOURCE_TYPE_PRIVATE", + "INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE" + ], + "enumDescriptions": [ + "The inventory source type is not specified or is unknown in this version.", + "Private inventory source.", + "Auction package." + ], + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the inventory source.", + "readOnly": true, + "type": "string" + }, + "publisherName": { + "description": "The publisher/seller name of the inventory source.", + "type": "string" + }, + "rateDetails": { + "$ref": "RateDetails", + "description": "Required. The rate details of the inventory source." + }, + "readAdvertiserIds": { + "description": "Output only. The IDs of advertisers with read-only access to the inventory source.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "readPartnerIds": { + "description": "Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "readWriteAccessors": { + "$ref": "InventorySourceAccessors", + "description": "The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids." + }, + "status": { + "$ref": "InventorySourceStatus", + "description": "The status settings of the inventory source." + }, + "timeRange": { + "$ref": "TimeRange", + "description": "The time range when this inventory source starts and stops serving." + }, + "updateTime": { + "description": "Output only. The timestamp when the inventory source was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceAccessors": { + "description": "The partner or advertisers with access to the inventory source.", + "id": "InventorySourceAccessors", + "properties": { + "advertisers": { + "$ref": "InventorySourceAccessorsAdvertiserAccessors", + "description": "The advertisers with access to the inventory source. All advertisers must belong to the same partner." + }, + "partner": { + "$ref": "InventorySourceAccessorsPartnerAccessor", + "description": "The partner with access to the inventory source." + } + }, + "type": "object" + }, + "InventorySourceAccessorsAdvertiserAccessors": { + "description": "The advertisers with access to the inventory source.", + "id": "InventorySourceAccessorsAdvertiserAccessors", + "properties": { + "advertiserIds": { + "description": "The IDs of the advertisers.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InventorySourceAccessorsPartnerAccessor": { + "description": "The partner with access to the inventory source.", + "id": "InventorySourceAccessorsPartnerAccessor", + "properties": { + "partnerId": { + "description": "The ID of the partner.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceAssignedTargetingOptionDetails": { + "description": "Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.", + "id": "InventorySourceAssignedTargetingOptionDetails", + "properties": { + "inventorySourceId": { + "description": "Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceDisplayCreativeConfig": { + "description": "The configuration for display creatives.", + "id": "InventorySourceDisplayCreativeConfig", + "properties": { + "creativeSize": { + "$ref": "Dimensions", + "description": "The size requirements for display creatives that can be assigned to the inventory source." + } + }, + "type": "object" + }, + "InventorySourceFilter": { + "description": "A filtering option for filtering on Inventory Source entities.", + "id": "InventorySourceFilter", + "properties": { + "inventorySourceIds": { + "description": "Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InventorySourceGroup": { + "description": "A collection of targetable inventory sources.", + "id": "InventorySourceGroup", + "properties": { + "displayName": { + "description": "Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Output only. The unique ID of the inventory source group. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the inventory source group.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceGroupAssignedTargetingOptionDetails": { + "description": "Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.", + "id": "InventorySourceGroupAssignedTargetingOptionDetails", + "properties": { + "inventorySourceGroupId": { + "description": "Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceStatus": { + "description": "The status related settings of the inventory source.", + "id": "InventorySourceStatus", + "properties": { + "configStatus": { + "description": "Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.", + "enum": [ + "INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED", + "INVENTORY_SOURCE_CONFIG_STATUS_PENDING", + "INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED" + ], + "enumDescriptions": [ + "The approval status is not specified or is unknown in this version.", + "The beginning state of a guaranteed inventory source. The inventory source in this state needs to be configured.", + "The state after the buyer configures a guaranteed inventory source." + ], + "readOnly": true, + "type": "string" + }, + "entityPauseReason": { + "description": "The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.", + "type": "string" + }, + "entityStatus": { + "description": "Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "sellerPauseReason": { + "description": "Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.", + "readOnly": true, + "type": "string" + }, + "sellerStatus": { + "description": "Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceVideoCreativeConfig": { + "description": "The configuration for video creatives.", + "id": "InventorySourceVideoCreativeConfig", + "properties": { + "duration": { + "description": "The duration requirements for the video creatives that can be assigned to the inventory source.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "Invoice": { + "description": "A single invoice.", + "id": "Invoice", + "properties": { + "budgetInvoiceGroupingId": { + "description": "The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to \"Budget invoice grouping ID\".", + "type": "string" + }, + "budgetSummaries": { + "description": "The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to \"Budget level PO\".", + "items": { + "$ref": "BudgetSummary" + }, + "type": "array" + }, + "correctedInvoiceId": { + "description": "The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty.", + "type": "string" + }, + "currencyCode": { + "description": "The currency used in the invoice in ISO 4217 format.", + "type": "string" + }, + "displayName": { + "description": "The display name of the invoice.", + "type": "string" + }, + "dueDate": { + "$ref": "Date", + "description": "The date when the invoice is due." + }, + "invoiceId": { + "description": "The unique ID of the invoice.", + "type": "string" + }, + "invoiceType": { + "description": "The type of invoice document.", + "enum": [ + "INVOICE_TYPE_UNSPECIFIED", + "INVOICE_TYPE_CREDIT", + "INVOICE_TYPE_INVOICE" + ], + "enumDescriptions": [ + "Not specified or is unknown in this version.", + "The invoice has a negative amount.", + "The invoice has a positive amount." + ], + "type": "string" + }, + "issueDate": { + "$ref": "Date", + "description": "The date when the invoice was issued." + }, + "name": { + "description": "The resource name of the invoice.", + "type": "string" + }, + "nonBudgetMicros": { + "description": "The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "paymentsAccountId": { + "description": "The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.", + "type": "string" + }, + "paymentsProfileId": { + "description": "The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.", + "type": "string" + }, + "pdfUrl": { + "description": "The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again.", + "type": "string" + }, + "purchaseOrderNumber": { + "description": "Purchase order number associated with the invoice.", + "type": "string" + }, + "replacedInvoiceIds": { + "description": "The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty.", + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceDateRange": { + "$ref": "DateRange", + "description": "The service start and end dates which are covered by this invoice." + }, + "subtotalAmountMicros": { + "description": "The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "totalAmountMicros": { + "description": "The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "totalTaxAmountMicros": { + "description": "The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "KeywordAssignedTargetingOptionDetails": { + "description": "Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`.", + "id": "KeywordAssignedTargetingOptionDetails", + "properties": { + "keyword": { + "description": "Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.", + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + } + }, + "type": "object" + }, + "Kpi": { + "description": "Settings that control the key performance indicator, or KPI, of an insertion order.", + "id": "Kpi", + "properties": { + "kpiAlgorithmId": { + "description": "Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.", + "format": "int64", + "type": "string" + }, + "kpiAmountMicros": { + "description": "The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "kpiPercentageMicros": { + "description": "The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).", + "format": "int64", + "type": "string" + }, + "kpiString": { + "description": "A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.", + "type": "string" + }, + "kpiType": { + "description": "Required. The type of KPI.", + "enum": [ + "KPI_TYPE_UNSPECIFIED", + "KPI_TYPE_CPM", + "KPI_TYPE_CPC", + "KPI_TYPE_CPA", + "KPI_TYPE_CTR", + "KPI_TYPE_VIEWABILITY", + "KPI_TYPE_CPIAVC", + "KPI_TYPE_CPE", + "KPI_TYPE_CPV", + "KPI_TYPE_CLICK_CVR", + "KPI_TYPE_IMPRESSION_CVR", + "KPI_TYPE_VCPM", + "KPI_TYPE_VTR", + "KPI_TYPE_AUDIO_COMPLETION_RATE", + "KPI_TYPE_VIDEO_COMPLETION_RATE", + "KPI_TYPE_CPCL", + "KPI_TYPE_CPCV", + "KPI_TYPE_TOS10", + "KPI_TYPE_MAXIMIZE_PACING", + "KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST", + "KPI_TYPE_OTHER" + ], + "enumDescriptions": [ + "KPI type is not specified or is unknown in this version.", + "The KPI is CPM (cost per mille).", + "The KPI is CPC (cost per click).", + "The KPI is CPA (cost per action).", + "The KPI is CTR (click-through rate) percentage.", + "The KPI is Viewability percentage.", + "The KPI is CPIAVC (cost per impression audible and visible at completion).", + "The KPI is CPE (cost per engagement).", + "The KPI is set in CPV (cost per view).", + "The KPI is click conversion rate (conversions per click) percentage.", + "The KPI is impression conversion rate (conversions per impression) percentage.", + "The KPI is VCPM (cost per thousand viewable impressions).", + "The KPI is YouTube view rate (YouTube views per impression) percentage.", + "The KPI is audio completion rate (complete audio listens per impression) percentage.", + "The KPI is video completion rate (complete video views per impression) percentage.", + "The KPI is set in CPCL (cost per complete audio listen).", + "The KPI is set in CPCV (cost per complete video view).", + "The KPI is set in rate of time on screen 10+ seconds (Percentage of measurable, non-skippable impressions that were on the screen for at least 10 seconds).", + "The KPI is set to maximize brand impact while prioritizing spending the full budget.", + "The KPI is set in custom impression value divided by cost.", + "The KPI is some other value." + ], + "type": "string" + } + }, + "type": "object" + }, + "LanguageAssignedTargetingOptionDetails": { + "description": "Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`.", + "id": "LanguageAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the language (e.g., \"French\").", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.", + "type": "string" + } + }, + "type": "object" + }, + "LanguageTargetingOptionDetails": { + "description": "Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`.", + "id": "LanguageTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the language (e.g., \"French\").", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LineItem": { + "description": "A single line item.", + "id": "LineItem", + "properties": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the line item belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "bidStrategy": { + "$ref": "BiddingStrategy", + "description": "Required. The bidding strategy of the line item." + }, + "budget": { + "$ref": "LineItemBudget", + "description": "Required. The budget allocation setting of the line item." + }, + "campaignId": { + "description": "Output only. The unique ID of the campaign that the line item belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "conversionCounting": { + "$ref": "ConversionCountingConfig", + "description": "The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight)." + }, + "creativeIds": { + "description": "The IDs of the creatives associated with the line item.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "excludeNewExchanges": { + "description": "Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.", + "type": "boolean" + }, + "flight": { + "$ref": "LineItemFlight", + "description": "Required. The start and end time of the line item's flight." + }, + "frequencyCap": { + "$ref": "FrequencyCap", + "description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." + }, + "insertionOrderId": { + "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", + "format": "int64", + "type": "string" + }, + "integrationDetails": { + "$ref": "IntegrationDetails", + "description": "Integration details of the line item." + }, + "lineItemId": { + "description": "Output only. The unique ID of the line item. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "lineItemType": { + "description": "Required. Immutable. The type of the line item.", + "enum": [ + "LINE_ITEM_TYPE_UNSPECIFIED", + "LINE_ITEM_TYPE_DISPLAY_DEFAULT", + "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL", + "LINE_ITEM_TYPE_VIDEO_DEFAULT", + "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL", + "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY", + "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY", + "LINE_ITEM_TYPE_AUDIO_DEFAULT", + "LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", + "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", + "LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", + "Image, HTML5, native, or rich media ads.", + "Display ads that drive installs of an app.", + "Video ads sold on a CPM basis for a variety of environments.", + "Video ads that drive installs of an app.", + "Display ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "RTB Audio ads sold for a variety of environments.", + "Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertion_order_type `OVER_THE_TOP`.", + "YouTube video ads that promote conversions. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that show a story in a particular sequence using a mix of formats. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube audio ads. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", + "Default YouTube video ads. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV youTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV youTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.", + "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", + "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." + ], + "type": "string" + }, + "mobileApp": { + "$ref": "MobileApp", + "description": "The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`." + }, + "name": { + "description": "Output only. The resource name of the line item.", + "readOnly": true, + "type": "string" + }, + "pacing": { + "$ref": "Pacing", + "description": "Required. The budget spending speed setting of the line item." + }, + "partnerCosts": { + "description": "The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.", + "items": { + "$ref": "PartnerCost" + }, + "type": "array" + }, + "partnerRevenueModel": { + "$ref": "PartnerRevenueModel", + "description": "Required. The partner revenue model setting of the line item." + }, + "reservationType": { + "description": "Output only. The reservation type of the line item.", + "enum": [ + "RESERVATION_TYPE_UNSPECIFIED", + "RESERVATION_TYPE_NOT_GUARANTEED", + "RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED", + "RESERVATION_TYPE_TAG_GUARANTEED", + "RESERVATION_TYPE_PETRA_VIRAL", + "RESERVATION_TYPE_INSTANT_RESERVE" + ], + "enumDescriptions": [ + "Reservation type value is not specified or is unknown in this version.", + "Not created through a guaranteed inventory source.", + "Created through a programmatic guaranteed inventory source.", + "Created through a tag guaranteed inventory source.", + "Created through a Petra inventory source. Only applicable to YouTube and Partners line items.", + "Created with an instant quote. Only applicable to YouTube and partners line items." + ], + "readOnly": true, + "type": "string" + }, + "targetingExpansion": { + "$ref": "TargetingExpansionConfig", + "description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists." + }, + "updateTime": { + "description": "Output only. The timestamp when the line item was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "warningMessages": { + "description": "Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.", + "items": { + "enum": [ + "LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED", + "INVALID_FLIGHT_DATES", + "EXPIRED", + "PENDING_FLIGHT", + "ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED", + "INVALID_INVENTORY_SOURCE", + "APP_INVENTORY_INVALID_SITE_TARGETING", + "APP_INVENTORY_INVALID_AUDIENCE_LISTS", + "NO_VALID_CREATIVE", + "PARENT_INSERTION_ORDER_PAUSED", + "PARENT_INSERTION_ORDER_EXPIRED" + ], + "enumDescriptions": [ + "Not specified or is unknown.", + "This line item has invalid flight dates. The line item will not run.", + "This line item's end date is in the past.", + "This line item will begin running in the future.", + "All partner enabled exchanges are negatively targeted. The line item will not run.", + "No active inventory sources are being targeted. The line item will not run.", + "This line item's Apps & URLs targeting doesn't include any mobile apps. This line item's type requires you to include mobile apps in your channel, sitelist, or apps targeting. The line item will not run.", + "This line item isn't targeting any mobile users. This line item's type requires you to target a user list with mobile users. The line item will not run.", + "This line item does not contain any valid creative. The line item will not run.", + "The insertion order of this line item is paused. The line item will not run.", + "The insertion order of this line item has its end date set in the past. The line item will not run." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "youtubeAndPartnersSettings": { + "$ref": "YoutubeAndPartnersSettings", + "description": "Output only. Settings specific to YouTube and Partners line items.", + "readOnly": true + } + }, + "type": "object" + }, + "LineItemAssignedTargetingOption": { + "description": "Wrapper object associating an assigned_targeting_option resource and the line item it is assigned to.", + "id": "LineItemAssignedTargetingOption", + "properties": { + "assignedTargetingOption": { + "$ref": "AssignedTargetingOption", + "description": "The assigned targeting option resource." + }, + "lineItemId": { + "description": "The ID of the line item the assigned targeting option is assigned to.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "LineItemBudget": { + "description": "Settings that control how budget is allocated.", + "id": "LineItemBudget", + "properties": { + "budgetAllocationType": { + "description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.", + "enum": [ + "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", + "LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", + "LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED", + "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Automatic budget allocation is enabled for the line item.", + "A fixed max budget amount is allocated for the line item.", + "No budget limit is applied to the line item." + ], + "type": "string" + }, + "budgetUnit": { + "description": "Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.", + "enum": [ + "BUDGET_UNIT_UNSPECIFIED", + "BUDGET_UNIT_CURRENCY", + "BUDGET_UNIT_IMPRESSIONS" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Budgeting in currency amounts.", + "Budgeting in impression amounts." + ], + "readOnly": true, + "type": "string" + }, + "maxAmount": { + "description": "The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "LineItemFlight": { + "description": "Settings that control the active duration of a line item.", + "id": "LineItemFlight", + "properties": { + "dateRange": { + "$ref": "DateRange", + "description": "The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." + }, + "flightDateType": { + "description": "Required. The type of the line item's flight dates.", + "enum": [ + "LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED", + "LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED", + "LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The line item's flight dates are inherited from its parent insertion order.", + "The line item uses its own custom flight dates." + ], + "type": "string" + } + }, + "type": "object" + }, + "ListAdGroupAdsResponse": { + "id": "ListAdGroupAdsResponse", + "properties": { + "adGroupAds": { + "description": "The list of ad group ads. This list will be absent if empty.", + "items": { + "$ref": "AdGroupAd" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdGroupAssignedTargetingOptionsResponse": { + "description": "Response message for ListAdGroupAssignedTargetingOptions.", + "id": "ListAdGroupAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdGroupAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more AssignedTargetingOption resources to return.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdGroupsResponse": { + "id": "ListAdGroupsResponse", + "properties": { + "adGroups": { + "description": "The list of ad groups. This list will be absent if empty.", + "items": { + "$ref": "AdGroup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroups` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdvertiserAssignedTargetingOptionsResponse": { + "description": "Response message for ListAdvertiserAssignedTargetingOptions.", + "id": "ListAdvertiserAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdvertisersResponse": { + "id": "ListAdvertisersResponse", + "properties": { + "advertisers": { + "description": "The list of advertisers. This list will be absent if empty.", + "items": { + "$ref": "Advertiser" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdvertisers` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAssignedInventorySourcesResponse": { + "description": "Response message for AssignedInventorySourceService.ListAssignedInventorySources.", + "id": "ListAssignedInventorySourcesResponse", + "properties": { + "assignedInventorySources": { + "description": "The list of assigned inventory sources. This list will be absent if empty.", + "items": { + "$ref": "AssignedInventorySource" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedInventorySources` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAssignedLocationsResponse": { + "description": "Response message for AssignedLocationService.ListAssignedLocations.", + "id": "ListAssignedLocationsResponse", + "properties": { + "assignedLocations": { + "description": "The list of assigned locations. This list will be absent if empty.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedLocations` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListCampaignsResponse": { + "id": "ListCampaignsResponse", + "properties": { + "campaigns": { + "description": "The list of campaigns. This list will be absent if empty.", + "items": { + "$ref": "Campaign" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCampaigns` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListChannelsResponse": { + "id": "ListChannelsResponse", + "properties": { + "channels": { + "description": "The list of channels. This list will be absent if empty.", + "items": { + "$ref": "Channel" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListCombinedAudiencesResponse": { + "id": "ListCombinedAudiencesResponse", + "properties": { + "combinedAudiences": { + "description": "The list of combined audiences. This list will be absent if empty.", + "items": { + "$ref": "CombinedAudience" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCombinedAudiences` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListCreativesResponse": { + "id": "ListCreativesResponse", + "properties": { + "creatives": { + "description": "The list of creatives. This list will be absent if empty.", + "items": { + "$ref": "Creative" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCreativesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomBiddingAlgorithmRulesResponse": { + "id": "ListCustomBiddingAlgorithmRulesResponse", + "properties": { + "customBiddingRules": { + "description": "The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty.", + "items": { + "$ref": "CustomBiddingAlgorithmRules" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomBiddingAlgorithmsResponse": { + "id": "ListCustomBiddingAlgorithmsResponse", + "properties": { + "customBiddingAlgorithms": { + "description": "The list of custom bidding algorithms. This list will be absent if empty.", + "items": { + "$ref": "CustomBiddingAlgorithm" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomBiddingScriptsResponse": { + "id": "ListCustomBiddingScriptsResponse", + "properties": { + "customBiddingScripts": { + "description": "The list of custom bidding scripts. This list will be absent if empty.", + "items": { + "$ref": "CustomBiddingScript" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingScriptsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomListsResponse": { + "id": "ListCustomListsResponse", + "properties": { + "customLists": { + "description": "The list of custom lists. This list will be absent if empty.", + "items": { + "$ref": "CustomList" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomLists` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListFirstPartyAndPartnerAudiencesResponse": { + "id": "ListFirstPartyAndPartnerAudiencesResponse", + "properties": { + "firstPartyAndPartnerAudiences": { + "description": "The list of first party and partner audiences. Audience size properties will not be included. This list will be absent if empty.", + "items": { + "$ref": "FirstPartyAndPartnerAudience" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstPartyAndPartnerAudiences` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListFloodlightActivitiesResponse": { + "id": "ListFloodlightActivitiesResponse", + "properties": { + "floodlightActivities": { + "description": "The list of Floodlight activities. This list will be absent if empty.", + "items": { + "$ref": "FloodlightActivity" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFloodlightActivities` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListGoogleAudiencesResponse": { + "id": "ListGoogleAudiencesResponse", + "properties": { + "googleAudiences": { + "description": "The list of Google audiences. This list will be absent if empty.", + "items": { + "$ref": "GoogleAudience" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGoogleAudiences` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListGuaranteedOrdersResponse": { + "id": "ListGuaranteedOrdersResponse", + "properties": { + "guaranteedOrders": { + "description": "The list of guaranteed orders. This list will be absent if empty.", + "items": { + "$ref": "GuaranteedOrder" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGuaranteedOrders` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListInsertionOrdersResponse": { + "id": "ListInsertionOrdersResponse", + "properties": { + "insertionOrders": { + "description": "The list of insertion orders. This list will be absent if empty.", + "items": { + "$ref": "InsertionOrder" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInsertionOrders` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListInventorySourceGroupsResponse": { + "description": "Response message for InventorySourceGroupService.ListInventorySourceGroups.", + "id": "ListInventorySourceGroupsResponse", + "properties": { + "inventorySourceGroups": { + "description": "The list of inventory source groups. This list will be absent if empty.", + "items": { + "$ref": "InventorySourceGroup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySourceGroups` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListInventorySourcesResponse": { + "id": "ListInventorySourcesResponse", + "properties": { + "inventorySources": { + "description": "The list of inventory sources. This list will be absent if empty.", + "items": { + "$ref": "InventorySource" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListInvoicesResponse": { + "id": "ListInvoicesResponse", + "properties": { + "invoices": { + "description": "The list of invoices. This list will be absent if empty.", + "items": { + "$ref": "Invoice" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInvoices` method to retrieve the next page of results. This token will be absent if there are no more invoices to return.", + "type": "string" + } + }, + "type": "object" + }, + "ListLineItemAssignedTargetingOptionsResponse": { + "description": "Response message for ListLineItemAssignedTargetingOptions.", + "id": "ListLineItemAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "ListLineItemsResponse": { + "id": "ListLineItemsResponse", + "properties": { + "lineItems": { + "description": "The list of line items. This list will be absent if empty.", + "items": { + "$ref": "LineItem" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLineItems` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListLocationListsResponse": { + "id": "ListLocationListsResponse", + "properties": { + "locationLists": { + "description": "The list of location lists. This list will be absent if empty.", + "items": { + "$ref": "LocationList" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLocationLists` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListNegativeKeywordListsResponse": { + "description": "Response message for NegativeKeywordListService.ListNegativeKeywordLists.", + "id": "ListNegativeKeywordListsResponse", + "properties": { + "negativeKeywordLists": { + "description": "The list of negative keyword lists. This list will be absent if empty.", + "items": { + "$ref": "NegativeKeywordList" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywordLists` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListNegativeKeywordsResponse": { + "description": "Response message for NegativeKeywordService.ListNegativeKeywords.", + "id": "ListNegativeKeywordsResponse", + "properties": { + "negativeKeywords": { + "description": "The list of negative keywords. This list will be absent if empty.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywords` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListPartnerAssignedTargetingOptionsResponse": { + "id": "ListPartnerAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListPartnerAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "ListPartnersResponse": { + "id": "ListPartnersResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListPartners` method to retrieve the next page of results.", + "type": "string" + }, + "partners": { + "description": "The list of partners. This list will be absent if empty.", + "items": { + "$ref": "Partner" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSitesResponse": { + "description": "Response message for SiteService.ListSites.", + "id": "ListSitesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results.", + "type": "string" + }, + "sites": { + "description": "The list of sites. This list will be absent if empty.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListTargetingOptionsResponse": { + "description": "Response message for ListTargetingOptions.", + "id": "ListTargetingOptionsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListTargetingOptions` method to retrieve the next page of results.", + "type": "string" + }, + "targetingOptions": { + "description": "The list of targeting options. This list will be absent if empty.", + "items": { + "$ref": "TargetingOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListUsersResponse": { + "id": "ListUsersResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return.", + "type": "string" + }, + "users": { + "description": "The list of users. This list will be absent if empty.", + "items": { + "$ref": "User" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationList": { + "description": "A list of locations used for targeting.", + "id": "LocationList", + "properties": { + "advertiserId": { + "description": "Required. Immutable. The unique ID of the advertiser the location list belongs to.", + "format": "int64", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "locationListId": { + "description": "Output only. The unique ID of the location list. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "locationType": { + "description": "Required. Immutable. The type of location. All locations in the list will share this type.", + "enum": [ + "TARGETING_LOCATION_TYPE_UNSPECIFIED", + "TARGETING_LOCATION_TYPE_PROXIMITY", + "TARGETING_LOCATION_TYPE_REGIONAL" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown.", + "The type for proximity geo location.", + "The type for regional geo location." + ], + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the location list.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LookbackWindow": { + "description": "Specifies how many days into the past to look when determining whether to record a conversion.", + "id": "LookbackWindow", + "properties": { + "clickDays": { + "description": "Lookback window, in days, from the last time a given user clicked on one of your ads.", + "format": "int32", + "type": "integer" + }, + "impressionDays": { + "description": "Lookback window, in days, from the last time a given user viewed one of your ads.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LookupInvoiceCurrencyResponse": { + "id": "LookupInvoiceCurrencyResponse", + "properties": { + "currencyCode": { + "description": "Currency used by the advertiser in ISO 4217 format.", + "type": "string" + } + }, + "type": "object" + }, + "MastheadAd": { + "description": "Details for a Masthead Ad.", + "id": "MastheadAd", + "properties": { + "autoplayVideoDuration": { + "description": "The duration of time the video will autoplay.", + "format": "google-duration", + "type": "string" + }, + "autoplayVideoStartMillisecond": { + "description": "The amount of time in milliseconds after which the video will start to play.", + "format": "int64", + "type": "string" + }, + "callToActionButtonLabel": { + "description": "The text on the call-to-action button.", + "type": "string" + }, + "callToActionFinalUrl": { + "description": "The destination URL for the call-to-action button.", + "type": "string" + }, + "callToActionTrackingUrl": { + "description": "The tracking URL for the call-to-action button.", + "type": "string" + }, + "companionYoutubeVideos": { + "description": "The videos that appear next to the Masthead Ad on desktop. Can be no more than two.", + "items": { + "$ref": "YoutubeVideoDetails" + }, + "type": "array" + }, + "description": { + "description": "The description of the ad.", + "type": "string" + }, + "headline": { + "description": "The headline of the ad.", + "type": "string" + }, + "showChannelArt": { + "description": "Whether to show a background or banner that appears at the top of a YouTube page.", + "type": "boolean" + }, + "video": { + "$ref": "YoutubeVideoDetails", + "description": "The YouTube video used by the ad." + }, + "videoAspectRatio": { + "description": "The aspect ratio of the autoplaying YouTube video on the Masthead.", + "enum": [ + "VIDEO_ASPECT_RATIO_UNSPECIFIED", + "VIDEO_ASPECT_RATIO_WIDESCREEN", + "VIDEO_ASPECT_RATIO_FIXED_16_9" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "The video is stretched and the top and bottom are cropped.", + "The video uses a fixed 16:9 aspect ratio." + ], + "type": "string" + } + }, + "type": "object" + }, + "MaximizeSpendBidStrategy": { + "description": "A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget.", + "id": "MaximizeSpendBidStrategy", + "properties": { + "customBiddingAlgorithmId": { + "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", + "format": "int64", + "type": "string" + }, + "maxAverageCpmBidAmountMicros": { + "description": "The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "performanceGoalType": { + "description": "Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.", + "enum": [ + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Cost per action.", + "Cost per click.", + "Viewable CPM.", + "Custom bidding algorithm.", + "Completed inview and audible views.", + "Inview time over 10 secs views.", + "Viewable impressions." + ], + "type": "string" + }, + "raiseBidForDeals": { + "description": "Whether the strategy takes deal floor prices into account.", + "type": "boolean" + } + }, + "type": "object" + }, + "MeasurementConfig": { + "description": "Measurement settings of a partner.", + "id": "MeasurementConfig", + "properties": { + "dv360ToCmCostReportingEnabled": { + "description": "Whether or not to report DV360 cost to CM360.", + "type": "boolean" + }, + "dv360ToCmDataSharingEnabled": { + "description": "Whether or not to include DV360 data in CM360 data transfer reports.", + "type": "boolean" + } + }, + "type": "object" + }, + "MobileApp": { + "description": "A mobile app promoted by a mobile app install line item.", + "id": "MobileApp", + "properties": { + "appId": { + "description": "Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.", + "type": "string" + }, + "displayName": { + "description": "Output only. The app name.", + "readOnly": true, + "type": "string" + }, + "platform": { + "description": "Output only. The app platform.", + "enum": [ + "PLATFORM_UNSPECIFIED", + "IOS", + "ANDROID" + ], + "enumDescriptions": [ + "Platform is not specified.", + "iOS platform.", + "Android platform." + ], + "readOnly": true, + "type": "string" + }, + "publisher": { + "description": "Output only. The app publisher.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MobileDeviceIdList": { + "description": "Wrapper message for a list of mobile device IDs defining Customer Match audience members.", + "id": "MobileDeviceIdList", + "properties": { + "consent": { + "$ref": "Consent", + "description": "Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error." + }, + "mobileDeviceIds": { + "description": "A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The three-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "format": "int32", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "NativeContentPositionAssignedTargetingOptionDetails": { + "description": "Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect.", + "id": "NativeContentPositionAssignedTargetingOptionDetails", + "properties": { + "contentPosition": { + "description": "Required. The content position.", + "enum": [ + "NATIVE_CONTENT_POSITION_UNSPECIFIED", + "NATIVE_CONTENT_POSITION_UNKNOWN", + "NATIVE_CONTENT_POSITION_IN_ARTICLE", + "NATIVE_CONTENT_POSITION_IN_FEED", + "NATIVE_CONTENT_POSITION_PERIPHERAL", + "NATIVE_CONTENT_POSITION_RECOMMENDATION" + ], + "enumDescriptions": [ + "Native content position is not specified in this version. This enum is a place holder for a default value and does not represent a real native content position.", + "The native content position is unknown.", + "Native content position is in-article, i.e., ads appear between the paragraphs of pages.", + "Native content position is in-feed, i.e., ads appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", + "Native content position is peripheral, i.e., ads appear outside of core content on pages, such as the right- or left-hand side of the page.", + "Native content position is recommendation, i.e., ads appear in sections for recommended content." + ], + "type": "string" + } + }, + "type": "object" + }, + "NativeContentPositionTargetingOptionDetails": { + "description": "Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.", + "id": "NativeContentPositionTargetingOptionDetails", + "properties": { + "contentPosition": { + "description": "Output only. The content position.", + "enum": [ + "NATIVE_CONTENT_POSITION_UNSPECIFIED", + "NATIVE_CONTENT_POSITION_UNKNOWN", + "NATIVE_CONTENT_POSITION_IN_ARTICLE", + "NATIVE_CONTENT_POSITION_IN_FEED", + "NATIVE_CONTENT_POSITION_PERIPHERAL", + "NATIVE_CONTENT_POSITION_RECOMMENDATION" + ], + "enumDescriptions": [ + "Native content position is not specified in this version. This enum is a place holder for a default value and does not represent a real native content position.", + "The native content position is unknown.", + "Native content position is in-article, i.e., ads appear between the paragraphs of pages.", + "Native content position is in-feed, i.e., ads appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", + "Native content position is peripheral, i.e., ads appear outside of core content on pages, such as the right- or left-hand side of the page.", + "Native content position is recommendation, i.e., ads appear in sections for recommended content." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NegativeKeyword": { + "description": "A negatively targeted keyword that belongs to a negative keyword list.", + "id": "NegativeKeyword", + "properties": { + "keywordValue": { + "description": "Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the negative keyword.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NegativeKeywordList": { + "description": "A list of negative keywords used for targeting.", + "id": "NegativeKeywordList", + "properties": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the negative keyword list belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the negative keyword list.", + "readOnly": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Output only. The unique ID of the negative keyword list. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "targetedLineItemCount": { + "description": "Output only. Number of line items that are directly targeting this negative keyword list.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NegativeKeywordListAssignedTargetingOptionDetails": { + "description": "Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.", + "id": "NegativeKeywordListAssignedTargetingOptionDetails", + "properties": { + "negativeKeywordListId": { + "description": "Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "NonSkippableAd": { + "description": "Details for a non-skippable ad.", + "id": "NonSkippableAd", + "properties": { + "commonInStreamAttribute": { + "$ref": "CommonInStreamAttribute", + "description": "Common ad attributes." + }, + "customParameters": { + "additionalProperties": { + "type": "string" + }, + "description": "The custom parameters to pass custom values to tracking URL template.", + "type": "object" + } + }, + "type": "object" + }, + "ObaIcon": { + "description": "OBA Icon for a Creative", + "id": "ObaIcon", + "properties": { + "clickTrackingUrl": { + "description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", + "type": "string" + }, + "dimensions": { + "$ref": "Dimensions", + "description": "Optional. The dimensions of the OBA icon." + }, + "landingPageUrl": { + "description": "Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", + "type": "string" + }, + "position": { + "description": "Optional. The position of the OBA icon on the creative.", + "enum": [ + "OBA_ICON_POSITION_UNSPECIFIED", + "OBA_ICON_POSITION_UPPER_RIGHT", + "OBA_ICON_POSITION_UPPER_LEFT", + "OBA_ICON_POSITION_LOWER_RIGHT", + "OBA_ICON_POSITION_LOWER_LEFT" + ], + "enumDescriptions": [ + "The OBA icon position is not specified.", + "At the upper right side of the creative.", + "At the upper left side of the creative.", + "At the lower right side of the creative.", + "At the lower left side of the creative." + ], + "type": "string" + }, + "program": { + "description": "Optional. The program of the OBA icon. For example: “AdChoices”.", + "type": "string" + }, + "resourceMimeType": { + "description": "Optional. The MIME type of the OBA icon resource.", + "type": "string" + }, + "resourceUrl": { + "description": "Optional. The URL of the OBA icon resource.", + "type": "string" + }, + "viewTrackingUrl": { + "description": "Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`", + "type": "string" + } + }, + "type": "object" + }, + "OmidAssignedTargetingOptionDetails": { + "description": "Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`.", + "id": "OmidAssignedTargetingOptionDetails", + "properties": { + "omid": { + "description": "Required. The type of Open Measurement enabled inventory.", + "enum": [ + "OMID_UNSPECIFIED", + "OMID_FOR_MOBILE_DISPLAY_ADS" + ], + "enumDescriptions": [ + "Default value when omid targeting is not specified in this version.", + "Open Measurement enabled mobile display inventory." + ], + "type": "string" + } + }, + "type": "object" + }, + "OmidTargetingOptionDetails": { + "description": "Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`.", + "id": "OmidTargetingOptionDetails", + "properties": { + "omid": { + "description": "Output only. The type of Open Measurement enabled inventory.", + "enum": [ + "OMID_UNSPECIFIED", + "OMID_FOR_MOBILE_DISPLAY_ADS" + ], + "enumDescriptions": [ + "Default value when omid targeting is not specified in this version.", + "Open Measurement enabled mobile display inventory." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OnScreenPositionAssignedTargetingOptionDetails": { + "description": "On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", + "id": "OnScreenPositionAssignedTargetingOptionDetails", + "properties": { + "adType": { + "description": "Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.", + "enum": [ + "AD_TYPE_UNSPECIFIED", + "AD_TYPE_DISPLAY", + "AD_TYPE_VIDEO", + "AD_TYPE_AUDIO" + ], + "enumDescriptions": [ + "Ad type is not specified or is unknown in this version.", + "Display creatives, e.g. image and HTML5.", + "Video creatives, e.g. video ads that play during streaming content in video players.", + "Audio creatives, e.g. audio ads that play during audio content." + ], + "readOnly": true, + "type": "string" + }, + "onScreenPosition": { + "description": "Output only. The on screen position.", + "enum": [ + "ON_SCREEN_POSITION_UNSPECIFIED", + "ON_SCREEN_POSITION_UNKNOWN", + "ON_SCREEN_POSITION_ABOVE_THE_FOLD", + "ON_SCREEN_POSITION_BELOW_THE_FOLD" + ], + "enumDescriptions": [ + "On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", + "The ad position is unknown on the screen.", + "The ad is located above the fold.", + "The ad is located below the fold." + ], + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", + "type": "string" + } + }, + "type": "object" + }, + "OnScreenPositionTargetingOptionDetails": { + "description": "Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", + "id": "OnScreenPositionTargetingOptionDetails", + "properties": { + "onScreenPosition": { + "description": "Output only. The on screen position.", + "enum": [ + "ON_SCREEN_POSITION_UNSPECIFIED", + "ON_SCREEN_POSITION_UNKNOWN", + "ON_SCREEN_POSITION_ABOVE_THE_FOLD", + "ON_SCREEN_POSITION_BELOW_THE_FOLD" + ], + "enumDescriptions": [ + "On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", + "The ad position is unknown on the screen.", + "The ad is located above the fold.", + "The ad is located below the fold." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OperatingSystemAssignedTargetingOptionDetails": { + "description": "Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", + "id": "OperatingSystemAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the operating system.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", + "type": "string" + } + }, + "type": "object" + }, + "OperatingSystemTargetingOptionDetails": { + "description": "Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", + "id": "OperatingSystemTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the operating system.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "Pacing": { + "description": "Settings that control the rate at which a budget is spent.", + "id": "Pacing", + "properties": { + "dailyMaxImpressions": { + "description": "Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.", + "format": "int64", + "type": "string" + }, + "dailyMaxMicros": { + "description": "Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.", + "format": "int64", + "type": "string" + }, + "pacingPeriod": { + "description": "Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.", + "enum": [ + "PACING_PERIOD_UNSPECIFIED", + "PACING_PERIOD_DAILY", + "PACING_PERIOD_FLIGHT" + ], + "enumDescriptions": [ + "Period value is not specified or is unknown in this version.", + "The pacing setting will be applied on daily basis.", + "The pacing setting will be applied to the whole flight duration." + ], + "type": "string" + }, + "pacingType": { + "description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.", + "enum": [ + "PACING_TYPE_UNSPECIFIED", + "PACING_TYPE_AHEAD", + "PACING_TYPE_ASAP", + "PACING_TYPE_EVEN" + ], + "enumDescriptions": [ + "Pacing mode value is not specified or is unknown in this version.", + "Only applicable to `PACING_PERIOD_FLIGHT` pacing period. Ahead pacing attempts to spend faster than evenly, to make sure the entire budget is spent by the end of the flight.", + "Spend all of pacing budget amount as quick as possible.", + "Spend a consistent budget amount every period of time." + ], + "type": "string" + } + }, + "type": "object" + }, + "ParentEntityFilter": { + "description": "A filtering option that filters on selected file types belonging to a chosen set of filter entities.", + "id": "ParentEntityFilter", + "properties": { + "fileType": { + "description": "Required. File types that will be returned.", + "items": { + "enum": [ + "FILE_TYPE_UNSPECIFIED", + "FILE_TYPE_CAMPAIGN", + "FILE_TYPE_MEDIA_PRODUCT", + "FILE_TYPE_INSERTION_ORDER", + "FILE_TYPE_LINE_ITEM", + "FILE_TYPE_AD_GROUP", + "FILE_TYPE_AD", + "FILE_TYPE_LINE_ITEM_QA", + "FILE_TYPE_AD_GROUP_QA" + ], + "enumDescriptions": [ + "Default value when type is unspecified or is unknown in this version.", + "Campaign.", + "Media Product.", + "Insertion Order.", + "Line Item.", + "YouTube Ad Group.", + "YouTube Ad.", + "Line Item - QA format.", + "YouTube Ad Group - QA format." + ], + "type": "string" + }, + "type": "array" + }, + "filterIds": { + "description": "The IDs of the specified filter type. This is used to filter entities to fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be specified.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "filterType": { + "description": "Required. Filter type used to filter fetched entities.", + "enum": [ + "FILTER_TYPE_UNSPECIFIED", + "FILTER_TYPE_NONE", + "FILTER_TYPE_ADVERTISER_ID", + "FILTER_TYPE_CAMPAIGN_ID", + "FILTER_TYPE_MEDIA_PRODUCT_ID", + "FILTER_TYPE_INSERTION_ORDER_ID", + "FILTER_TYPE_LINE_ITEM_ID" + ], + "enumDescriptions": [ + "Default value when type is unspecified or is unknown in this version.", + "If selected, no filter will be applied to the download. Can only be used if an Advertiser is specified in CreateSdfDownloadTaskRequest.", + "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_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" + } + }, + "type": "object" + }, + "ParentalStatusAssignedTargetingOptionDetails": { + "description": "Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.", + "id": "ParentalStatusAssignedTargetingOptionDetails", + "properties": { + "parentalStatus": { + "description": "Required. The parental status of the audience.", + "enum": [ + "PARENTAL_STATUS_UNSPECIFIED", + "PARENTAL_STATUS_PARENT", + "PARENTAL_STATUS_NOT_A_PARENT", + "PARENTAL_STATUS_UNKNOWN" + ], + "enumDescriptions": [ + "Default value when parental status is not specified in this version. This enum is a place holder for default value and does not represent a real parental status option.", + "The audience is a parent.", + "The audience is not a parent.", + "The parental status of the audience is unknown." + ], + "type": "string" + } + }, + "type": "object" + }, + "ParentalStatusTargetingOptionDetails": { + "description": "Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.", + "id": "ParentalStatusTargetingOptionDetails", + "properties": { + "parentalStatus": { + "description": "Output only. The parental status of an audience.", + "enum": [ + "PARENTAL_STATUS_UNSPECIFIED", + "PARENTAL_STATUS_PARENT", + "PARENTAL_STATUS_NOT_A_PARENT", + "PARENTAL_STATUS_UNKNOWN" + ], + "enumDescriptions": [ + "Default value when parental status is not specified in this version. This enum is a place holder for default value and does not represent a real parental status option.", + "The audience is a parent.", + "The audience is not a parent.", + "The parental status of the audience is unknown." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Partner": { + "description": "A single partner in Display & Video 360 (DV360).", + "id": "Partner", + "properties": { + "adServerConfig": { + "$ref": "PartnerAdServerConfig", + "description": "Ad server related settings of the partner." + }, + "billingConfig": { + "$ref": "PartnerBillingConfig", + "description": "Billing related settings of the partner." + }, + "dataAccessConfig": { + "$ref": "PartnerDataAccessConfig", + "description": "Settings that control how partner data may be accessed." + }, + "displayName": { + "description": "The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Output only. The status of the partner.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "readOnly": true, + "type": "string" + }, + "exchangeConfig": { + "$ref": "ExchangeConfig", + "description": "Settings that control which exchanges are enabled for the partner." + }, + "generalConfig": { + "$ref": "PartnerGeneralConfig", + "description": "General settings of the partner." + }, + "name": { + "description": "Output only. The resource name of the partner.", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "Output only. The unique ID of the partner. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the partner was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "PartnerAdServerConfig": { + "description": "Ad server related settings of a partner.", + "id": "PartnerAdServerConfig", + "properties": { + "measurementConfig": { + "$ref": "MeasurementConfig", + "description": "Measurement settings of a partner." + } + }, + "type": "object" + }, + "PartnerBillingConfig": { + "description": "Billing related settings of a partner.", + "id": "PartnerBillingConfig", + "properties": { + "billingProfileId": { + "description": "The ID of a partner default billing profile.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "PartnerCost": { + "description": "Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.", + "id": "PartnerCost", + "properties": { + "costType": { + "description": "Required. The type of the partner cost.", + "enum": [ + "PARTNER_COST_TYPE_UNSPECIFIED", + "PARTNER_COST_TYPE_ADLOOX", + "PARTNER_COST_TYPE_ADLOOX_PREBID", + "PARTNER_COST_TYPE_ADSAFE", + "PARTNER_COST_TYPE_ADXPOSE", + "PARTNER_COST_TYPE_AGGREGATE_KNOWLEDGE", + "PARTNER_COST_TYPE_AGENCY_TRADING_DESK", + "PARTNER_COST_TYPE_DV360_FEE", + "PARTNER_COST_TYPE_COMSCORE_VCE", + "PARTNER_COST_TYPE_DATA_MANAGEMENT_PLATFORM", + "PARTNER_COST_TYPE_DEFAULT", + "PARTNER_COST_TYPE_DOUBLE_VERIFY", + "PARTNER_COST_TYPE_DOUBLE_VERIFY_PREBID", + "PARTNER_COST_TYPE_EVIDON", + "PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO", + "PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_PREBID", + "PARTNER_COST_TYPE_MEDIA_COST_DATA", + "PARTNER_COST_TYPE_MOAT_VIDEO", + "PARTNER_COST_TYPE_NIELSEN_DAR", + "PARTNER_COST_TYPE_SHOP_LOCAL", + "PARTNER_COST_TYPE_TERACENT", + "PARTNER_COST_TYPE_THIRD_PARTY_AD_SERVER", + "PARTNER_COST_TYPE_TRUST_METRICS", + "PARTNER_COST_TYPE_VIZU", + "PARTNER_COST_TYPE_ADLINGO_FEE", + "PARTNER_COST_TYPE_CUSTOM_FEE_1", + "PARTNER_COST_TYPE_CUSTOM_FEE_2", + "PARTNER_COST_TYPE_CUSTOM_FEE_3", + "PARTNER_COST_TYPE_CUSTOM_FEE_4", + "PARTNER_COST_TYPE_CUSTOM_FEE_5", + "PARTNER_COST_TYPE_SCIBIDS_FEE" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The cost is charged for using Adloox. Billed by the partner.", + "The cost is charged for using Adloox Pre-Bid. Billed through DV360.", + "The cost is charged for using AdSafe. Billed by the partner.", + "The cost is charged for using AdExpose. Billed by the partner.", + "The cost is charged for using Aggregate Knowledge. Billed by the partner.", + "The cost is charged for using an Agency Trading Desk. Billed by the partner.", + "The cost is charged for using DV360. Billed through DV360.", + "The cost is charged for using comScore vCE. Billed through DV360.", + "The cost is charged for using a Data Management Platform. Billed by the partner.", + "The default cost type. Billed by the partner.", + "The cost is charged for using DoubleVerify. Billed by the partner.", + "The cost is charged for using DoubleVerify Pre-Bid. Billed through DV360.", + "The cost is charged for using Evidon. Billed by the partner.", + "The cost is charged for using Integral Ad Science Video. Billed by the partner.", + "The cost is charged for using Integral Ad Science Pre-Bid. Billed through DV360.", + "The cost is charged for using media cost data. Billed by the partner.", + "The cost is charged for using MOAT Video. Billed by the partner.", + "The cost is charged for using Nielsen Digital Ad Ratings. Billed through DV360.", + "The cost is charged for using ShopLocal. Billed by the partner.", + "The cost is charged for using Teracent. Billed by the partner.", + "The cost is charged for using a third-party ad server. Billed by the partner.", + "The cost is charged for using TrustMetrics. Billed by the partner.", + "The cost is charged for using Vizu. Billed by the partner.", + "The cost is charged for using AdLingo. Billed through DV360.", + "The cost is charged as custom fee 1. Billed by the partner.", + "The cost is charged as custom fee 2. Billed by the partner.", + "The cost is charged as custom fee 3. Billed by the partner.", + "The cost is charged as custom fee 4. Billed by the partner.", + "The cost is charged as custom fee 5. Billed by the partner.", + "The cost is charged for using Scibids. Billed through DV360. This type is currently only available to certain customers. Other customers attempting to use this type will receive an error." + ], + "type": "string" + }, + "feeAmount": { + "description": "The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.", + "format": "int64", + "type": "string" + }, + "feePercentageMillis": { + "description": "The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.", + "format": "int64", + "type": "string" + }, + "feeType": { + "description": "Required. The fee type for this partner cost.", + "enum": [ + "PARTNER_COST_FEE_TYPE_UNSPECIFIED", + "PARTNER_COST_FEE_TYPE_CPM_FEE", + "PARTNER_COST_FEE_TYPE_MEDIA_FEE" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "The partner cost is a fixed CPM fee. Not applicable when the partner cost cost_type is one of: * `PARTNER_COST_TYPE_MEDIA_COST_DATA` * `PARTNER_COST_TYPE_DV360_FEE`.", + "The partner cost is a percentage surcharge based on the media cost. Not applicable when the partner cost_type is one of: * `PARTNER_COST_TYPE_SHOP_LOCAL` * `PARTNER_COST_TYPE_TRUST_METRICS` * `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO` * `PARTNER_COST_TYPE_MOAT_VIDEO`." + ], + "type": "string" + }, + "invoiceType": { + "description": "The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.", + "enum": [ + "PARTNER_COST_INVOICE_TYPE_UNSPECIFIED", + "PARTNER_COST_INVOICE_TYPE_DV360", + "PARTNER_COST_INVOICE_TYPE_PARTNER" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Partner cost is billed through DV360.", + "Partner cost is billed by the partner." + ], + "type": "string" + } + }, + "type": "object" + }, + "PartnerDataAccessConfig": { + "description": "Settings that control how partner related data may be accessed.", + "id": "PartnerDataAccessConfig", + "properties": { + "sdfConfig": { + "$ref": "SdfConfig", + "description": "Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner." + } + }, + "type": "object" + }, + "PartnerGeneralConfig": { + "description": "General settings of a partner.", + "id": "PartnerGeneralConfig", + "properties": { + "currencyCode": { + "description": "Immutable. Partner's currency in ISO 4217 format.", + "type": "string" + }, + "timeZone": { + "description": "Immutable. The standard TZ database name of the partner's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", + "type": "string" + } + }, + "type": "object" + }, + "PartnerRevenueModel": { + "description": "Settings that control how partner revenue is calculated.", + "id": "PartnerRevenueModel", + "properties": { + "markupAmount": { + "description": "Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).", + "format": "int64", + "type": "string" + }, + "markupType": { + "description": "Required. The markup type of the partner revenue model.", + "enum": [ + "PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", + "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", + "PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP", + "PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP" + ], + "enumDeprecated": [ + false, + false, + true, + false + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Calculate the partner revenue based on a fixed CPM.", + "Calculate the partner revenue based on a percentage surcharge of its media cost.", + "Calculate the partner revenue based on a percentage surcharge of its total media cost, which includes all partner costs and data costs." + ], + "type": "string" + } + }, + "type": "object" + }, + "PerformanceGoal": { + "description": "Settings that control the performance goal of a campaign.", + "id": "PerformanceGoal", + "properties": { + "performanceGoalAmountMicros": { + "description": "The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "performanceGoalPercentageMicros": { + "description": "The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).", + "format": "int64", + "type": "string" + }, + "performanceGoalString": { + "description": "A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.", + "type": "string" + }, + "performanceGoalType": { + "description": "Required. The type of the performance goal.", + "enum": [ + "PERFORMANCE_GOAL_TYPE_UNSPECIFIED", + "PERFORMANCE_GOAL_TYPE_CPM", + "PERFORMANCE_GOAL_TYPE_CPC", + "PERFORMANCE_GOAL_TYPE_CPA", + "PERFORMANCE_GOAL_TYPE_CTR", + "PERFORMANCE_GOAL_TYPE_VIEWABILITY", + "PERFORMANCE_GOAL_TYPE_CPIAVC", + "PERFORMANCE_GOAL_TYPE_CPE", + "PERFORMANCE_GOAL_TYPE_CPV", + "PERFORMANCE_GOAL_TYPE_CLICK_CVR", + "PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR", + "PERFORMANCE_GOAL_TYPE_VCPM", + "PERFORMANCE_GOAL_TYPE_VTR", + "PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE", + "PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE", + "PERFORMANCE_GOAL_TYPE_OTHER" + ], + "enumDescriptions": [ + "Performance goal type is not specified or is unknown in this version.", + "The performance goal is set in CPM (cost per mille).", + "The performance goal is set in CPC (cost per click).", + "The performance goal is set in CPA (cost per action).", + "The performance goal is set in CTR (click-through rate) percentage.", + "The performance goal is set in Viewability percentage.", + "The performance goal is set as CPIAVC (cost per impression audible and visible at completion).", + "The performance goal is set in CPE (cost per engagement).", + "The performance goal is set in CPV (cost per view).", + "The performance goal is set in click conversion rate (conversions per click) percentage.", + "The performance goal is set in impression conversion rate (conversions per impression) percentage.", + "The performance goal is set in VCPM (cost per thousand viewable impressions).", + "The performance goal is set in YouTube view rate (YouTube views per impression) percentage.", + "The performance goal is set in audio completion rate (complete audio listens per impression) percentage.", + "The performance goal is set in video completion rate (complete video views per impression) percentage.", + "The performance goal is set to Other." + ], + "type": "string" + } + }, + "type": "object" + }, + "PerformanceGoalBidStrategy": { + "description": "A strategy that automatically adjusts the bid to meet or beat a specified performance goal.", + "id": "PerformanceGoalBidStrategy", + "properties": { + "customBiddingAlgorithmId": { + "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).", + "format": "int64", + "type": "string" + }, + "maxAverageCpmBidAmountMicros": { + "description": "The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "performanceGoalAmountMicros": { + "description": "Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.", + "format": "int64", + "type": "string" + }, + "performanceGoalType": { + "description": "Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", + "enum": [ + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN", + "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Cost per action.", + "Cost per click.", + "Viewable CPM.", + "Custom bidding algorithm.", + "Completed inview and audible views.", + "Inview time over 10 secs views.", + "Viewable impressions." + ], + "type": "string" + } + }, + "type": "object" + }, + "PoiAssignedTargetingOptionDetails": { + "description": "Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`.", + "id": "PoiAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of a POI, e.g. \"Times Square\", \"Space Needle\", followed by its full address if available.", + "readOnly": true, + "type": "string" + }, + "latitude": { + "description": "Output only. Latitude of the POI rounding to 6th decimal place.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "longitude": { + "description": "Output only. Longitude of the POI rounding to 6th decimal place.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "proximityRadiusAmount": { + "description": "Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.", + "format": "double", + "type": "number" + }, + "proximityRadiusUnit": { + "description": "Required. The unit of distance by which the targeting radius is measured.", + "enum": [ + "DISTANCE_UNIT_UNSPECIFIED", + "DISTANCE_UNIT_MILES", + "DISTANCE_UNIT_KILOMETERS" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Miles.", + "Kilometers." + ], + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID \"40741469;-74003387\". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**", + "type": "string" + } + }, + "type": "object" + }, + "PoiSearchTerms": { + "description": "Search terms for POI targeting options.", + "id": "PoiSearchTerms", + "properties": { + "poiQuery": { + "description": "The search query for the desired POI name, street address, or coordinate of the desired POI. The query can be a prefix, e.g. \"Times squar\", \"40.7505045,-73.99562\", \"315 W 44th St\", etc.", + "type": "string" + } + }, + "type": "object" + }, + "PoiTargetingOptionDetails": { + "description": "Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`.", + "id": "PoiTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of a POI(e.g. \"Times Square\", \"Space Needle\"), followed by its full address if available.", + "readOnly": true, + "type": "string" + }, + "latitude": { + "description": "Output only. Latitude of the POI rounding to 6th decimal place.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "longitude": { + "description": "Output only. Longitude of the POI rounding to 6th decimal place.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "PrismaConfig": { + "description": "Settings specific to the Mediaocean Prisma tool.", + "id": "PrismaConfig", + "properties": { + "prismaCpeCode": { + "$ref": "PrismaCpeCode", + "description": "Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool." + }, + "prismaType": { + "description": "Required. The Prisma type.", + "enum": [ + "PRISMA_TYPE_UNSPECIFIED", + "PRISMA_TYPE_DISPLAY", + "PRISMA_TYPE_SEARCH", + "PRISMA_TYPE_VIDEO", + "PRISMA_TYPE_AUDIO", + "PRISMA_TYPE_SOCIAL", + "PRISMA_TYPE_FEE" + ], + "enumDescriptions": [ + "Type is not specified or unknown in this version.", + "Display type.", + "Search type.", + "Video type.", + "Audio type.", + "Social type.", + "Fee type." + ], + "type": "string" + }, + "supplier": { + "description": "Required. The entity allocated this budget (DSP, site, etc.).", + "type": "string" + } + }, + "type": "object" + }, + "PrismaCpeCode": { + "description": "Google Payments Center supports searching and filtering on the component fields of this code.", + "id": "PrismaCpeCode", + "properties": { + "prismaClientCode": { + "description": "The Prisma client code.", + "type": "string" + }, + "prismaEstimateCode": { + "description": "The Prisma estimate code.", + "type": "string" + }, + "prismaProductCode": { + "description": "The Prisma product code.", + "type": "string" + } + }, + "type": "object" + }, + "ProductFeedData": { + "description": "The details of product feed.", + "id": "ProductFeedData", + "properties": { + "isFeedDisabled": { + "description": "Whether the product feed has opted-out of showing products.", + "type": "boolean" + }, + "productMatchDimensions": { + "description": "A list of dimensions used to match products.", + "items": { + "$ref": "ProductMatchDimension" + }, + "type": "array" + }, + "productMatchType": { + "description": "How products are selected by the product feed.", + "enum": [ + "PRODUCT_MATCH_TYPE_UNSPECIFIED", + "PRODUCT_MATCH_TYPE_ALL_PRODUCTS", + "PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS", + "PRODUCT_MATCH_TYPE_CUSTOM_LABEL" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "All the products are matched.", + "Specific products are selected.", + "Match products by their custom labels." + ], + "type": "string" + } + }, + "type": "object" + }, + "ProductMatchDimension": { + "description": "A dimension used to match products.", + "id": "ProductMatchDimension", + "properties": { + "customLabel": { + "$ref": "CustomLabel", + "description": "The custom label to match all the products with the label." + }, + "productOfferId": { + "description": "The ID of the product offer to match with a product with the same offer ID.", + "type": "string" + } + }, + "type": "object" + }, + "ProximityLocationListAssignedTargetingOptionDetails": { + "description": "Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.", + "id": "ProximityLocationListAssignedTargetingOptionDetails", + "properties": { + "proximityLocationListId": { + "description": "Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.", + "format": "int64", + "type": "string" + }, + "proximityRadius": { + "description": "Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.", + "format": "double", + "type": "number" + }, + "proximityRadiusUnit": { + "description": "Required. Radius distance units.", + "enum": [ + "PROXIMITY_RADIUS_UNIT_UNSPECIFIED", + "PROXIMITY_RADIUS_UNIT_MILES", + "PROXIMITY_RADIUS_UNIT_KILOMETERS" + ], + "enumDescriptions": [ + "Default value when distance units is not specified in this version. This enum is a place holder for default value and does not represent a real distance unit.", + "Radius distance unit in miles.", + "Radius distance unit in kilometeres" + ], + "type": "string" + } + }, + "type": "object" + }, + "RateDetails": { + "description": "The rate related settings of the inventory source.", + "id": "RateDetails", + "properties": { + "inventorySourceRateType": { + "description": "The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.", + "enum": [ + "INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED", + "INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED", + "INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR", + "INVENTORY_SOURCE_RATE_TYPE_CPD", + "INVENTORY_SOURCE_RATE_TYPE_FLAT" + ], + "enumDescriptions": [ + "The rate type is not specified or is unknown in this version.", + "The rate type is CPM (Fixed).", + "The rate type is CPM (Floor).", + "The rate type is Cost per Day.", + "The rate type is Flat." + ], + "type": "string" + }, + "minimumSpend": { + "$ref": "Money", + "description": "Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.", + "readOnly": true + }, + "rate": { + "$ref": "Money", + "description": "The rate for the inventory source." + }, + "unitsPurchased": { + "description": "Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RegionalLocationListAssignedTargetingOptionDetails": { + "description": "Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.", + "id": "RegionalLocationListAssignedTargetingOptionDetails", + "properties": { + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "regionalLocationListId": { + "description": "Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RemarketingConfig": { + "description": "Settings that control the whether remarketing is enabled for the given identified advertiser.", + "id": "RemarketingConfig", + "properties": { + "advertiserId": { + "description": "Output only. The ID of the advertiser.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "remarketingEnabled": { + "description": "Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "ReplaceNegativeKeywordsRequest": { + "description": "Request message for NegativeKeywordService.ReplaceNegativeKeywords.", + "id": "ReplaceNegativeKeywordsRequest", + "properties": { + "newNegativeKeywords": { + "description": "The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of NegativeKeywords.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + } + }, + "type": "object" + }, + "ReplaceNegativeKeywordsResponse": { + "description": "Response message for NegativeKeywordService.ReplaceNegativeKeywords.", + "id": "ReplaceNegativeKeywordsResponse", + "properties": { + "negativeKeywords": { + "description": "The full list of negative keywords now present in the negative keyword list.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + } + }, + "type": "object" + }, + "ReplaceSitesRequest": { + "description": "Request message for SiteService.ReplaceSites.", + "id": "ReplaceSitesRequest", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "type": "string" + }, + "newSites": { + "description": "The sites that will replace the existing sites assigned to the channel, specified as a list of Sites.", + "items": { + "$ref": "Site" + }, + "type": "array" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ReplaceSitesResponse": { + "description": "Response message for SiteService.ReplaceSites.", + "id": "ReplaceSitesResponse", + "properties": { + "sites": { + "description": "The list of sites in the channel after replacing.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "ReviewStatusInfo": { + "description": "Review statuses for the creative.", + "id": "ReviewStatusInfo", + "properties": { + "approvalStatus": { + "description": "Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.", + "enum": [ + "APPROVAL_STATUS_UNSPECIFIED", + "APPROVAL_STATUS_PENDING_NOT_SERVABLE", + "APPROVAL_STATUS_PENDING_SERVABLE", + "APPROVAL_STATUS_APPROVED_SERVABLE", + "APPROVAL_STATUS_REJECTED_NOT_SERVABLE" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The creative is still under review and not servable.", + "The creative has passed creative & landing page review and is servable, but is awaiting additional content & policy review.", + "Both creative & landing page review and content & policy review are approved. The creative is servable.", + "There is an issue with the creative that must be fixed before it can serve." + ], + "type": "string" + }, + "contentAndPolicyReviewStatus": { + "description": "Content and policy review status for the creative.", + "enum": [ + "REVIEW_STATUS_UNSPECIFIED", + "REVIEW_STATUS_APPROVED", + "REVIEW_STATUS_REJECTED", + "REVIEW_STATUS_PENDING" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The creative is approved.", + "The creative is rejected.", + "The creative is pending review." + ], + "type": "string" + }, + "creativeAndLandingPageReviewStatus": { + "description": "Creative and landing page review status for the creative.", + "enum": [ + "REVIEW_STATUS_UNSPECIFIED", + "REVIEW_STATUS_APPROVED", + "REVIEW_STATUS_REJECTED", + "REVIEW_STATUS_PENDING" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The creative is approved.", + "The creative is rejected.", + "The creative is pending review." + ], + "type": "string" + }, + "exchangeReviewStatuses": { + "description": "Exchange review statuses for the creative.", + "items": { + "$ref": "ExchangeReviewStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "ScriptError": { + "description": "An error message for a custom bidding script.", + "id": "ScriptError", + "properties": { + "column": { + "description": "The column number in the script where the error was thrown.", + "format": "int64", + "type": "string" + }, + "errorCode": { + "description": "The type of error.", + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "SYNTAX_ERROR", + "DEPRECATED_SYNTAX", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "The script error is not specified or is unknown in this version.", + "The script has a syntax error.", + "The script uses deprecated syntax.", + "Internal errors were thrown while processing the script." + ], + "type": "string" + }, + "errorMessage": { + "description": "The detailed error message.", + "type": "string" + }, + "line": { + "description": "The line number in the script where the error was thrown.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "SdfConfig": { + "description": "Structured Data File (SDF) related settings.", + "id": "SdfConfig", + "properties": { + "adminEmail": { + "description": "An administrator email address to which the SDF processing status reports will be sent.", + "type": "string" + }, + "version": { + "description": "Required. The version of SDF being used.", + "enum": [ + "SDF_VERSION_UNSPECIFIED", + "SDF_VERSION_3_1", + "SDF_VERSION_4", + "SDF_VERSION_4_1", + "SDF_VERSION_4_2", + "SDF_VERSION_5", + "SDF_VERSION_5_1", + "SDF_VERSION_5_2", + "SDF_VERSION_5_3", + "SDF_VERSION_5_4", + "SDF_VERSION_5_5", + "SDF_VERSION_6", + "SDF_VERSION_7", + "SDF_VERSION_7_1", + "SDF_VERSION_8" + ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "SDF version value is not specified or is unknown in this version.", + "SDF version 3.1", + "SDF version 4", + "SDF version 4.1", + "SDF version 4.2", + "SDF version 5.", + "SDF version 5.1", + "SDF version 5.2", + "SDF version 5.3", + "SDF version 5.4", + "SDF version 5.5", + "SDF version 6", + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", + "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version." + ], + "type": "string" + } + }, + "type": "object" + }, + "SdfDownloadTask": { + "description": "Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "id": "SdfDownloadTask", + "properties": { + "resourceName": { + "description": "A resource name to be used in media.download to Download the prepared files. Resource names have the format `download/sdfdownloadtasks/media/{media_id}`. `media_id` will be made available by the long running operation service once the task status is done.", + "type": "string" + } + }, + "type": "object" + }, + "SdfDownloadTaskMetadata": { + "description": "Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "id": "SdfDownloadTaskMetadata", + "properties": { + "createTime": { + "description": "The time when the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time when execution was completed.", + "format": "google-datetime", + "type": "string" + }, + "version": { + "description": "The SDF version used to execute this download task.", + "enum": [ + "SDF_VERSION_UNSPECIFIED", + "SDF_VERSION_3_1", + "SDF_VERSION_4", + "SDF_VERSION_4_1", + "SDF_VERSION_4_2", + "SDF_VERSION_5", + "SDF_VERSION_5_1", + "SDF_VERSION_5_2", + "SDF_VERSION_5_3", + "SDF_VERSION_5_4", + "SDF_VERSION_5_5", + "SDF_VERSION_6", + "SDF_VERSION_7", + "SDF_VERSION_7_1", + "SDF_VERSION_8" + ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "SDF version value is not specified or is unknown in this version.", + "SDF version 3.1", + "SDF version 4", + "SDF version 4.1", + "SDF version 4.2", + "SDF version 5.", + "SDF version 5.1", + "SDF version 5.2", + "SDF version 5.3", + "SDF version 5.4", + "SDF version 5.5", + "SDF version 6", + "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", + "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.", + "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version." + ], + "type": "string" + } + }, + "type": "object" + }, + "SearchTargetingOptionsRequest": { + "description": "Request message for SearchTargetingOptions.", + "id": "SearchTargetingOptionsRequest", + "properties": { + "advertiserId": { + "description": "Required. The Advertiser this request is being made in the context of.", + "format": "int64", + "type": "string" + }, + "businessChainSearchTerms": { + "$ref": "BusinessChainSearchTerms", + "description": "Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`." + }, + "geoRegionSearchTerms": { + "$ref": "GeoRegionSearchTerms", + "description": "Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`." + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned.", + "type": "string" + }, + "poiSearchTerms": { + "$ref": "PoiSearchTerms", + "description": "Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`." + } + }, + "type": "object" + }, + "SearchTargetingOptionsResponse": { + "description": "Response message for SearchTargetingOptions.", + "id": "SearchTargetingOptionsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `SearchTargetingOptions` method to retrieve the next page of results.", + "type": "string" + }, + "targetingOptions": { + "description": "The list of targeting options that match the search criteria. This list will be absent if empty.", + "items": { + "$ref": "TargetingOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "SensitiveCategoryAssignedTargetingOptionDetails": { + "description": "Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.", + "id": "SensitiveCategoryAssignedTargetingOptionDetails", + "properties": { + "excludedSensitiveCategory": { + "description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.", + "enum": [ + "SENSITIVE_CATEGORY_UNSPECIFIED", + "SENSITIVE_CATEGORY_ADULT", + "SENSITIVE_CATEGORY_DEROGATORY", + "SENSITIVE_CATEGORY_DOWNLOADS_SHARING", + "SENSITIVE_CATEGORY_WEAPONS", + "SENSITIVE_CATEGORY_GAMBLING", + "SENSITIVE_CATEGORY_VIOLENCE", + "SENSITIVE_CATEGORY_SUGGESTIVE", + "SENSITIVE_CATEGORY_PROFANITY", + "SENSITIVE_CATEGORY_ALCOHOL", + "SENSITIVE_CATEGORY_DRUGS", + "SENSITIVE_CATEGORY_TOBACCO", + "SENSITIVE_CATEGORY_POLITICS", + "SENSITIVE_CATEGORY_RELIGION", + "SENSITIVE_CATEGORY_TRAGEDY", + "SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS", + "SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES", + "SENSITIVE_CATEGORY_SHOCKING", + "SENSITIVE_CATEGORY_EMBEDDED_VIDEO", + "SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", + "Adult or pornographic text, image, or video content.", + "Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", + "Content related to audio, video, or software downloads.", + "Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", + "Contains content related to betting or wagering in a real-world or online setting.", + "Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", + "Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", + "Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", + "Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", + "Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", + "Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", + "Political news and media, including discussions of social, governmental, and public policy.", + "Content related to religious thought or beliefs.", + "Content related to death, disasters, accidents, war, etc.", + "Content related to motor vehicle, aviation or other transportation accidents.", + "Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", + "Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", + "YouTube videos embedded on websites outside of YouTube.com.", + "Video of live events streamed over the internet." + ], + "type": "string" + } + }, + "type": "object" + }, + "SensitiveCategoryTargetingOptionDetails": { + "description": "Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.", + "id": "SensitiveCategoryTargetingOptionDetails", + "properties": { + "sensitiveCategory": { + "description": "Output only. An enum for the DV360 Sensitive category content classifier.", + "enum": [ + "SENSITIVE_CATEGORY_UNSPECIFIED", + "SENSITIVE_CATEGORY_ADULT", + "SENSITIVE_CATEGORY_DEROGATORY", + "SENSITIVE_CATEGORY_DOWNLOADS_SHARING", + "SENSITIVE_CATEGORY_WEAPONS", + "SENSITIVE_CATEGORY_GAMBLING", + "SENSITIVE_CATEGORY_VIOLENCE", + "SENSITIVE_CATEGORY_SUGGESTIVE", + "SENSITIVE_CATEGORY_PROFANITY", + "SENSITIVE_CATEGORY_ALCOHOL", + "SENSITIVE_CATEGORY_DRUGS", + "SENSITIVE_CATEGORY_TOBACCO", + "SENSITIVE_CATEGORY_POLITICS", + "SENSITIVE_CATEGORY_RELIGION", + "SENSITIVE_CATEGORY_TRAGEDY", + "SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS", + "SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES", + "SENSITIVE_CATEGORY_SHOCKING", + "SENSITIVE_CATEGORY_EMBEDDED_VIDEO", + "SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", + "Adult or pornographic text, image, or video content.", + "Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", + "Content related to audio, video, or software downloads.", + "Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", + "Contains content related to betting or wagering in a real-world or online setting.", + "Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", + "Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", + "Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", + "Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", + "Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", + "Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", + "Political news and media, including discussions of social, governmental, and public policy.", + "Content related to religious thought or beliefs.", + "Content related to death, disasters, accidents, war, etc.", + "Content related to motor vehicle, aviation or other transportation accidents.", + "Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", + "Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", + "YouTube videos embedded on websites outside of YouTube.com.", + "Video of live events streamed over the internet." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SessionPositionAssignedTargetingOptionDetails": { + "description": "Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`.", + "id": "SessionPositionAssignedTargetingOptionDetails", + "properties": { + "sessionPosition": { + "description": "The position where the ad will show in a session.", + "enum": [ + "SESSION_POSITION_UNSPECIFIED", + "SESSION_POSITION_FIRST_IMPRESSION" + ], + "enumDescriptions": [ + "This is a placeholder, does not indicate any positions.", + "The first impression of the session." + ], + "type": "string" + } + }, + "type": "object" + }, + "Site": { + "description": "A single site. Sites are apps or websites belonging to a channel.", + "id": "Site", + "properties": { + "name": { + "description": "Output only. The resource name of the site.", + "readOnly": true, + "type": "string" + }, + "urlOrAppId": { + "description": "Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "SubExchangeAssignedTargetingOptionDetails": { + "description": "Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.", + "id": "SubExchangeAssignedTargetingOptionDetails", + "properties": { + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.", + "type": "string" + } + }, + "type": "object" + }, + "SubExchangeTargetingOptionDetails": { + "description": "Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.", + "id": "SubExchangeTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the sub-exchange.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TargetFrequency": { + "description": "Setting that controls the average number of times the ads will show to the same person over a certain period of time.", + "id": "TargetFrequency", + "properties": { + "targetCount": { + "description": "The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.", + "format": "int64", + "type": "string" + }, + "timeUnit": { + "description": "The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`", + "enum": [ + "TIME_UNIT_UNSPECIFIED", + "TIME_UNIT_LIFETIME", + "TIME_UNIT_MONTHS", + "TIME_UNIT_WEEKS", + "TIME_UNIT_DAYS", + "TIME_UNIT_HOURS", + "TIME_UNIT_MINUTES" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Time unit value is not specified or is unknown in this version.", + "The frequency cap will be applied to the whole life time of the line item.", + "The frequency cap will be applied to a number of months.", + "The frequency cap will be applied to a number of weeks.", + "The frequency cap will be applied to a number of days.", + "The frequency cap will be applied to a number of hours.", + "The frequency cap will be applied to a number of minutes." + ], + "type": "string" + }, + "timeUnitCount": { + "description": "The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TargetingExpansionConfig": { + "description": "Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.", + "id": "TargetingExpansionConfig", + "properties": { + "audienceExpansionLevel": { + "description": "Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.", + "enum": [ + "UNKNOWN", + "NO_REACH", + "LEAST_REACH", + "MID_REACH", + "MOST_REACH" + ], + "enumDescriptions": [ + "Audience expansion level is not specified or is unknown in this version.", + "Audience expansion off.", + "Conservative audience expansion.", + "Moderate audience expansion.", + "Aggressive audience expansion." + ], + "readOnly": true, + "type": "string" + }, + "audienceExpansionSeedListExcluded": { + "description": "Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.", + "readOnly": true, + "type": "boolean" + }, + "enableOptimizedTargeting": { + "description": "Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`", + "type": "boolean" + } + }, + "type": "object" + }, + "TargetingOption": { + "description": "Represents a single targeting option, which is a targetable concept in DV360.", + "id": "TargetingOption", + "properties": { + "ageRangeDetails": { + "$ref": "AgeRangeTargetingOptionDetails", + "description": "Age range details." + }, + "appCategoryDetails": { + "$ref": "AppCategoryTargetingOptionDetails", + "description": "App category details." + }, + "audioContentTypeDetails": { + "$ref": "AudioContentTypeTargetingOptionDetails", + "description": "Audio content type details." + }, + "authorizedSellerStatusDetails": { + "$ref": "AuthorizedSellerStatusTargetingOptionDetails", + "description": "Authorized seller status resource details." + }, + "browserDetails": { + "$ref": "BrowserTargetingOptionDetails", + "description": "Browser details." + }, + "businessChainDetails": { + "$ref": "BusinessChainTargetingOptionDetails", + "description": "Business chain resource details." + }, + "carrierAndIspDetails": { + "$ref": "CarrierAndIspTargetingOptionDetails", + "description": "Carrier and ISP details." + }, + "categoryDetails": { + "$ref": "CategoryTargetingOptionDetails", + "description": "Category resource details." + }, + "contentDurationDetails": { + "$ref": "ContentDurationTargetingOptionDetails", + "description": "Content duration resource details." + }, + "contentGenreDetails": { + "$ref": "ContentGenreTargetingOptionDetails", + "description": "Content genre resource details." + }, + "contentInstreamPositionDetails": { + "$ref": "ContentInstreamPositionTargetingOptionDetails", + "description": "Content instream position details." + }, + "contentOutstreamPositionDetails": { + "$ref": "ContentOutstreamPositionTargetingOptionDetails", + "description": "Content outstream position details." + }, + "contentStreamTypeDetails": { + "$ref": "ContentStreamTypeTargetingOptionDetails", + "description": "Content stream type resource details." + }, + "deviceMakeModelDetails": { + "$ref": "DeviceMakeModelTargetingOptionDetails", + "description": "Device make and model resource details." + }, + "deviceTypeDetails": { + "$ref": "DeviceTypeTargetingOptionDetails", + "description": "Device type details." + }, + "digitalContentLabelDetails": { + "$ref": "DigitalContentLabelTargetingOptionDetails", + "description": "Digital content label details." + }, + "environmentDetails": { + "$ref": "EnvironmentTargetingOptionDetails", + "description": "Environment details." + }, + "exchangeDetails": { + "$ref": "ExchangeTargetingOptionDetails", + "description": "Exchange details." + }, + "genderDetails": { + "$ref": "GenderTargetingOptionDetails", + "description": "Gender details." + }, + "geoRegionDetails": { + "$ref": "GeoRegionTargetingOptionDetails", + "description": "Geographic region resource details." + }, + "householdIncomeDetails": { + "$ref": "HouseholdIncomeTargetingOptionDetails", + "description": "Household income details." + }, + "languageDetails": { + "$ref": "LanguageTargetingOptionDetails", + "description": "Language resource details." + }, + "name": { + "description": "Output only. The resource name for this targeting option.", + "readOnly": true, + "type": "string" + }, + "nativeContentPositionDetails": { + "$ref": "NativeContentPositionTargetingOptionDetails", + "description": "Native content position details." + }, + "omidDetails": { + "$ref": "OmidTargetingOptionDetails", + "description": "Open Measurement enabled inventory details." + }, + "onScreenPositionDetails": { + "$ref": "OnScreenPositionTargetingOptionDetails", + "description": "On screen position details." + }, + "operatingSystemDetails": { + "$ref": "OperatingSystemTargetingOptionDetails", + "description": "Operating system resources details." + }, + "parentalStatusDetails": { + "$ref": "ParentalStatusTargetingOptionDetails", + "description": "Parental status details." + }, + "poiDetails": { + "$ref": "PoiTargetingOptionDetails", + "description": "POI resource details." + }, + "sensitiveCategoryDetails": { + "$ref": "SensitiveCategoryTargetingOptionDetails", + "description": "Sensitive Category details." + }, + "subExchangeDetails": { + "$ref": "SubExchangeTargetingOptionDetails", + "description": "Sub-exchange details." + }, + "targetingOptionId": { + "description": "Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.", + "readOnly": true, + "type": "string" + }, + "targetingType": { + "description": "Output only. The type of this targeting option.", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "readOnly": true, + "type": "string" + }, + "userRewardedContentDetails": { + "$ref": "UserRewardedContentTargetingOptionDetails", + "description": "User rewarded content details." + }, + "videoPlayerSizeDetails": { + "$ref": "VideoPlayerSizeTargetingOptionDetails", + "description": "Video player size details." + }, + "viewabilityDetails": { + "$ref": "ViewabilityTargetingOptionDetails", + "description": "Viewability resource details." + } + }, + "type": "object" + }, + "ThirdPartyMeasurementConfigs": { + "description": "Settings that control what third-party vendors are measuring specific line item metrics.", + "id": "ThirdPartyMeasurementConfigs", + "properties": { + "brandLiftVendorConfigs": { + "description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`", + "items": { + "$ref": "ThirdPartyVendorConfig" + }, + "type": "array" + }, + "brandSafetyVendorConfigs": { + "description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`", + "items": { + "$ref": "ThirdPartyVendorConfig" + }, + "type": "array" + }, + "reachVendorConfigs": { + "description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`", + "items": { + "$ref": "ThirdPartyVendorConfig" + }, + "type": "array" + }, + "viewabilityVendorConfigs": { + "description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`", + "items": { + "$ref": "ThirdPartyVendorConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThirdPartyOnlyConfig": { + "description": "Settings for advertisers that use third-party ad servers only.", + "id": "ThirdPartyOnlyConfig", + "properties": { + "pixelOrderIdReportingEnabled": { + "description": "Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.", + "type": "boolean" + } + }, + "type": "object" + }, + "ThirdPartyUrl": { + "description": "Tracking URLs from third parties to track interactions with an audio or a video creative.", + "id": "ThirdPartyUrl", + "properties": { + "type": { + "description": "Optional. The type of interaction needs to be tracked by the tracking URL", + "enum": [ + "THIRD_PARTY_URL_TYPE_UNSPECIFIED", + "THIRD_PARTY_URL_TYPE_IMPRESSION", + "THIRD_PARTY_URL_TYPE_CLICK_TRACKING", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP", + "THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS" + ], + "enumDescriptions": [ + "The type of third-party URL is unspecified or is unknown in this version.", + "Used to count impressions of the creative after the audio or video buffering is complete.", + "Used to track user clicks on the audio or video.", + "Used to track the number of times a user starts the audio or video.", + "Used to track the number of times the audio or video plays to 25% of its length.", + "Used to track the number of times the audio or video plays to 50% of its length.", + "Used to track the number of times the audio or video plays to 75% of its length.", + "Used to track the number of times the audio or video plays to the end.", + "Used to track the number of times a user mutes the audio or video.", + "Used to track the number of times a user pauses the audio or video.", + "Used to track the number of times a user replays the audio or video.", + "Used to track the number of times a user expands the player to full-screen size.", + "Used to track the number of times a user stops the audio or video.", + "Used to track the number of times a user performs a custom click, such as clicking on a video hot spot.", + "Used to track the number of times the audio or video was skipped.", + "Used to track the number of times the audio or video plays to an offset determined by the progress_offset." + ], + "type": "string" + }, + "url": { + "description": "Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path`", + "type": "string" + } + }, + "type": "object" + }, + "ThirdPartyVendorConfig": { + "description": "Settings that control how third-party measurement vendors are configured.", + "id": "ThirdPartyVendorConfig", + "properties": { + "placementId": { + "description": "The ID used by the platform of the third-party vendor to identify the line item.", + "type": "string" + }, + "vendor": { + "description": "The third-party measurement vendor.", + "enum": [ + "THIRD_PARTY_VENDOR_UNSPECIFIED", + "THIRD_PARTY_VENDOR_MOAT", + "THIRD_PARTY_VENDOR_DOUBLE_VERIFY", + "THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE", + "THIRD_PARTY_VENDOR_COMSCORE", + "THIRD_PARTY_VENDOR_TELEMETRY", + "THIRD_PARTY_VENDOR_MEETRICS", + "THIRD_PARTY_VENDOR_ZEFR", + "THIRD_PARTY_VENDOR_NIELSEN", + "THIRD_PARTY_VENDOR_KANTAR", + "THIRD_PARTY_VENDOR_DYNATA" + ], + "enumDescriptions": [ + "Unknown third-party vendor.", + "Moat.", + "DoubleVerify.", + "Integral Ad Science.", + "Comscore.", + "Telemetry.", + "Meetrics.", + "ZEFR.", + "Nielsen.", + "Kantar.", + "Dynata." + ], + "type": "string" + } + }, + "type": "object" + }, + "ThirdPartyVerifierAssignedTargetingOptionDetails": { + "description": "Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.", + "id": "ThirdPartyVerifierAssignedTargetingOptionDetails", + "properties": { + "adloox": { + "$ref": "Adloox", + "description": "Third party brand verifier -- Adloox." + }, + "doubleVerify": { + "$ref": "DoubleVerify", + "description": "Third party brand verifier -- DoubleVerify." + }, + "integralAdScience": { + "$ref": "IntegralAdScience", + "description": "Third party brand verifier -- Integral Ad Science." + } + }, + "type": "object" + }, + "TimeRange": { + "description": "A time range.", + "id": "TimeRange", + "properties": { + "endTime": { + "description": "Required. The upper bound of a time range, inclusive.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Required. The lower bound of a time range, inclusive.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "TimerEvent": { + "description": "Timer event of the creative.", + "id": "TimerEvent", + "properties": { + "name": { + "description": "Required. The name of the timer event.", + "type": "string" + }, + "reportingName": { + "description": "Required. The name used to identify this timer event in reports.", + "type": "string" + } + }, + "type": "object" + }, + "TrackingFloodlightActivityConfig": { + "description": "Settings that control the behavior of a single Floodlight activity config.", + "id": "TrackingFloodlightActivityConfig", + "properties": { + "floodlightActivityId": { + "description": "Required. The ID of the Floodlight activity.", + "format": "int64", + "type": "string" + }, + "postClickLookbackWindowDays": { + "description": "Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.", + "format": "int32", + "type": "integer" + }, + "postViewLookbackWindowDays": { + "description": "Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Transcode": { + "description": "Represents information about the transcoded audio or video file.", + "id": "Transcode", + "properties": { + "audioBitRateKbps": { + "description": "Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second.", + "format": "int64", + "type": "string" + }, + "audioSampleRateHz": { + "description": "Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz.", + "format": "int64", + "type": "string" + }, + "bitRateKbps": { + "description": "Optional. The transcoding bit rate of the transcoded video, in kilobits per second.", + "format": "int64", + "type": "string" + }, + "dimensions": { + "$ref": "Dimensions", + "description": "Optional. The dimensions of the transcoded video." + }, + "fileSizeBytes": { + "description": "Optional. The size of the transcoded file, in bytes.", + "format": "int64", + "type": "string" + }, + "frameRate": { + "description": "Optional. The frame rate of the transcoded video, in frames per second.", + "format": "float", + "type": "number" + }, + "mimeType": { + "description": "Optional. The MIME type of the transcoded file.", + "type": "string" + }, + "name": { + "description": "Optional. The name of the transcoded file.", + "type": "string" + }, + "transcoded": { + "description": "Optional. Indicates if the transcoding was successful.", + "type": "boolean" + } + }, + "type": "object" + }, + "UniversalAdId": { + "description": "A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard.", + "id": "UniversalAdId", + "properties": { + "id": { + "description": "Optional. The unique creative identifier.", + "type": "string" + }, + "registry": { + "description": "Optional. The registry provides unique creative identifiers.", + "enum": [ + "UNIVERSAL_AD_REGISTRY_UNSPECIFIED", + "UNIVERSAL_AD_REGISTRY_OTHER", + "UNIVERSAL_AD_REGISTRY_AD_ID", + "UNIVERSAL_AD_REGISTRY_CLEARCAST", + "UNIVERSAL_AD_REGISTRY_DV360", + "UNIVERSAL_AD_REGISTRY_CM" + ], + "enumDescriptions": [ + "The Universal Ad registry is unspecified or is unknown in this version.", + "Use a custom provider to provide the Universal Ad ID.", + "Use Ad-ID to provide the Universal Ad ID.", + "Use clearcast.co.uk to provide the Universal Ad ID.", + "Use Display & Video 360 to provide the Universal Ad ID.", + "Use Campaign Manager 360 to provide the Universal Ad ID." + ], + "type": "string" + } + }, + "type": "object" + }, + "UrlAssignedTargetingOptionDetails": { + "description": "Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`.", + "id": "UrlAssignedTargetingOptionDetails", + "properties": { + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "url": { + "description": "Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.", + "type": "string" + } + }, + "type": "object" + }, + "User": { + "description": "A single user in Display & Video 360.", + "id": "User", + "properties": { + "assignedUserRoles": { + "description": "The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.", + "items": { + "$ref": "AssignedUserRole" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "email": { + "description": "Required. Immutable. The email address used to identify the user.", + "type": "string" + }, + "lastLoginTime": { + "description": "Output only. The timestamp when the user last logged in DV360 UI.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the user.", + "readOnly": true, + "type": "string" + }, + "userId": { + "description": "Output only. The unique ID of the user. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UserRewardedContentAssignedTargetingOptionDetails": { + "description": "User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.", + "id": "UserRewardedContentAssignedTargetingOptionDetails", + "properties": { + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.", + "type": "string" + }, + "userRewardedContent": { + "description": "Output only. User rewarded content status for video ads.", + "enum": [ + "USER_REWARDED_CONTENT_UNSPECIFIED", + "USER_REWARDED_CONTENT_USER_REWARDED", + "USER_REWARDED_CONTENT_NOT_USER_REWARDED" + ], + "enumDescriptions": [ + "User rewarded content is not specified or is unknown in this version.", + "Represents ads where the user will see a reward after viewing.", + "Represents all other ads besides user-rewarded." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UserRewardedContentTargetingOptionDetails": { + "description": "Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.", + "id": "UserRewardedContentTargetingOptionDetails", + "properties": { + "userRewardedContent": { + "description": "Output only. User rewarded content status for video ads.", + "enum": [ + "USER_REWARDED_CONTENT_UNSPECIFIED", + "USER_REWARDED_CONTENT_USER_REWARDED", + "USER_REWARDED_CONTENT_NOT_USER_REWARDED" + ], + "enumDescriptions": [ + "User rewarded content is not specified or is unknown in this version.", + "Represents ads where the user will see a reward after viewing.", + "Represents all other ads besides user-rewarded." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "VideoAdSequenceSettings": { + "description": "Settings related to VideoAdSequence.", + "id": "VideoAdSequenceSettings", + "properties": { + "minimumDuration": { + "description": "The minimum time interval before the same user sees this sequence again.", + "enum": [ + "VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED", + "VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK", + "VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH" + ], + "enumDescriptions": [ + "Unspecified or unknown.", + "7 days.", + "30 days." + ], + "type": "string" + }, + "steps": { + "description": "The steps of which the sequence consists.", + "items": { + "$ref": "VideoAdSequenceStep" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoAdSequenceStep": { + "description": "The detail of a single step in a VideoAdSequence.", + "id": "VideoAdSequenceStep", + "properties": { + "adGroupId": { + "description": "The ID of the corresponding ad group of the step.", + "format": "int64", + "type": "string" + }, + "interactionType": { + "description": "The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.", + "enum": [ + "INTERACTION_TYPE_UNSPECIFIED", + "INTERACTION_TYPE_PAID_VIEW", + "INTERACTION_TYPE_SKIP", + "INTERACTION_TYPE_IMPRESSION", + "INTERACTION_TYPE_ENGAGED_IMPRESSION" + ], + "enumDescriptions": [ + "Unspecified or unknown", + "A paid view.", + "Skipped by the viewer.", + "A (viewed) ad impression.", + "An ad impression that was not immediately skipped by the viewer, but didn't reach the billable event either." + ], + "type": "string" + }, + "previousStepId": { + "description": "The ID of the previous step. The first step does not have previous step.", + "format": "int64", + "type": "string" + }, + "stepId": { + "description": "The ID of the step.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "VideoDiscoveryAd": { + "description": "Details for a video discovery ad.", + "id": "VideoDiscoveryAd", + "properties": { + "description1": { + "description": "First text line for the ad.", + "type": "string" + }, + "description2": { + "description": "Second text line for the ad.", + "type": "string" + }, + "headline": { + "description": "The headline of ad.", + "type": "string" + }, + "thumbnail": { + "description": "Thumbnail image used in the ad.", + "enum": [ + "THUMBNAIL_UNSPECIFIED", + "THUMBNAIL_DEFAULT", + "THUMBNAIL_1", + "THUMBNAIL_2", + "THUMBNAIL_3" + ], + "enumDescriptions": [ + "Unknown or unspecified.", + "The default thumbnail, can be auto-generated or user-uploaded.", + "Thumbnail 1, generated from the video.", + "Thumbnail 2, generated from the video.", + "Thumbnail 3, generated from the video." + ], + "type": "string" + }, + "video": { + "$ref": "YoutubeVideoDetails", + "description": "The YouTube video the ad promotes." + } + }, + "type": "object" + }, + "VideoPerformanceAd": { + "description": "Details for a video performance ad.", + "id": "VideoPerformanceAd", + "properties": { + "actionButtonLabels": { + "description": "The list of text assets shown on the call-to-action button.", + "items": { + "type": "string" + }, + "type": "array" + }, + "companionBanners": { + "description": "The list of companion banners used by this ad.", + "items": { + "$ref": "ImageAsset" + }, + "type": "array" + }, + "customParameters": { "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" + "type": "string" }, - "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`.", + "description": "The custom parameters to pass custom values to tracking URL template.", "type": "object" + }, + "descriptions": { + "description": "The list of descriptions shown on the call-to-action banner.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayUrlBreadcrumb1": { + "description": "The first piece after the domain in the display URL.", + "type": "string" + }, + "displayUrlBreadcrumb2": { + "description": "The second piece after the domain in the display URL.", + "type": "string" + }, + "domain": { + "description": "The domain of the display URL.", + "type": "string" + }, + "finalUrl": { + "description": "The URL address of the webpage that people reach after they click the ad.", + "type": "string" + }, + "headlines": { + "description": "The list of headlines shown on the call-to-action banner.", + "items": { + "type": "string" + }, + "type": "array" + }, + "longHeadlines": { + "description": "The list of lone headlines shown on the call-to-action banner.", + "items": { + "type": "string" + }, + "type": "array" + }, + "trackingUrl": { + "description": "The URL address loaded in the background for tracking purposes.", + "type": "string" + }, + "videos": { + "description": "The list of YouTube video assets used by this ad.", + "items": { + "$ref": "YoutubeVideoDetails" + }, + "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", + "VideoPlayerSizeAssignedTargetingOptionDetails": { + "description": "Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect.", + "id": "VideoPlayerSizeAssignedTargetingOptionDetails", "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" + "videoPlayerSize": { + "description": "Required. The video player size.", + "enum": [ + "VIDEO_PLAYER_SIZE_UNSPECIFIED", + "VIDEO_PLAYER_SIZE_SMALL", + "VIDEO_PLAYER_SIZE_LARGE", + "VIDEO_PLAYER_SIZE_HD", + "VIDEO_PLAYER_SIZE_UNKNOWN" + ], + "enumDescriptions": [ + "Video player size is not specified in this version. This enum is a place holder for a default value and does not represent a real video player size.", + "The dimensions of the video player are less than 400×300 (desktop), or up to 20% of screen covered (mobile).", + "The dimensions of the video player are between 400x300 and 1280x720 pixels (desktop), or 20% to 90% of the screen covered (mobile).", + "The dimensions of the video player are 1280×720 or greater (desktop), or over 90% of the screen covered (mobile).", + "The dimensions of the video player are unknown." + ], + "type": "string" + } + }, + "type": "object" + }, + "VideoPlayerSizeTargetingOptionDetails": { + "description": "Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.", + "id": "VideoPlayerSizeTargetingOptionDetails", + "properties": { + "videoPlayerSize": { + "description": "Output only. The video player size.", + "enum": [ + "VIDEO_PLAYER_SIZE_UNSPECIFIED", + "VIDEO_PLAYER_SIZE_SMALL", + "VIDEO_PLAYER_SIZE_LARGE", + "VIDEO_PLAYER_SIZE_HD", + "VIDEO_PLAYER_SIZE_UNKNOWN" + ], + "enumDescriptions": [ + "Video player size is not specified in this version. This enum is a place holder for a default value and does not represent a real video player size.", + "The dimensions of the video player are less than 400×300 (desktop), or up to 20% of screen covered (mobile).", + "The dimensions of the video player are between 400x300 and 1280x720 pixels (desktop), or 20% to 90% of the screen covered (mobile).", + "The dimensions of the video player are 1280×720 or greater (desktop), or over 90% of the screen covered (mobile).", + "The dimensions of the video player are unknown." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ViewabilityAssignedTargetingOptionDetails": { + "description": "Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`.", + "id": "ViewabilityAssignedTargetingOptionDetails", + "properties": { + "viewability": { + "description": "Required. The predicted viewability percentage.", + "enum": [ + "VIEWABILITY_UNSPECIFIED", + "VIEWABILITY_10_PERCENT_OR_MORE", + "VIEWABILITY_20_PERCENT_OR_MORE", + "VIEWABILITY_30_PERCENT_OR_MORE", + "VIEWABILITY_40_PERCENT_OR_MORE", + "VIEWABILITY_50_PERCENT_OR_MORE", + "VIEWABILITY_60_PERCENT_OR_MORE", + "VIEWABILITY_70_PERCENT_OR_MORE", + "VIEWABILITY_80_PERCENT_OR_MORE", + "VIEWABILITY_90_PERCENT_OR_MORE" + ], + "enumDescriptions": [ + "Default value when viewability is not specified in this version. This enum is a placeholder for default value and does not represent a real viewability option.", + "Bid only on impressions that are at least 10% likely to be viewable.", + "Bid only on impressions that are at least 20% likely to be viewable.", + "Bid only on impressions that are at least 30% likely to be viewable.", + "Bid only on impressions that are at least 40% likely to be viewable.", + "Bid only on impressions that are at least 50% likely to be viewable.", + "Bid only on impressions that are at least 60% likely to be viewable.", + "Bid only on impressions that are at least 70% likely to be viewable.", + "Bid only on impressions that are at least 80% likely to be viewable.", + "Bid only on impressions that are at least 90% likely to be viewable." + ], + "type": "string" + } + }, + "type": "object" + }, + "ViewabilityTargetingOptionDetails": { + "description": "Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`.", + "id": "ViewabilityTargetingOptionDetails", + "properties": { + "viewability": { + "description": "Output only. The predicted viewability percentage.", + "enum": [ + "VIEWABILITY_UNSPECIFIED", + "VIEWABILITY_10_PERCENT_OR_MORE", + "VIEWABILITY_20_PERCENT_OR_MORE", + "VIEWABILITY_30_PERCENT_OR_MORE", + "VIEWABILITY_40_PERCENT_OR_MORE", + "VIEWABILITY_50_PERCENT_OR_MORE", + "VIEWABILITY_60_PERCENT_OR_MORE", + "VIEWABILITY_70_PERCENT_OR_MORE", + "VIEWABILITY_80_PERCENT_OR_MORE", + "VIEWABILITY_90_PERCENT_OR_MORE" + ], + "enumDescriptions": [ + "Default value when viewability is not specified in this version. This enum is a placeholder for default value and does not represent a real viewability option.", + "Bid only on impressions that are at least 10% likely to be viewable.", + "Bid only on impressions that are at least 20% likely to be viewable.", + "Bid only on impressions that are at least 30% likely to be viewable.", + "Bid only on impressions that are at least 40% likely to be viewable.", + "Bid only on impressions that are at least 50% likely to be viewable.", + "Bid only on impressions that are at least 60% likely to be viewable.", + "Bid only on impressions that are at least 70% likely to be viewable.", + "Bid only on impressions that are at least 80% likely to be viewable.", + "Bid only on impressions that are at least 90% likely to be viewable." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "YoutubeAndPartnersBiddingStrategy": { + "description": "Settings that control the bid strategy for YouTube and Partners resources.", + "id": "YoutubeAndPartnersBiddingStrategy", + "properties": { + "adGroupEffectiveTargetCpaSource": { + "description": "Output only. Source of the effective target CPA value for ad group.", + "enum": [ + "BIDDING_SOURCE_UNSPECIFIED", + "BIDDING_SOURCE_LINE_ITEM", + "BIDDING_SOURCE_AD_GROUP" + ], + "enumDescriptions": [ + "Bidding source is not specified or unknown.", + "Bidding value is inherited from the line item.", + "Bidding value is defined in the ad group." + ], + "readOnly": true, + "type": "string" }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "adGroupEffectiveTargetCpaValue": { + "description": "Output only. The effective target CPA for ad group, in micros of advertiser's currency.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of the bidding strategy.", + "enum": [ + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE" + ], + "enumDescriptions": [ + "Type is not specified or unknown.", + "A bidding strategy that pays a configurable amount per video view.", + "A bidding strategy that pays a configurable amount per impression.", + "A bidding strategy that automatically optimizes conversions per dollar.", + "A bidding strategy that pays a configurable amount per impression.", + "A bidding strategy for YouTube Instant Reserve line items that pays a fixed amount per impression.", + "An automated bidding strategy that sets bids to achieve maximum lift.", + "A bidding strategy that automatically maximizes number of conversions given a daily budget.", + "A bidding strategy that automatically optimizes cost per video view.", + "A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", + "A bidding strategy that automatically sets bids to maximize revenue while spending your budget." + ], + "type": "string" + }, + "value": { + "description": "The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "YoutubeAndPartnersInventorySourceConfig": { + "description": "Settings that control what YouTube related inventories the YouTube and Partners line item will target.", + "id": "YoutubeAndPartnersInventorySourceConfig", + "properties": { + "includeGoogleTv": { + "description": "Optional. Whether to target inventory in video apps available with Google TV.", + "type": "boolean" + }, + "includeYoutube": { + "description": "Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.", + "type": "boolean" + }, + "includeYoutubeVideoPartners": { + "description": "Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.", + "type": "boolean" + } + }, + "type": "object" + }, + "YoutubeAndPartnersSettings": { + "description": "Settings for YouTube and Partners line items.", + "id": "YoutubeAndPartnersSettings", + "properties": { + "contentCategory": { + "description": "The kind of content on which the YouTube and Partners ads will be shown.", + "enum": [ + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED" + ], + "enumDescriptions": [ + "Content category is not specified or is unknown in this version.", + "A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube's [advertiser-friendly content guidelines](https://support.google.com/youtube/answer/6162278).", + "A category including all content across YouTube and video partners that meets standards for monetization.", + "A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness." + ], + "type": "string" + }, + "effectiveContentCategory": { + "description": "Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.", + "enum": [ + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED" + ], + "enumDescriptions": [ + "Content category is not specified or is unknown in this version.", + "A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube's [advertiser-friendly content guidelines](https://support.google.com/youtube/answer/6162278).", + "A category including all content across YouTube and video partners that meets standards for monetization.", + "A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness." + ], + "readOnly": true, + "type": "string" + }, + "inventorySourceSettings": { + "$ref": "YoutubeAndPartnersInventorySourceConfig", + "description": "Settings that control what YouTube and Partners inventories the line item will target." + }, + "leadFormId": { + "description": "Optional. The ID of the form to generate leads.", + "format": "int64", + "type": "string" + }, + "linkedMerchantId": { + "description": "Optional. The ID of the merchant which is linked to the line item for product feed.", + "format": "int64", + "type": "string" + }, + "relatedVideoIds": { + "description": "Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.", "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" + "type": "string" }, "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.", + "targetFrequency": { + "$ref": "TargetFrequency", + "description": "Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time." + }, + "thirdPartyMeasurementConfigs": { + "$ref": "ThirdPartyMeasurementConfigs", + "description": "Optional. The third-party measurement configs of the line item." + }, + "videoAdSequenceSettings": { + "$ref": "VideoAdSequenceSettings", + "description": "Optional. The settings related to VideoAdSequence." + }, + "viewFrequencyCap": { + "$ref": "FrequencyCap", + "description": "The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap." + } + }, + "type": "object" + }, + "YoutubeChannelAssignedTargetingOptionDetails": { + "description": "Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.", + "id": "YoutubeChannelAssignedTargetingOptionDetails", + "properties": { + "channelId": { + "description": "The YouTube uploader channel id or the channel code of a YouTube channel.", + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + } + }, + "type": "object" + }, + "YoutubeVideoAssignedTargetingOptionDetails": { + "description": "Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.", + "id": "YoutubeVideoAssignedTargetingOptionDetails", + "properties": { + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "videoId": { + "description": "YouTube video id as it appears on the YouTube watch page.", + "type": "string" + } + }, + "type": "object" + }, + "YoutubeVideoDetails": { + "description": "Details of a YouTube video.", + "id": "YoutubeVideoDetails", + "properties": { + "id": { + "description": "The YouTube video ID which can be searched on YouTube webpage.", + "type": "string" + }, + "unavailableReason": { + "description": "The reason why the video data is not available.", + "enum": [ + "VIDEO_UNAVAILABLE_REASON_UNSPECIFIED", + "VIDEO_UNAVAILABLE_REASON_PRIVATE", + "VIDEO_UNAVAILABLE_REASON_DELETED" + ], + "enumDescriptions": [ + "Unknown or unspecified.", + "The video is private.", + "The video is deleted." + ], "type": "string" } }, diff --git a/src/apis/displayvideo/v2.ts b/src/apis/displayvideo/v2.ts index 3274c0d82bf..947e8ca473f 100644 --- a/src/apis/displayvideo/v2.ts +++ b/src/apis/displayvideo/v2.ts @@ -427,11 +427,11 @@ export namespace displayvideo_v2 { */ export interface Schema$AssetAssociation { /** - * The associated asset. + * Optional. The associated asset. */ asset?: Schema$Asset; /** - * The role of this asset for the creative. + * Optional. The role of this asset for the creative. */ role?: string | null; } @@ -708,23 +708,23 @@ export namespace displayvideo_v2 { userRole?: string | null; } /** - * Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 + * Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. */ export interface Schema$AudienceGroupAssignedTargetingOptionDetails { /** - * The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + * Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. */ excludedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; /** - * The combined audience ids of the included combined audience group. Contains combined audience ids only. + * Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. */ includedCombinedAudienceGroup?: Schema$CombinedAudienceGroup; /** - * The custom list ids of the included custom list group. Contains custom list ids only. + * Optional. The custom list ids of the included custom list group. Contains custom list ids only. */ includedCustomListGroup?: Schema$CustomListGroup; /** - * The Google audience ids of the included Google audience group. Contains Google audience ids only. + * Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. */ includedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; } @@ -772,11 +772,11 @@ export namespace displayvideo_v2 { */ export interface Schema$AudioVideoOffset { /** - * The offset in percentage of the audio or video duration. + * Optional. The offset in percentage of the audio or video duration. */ percentage?: string | null; /** - * The offset in seconds from the start of the audio or video. + * Optional. The offset in seconds from the start of the audio or video. */ seconds?: string | null; } @@ -1257,7 +1257,7 @@ export namespace displayvideo_v2 { */ entityStatus?: string | null; /** - * Required. The frequency cap setting of the campaign. + * Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) */ frequencyCap?: Schema$FrequencyCap; /** @@ -1476,15 +1476,15 @@ export namespace displayvideo_v2 { */ export interface Schema$CmTrackingAd { /** - * The ad ID of the campaign manager 360 tracking Ad. + * Optional. The ad ID of the campaign manager 360 tracking Ad. */ cmAdId?: string | null; /** - * The creative ID of the campaign manager 360 tracking Ad. + * Optional. The creative ID of the campaign manager 360 tracking Ad. */ cmCreativeId?: string | null; /** - * The placement ID of the campaign manager 360 tracking Ad. + * Optional. The placement ID of the campaign manager 360 tracking Ad. */ cmPlacementId?: string | null; } @@ -1510,7 +1510,7 @@ export namespace displayvideo_v2 { */ export interface Schema$CombinedAudienceGroup { /** - * Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + * Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. */ settings?: Schema$CombinedAudienceTargetingSetting[]; } @@ -1675,7 +1675,7 @@ export namespace displayvideo_v2 { */ export interface Schema$ConversionCountingConfig { /** - * The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + * The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */ floodlightActivityConfigs?: Schema$TrackingFloodlightActivityConfig[]; /** @@ -1761,7 +1761,7 @@ export namespace displayvideo_v2 { */ export interface Schema$Creative { /** - * Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + * Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. */ additionalDimensions?: Schema$Dimensions[]; /** @@ -1769,7 +1769,7 @@ export namespace displayvideo_v2 { */ advertiserId?: string | null; /** - * Third-party HTML tracking tag to be appended to the creative tag. + * Optional. Third-party HTML tracking tag to be appended to the creative tag. */ appendedTag?: string | null; /** @@ -1781,15 +1781,15 @@ export namespace displayvideo_v2 { */ cmPlacementId?: string | null; /** - * The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + * Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. */ cmTrackingAd?: Schema$CmTrackingAd; /** - * The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + * Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` */ companionCreativeIds?: string[] | null; /** - * Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + * Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. */ counterEvents?: Schema$CounterEvent[]; /** @@ -1845,15 +1845,15 @@ export namespace displayvideo_v2 { */ html5Video?: boolean | null; /** - * Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + * Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. */ iasCampaignMonitoring?: boolean | null; /** - * ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + * Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. */ integrationCode?: string | null; /** - * JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + * Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` */ jsTrackerUrl?: string | null; /** @@ -1873,11 +1873,11 @@ export namespace displayvideo_v2 { */ name?: string | null; /** - * User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + * Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. */ notes?: string | null; /** - * Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` + * Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` */ obaIcon?: Schema$ObaIcon; /** @@ -1885,7 +1885,7 @@ export namespace displayvideo_v2 { */ oggAudio?: boolean | null; /** - * Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + * Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` */ progressOffset?: Schema$AudioVideoOffset; /** @@ -1905,11 +1905,11 @@ export namespace displayvideo_v2 { */ reviewStatus?: Schema$ReviewStatusInfo; /** - * Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + * Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` */ skipOffset?: Schema$AudioVideoOffset; /** - * Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + * Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` */ skippable?: boolean | null; /** @@ -1917,19 +1917,19 @@ export namespace displayvideo_v2 { */ thirdPartyTag?: string | null; /** - * Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + * Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` */ thirdPartyUrls?: Schema$ThirdPartyUrl[]; /** - * Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + * Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. */ timerEvents?: Schema$TimerEvent[]; /** - * Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + * Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` */ trackerUrls?: string[] | null; /** - * Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + * Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` */ transcodes?: Schema$Transcode[]; /** @@ -2105,7 +2105,7 @@ export namespace displayvideo_v2 { */ export interface Schema$CustomListGroup { /** - * Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + * Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. */ settings?: Schema$CustomListTargetingSetting[]; } @@ -2544,11 +2544,11 @@ export namespace displayvideo_v2 { */ export interface Schema$ExitEvent { /** - * The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + * Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. */ name?: string | null; /** - * The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + * Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. */ reportingName?: string | null; /** @@ -2656,7 +2656,7 @@ export namespace displayvideo_v2 { */ timeUnit?: string | null; /** - * The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + * The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 */ timeUnitCount?: number | null; /** @@ -2772,7 +2772,7 @@ export namespace displayvideo_v2 { */ export interface Schema$GoogleAudienceGroup { /** - * Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + * Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. */ settings?: Schema$GoogleAudienceTargetingSetting[]; } @@ -2945,7 +2945,7 @@ export namespace displayvideo_v2 { */ advertiserId?: string | null; /** - * The bidding strategy of the insertion order. By default, fixed_bid is set. + * Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. */ bidStrategy?: Schema$BiddingStrategy; /** @@ -2977,11 +2977,11 @@ export namespace displayvideo_v2 { */ insertionOrderId?: string | null; /** - * The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + * Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. */ insertionOrderType?: string | null; /** - * Additional integration details of the insertion order. + * Optional. Additional integration details of the insertion order. */ integrationDetails?: Schema$IntegrationDetails; /** @@ -2993,7 +2993,7 @@ export namespace displayvideo_v2 { */ pacing?: Schema$Pacing; /** - * The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + * Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. */ partnerCosts?: Schema$PartnerCost[]; /** @@ -3014,7 +3014,7 @@ export namespace displayvideo_v2 { */ export interface Schema$InsertionOrderBudget { /** - * The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + * Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. */ automationType?: string | null; /** @@ -3035,7 +3035,7 @@ export namespace displayvideo_v2 { */ budgetAmountMicros?: string | null; /** - * The budget_id of the campaign budget that this insertion order budget segment is a part of. + * Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. */ campaignBudgetId?: string | null; /** @@ -3043,7 +3043,7 @@ export namespace displayvideo_v2 { */ dateRange?: Schema$DateRange; /** - * The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + * Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. */ description?: string | null; } @@ -3478,7 +3478,7 @@ export namespace displayvideo_v2 { */ campaignId?: string | null; /** - * The conversion tracking setting of the line item. + * The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */ conversionCounting?: Schema$ConversionCountingConfig; /** @@ -4086,7 +4086,7 @@ export namespace displayvideo_v2 { */ export interface Schema$MaximizeSpendBidStrategy { /** - * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */ customBiddingAlgorithmId?: string | null; /** @@ -4236,35 +4236,35 @@ export namespace displayvideo_v2 { */ export interface Schema$ObaIcon { /** - * Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + * Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` */ clickTrackingUrl?: string | null; /** - * The dimensions of the OBA icon. + * Optional. The dimensions of the OBA icon. */ dimensions?: Schema$Dimensions; /** - * Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + * Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` */ landingPageUrl?: string | null; /** - * The position of the OBA icon on the creative. + * Optional. The position of the OBA icon on the creative. */ position?: string | null; /** - * The program of the OBA icon. For example: “AdChoices”. + * Optional. The program of the OBA icon. For example: “AdChoices”. */ program?: string | null; /** - * The MIME type of the OBA icon resource. + * Optional. The MIME type of the OBA icon resource. */ resourceMimeType?: string | null; /** - * The URL of the OBA icon resource. + * Optional. The URL of the OBA icon resource. */ resourceUrl?: string | null; /** - * Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + * Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` */ viewTrackingUrl?: string | null; } @@ -4555,7 +4555,7 @@ export namespace displayvideo_v2 { */ export interface Schema$PerformanceGoalBidStrategy { /** - * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */ customBiddingAlgorithmId?: string | null; /** @@ -5206,11 +5206,11 @@ export namespace displayvideo_v2 { */ export interface Schema$ThirdPartyUrl { /** - * The type of interaction needs to be tracked by the tracking URL + * Optional. The type of interaction needs to be tracked by the tracking URL */ type?: string | null; /** - * Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + * Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` */ url?: string | null; } @@ -5292,39 +5292,39 @@ export namespace displayvideo_v2 { */ export interface Schema$Transcode { /** - * The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + * Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. */ audioBitRateKbps?: string | null; /** - * The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + * Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. */ audioSampleRateHz?: string | null; /** - * The transcoding bit rate of the transcoded video, in kilobits per second. + * Optional. The transcoding bit rate of the transcoded video, in kilobits per second. */ bitRateKbps?: string | null; /** - * The dimensions of the transcoded video. + * Optional. The dimensions of the transcoded video. */ dimensions?: Schema$Dimensions; /** - * The size of the transcoded file, in bytes. + * Optional. The size of the transcoded file, in bytes. */ fileSizeBytes?: string | null; /** - * The frame rate of the transcoded video, in frames per second. + * Optional. The frame rate of the transcoded video, in frames per second. */ frameRate?: number | null; /** - * The MIME type of the transcoded file. + * Optional. The MIME type of the transcoded file. */ mimeType?: string | null; /** - * The name of the transcoded file. + * Optional. The name of the transcoded file. */ name?: string | null; /** - * Indicates if the transcoding was successful. + * Optional. Indicates if the transcoding was successful. */ transcoded?: boolean | null; } @@ -5333,11 +5333,11 @@ export namespace displayvideo_v2 { */ export interface Schema$UniversalAdId { /** - * The unique creative identifier. + * Optional. The unique creative identifier. */ id?: string | null; /** - * The registry provides unique creative identifiers. + * Optional. The registry provides unique creative identifiers. */ registry?: string | null; } @@ -15763,7 +15763,7 @@ export namespace displayvideo_v2 { } /** - * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. + * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16039,7 +16039,7 @@ export namespace displayvideo_v2 { } /** - * Creates a new custom bidding script. Returns the newly created script if successful. + * Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index 574658cd4b8..bbb0b4bf963 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -125,6 +125,7 @@ export namespace displayvideo_v3 { media: Resource$Media; partners: Resource$Partners; sdfdownloadtasks: Resource$Sdfdownloadtasks; + sdfuploadtasks: Resource$Sdfuploadtasks; targetingTypes: Resource$Targetingtypes; users: Resource$Users; @@ -152,6 +153,7 @@ export namespace displayvideo_v3 { this.media = new Resource$Media(this.context); this.partners = new Resource$Partners(this.context); this.sdfdownloadtasks = new Resource$Sdfdownloadtasks(this.context); + this.sdfuploadtasks = new Resource$Sdfuploadtasks(this.context); this.targetingTypes = new Resource$Targetingtypes(this.context); this.users = new Resource$Users(this.context); } @@ -756,11 +758,11 @@ export namespace displayvideo_v3 { */ export interface Schema$AssetAssociation { /** - * The associated asset. + * Optional. The associated asset. */ asset?: Schema$Asset; /** - * The role of this asset for the creative. + * Optional. The role of this asset for the creative. */ role?: string | null; } @@ -1037,31 +1039,31 @@ export namespace displayvideo_v3 { userRole?: string | null; } /** - * Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. NEXT_ID: 9 + * Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. */ export interface Schema$AudienceGroupAssignedTargetingOptionDetails { /** - * The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + * Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. */ excludedFirstAndThirdPartyAudienceGroup?: Schema$FirstAndThirdPartyAudienceGroup; /** - * The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + * Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. */ excludedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; /** - * The combined audience ids of the included combined audience group. Contains combined audience ids only. + * Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. */ includedCombinedAudienceGroup?: Schema$CombinedAudienceGroup; /** - * The custom list ids of the included custom list group. Contains custom list ids only. + * Optional. The custom list ids of the included custom list group. Contains custom list ids only. */ includedCustomListGroup?: Schema$CustomListGroup; /** - * The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + * Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. */ includedFirstAndThirdPartyAudienceGroups?: Schema$FirstAndThirdPartyAudienceGroup[]; /** - * The Google audience ids of the included Google audience group. Contains Google audience ids only. + * Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. */ includedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; } @@ -1109,11 +1111,11 @@ export namespace displayvideo_v3 { */ export interface Schema$AudioVideoOffset { /** - * The offset in percentage of the audio or video duration. + * Optional. The offset in percentage of the audio or video duration. */ percentage?: string | null; /** - * The offset in seconds from the start of the audio or video. + * Optional. The offset in seconds from the start of the audio or video. */ seconds?: string | null; } @@ -1618,7 +1620,7 @@ export namespace displayvideo_v3 { */ entityStatus?: string | null; /** - * Required. The frequency cap setting of the campaign. + * Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) */ frequencyCap?: Schema$FrequencyCap; /** @@ -1837,15 +1839,15 @@ export namespace displayvideo_v3 { */ export interface Schema$CmTrackingAd { /** - * The ad ID of the campaign manager 360 tracking Ad. + * Optional. The ad ID of the campaign manager 360 tracking Ad. */ cmAdId?: string | null; /** - * The creative ID of the campaign manager 360 tracking Ad. + * Optional. The creative ID of the campaign manager 360 tracking Ad. */ cmCreativeId?: string | null; /** - * The placement ID of the campaign manager 360 tracking Ad. + * Optional. The placement ID of the campaign manager 360 tracking Ad. */ cmPlacementId?: string | null; } @@ -1871,7 +1873,7 @@ export namespace displayvideo_v3 { */ export interface Schema$CombinedAudienceGroup { /** - * Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + * Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. */ settings?: Schema$CombinedAudienceTargetingSetting[]; } @@ -2091,7 +2093,7 @@ export namespace displayvideo_v3 { */ export interface Schema$ConversionCountingConfig { /** - * The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + * The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */ floodlightActivityConfigs?: Schema$TrackingFloodlightActivityConfig[]; /** @@ -2177,7 +2179,7 @@ export namespace displayvideo_v3 { */ export interface Schema$Creative { /** - * Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + * Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. */ additionalDimensions?: Schema$Dimensions[]; /** @@ -2185,7 +2187,7 @@ export namespace displayvideo_v3 { */ advertiserId?: string | null; /** - * Third-party HTML tracking tag to be appended to the creative tag. + * Optional. Third-party HTML tracking tag to be appended to the creative tag. */ appendedTag?: string | null; /** @@ -2197,15 +2199,15 @@ export namespace displayvideo_v3 { */ cmPlacementId?: string | null; /** - * The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + * Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. */ cmTrackingAd?: Schema$CmTrackingAd; /** - * The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + * Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` */ companionCreativeIds?: string[] | null; /** - * Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + * Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. */ counterEvents?: Schema$CounterEvent[]; /** @@ -2261,15 +2263,15 @@ export namespace displayvideo_v3 { */ html5Video?: boolean | null; /** - * Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + * Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. */ iasCampaignMonitoring?: boolean | null; /** - * ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + * Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. */ integrationCode?: string | null; /** - * JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + * Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` */ jsTrackerUrl?: string | null; /** @@ -2289,11 +2291,11 @@ export namespace displayvideo_v3 { */ name?: string | null; /** - * User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + * Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. */ notes?: string | null; /** - * Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` + * Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` */ obaIcon?: Schema$ObaIcon; /** @@ -2301,7 +2303,7 @@ export namespace displayvideo_v3 { */ oggAudio?: boolean | null; /** - * Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + * Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` */ progressOffset?: Schema$AudioVideoOffset; /** @@ -2321,11 +2323,11 @@ export namespace displayvideo_v3 { */ reviewStatus?: Schema$ReviewStatusInfo; /** - * Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + * Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` */ skipOffset?: Schema$AudioVideoOffset; /** - * Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + * Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` */ skippable?: boolean | null; /** @@ -2333,19 +2335,19 @@ export namespace displayvideo_v3 { */ thirdPartyTag?: string | null; /** - * Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + * Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` */ thirdPartyUrls?: Schema$ThirdPartyUrl[]; /** - * Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + * Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. */ timerEvents?: Schema$TimerEvent[]; /** - * Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + * Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` */ trackerUrls?: string[] | null; /** - * Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + * Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` */ transcodes?: Schema$Transcode[]; /** @@ -2576,7 +2578,7 @@ export namespace displayvideo_v3 { */ export interface Schema$CustomListGroup { /** - * Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + * Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. */ settings?: Schema$CustomListTargetingSetting[]; } @@ -3062,11 +3064,11 @@ export namespace displayvideo_v3 { */ export interface Schema$ExitEvent { /** - * The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + * Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. */ name?: string | null; /** - * The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + * Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. */ reportingName?: string | null; /** @@ -3139,7 +3141,7 @@ export namespace displayvideo_v3 { */ gmailAudienceSize?: string | null; /** - * The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + * The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). */ membershipDurationDays?: string | null; /** @@ -3160,7 +3162,7 @@ export namespace displayvideo_v3 { */ export interface Schema$FirstAndThirdPartyAudienceGroup { /** - * Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + * Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed. */ settings?: Schema$FirstAndThirdPartyAudienceTargetingSetting[]; } @@ -3173,7 +3175,7 @@ export namespace displayvideo_v3 { */ firstAndThirdPartyAudienceId?: string | null; /** - * The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + * Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. */ recency?: string | null; } @@ -3273,7 +3275,7 @@ export namespace displayvideo_v3 { */ timeUnit?: string | null; /** - * The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + * The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 */ timeUnitCount?: number | null; /** @@ -3389,7 +3391,7 @@ export namespace displayvideo_v3 { */ export interface Schema$GoogleAudienceGroup { /** - * Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + * Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. */ settings?: Schema$GoogleAudienceTargetingSetting[]; } @@ -3570,7 +3572,7 @@ export namespace displayvideo_v3 { */ advertiserId?: string | null; /** - * The bidding strategy of the insertion order. By default, fixed_bid is set. + * Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. */ bidStrategy?: Schema$BiddingStrategy; /** @@ -3598,11 +3600,11 @@ export namespace displayvideo_v3 { */ insertionOrderId?: string | null; /** - * The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + * Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. */ insertionOrderType?: string | null; /** - * Additional integration details of the insertion order. + * Optional. Additional integration details of the insertion order. */ integrationDetails?: Schema$IntegrationDetails; /** @@ -3614,7 +3616,7 @@ export namespace displayvideo_v3 { */ name?: string | null; /** - * Optional. The optimization objective of the insertion order. **This field is only available to allowlisted customers.** If a customer is not allowlisted, this field will be null and attempts to set it will return an error. + * Optional. Required. The optimization objective of the insertion order. */ optimizationObjective?: string | null; /** @@ -3622,7 +3624,7 @@ export namespace displayvideo_v3 { */ pacing?: Schema$Pacing; /** - * The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + * Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. */ partnerCosts?: Schema$PartnerCost[]; /** @@ -3639,7 +3641,7 @@ export namespace displayvideo_v3 { */ export interface Schema$InsertionOrderBudget { /** - * The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + * Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. */ automationType?: string | null; /** @@ -3660,7 +3662,7 @@ export namespace displayvideo_v3 { */ budgetAmountMicros?: string | null; /** - * The budget_id of the campaign budget that this insertion order budget segment is a part of. + * Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. */ campaignBudgetId?: string | null; /** @@ -3668,7 +3670,7 @@ export namespace displayvideo_v3 { */ dateRange?: Schema$DateRange; /** - * The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + * Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. */ description?: string | null; } @@ -3737,6 +3739,10 @@ export namespace displayvideo_v3 { * Brand Safety - **Unrateable**. */ excludeUnrateable?: boolean | null; + /** + * Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive. + */ + qualitySyncCustomSegmentId?: string[] | null; /** * True advertising quality (applicable to Display line items only). */ @@ -4128,7 +4134,7 @@ export namespace displayvideo_v3 { */ campaignId?: string | null; /** - * The conversion tracking setting of the line item. + * The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */ conversionCounting?: Schema$ConversionCountingConfig; /** @@ -4736,7 +4742,7 @@ export namespace displayvideo_v3 { */ export interface Schema$MaximizeSpendBidStrategy { /** - * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */ customBiddingAlgorithmId?: string | null; /** @@ -4899,35 +4905,35 @@ export namespace displayvideo_v3 { */ export interface Schema$ObaIcon { /** - * Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + * Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` */ clickTrackingUrl?: string | null; /** - * The dimensions of the OBA icon. + * Optional. The dimensions of the OBA icon. */ dimensions?: Schema$Dimensions; /** - * Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + * Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` */ landingPageUrl?: string | null; /** - * The position of the OBA icon on the creative. + * Optional. The position of the OBA icon on the creative. */ position?: string | null; /** - * The program of the OBA icon. For example: “AdChoices”. + * Optional. The program of the OBA icon. For example: “AdChoices”. */ program?: string | null; /** - * The MIME type of the OBA icon resource. + * Optional. The MIME type of the OBA icon resource. */ resourceMimeType?: string | null; /** - * The URL of the OBA icon resource. + * Optional. The URL of the OBA icon resource. */ resourceUrl?: string | null; /** - * Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + * Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` */ viewTrackingUrl?: string | null; } @@ -5231,7 +5237,7 @@ export namespace displayvideo_v3 { */ export interface Schema$PerformanceGoalBidStrategy { /** - * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */ customBiddingAlgorithmId?: string | null; /** @@ -5719,7 +5725,7 @@ export namespace displayvideo_v3 { */ audienceExpansionSeedListExcluded?: boolean | null; /** - * Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + * Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` */ enableOptimizedTargeting?: boolean | null; } @@ -5907,11 +5913,11 @@ export namespace displayvideo_v3 { */ export interface Schema$ThirdPartyUrl { /** - * The type of interaction needs to be tracked by the tracking URL + * Optional. The type of interaction needs to be tracked by the tracking URL */ type?: string | null; /** - * Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + * Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` */ url?: string | null; } @@ -5993,39 +5999,39 @@ export namespace displayvideo_v3 { */ export interface Schema$Transcode { /** - * The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + * Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. */ audioBitRateKbps?: string | null; /** - * The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + * Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. */ audioSampleRateHz?: string | null; /** - * The transcoding bit rate of the transcoded video, in kilobits per second. + * Optional. The transcoding bit rate of the transcoded video, in kilobits per second. */ bitRateKbps?: string | null; /** - * The dimensions of the transcoded video. + * Optional. The dimensions of the transcoded video. */ dimensions?: Schema$Dimensions; /** - * The size of the transcoded file, in bytes. + * Optional. The size of the transcoded file, in bytes. */ fileSizeBytes?: string | null; /** - * The frame rate of the transcoded video, in frames per second. + * Optional. The frame rate of the transcoded video, in frames per second. */ frameRate?: number | null; /** - * The MIME type of the transcoded file. + * Optional. The MIME type of the transcoded file. */ mimeType?: string | null; /** - * The name of the transcoded file. + * Optional. The name of the transcoded file. */ name?: string | null; /** - * Indicates if the transcoding was successful. + * Optional. Indicates if the transcoding was successful. */ transcoded?: boolean | null; } @@ -6034,11 +6040,11 @@ export namespace displayvideo_v3 { */ export interface Schema$UniversalAdId { /** - * The unique creative identifier. + * Optional. The unique creative identifier. */ id?: string | null; /** - * The registry provides unique creative identifiers. + * Optional. The registry provides unique creative identifiers. */ registry?: string | null; } @@ -16693,7 +16699,7 @@ export namespace displayvideo_v3 { } /** - * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. + * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17081,7 +17087,7 @@ export namespace displayvideo_v3 { } /** - * Creates a new rules resource. Returns the newly created rules resource if successful. + * Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17448,7 +17454,7 @@ export namespace displayvideo_v3 { } /** - * Creates a new custom bidding script. Returns the newly created script if successful. + * Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18551,7 +18557,7 @@ export namespace displayvideo_v3 { */ orderBy?: string; /** - * Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */ pageSize?: number; /** @@ -23671,6 +23677,115 @@ export namespace displayvideo_v3 { name?: string; } + export class Resource$Sdfuploadtasks { + context: APIRequestContext; + operations: Resource$Sdfuploadtasks$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Sdfuploadtasks$Operations(this.context); + } + } + + export class Resource$Sdfuploadtasks$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Sdfuploadtasks$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Sdfuploadtasks$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sdfuploadtasks$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sdfuploadtasks$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sdfuploadtasks$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sdfuploadtasks$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sdfuploadtasks$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sdfuploadtasks$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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$Sdfuploadtasks$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export class Resource$Targetingtypes { context: APIRequestContext; targetingOptions: Resource$Targetingtypes$Targetingoptions; diff --git a/src/apis/displayvideo/v4.ts b/src/apis/displayvideo/v4.ts index 041077e3ca8..de106dfde5f 100644 --- a/src/apis/displayvideo/v4.ts +++ b/src/apis/displayvideo/v4.ts @@ -112,8 +112,22 @@ export namespace displayvideo_v4 { */ export class Displayvideo { context: APIRequestContext; + advertisers: Resource$Advertisers; + combinedAudiences: Resource$Combinedaudiences; + customBiddingAlgorithms: Resource$Custombiddingalgorithms; + customLists: Resource$Customlists; + firstPartyAndPartnerAudiences: Resource$Firstpartyandpartneraudiences; + floodlightGroups: Resource$Floodlightgroups; + googleAudiences: Resource$Googleaudiences; + guaranteedOrders: Resource$Guaranteedorders; + inventorySourceGroups: Resource$Inventorysourcegroups; + inventorySources: Resource$Inventorysources; media: Resource$Media; + partners: Resource$Partners; sdfdownloadtasks: Resource$Sdfdownloadtasks; + sdfuploadtasks: Resource$Sdfuploadtasks; + targetingTypes: Resource$Targetingtypes; + users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -121,127 +135,23159 @@ export namespace displayvideo_v4 { google, }; + this.advertisers = new Resource$Advertisers(this.context); + this.combinedAudiences = new Resource$Combinedaudiences(this.context); + this.customBiddingAlgorithms = new Resource$Custombiddingalgorithms( + this.context + ); + this.customLists = new Resource$Customlists(this.context); + this.firstPartyAndPartnerAudiences = + new Resource$Firstpartyandpartneraudiences(this.context); + this.floodlightGroups = new Resource$Floodlightgroups(this.context); + this.googleAudiences = new Resource$Googleaudiences(this.context); + this.guaranteedOrders = new Resource$Guaranteedorders(this.context); + this.inventorySourceGroups = new Resource$Inventorysourcegroups( + this.context + ); + this.inventorySources = new Resource$Inventorysources(this.context); this.media = new Resource$Media(this.context); + this.partners = new Resource$Partners(this.context); this.sdfdownloadtasks = new Resource$Sdfdownloadtasks(this.context); + this.sdfuploadtasks = new Resource$Sdfuploadtasks(this.context); + this.targetingTypes = new Resource$Targetingtypes(this.context); + this.users = new Resource$Users(this.context); } } /** - * Media resource. + * Configuration for custom Active View video viewability metrics. */ - export interface Schema$GoogleBytestreamMedia { + export interface Schema$ActiveViewVideoViewabilityMetricConfig { /** - * Name of the media resource. + * Required. The display name of the custom metric. */ - resourceName?: string | null; + displayName?: string | null; + /** + * The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). + */ + minimumDuration?: string | null; + /** + * The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). + */ + minimumQuartile?: string | null; + /** + * Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded. + */ + minimumViewability?: string | null; + /** + * Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. + */ + minimumVolume?: string | null; } /** - * This resource represents a long-running operation that is the result of a network API call. + * A single ad group associated with a line item. */ - export interface Schema$Operation { + export interface Schema$AdGroup { /** - * 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. + * The format of the ads in the ad group. */ - done?: boolean | null; + adGroupFormat?: string | null; /** - * The error result of the operation in case of failure or cancellation. + * The unique ID of the ad group. Assigned by the system. */ - error?: Schema$Status; + adGroupId?: 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. + * The unique ID of the advertiser the ad group belongs to. */ - metadata?: {[key: string]: any} | null; + advertiserId?: 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\}`. + * The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy. + */ + bidStrategy?: Schema$BiddingStrategy; + /** + * The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes. + */ + displayName?: string | null; + /** + * Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. + */ + entityStatus?: string | null; + /** + * The unique ID of the line item that the ad group belongs to. + */ + lineItemId?: string | null; + /** + * The resource name of the ad group. */ 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`. + * The settings of the product feed in this ad group. */ - response?: {[key: string]: any} | null; + productFeedData?: Schema$ProductFeedData; + /** + * The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group. + */ + targetingExpansion?: Schema$TargetingExpansionConfig; } /** - * 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). + * A single ad associated with an ad group. */ - export interface Schema$Status { + export interface Schema$AdGroupAd { /** - * The status code, which should be an enum value of google.rpc.Code. + * The unique ID of the ad. Assigned by the system. */ - code?: number | null; + adGroupAdId?: string | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * The unique ID of the ad group that the ad belongs to. */ - details?: Array<{[key: string]: any}> | null; + adGroupId?: 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. + * List of URLs used by the ad. */ - message?: string | null; + adUrls?: Schema$AdUrl[]; + /** + * The unique ID of the advertiser the ad belongs to. + */ + advertiserId?: string | null; + /** + * Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. + */ + audioAd?: Schema$AudioAd; + /** + * Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. + */ + bumperAd?: Schema$BumperAd; + /** + * The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. + */ + displayName?: string | null; + /** + * Details of an ad sourced from a Display & Video 360 creative. + */ + displayVideoSourceAd?: Schema$DisplayVideoSourceAd; + /** + * The entity status of the ad. + */ + entityStatus?: string | null; + /** + * Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. + */ + inStreamAd?: Schema$InStreamAd; + /** + * Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826). + */ + mastheadAd?: Schema$MastheadAd; + /** + * The resource name of the ad. + */ + name?: string | null; + /** + * Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. + */ + nonSkippableAd?: Schema$NonSkippableAd; + /** + * Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery. + */ + videoDiscoverAd?: Schema$VideoDiscoveryAd; + /** + * Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. + */ + videoPerformanceAd?: Schema$VideoPerformanceAd; } - - export class Resource$Media { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + /** + * Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to. + */ + export interface Schema$AdGroupAssignedTargetingOption { + /** + * The ID of the ad group the assigned targeting option is assigned to. + */ + adGroupId?: string | null; + /** + * The assigned targeting option resource. + */ + assignedTargetingOption?: Schema$AssignedTargetingOption; + } + /** + * Details of Adloox brand safety settings. + */ + export interface Schema$Adloox { + /** + * Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + adultExplicitSexualContent?: string | null; + /** + * Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + armsAmmunitionContent?: string | null; + /** + * Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent?: + | string + | null; + /** + * Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + deathInjuryMilitaryConflictContent?: string | null; + /** + * Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + debatedSensitiveSocialIssueContent?: string | null; + /** + * Optional. IAB viewability threshold for display ads. + */ + displayIabViewability?: string | null; + /** + * Adloox categories to exclude. + */ + excludedAdlooxCategories?: string[] | null; + /** + * Optional. Adloox's fraud IVT MFA categories to exclude. + */ + excludedFraudIvtMfaCategories?: string[] | null; + /** + * Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + hateSpeechActsAggressionContent?: string | null; + /** + * Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + illegalDrugsTobaccoEcigarettesVapingAlcoholContent?: string | null; + /** + * Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + misinformationContent?: string | null; + /** + * Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + obscenityProfanityContent?: string | null; + /** + * Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + onlinePiracyContent?: string | null; + /** + * Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + spamHarmfulContent?: string | null; + /** + * Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. + */ + terrorismContent?: string | null; + /** + * Optional. IAB viewability threshold for video ads. + */ + videoIabViewability?: string | null; + } + /** + * Additional URLs related to the ad, including beacons. + */ + export interface Schema$AdUrl { + /** + * The type of the Ad URL. + */ + type?: string | null; + /** + * The URL string value. + */ + url?: string | null; + } + /** + * A single advertiser in Display & Video 360 (DV360). + */ + export interface Schema$Advertiser { + /** + * Required. Immutable. Ad server related settings of the advertiser. + */ + adServerConfig?: Schema$AdvertiserAdServerConfig; + /** + * Output only. The unique ID of the advertiser. Assigned by the system. + */ + advertiserId?: string | null; + /** + * Required. Billing related settings of the advertiser. + */ + billingConfig?: Schema$AdvertiserBillingConfig; + /** + * Required. Creative related settings of the advertiser. + */ + creativeConfig?: Schema$AdvertiserCreativeConfig; + /** + * Settings that control how advertiser data may be accessed. + */ + dataAccessConfig?: Schema$AdvertiserDataAccessConfig; + /** + * Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. + */ + entityStatus?: string | null; + /** + * Required. General settings of the advertiser. + */ + generalConfig?: Schema$AdvertiserGeneralConfig; + /** + * Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * Output only. The resource name of the advertiser. + */ + name?: string | null; + /** + * Required. Immutable. The unique ID of the partner that the advertiser belongs to. + */ + partnerId?: string | null; + /** + * Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. + */ + prismaEnabled?: boolean | null; + /** + * Targeting settings related to ad serving of the advertiser. + */ + servingConfig?: Schema$AdvertiserTargetingConfig; + /** + * Output only. The timestamp when the advertiser was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Ad server related settings of an advertiser. + */ + export interface Schema$AdvertiserAdServerConfig { + /** + * The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. + */ + cmHybridConfig?: Schema$CmHybridConfig; + /** + * The configuration for advertisers that use third-party ad servers only. + */ + thirdPartyOnlyConfig?: Schema$ThirdPartyOnlyConfig; + } + /** + * Billing related settings of an advertiser. + */ + export interface Schema$AdvertiserBillingConfig { + /** + * Required. The ID of a billing profile assigned to the advertiser. + */ + billingProfileId?: string | null; + } + /** + * Creatives related settings of an advertiser. + */ + export interface Schema$AdvertiserCreativeConfig { + /** + * Whether or not the advertiser is enabled for dynamic creatives. + */ + dynamicCreativeEnabled?: boolean | null; + /** + * An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag. + */ + iasClientId?: string | null; + /** + * Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091). + */ + obaComplianceDisabled?: boolean | null; + /** + * By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration. + */ + videoCreativeDataSharingAuthorized?: boolean | null; + } + /** + * Settings that control how advertiser related data may be accessed. + */ + export interface Schema$AdvertiserDataAccessConfig { + /** + * Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used. + */ + sdfConfig?: Schema$AdvertiserSdfConfig; + } + /** + * General settings of an advertiser. + */ + export interface Schema$AdvertiserGeneralConfig { + /** + * Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand + */ + currencyCode?: string | null; + /** + * Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com + */ + domainUrl?: string | null; + /** + * Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner. + */ + timeZone?: string | null; + } + /** + * Structured Data Files (SDF) settings of an advertiser. + */ + export interface Schema$AdvertiserSdfConfig { + /** + * Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig. + */ + overridePartnerSdfConfig?: boolean | null; + /** + * The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`. + */ + sdfConfig?: Schema$SdfConfig; + } + /** + * Targeting settings related to ad serving of an advertiser. + */ + export interface Schema$AdvertiserTargetingConfig { + /** + * Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. + */ + exemptTvFromViewabilityTargeting?: boolean | null; + } + /** + * Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. + */ + export interface Schema$AgeRangeAssignedTargetingOptionDetails { + /** + * Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age. + */ + ageRange?: string | null; + } + /** + * Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. + */ + export interface Schema$AgeRangeTargetingOptionDetails { + /** + * Output only. The age range of an audience. + */ + ageRange?: string | null; + } + /** + * Rule-based algorithm. + */ + export interface Schema$AlgorithmRules { + /** + * Rules for the impression signals. + */ + impressionSignalRuleset?: Schema$AlgorithmRulesRuleset; + } + /** + * A value to compare the signal to. + */ + export interface Schema$AlgorithmRulesComparisonValue { + /** + * Boolean value. + */ + boolValue?: boolean | null; + /** + * Creative dimension value. + */ + creativeDimensionValue?: Schema$Dimensions; + /** + * Day and time value. Only `TIME_ZONE_RESOLUTION_END_USER` is supported. + */ + dayAndTimeValue?: Schema$DayAndTime; + /** + * Device type value. + */ + deviceTypeValue?: string | null; + /** + * Double value. + */ + doubleValue?: number | null; + /** + * Environment value. + */ + environmentValue?: string | null; + /** + * Exchange value. + */ + exchangeValue?: string | null; + /** + * Integer value. + */ + int64Value?: string | null; + /** + * Ad position value. + */ + onScreenPositionValue?: string | null; + /** + * String value. + */ + stringValue?: string | null; + } + /** + * Set of conditions. The return value of the rule is either: * The return value for single met condition or * The defined default return value if no conditions are met. + */ + export interface Schema$AlgorithmRulesRule { + /** + * List of conditions in this rule. The criteria among conditions should be mutually exclusive. + */ + conditions?: Schema$AlgorithmRulesRuleCondition[]; + /** + * The default return value applied when none of the conditions are met. + */ + defaultReturnValue?: Schema$AlgorithmRulesSignalValue; + } + /** + * Set of signal comparisons. Equivalent of an `if` statement. + */ + export interface Schema$AlgorithmRulesRuleCondition { + /** + * The value returned if the `signalComparisons` condition evaluates to `TRUE`. + */ + returnValue?: Schema$AlgorithmRulesSignalValue; + /** + * List of comparisons that build `if` statement condition. The comparisons are combined into a single condition with `AND` logical operators. + */ + signalComparisons?: Schema$AlgorithmRulesSignalComparison[]; + } + /** + * A ruleset consisting of a list of rules and how to aggregate the resulting values. + */ + export interface Schema$AlgorithmRulesRuleset { + /** + * How to aggregate values of evaluated rules. + */ + aggregationType?: string | null; + /** + * Maximum value the ruleset can evaluate to. + */ + maxValue?: number | null; + /** + * List of rules to generate the impression value. + */ + rules?: Schema$AlgorithmRulesRule[]; + } + /** + * Signal used to evaluate rules. + */ + export interface Schema$AlgorithmRulesSignal { + /** + * Signal based on impressions. + */ + impressionSignal?: string | null; + } + /** + * A single comparison. The comparison compares the `signal` to the `comparisonValue`. The comparison of `siteId==123` is represented with the following field values: * `signal` has an `impressionSignal` of `SITE_ID`. * `comparisonOperator` is set to `EQUAL`. * `comparisonValue` is set to 123. + */ + export interface Schema$AlgorithmRulesSignalComparison { + /** + * Operator used to compare the two values. In the resulting experession, the `signal` will be the first value and the `comparisonValue will be the second. + */ + comparisonOperator?: string | null; + /** + * Value to compare signal to. + */ + comparisonValue?: Schema$AlgorithmRulesComparisonValue; + /** + * Signal to compare. + */ + signal?: Schema$AlgorithmRulesSignal; + } + /** + * Adjusted value of the signal used for rule evaluation. + */ + export interface Schema$AlgorithmRulesSignalValue { + /** + * Value to use as result. + */ + number?: number | null; + } + /** + * Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. + */ + export interface Schema$AppAssignedTargetingOptionDetails { + /** + * Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`. + */ + appId?: string | null; + /** + * Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID. + */ + appPlatform?: string | null; + /** + * Output only. The display name of the app. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + export interface Schema$AppCategoryAssignedTargetingOptionDetails { + /** + * Output only. The display name of the app category. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + export interface Schema$AppCategoryTargetingOptionDetails { + /** + * Output only. The name of the app collection. + */ + displayName?: string | null; + } + /** + * A single asset. + */ + export interface Schema$Asset { + /** + * The asset content. For uploaded assets, the content is the serving path. + */ + content?: string | null; + /** + * Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. + */ + mediaId?: string | null; + } + /** + * Asset association for the creative. + */ + export interface Schema$AssetAssociation { + /** + * Optional. The associated asset. + */ + asset?: Schema$Asset; + /** + * Optional. The role of this asset for the creative. + */ + role?: string | null; + } + /** + * An assignment between a targetable inventory source and an inventory source group. + */ + export interface Schema$AssignedInventorySource { + /** + * Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts. + */ + assignedInventorySourceId?: string | null; + /** + * Required. The ID of the inventory source entity being targeted. + */ + inventorySourceId?: string | null; + /** + * Output only. The resource name of the assigned inventory source. + */ + name?: string | null; + } + /** + * An assignment between a location list and a relevant targeting option. + */ + export interface Schema$AssignedLocation { + /** + * Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts. + */ + assignedLocationId?: string | null; + /** + * Output only. The resource name of the assigned location. + */ + name?: string | null; + /** + * Required. The ID of the targeting option assigned to the location list. + */ + targetingOptionId?: string | null; + } + /** + * A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. + */ + export interface Schema$AssignedTargetingOption { + /** + * Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`. + */ + ageRangeDetails?: Schema$AgeRangeAssignedTargetingOptionDetails; + /** + * App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + appCategoryDetails?: Schema$AppCategoryAssignedTargetingOptionDetails; + /** + * App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`. + */ + appDetails?: Schema$AppAssignedTargetingOptionDetails; + /** + * Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. + */ + assignedTargetingOptionId?: string | null; + /** + * Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` + */ + assignedTargetingOptionIdAlias?: string | null; + /** + * Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource. + */ + audienceGroupDetails?: Schema$AudienceGroupAssignedTargetingOptionDetails; + /** + * Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. + */ + audioContentTypeDetails?: Schema$AudioContentTypeAssignedTargetingOptionDetails; + /** + * Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default. + */ + authorizedSellerStatusDetails?: Schema$AuthorizedSellerStatusAssignedTargetingOptionDetails; + /** + * Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`. + */ + browserDetails?: Schema$BrowserAssignedTargetingOptionDetails; + /** + * Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. + */ + businessChainDetails?: Schema$BusinessChainAssignedTargetingOptionDetails; + /** + * Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + carrierAndIspDetails?: Schema$CarrierAndIspAssignedTargetingOptionDetails; + /** + * Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence. + */ + categoryDetails?: Schema$CategoryAssignedTargetingOptionDetails; + /** + * Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`. + */ + channelDetails?: Schema$ChannelAssignedTargetingOptionDetails; + /** + * Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. + */ + contentDurationDetails?: Schema$ContentDurationAssignedTargetingOptionDetails; + /** + * Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. + */ + contentGenreDetails?: Schema$ContentGenreAssignedTargetingOptionDetails; + /** + * Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + */ + contentInstreamPositionDetails?: Schema$ContentInstreamPositionAssignedTargetingOptionDetails; + /** + * Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + */ + contentOutstreamPositionDetails?: Schema$ContentOutstreamPositionAssignedTargetingOptionDetails; + /** + * Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. + */ + contentStreamTypeDetails?: Schema$ContentStreamTypeAssignedTargetingOptionDetails; + /** + * Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`. + */ + dayAndTimeDetails?: Schema$DayAndTimeAssignedTargetingOptionDetails; + /** + * Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + deviceMakeModelDetails?: Schema$DeviceMakeModelAssignedTargetingOptionDetails; + /** + * Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. + */ + deviceTypeDetails?: Schema$DeviceTypeAssignedTargetingOptionDetails; + /** + * Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. + */ + digitalContentLabelExclusionDetails?: Schema$DigitalContentLabelAssignedTargetingOptionDetails; + /** + * Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. + */ + environmentDetails?: Schema$EnvironmentAssignedTargetingOptionDetails; + /** + * Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`. + */ + exchangeDetails?: Schema$ExchangeAssignedTargetingOptionDetails; + /** + * Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`. + */ + genderDetails?: Schema$GenderAssignedTargetingOptionDetails; + /** + * Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + geoRegionDetails?: Schema$GeoRegionAssignedTargetingOptionDetails; + /** + * Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. + */ + householdIncomeDetails?: Schema$HouseholdIncomeAssignedTargetingOptionDetails; + /** + * Output only. The inheritance status of the assigned targeting option. + */ + inheritance?: string | null; + /** + * Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. + */ + inventorySourceDetails?: Schema$InventorySourceAssignedTargetingOptionDetails; + /** + * Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + */ + inventorySourceGroupDetails?: Schema$InventorySourceGroupAssignedTargetingOptionDetails; + /** + * Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + */ + keywordDetails?: Schema$KeywordAssignedTargetingOptionDetails; + /** + * Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`. + */ + languageDetails?: Schema$LanguageAssignedTargetingOptionDetails; + /** + * Output only. The resource name for this assigned targeting option. + */ + name?: string | null; + /** + * Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. + */ + nativeContentPositionDetails?: Schema$NativeContentPositionAssignedTargetingOptionDetails; + /** + * Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource. + */ + negativeKeywordListDetails?: Schema$NegativeKeywordListAssignedTargetingOptionDetails; + /** + * Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`. + */ + omidDetails?: Schema$OmidAssignedTargetingOptionDetails; + /** + * On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + onScreenPositionDetails?: Schema$OnScreenPositionAssignedTargetingOptionDetails; + /** + * Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + operatingSystemDetails?: Schema$OperatingSystemAssignedTargetingOptionDetails; + /** + * Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. + */ + parentalStatusDetails?: Schema$ParentalStatusAssignedTargetingOptionDetails; + /** + * POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`. + */ + poiDetails?: Schema$PoiAssignedTargetingOptionDetails; + /** + * Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + */ + proximityLocationListDetails?: Schema$ProximityLocationListAssignedTargetingOptionDetails; + /** + * Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + */ + regionalLocationListDetails?: Schema$RegionalLocationListAssignedTargetingOptionDetails; + /** + * Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. + */ + sensitiveCategoryExclusionDetails?: Schema$SensitiveCategoryAssignedTargetingOptionDetails; + /** + * Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. + */ + sessionPositionDetails?: Schema$SessionPositionAssignedTargetingOptionDetails; + /** + * Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. + */ + subExchangeDetails?: Schema$SubExchangeAssignedTargetingOptionDetails; + /** + * Output only. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + /** + * Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + */ + thirdPartyVerifierDetails?: Schema$ThirdPartyVerifierAssignedTargetingOptionDetails; + /** + * URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`. + */ + urlDetails?: Schema$UrlAssignedTargetingOptionDetails; + /** + * User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + userRewardedContentDetails?: Schema$UserRewardedContentAssignedTargetingOptionDetails; + /** + * Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + */ + videoPlayerSizeDetails?: Schema$VideoPlayerSizeAssignedTargetingOptionDetails; + /** + * Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource. + */ + viewabilityDetails?: Schema$ViewabilityAssignedTargetingOptionDetails; + /** + * YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. + */ + youtubeChannelDetails?: Schema$YoutubeChannelAssignedTargetingOptionDetails; + /** + * YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. + */ + youtubeVideoDetails?: Schema$YoutubeVideoAssignedTargetingOptionDetails; + } + /** + * A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. + */ + export interface Schema$AssignedUserRole { + /** + * The ID of the advertiser that the assigend user role applies to. + */ + advertiserId?: string | null; + /** + * Output only. The ID of the assigned user role. + */ + assignedUserRoleId?: string | null; + /** + * The ID of the partner that the assigned user role applies to. + */ + partnerId?: string | null; + /** + * Required. The user role to assign to a user for the entity. + */ + userRole?: string | null; + } + /** + * Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. + */ + export interface Schema$AudienceGroupAssignedTargetingOptionDetails { + /** + * Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. + */ + excludedFirstPartyAndPartnerAudienceGroup?: Schema$FirstPartyAndPartnerAudienceGroup; + /** + * Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. + */ + excludedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; + /** + * Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only. + */ + includedCombinedAudienceGroup?: Schema$CombinedAudienceGroup; + /** + * Optional. The custom list ids of the included custom list group. Contains custom list ids only. + */ + includedCustomListGroup?: Schema$CustomListGroup; + /** + * Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored. + */ + includedFirstPartyAndPartnerAudienceGroups?: Schema$FirstPartyAndPartnerAudienceGroup[]; + /** + * Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only. + */ + includedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; + } + /** + * Details for an audio ad. + */ + export interface Schema$AudioAd { + /** + * The webpage address that appears with the ad. + */ + displayUrl?: string | null; + /** + * The URL address of the webpage that people reach after they click the ad. + */ + finalUrl?: string | null; + /** + * The URL address loaded in the background for tracking purposes. + */ + trackingUrl?: string | null; + /** + * The YouTube video of the ad. + */ + video?: Schema$YoutubeVideoDetails; + } + /** + * Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. + */ + export interface Schema$AudioContentTypeAssignedTargetingOptionDetails { + /** + * Required. The audio content type. + */ + audioContentType?: string | null; + } + /** + * Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. + */ + export interface Schema$AudioContentTypeTargetingOptionDetails { + /** + * Output only. The audio content type. + */ + audioContentType?: string | null; + } + /** + * The length an audio or a video has been played. + */ + export interface Schema$AudioVideoOffset { + /** + * Optional. The offset in percentage of the audio or video duration. + */ + percentage?: string | null; + /** + * Optional. The offset in seconds from the start of the audio or video. + */ + seconds?: string | null; + } + /** + * Response message for AdvertiserService.AuditAdvertiser. + */ + export interface Schema$AuditAdvertiserResponse { + /** + * The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 4500000 ad group targeting options per advertiser. Qualifying Targeting types: * Channels, URLs, apps, and collections * Demographic * Google Audiences, including Affinity, Custom Affinity, and In-market audiences * Inventory source * Keyword * Mobile app category * User lists * Video targeting * Viewability + */ + adGroupCriteriaCount?: string | null; + /** + * The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 900000 campaign targeting options per advertiser. Qualifying Targeting types: * Position * Browser * Connection speed * Day and time * Device and operating system * Digital content label * Sensitive categories * Environment * Geography, including business chains and proximity * ISP * Language * Third-party verification + */ + campaignCriteriaCount?: string | null; + /** + * The number of channels created under this advertiser. These channels count towards the limit of 1000 channels per advertiser. + */ + channelsCount?: string | null; + /** + * The number of negative keyword lists created under this advertiser. These negative keyword lists count towards the limit of 20 negative keyword lists per advertiser. + */ + negativeKeywordListsCount?: string | null; + /** + * The number of negatively targeted channels created under this advertiser. These negatively targeted channels count towards the limit of 5 negatively targeted channels per advertiser. + */ + negativelyTargetedChannelsCount?: string | null; + /** + * The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser. + */ + usedCampaignsCount?: string | null; + /** + * The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser. + */ + usedInsertionOrdersCount?: string | null; + /** + * The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser. + */ + usedLineItemsCount?: string | null; + } + /** + * Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. + */ + export interface Schema$AuthorizedSellerStatusAssignedTargetingOptionDetails { + /** + * Output only. The authorized seller status to target. + */ + authorizedSellerStatus?: string | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + */ + export interface Schema$AuthorizedSellerStatusTargetingOptionDetails { + /** + * Output only. The authorized seller status. + */ + authorizedSellerStatus?: string | null; + } + /** + * Settings that control the bid strategy. Bid strategy determines the bid price. + */ + export interface Schema$BiddingStrategy { + /** + * A strategy that uses a fixed bid price. + */ + fixedBid?: Schema$FixedBidStrategy; + /** + * A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. + */ + maximizeSpendAutoBid?: Schema$MaximizeSpendBidStrategy; + /** + * A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. + */ + performanceGoalAutoBid?: Schema$PerformanceGoalBidStrategy; + /** + * A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity. + */ + youtubeAndPartnersBid?: Schema$YoutubeAndPartnersBiddingStrategy; + } + /** + * Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. + */ + export interface Schema$BrowserAssignedTargetingOptionDetails { + /** + * Output only. The display name of the browser. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. + */ + export interface Schema$BrowserTargetingOptionDetails { + /** + * Output only. The display name of the browser. + */ + displayName?: string | null; + } + /** + * Summarized information of an individual campaign budget. + */ + export interface Schema$BudgetSummary { + /** + * Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty. + */ + externalBudgetId?: string | null; + /** + * The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. + */ + preTaxAmountMicros?: string | null; + /** + * Relevant client, product, and estimate codes from the Mediaocean Prisma tool. Only applicable for campaign budgets with an external_budget_source of EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN. + */ + prismaCpeCode?: Schema$PrismaCpeCode; + /** + * The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. + */ + taxAmountMicros?: string | null; + /** + * The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. + */ + totalAmountMicros?: string | null; + } + /** + * Request message for BulkEditAdvertiserAssignedTargetingOptions. + */ + export interface Schema$BulkEditAdvertiserAssignedTargetingOptionsRequest { + /** + * The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` + */ + createRequests?: Schema$CreateAssignedTargetingOptionsRequest[]; + /** + * The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` + */ + deleteRequests?: Schema$DeleteAssignedTargetingOptionsRequest[]; + } + export interface Schema$BulkEditAdvertiserAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options that have been successfully created. This list will be absent if empty. + */ + createdAssignedTargetingOptions?: Schema$AssignedTargetingOption[]; + } + /** + * Request message for AssignedInventorySourceService.BulkEdit. + */ + export interface Schema$BulkEditAssignedInventorySourcesRequest { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources. + */ + advertiserId?: string | null; + /** + * The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources. + */ + createdAssignedInventorySources?: Schema$AssignedInventorySource[]; + /** + * The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids. + */ + deletedAssignedInventorySources?: string[] | null; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources. + */ + partnerId?: string | null; + } + /** + * Response message for AssignedInventorySourceService.BulkEdit. + */ + export interface Schema$BulkEditAssignedInventorySourcesResponse { + /** + * The list of assigned inventory sources that have been successfully created. This list will be absent if empty. + */ + assignedInventorySources?: Schema$AssignedInventorySource[]; + } + /** + * Request message for AssignedLocationService.BulkEditAssignedLocations. + */ + export interface Schema$BulkEditAssignedLocationsRequest { + /** + * The assigned locations to create in bulk, specified as a list of AssignedLocation resources. + */ + createdAssignedLocations?: Schema$AssignedLocation[]; + /** + * The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values. + */ + deletedAssignedLocations?: string[] | null; + } + export interface Schema$BulkEditAssignedLocationsResponse { + /** + * The list of assigned locations that have been successfully created. This list will be absent if empty. + */ + assignedLocations?: Schema$AssignedLocation[]; + } + /** + * Request message for BulkEditLineItemsAssignedTargetingOptions. + */ + export interface Schema$BulkEditAssignedTargetingOptionsRequest { + /** + * The assigned targeting options to create in batch, specified as a list of CreateAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + createRequests?: Schema$CreateAssignedTargetingOptionsRequest[]; + /** + * The assigned targeting options to delete in batch, specified as a list of DeleteAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + deleteRequests?: Schema$DeleteAssignedTargetingOptionsRequest[]; + /** + * Required. The ID of the line items whose targeting is being updated. + */ + lineItemIds?: string[] | null; + } + export interface Schema$BulkEditAssignedTargetingOptionsResponse { + /** + * The error information for each line item that failed to update. + */ + errors?: Schema$Status[]; + /** + * Output only. The IDs of the line items which failed. + */ + failedLineItemIds?: string[] | null; + /** + * Output only. The IDs of the line items which successfully updated. + */ + updatedLineItemIds?: string[] | null; + } + /** + * Request message for BulkEditAssignedUserRoles. + */ + export interface Schema$BulkEditAssignedUserRolesRequest { + /** + * The assigned user roles to create in batch, specified as a list of AssignedUserRoles. + */ + createdAssignedUserRoles?: Schema$AssignedUserRole[]; + /** + * The assigned user roles to delete in batch, specified as a list of assigned_user_role_ids. The format of assigned_user_role_id is `entityType-entityid`, for example `partner-123`. + */ + deletedAssignedUserRoles?: string[] | null; + } + export interface Schema$BulkEditAssignedUserRolesResponse { + /** + * The list of assigned user roles that have been successfully created. This list will be absent if empty. + */ + createdAssignedUserRoles?: Schema$AssignedUserRole[]; + } + /** + * Request message for NegativeKeywordService.BulkEditNegativeKeywords. + */ + export interface Schema$BulkEditNegativeKeywordsRequest { + /** + * The negative keywords to create in batch, specified as a list of NegativeKeywords. + */ + createdNegativeKeywords?: Schema$NegativeKeyword[]; + /** + * The negative keywords to delete in batch, specified as a list of keyword_values. + */ + deletedNegativeKeywords?: string[] | null; + } + /** + * Response message for NegativeKeywordService.BulkEditNegativeKeywords. + */ + export interface Schema$BulkEditNegativeKeywordsResponse { + /** + * The list of negative keywords that have been successfully created. This list will be absent if empty. + */ + negativeKeywords?: Schema$NegativeKeyword[]; + } + /** + * Request message for BulkEditPartnerAssignedTargetingOptions. + */ + export interface Schema$BulkEditPartnerAssignedTargetingOptionsRequest { + /** + * The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + createRequests?: Schema$CreateAssignedTargetingOptionsRequest[]; + /** + * The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + deleteRequests?: Schema$DeleteAssignedTargetingOptionsRequest[]; + } + export interface Schema$BulkEditPartnerAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options that have been successfully created. This list will be absent if empty. + */ + createdAssignedTargetingOptions?: Schema$AssignedTargetingOption[]; + } + /** + * Request message for SiteService.BulkEditSites. + */ + export interface Schema$BulkEditSitesRequest { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string | null; + /** + * The sites to create in batch, specified as a list of Sites. + */ + createdSites?: Schema$Site[]; + /** + * The sites to delete in batch, specified as a list of site url_or_app_ids. + */ + deletedSites?: string[] | null; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string | null; + } + /** + * Response message for SiteService.BulkEditSites. + */ + export interface Schema$BulkEditSitesResponse { + /** + * The list of sites that have been successfully created. This list will be absent if empty. + */ + sites?: Schema$Site[]; + } + export interface Schema$BulkListAdGroupAssignedTargetingOptionsResponse { + /** + * The list of wrapper objects, each providing an assigned targeting option and the ad group it is assigned to. This list will be absent if empty. + */ + adGroupAssignedTargetingOptions?: Schema$AdGroupAssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return. + */ + nextPageToken?: string | null; + } + export interface Schema$BulkListAdvertiserAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. + */ + nextPageToken?: string | null; + } + export interface Schema$BulkListAssignedTargetingOptionsResponse { + /** + * The list of wrapper objects, each providing an assigned targeting option and the line item it is assigned to. This list will be absent if empty. + */ + lineItemAssignedTargetingOptions?: Schema$LineItemAssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more line_item_assigned_targeting_options to return. + */ + nextPageToken?: string | null; + } + /** + * Request message for LineItemService.BulkUpdateLineItems. + */ + export interface Schema$BulkUpdateLineItemsRequest { + /** + * Required. IDs of line items to update. + */ + lineItemIds?: string[] | null; + /** + * Required. A line item object containing the fields to be updated and the new values to assign to all line items specified in line_item_ids." + */ + targetLineItem?: Schema$LineItem; + /** + * Required. A field mask identifying which fields to update. Only the following fields are currently supported: * entityStatus + */ + updateMask?: string | null; + } + /** + * Response message for LineItemService.BulkUpdateLineItems. + */ + export interface Schema$BulkUpdateLineItemsResponse { + /** + * Errors returned by line items that failed to update. + */ + errors?: Schema$Status[]; + /** + * The IDs of line items that failed to update. + */ + failedLineItemIds?: string[] | null; + /** + * The IDs of line items that are skipped for updates. For example, unnecessary mutates that will result in effectively no changes to line items will be skipped and corresponding line item IDs can be tracked here. + */ + skippedLineItemIds?: string[] | null; + /** + * The IDs of successfully updated line items. + */ + updatedLineItemIds?: string[] | null; + } + /** + * Details for a bumper ad. + */ + export interface Schema$BumperAd { + /** + * Common ad attributes. + */ + commonInStreamAttribute?: Schema$CommonInStreamAttribute; + } + /** + * Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. + */ + export interface Schema$BusinessChainAssignedTargetingOptionDetails { + /** + * Output only. The display name of a business chain, e.g. "KFC", "Chase Bank". + */ + displayName?: string | null; + /** + * Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6. + */ + proximityRadiusAmount?: number | null; + /** + * Required. The unit of distance by which the targeting radius is measured. + */ + proximityRadiusUnit?: string | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions. + */ + targetingOptionId?: string | null; + } + /** + * Search terms for Business Chain targeting options. At least one of the field should be populated. + */ + export interface Schema$BusinessChainSearchTerms { + /** + * The search query for the desired business chain. The query must be the full name of the business, e.g. "KFC", "mercedes-benz". + */ + businessChainQuery?: string | null; + /** + * The search query for the desired geo region, e.g. "Seattle", "United State". + */ + regionQuery?: string | null; + } + /** + * Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. + */ + export interface Schema$BusinessChainTargetingOptionDetails { + /** + * Output only. The display name of the business chain, e.g. "KFC", "Chase Bank". + */ + businessChain?: string | null; + /** + * Output only. The display name of the geographic region, e.g. "Ontario, Canada". + */ + geoRegion?: string | null; + /** + * Output only. The type of the geographic region. + */ + geoRegionType?: string | null; + } + /** + * A single campaign. + */ + export interface Schema$Campaign { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string | null; + /** + * The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. + */ + campaignBudgets?: Schema$CampaignBudget[]; + /** + * Required. The planned spend and duration of the campaign. + */ + campaignFlight?: Schema$CampaignFlight; + /** + * Required. The goal of the campaign. + */ + campaignGoal?: Schema$CampaignGoal; + /** + * Output only. The unique ID of the campaign. Assigned by the system. + */ + campaignId?: string | null; + /** + * Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. + */ + entityStatus?: string | null; + /** + * Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap) + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Output only. The resource name of the campaign. + */ + name?: string | null; + /** + * Output only. The timestamp when the campaign was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Settings that control how the campaign budget is allocated. + */ + export interface Schema$CampaignBudget { + /** + * Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + */ + budgetAmountMicros?: string | null; + /** + * The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. + */ + budgetId?: string | null; + /** + * Required. Immutable. Specifies whether the budget is measured in currency or impressions. + */ + budgetUnit?: string | null; + /** + * Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037. + */ + dateRange?: Schema$DateRange; + /** + * Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. + */ + externalBudgetId?: string | null; + /** + * Required. The external source of the budget. + */ + externalBudgetSource?: string | null; + /** + * Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. + */ + invoiceGroupingId?: string | null; + /** + * Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers. + */ + prismaConfig?: Schema$PrismaConfig; + } + /** + * Settings that track the planned spend and duration of a campaign. + */ + export interface Schema$CampaignFlight { + /** + * Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037. + */ + plannedDates?: Schema$DateRange; + /** + * The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency. + */ + plannedSpendAmountMicros?: string | null; + } + /** + * Settings that control the goal of a campaign. + */ + export interface Schema$CampaignGoal { + /** + * Required. The type of the campaign goal. + */ + campaignGoalType?: string | null; + /** + * Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER` + */ + performanceGoal?: Schema$PerformanceGoal; + } + /** + * Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + export interface Schema$CarrierAndIspAssignedTargetingOptionDetails { + /** + * Output only. The display name of the carrier or ISP. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + export interface Schema$CarrierAndIspTargetingOptionDetails { + /** + * Output only. The display name of the carrier or ISP. + */ + displayName?: string | null; + /** + * Output only. The type indicating if it's carrier or ISP. + */ + type?: string | null; + } + /** + * Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + export interface Schema$CategoryAssignedTargetingOptionDetails { + /** + * Output only. The display name of the category. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + export interface Schema$CategoryTargetingOptionDetails { + /** + * Output only. The display name of the category. + */ + displayName?: string | null; + } + /** + * A single channel. Channels are custom groups of related websites and apps. + */ + export interface Schema$Channel { + /** + * The ID of the advertiser that owns the channel. + */ + advertiserId?: string | null; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string | null; + /** + * Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The resource name of the channel. + */ + name?: string | null; + /** + * Output only. Number of line items that are directly targeting this channel negatively. + */ + negativelyTargetedLineItemCount?: string | null; + /** + * The ID of the partner that owns the channel. + */ + partnerId?: string | null; + /** + * Output only. Number of line items that are directly targeting this channel positively. + */ + positivelyTargetedLineItemCount?: string | null; + } + /** + * Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. + */ + export interface Schema$ChannelAssignedTargetingOptionDetails { + /** + * Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource. + */ + channelId?: string | null; + /** + * Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. + */ + negative?: boolean | null; + } + /** + * Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. + */ + export interface Schema$CmHybridConfig { + /** + * Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser. + */ + cmAccountId?: string | null; + /** + * Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration. + */ + cmAdvertiserIds?: string[] | null; + /** + * Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser. + */ + cmFloodlightConfigId?: string | null; + /** + * Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser. + */ + cmFloodlightLinkingAuthorized?: boolean | null; + /** + * A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified. + */ + cmSyncableSiteIds?: string[] | null; + /** + * Whether or not to report DV360 cost to CM360. + */ + dv360ToCmCostReportingEnabled?: boolean | null; + /** + * Whether or not to include DV360 data in CM360 data transfer reports. + */ + dv360ToCmDataSharingEnabled?: boolean | null; + } + /** + * A Campaign Manager 360 tracking ad. + */ + export interface Schema$CmTrackingAd { + /** + * Optional. The ad ID of the campaign manager 360 tracking Ad. + */ + cmAdId?: string | null; + /** + * Optional. The creative ID of the campaign manager 360 tracking Ad. + */ + cmCreativeId?: string | null; + /** + * Optional. The placement ID of the campaign manager 360 tracking Ad. + */ + cmPlacementId?: string | null; + } + /** + * Describes a combined audience resource. + */ + export interface Schema$CombinedAudience { + /** + * Output only. The unique ID of the combined audience. Assigned by the system. + */ + combinedAudienceId?: string | null; + /** + * Output only. The display name of the combined audience. . + */ + displayName?: string | null; + /** + * Output only. The resource name of the combined audience. + */ + name?: string | null; + } + /** + * Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$CombinedAudienceGroup { + /** + * Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + */ + settings?: Schema$CombinedAudienceTargetingSetting[]; + } + /** + * Details of combined audience targeting setting. + */ + export interface Schema$CombinedAudienceTargetingSetting { + /** + * Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. + */ + combinedAudienceId?: string | null; + } + /** + * Common attributes for in-stream, non-skippable and bumper ads. + */ + export interface Schema$CommonInStreamAttribute { + /** + * The text on the call-to-action button. + */ + actionButtonLabel?: string | null; + /** + * The headline of the call-to-action banner. + */ + actionHeadline?: string | null; + /** + * The image which shows next to the video ad. + */ + companionBanner?: Schema$ImageAsset; + /** + * The webpage address that appears with the ad. + */ + displayUrl?: string | null; + /** + * The URL address of the webpage that people reach after they click the ad. + */ + finalUrl?: string | null; + /** + * The URL address loaded in the background for tracking purposes. + */ + trackingUrl?: string | null; + /** + * The YouTube video of the ad. + */ + video?: Schema$YoutubeVideoDetails; + } + /** + * User consent status. + */ + export interface Schema$Consent { + /** + * Represents consent for ad personalization. + */ + adPersonalization?: string | null; + /** + * Represents consent for ad user data. + */ + adUserData?: string | null; + } + /** + * Contact information defining a Customer Match audience member. + */ + export interface Schema$ContactInfo { + /** + * Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes + */ + countryCode?: string | null; + /** + * A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + */ + hashedEmails?: string[] | null; + /** + * SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + */ + hashedFirstName?: string | null; + /** + * SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + */ + hashedLastName?: string | null; + /** + * A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + */ + hashedPhoneNumbers?: string[] | null; + /** + * A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + */ + zipCodes?: string[] | null; + } + /** + * Wrapper message for a list of contact information defining Customer Match audience members. + */ + export interface Schema$ContactInfoList { + /** + * Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. + */ + consent?: Schema$Consent; + /** + * A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + */ + contactInfos?: Schema$ContactInfo[]; + } + /** + * Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. + */ + export interface Schema$ContentDurationAssignedTargetingOptionDetails { + /** + * Output only. The content duration. + */ + contentDuration?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. + */ + export interface Schema$ContentDurationTargetingOptionDetails { + /** + * Output only. The content duration. + */ + contentDuration?: string | null; + } + /** + * Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. + */ + export interface Schema$ContentGenreAssignedTargetingOptionDetails { + /** + * Output only. The display name of the content genre. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. + */ + export interface Schema$ContentGenreTargetingOptionDetails { + /** + * Output only. The display name of the content genre + */ + displayName?: string | null; + } + /** + * Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + */ + export interface Schema$ContentInstreamPositionAssignedTargetingOptionDetails { + /** + * Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`. + */ + adType?: string | null; + /** + * Required. The content instream position for video or audio ads. + */ + contentInstreamPosition?: string | null; + } + /** + * Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + */ + export interface Schema$ContentInstreamPositionTargetingOptionDetails { + /** + * Output only. The content instream position. + */ + contentInstreamPosition?: string | null; + } + /** + * Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + */ + export interface Schema$ContentOutstreamPositionAssignedTargetingOptionDetails { + /** + * Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. + */ + adType?: string | null; + /** + * Required. The content outstream position. + */ + contentOutstreamPosition?: string | null; + } + /** + * Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + */ + export interface Schema$ContentOutstreamPositionTargetingOptionDetails { + /** + * Output only. The content outstream position. + */ + contentOutstreamPosition?: string | null; + } + /** + * Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. + */ + export interface Schema$ContentStreamTypeAssignedTargetingOptionDetails { + /** + * Output only. The content stream type. + */ + contentStreamType?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. + */ + export interface Schema$ContentStreamTypeTargetingOptionDetails { + /** + * Output only. The content stream type. + */ + contentStreamType?: string | null; + } + /** + * Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. + */ + export interface Schema$ConversionCountingConfig { + /** + * The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + */ + floodlightActivityConfigs?: Schema$TrackingFloodlightActivityConfig[]; + /** + * The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + */ + postViewCountPercentageMillis?: string | null; + } + /** + * Counter event of the creative. + */ + export interface Schema$CounterEvent { + /** + * Required. The name of the counter event. + */ + name?: string | null; + /** + * Required. The name used to identify this counter event in reports. + */ + reportingName?: string | null; + } + /** + * A request message for CreateAsset. + */ + export interface Schema$CreateAssetRequest { + /** + * Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes. + */ + filename?: string | null; + } + /** + * A response message for CreateAsset. + */ + export interface Schema$CreateAssetResponse { + /** + * The uploaded asset, if successful. + */ + asset?: Schema$Asset; + } + /** + * A request listing which assigned targeting options of a given targeting type should be created and added. + */ + export interface Schema$CreateAssignedTargetingOptionsRequest { + /** + * Required. The assigned targeting options to create and add. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + } + /** + * Request message for [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$CreateSdfDownloadTaskRequest { + /** + * The ID of the advertiser to download SDF for. + */ + advertiserId?: string | null; + /** + * Filters on entities by their entity IDs. + */ + idFilter?: Schema$IdFilter; + /** + * Filters on Inventory Sources by their IDs. + */ + inventorySourceFilter?: Schema$InventorySourceFilter; + /** + * Filters on selected file types. The entities in each file are filtered by a chosen set of filter entities. The filter entities must be the same type as, or a parent type of, the selected file types. + */ + parentEntityFilter?: Schema$ParentEntityFilter; + /** + * The ID of the partner to download SDF for. + */ + partnerId?: string | null; + /** + * Required. The SDF version of the downloaded file. If set to `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the advertiser or partner identified by `root_id`. An advertiser inherits its SDF version from its partner unless configured otherwise. + */ + version?: string | null; + } + /** + * A single Creative. + */ + export interface Schema$Creative { + /** + * Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + */ + additionalDimensions?: Schema$Dimensions[]; + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string | null; + /** + * Optional. Third-party HTML tracking tag to be appended to the creative tag. + */ + appendedTag?: string | null; + /** + * Required. Assets associated to this creative. + */ + assets?: Schema$AssetAssociation[]; + /** + * Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. + */ + cmPlacementId?: string | null; + /** + * Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + */ + cmTrackingAd?: Schema$CmTrackingAd; + /** + * Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + */ + companionCreativeIds?: string[] | null; + /** + * Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + */ + counterEvents?: Schema$CounterEvent[]; + /** + * Output only. The timestamp when the creative was created. Assigned by the system. + */ + createTime?: string | null; + /** + * Output only. A list of attributes of the creative that is generated by the system. + */ + creativeAttributes?: string[] | null; + /** + * Output only. The unique ID of the creative. Assigned by the system. + */ + creativeId?: string | null; + /** + * Required. Immutable. The type of the creative. + */ + creativeType?: string | null; + /** + * Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + dimensions?: Schema$Dimensions; + /** + * Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. Indicates whether the creative is dynamic. + */ + dynamic?: boolean | null; + /** + * Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` + */ + entityStatus?: string | null; + /** + * Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. + */ + exitEvents?: Schema$ExitEvent[]; + /** + * Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` + */ + expandingDirection?: string | null; + /** + * Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` + */ + expandOnHover?: boolean | null; + /** + * Required. Indicates where the creative is hosted. + */ + hostingSource?: string | null; + /** + * Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + html5Video?: boolean | null; + /** + * Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + */ + iasCampaignMonitoring?: boolean | null; + /** + * Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + */ + integrationCode?: string | null; + /** + * Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + jsTrackerUrl?: string | null; + /** + * Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. + */ + lineItemIds?: string[] | null; + /** + * Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` + */ + mediaDuration?: string | null; + /** + * Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` + */ + mp3Audio?: boolean | null; + /** + * Output only. The resource name of the creative. + */ + name?: string | null; + /** + * Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + */ + notes?: string | null; + /** + * Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + obaIcon?: Schema$ObaIcon; + /** + * Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` + */ + oggAudio?: boolean | null; + /** + * Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + progressOffset?: Schema$AudioVideoOffset; + /** + * Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` + */ + requireHtml5?: boolean | null; + /** + * Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` + */ + requireMraid?: boolean | null; + /** + * Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN\} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + */ + requirePingForAttribution?: boolean | null; + /** + * Output only. The current status of the creative review process. + */ + reviewStatus?: Schema$ReviewStatusInfo; + /** + * Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + skipOffset?: Schema$AudioVideoOffset; + /** + * Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + skippable?: boolean | null; + /** + * Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` + */ + thirdPartyTag?: string | null; + /** + * Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + thirdPartyUrls?: Schema$ThirdPartyUrl[]; + /** + * Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + */ + timerEvents?: Schema$TimerEvent[]; + /** + * Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + trackerUrls?: string[] | null; + /** + * Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + */ + transcodes?: Schema$Transcode[]; + /** + * Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + universalAdId?: Schema$UniversalAdId; + /** + * Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. + */ + updateTime?: string | null; + /** + * Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + */ + vastTagUrl?: string | null; + /** + * Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + vpaid?: boolean | null; + } + /** + * Creative requirements configuration for the inventory source. + */ + export interface Schema$CreativeConfig { + /** + * The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO` + */ + creativeType?: string | null; + /** + * The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`. + */ + displayCreativeConfig?: Schema$InventorySourceDisplayCreativeConfig; + /** + * The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`. + */ + videoCreativeConfig?: Schema$InventorySourceVideoCreativeConfig; + } + /** + * A single custom bidding algorithm. + */ + export interface Schema$CustomBiddingAlgorithm { + /** + * Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. + */ + advertiserId?: string | null; + /** + * Output only. The unique ID of the custom bidding algorithm. Assigned by the system. + */ + customBiddingAlgorithmId?: string | null; + /** + * Required. Immutable. The type of custom bidding algorithm. + */ + customBiddingAlgorithmType?: string | null; + /** + * Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` + */ + entityStatus?: string | null; + /** + * Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). + */ + modelDetails?: Schema$CustomBiddingModelDetails[]; + /** + * Output only. The resource name of the custom bidding algorithm. + */ + name?: string | null; + /** + * Immutable. The unique ID of the partner that owns the custom bidding algorithm. + */ + partnerId?: string | null; + /** + * The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor). + */ + sharedAdvertiserIds?: string[] | null; + } + /** + * A single custom bidding algorithm rules. + */ + export interface Schema$CustomBiddingAlgorithmRules { + /** + * Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. + */ + active?: boolean | null; + /** + * Output only. The time when the rules resource was created. + */ + createTime?: string | null; + /** + * Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. + */ + customBiddingAlgorithmId?: string | null; + /** + * Output only. The unique ID of the rules resource. + */ + customBiddingAlgorithmRulesId?: string | null; + /** + * Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`. + */ + error?: Schema$CustomBiddingAlgorithmRulesError; + /** + * Output only. The resource name of the rules resource. + */ + name?: string | null; + /** + * Required. Immutable. The reference to the uploaded AlgorithmRules file. + */ + rules?: Schema$CustomBiddingAlgorithmRulesRef; + /** + * Output only. The state of the rules resource. + */ + state?: string | null; + } + /** + * An error message for a CustomBiddingAlgorithmRules resource. + */ + export interface Schema$CustomBiddingAlgorithmRulesError { + /** + * The type of error. + */ + errorCode?: string | null; + } + /** + * The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. + */ + export interface Schema$CustomBiddingAlgorithmRulesRef { + /** + * A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id\}/rulesRef/{ref_id\}`. + */ + resourceName?: string | null; + } + /** + * The details of a custom bidding algorithm model for a single shared advertiser. + */ + export interface Schema$CustomBiddingModelDetails { + /** + * The unique ID of the relevant advertiser. + */ + advertiserId?: string | null; + /** + * The readiness state of custom bidding model. + */ + readinessState?: string | null; + /** + * Output only. The suspension state of custom bidding model. + */ + suspensionState?: string | null; + } + /** + * A single custom bidding script. + */ + export interface Schema$CustomBiddingScript { + /** + * Output only. Whether the script is currently being used for scoring by the parent algorithm. + */ + active?: boolean | null; + /** + * Output only. The time when the script was created. + */ + createTime?: string | null; + /** + * Output only. The unique ID of the custom bidding algorithm the script belongs to. + */ + customBiddingAlgorithmId?: string | null; + /** + * Output only. The unique ID of the custom bidding script. + */ + customBiddingScriptId?: string | null; + /** + * Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED. + */ + errors?: Schema$ScriptError[]; + /** + * Output only. The resource name of the custom bidding script. + */ + name?: string | null; + /** + * The reference to the uploaded script file. + */ + script?: Schema$CustomBiddingScriptRef; + /** + * Output only. The state of the custom bidding script. + */ + state?: string | null; + } + /** + * The reference to the uploaded custom bidding script file. + */ + export interface Schema$CustomBiddingScriptRef { + /** + * A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id\}/scriptRef/{ref_id\}`. + */ + resourceName?: string | null; + } + /** + * The key and value of a custom label. + */ + export interface Schema$CustomLabel { + /** + * The key of the label. + */ + key?: string | null; + /** + * The value of the label. + */ + value?: string | null; + } + /** + * Describes a custom list entity, such as a custom affinity or custom intent audience list. + */ + export interface Schema$CustomList { + /** + * Output only. The unique ID of the custom list. Assigned by the system. + */ + customListId?: string | null; + /** + * Output only. The display name of the custom list. . + */ + displayName?: string | null; + /** + * Output only. The resource name of the custom list. + */ + name?: string | null; + } + /** + * Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$CustomListGroup { + /** + * Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored. + */ + settings?: Schema$CustomListTargetingSetting[]; + } + /** + * Details of custom list targeting setting. + */ + export interface Schema$CustomListTargetingSetting { + /** + * Required. Custom id of custom list targeting setting. This id is custom_list_id. + */ + customListId?: 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$Date { + /** + * 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; + } + /** + * A date range. + */ + export interface Schema$DateRange { + /** + * The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. + */ + endDate?: Schema$Date; + /** + * The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. + */ + startDate?: Schema$Date; + } + /** + * Representation of time defined by day of the week and hour of the day. + */ + export interface Schema$DayAndTime { + /** + * Required. Day of the week. + */ + dayOfWeek?: string | null; + /** + * Required. Hour of the day. + */ + hourOfDay?: number | null; + /** + * Required. The mechanism used to determine the relevant timezone. + */ + timeZoneResolution?: string | null; + } + /** + * Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. + */ + export interface Schema$DayAndTimeAssignedTargetingOptionDetails { + /** + * Required. The day of the week for this day and time targeting setting. + */ + dayOfWeek?: string | null; + /** + * Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). + */ + endHour?: number | null; + /** + * Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). + */ + startHour?: number | null; + /** + * Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + */ + timeZoneResolution?: string | null; + } + /** + * A request listing which assigned targeting options of a given targeting type should be deleted. + */ + export interface Schema$DeleteAssignedTargetingOptionsRequest { + /** + * Required. The assigned targeting option IDs to delete. + */ + assignedTargetingOptionIds?: string[] | null; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + } + /** + * Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + export interface Schema$DeviceMakeModelAssignedTargetingOptionDetails { + /** + * Output only. The display name of the device make and model. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + export interface Schema$DeviceMakeModelTargetingOptionDetails { + /** + * Output only. The display name of the device make and model. + */ + displayName?: string | null; + } + /** + * Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. + */ + export interface Schema$DeviceTypeAssignedTargetingOptionDetails { + /** + * Required. The display name of the device type. + */ + deviceType?: string | null; + /** + * Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. + */ + youtubeAndPartnersBidMultiplier?: number | null; + } + /** + * Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. + */ + export interface Schema$DeviceTypeTargetingOptionDetails { + /** + * Output only. The device type that is used to be targeted. + */ + deviceType?: string | null; + } + /** + * Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + */ + export interface Schema$DigitalContentLabelAssignedTargetingOptionDetails { + /** + * Required. The display name of the digital content label rating tier to be EXCLUDED. + */ + excludedContentRatingTier?: string | null; + } + /** + * Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + */ + export interface Schema$DigitalContentLabelTargetingOptionDetails { + /** + * Output only. An enum for the content label brand safety tiers. + */ + contentRatingTier?: string | null; + } + /** + * Dimensions. + */ + export interface Schema$Dimensions { + /** + * The height in pixels. + */ + heightPixels?: number | null; + /** + * The width in pixels. + */ + widthPixels?: number | null; + } + /** + * The ad sourced from a DV360 creative. + */ + export interface Schema$DisplayVideoSourceAd { + /** + * The ID of the source creative. + */ + creativeId?: string | null; + } + /** + * Details of DoubleVerify settings. + */ + export interface Schema$DoubleVerify { + /** + * Avoid bidding on apps with the star ratings. + */ + appStarRating?: Schema$DoubleVerifyAppStarRating; + /** + * Avoid bidding on apps with the age rating. + */ + avoidedAgeRatings?: string[] | null; + /** + * DV Brand Safety Controls. + */ + brandSafetyCategories?: Schema$DoubleVerifyBrandSafetyCategories; + /** + * The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic + */ + customSegmentId?: string | null; + /** + * Display viewability settings (applicable to display line items only). + */ + displayViewability?: Schema$DoubleVerifyDisplayViewability; + /** + * Avoid Sites and Apps with historical Fraud & IVT Rates. + */ + fraudInvalidTraffic?: Schema$DoubleVerifyFraudInvalidTraffic; + /** + * Video viewability settings (applicable to video line items only). + */ + videoViewability?: Schema$DoubleVerifyVideoViewability; + } + /** + * Details of DoubleVerify star ratings settings. + */ + export interface Schema$DoubleVerifyAppStarRating { + /** + * Avoid bidding on apps with the star ratings. + */ + avoidedStarRating?: string | null; + /** + * Avoid bidding on apps with insufficient star ratings. + */ + avoidInsufficientStarRating?: boolean | null; + } + /** + * Settings for brand safety controls. + */ + export interface Schema$DoubleVerifyBrandSafetyCategories { + /** + * Brand safety high severity avoidance categories. + */ + avoidedHighSeverityCategories?: string[] | null; + /** + * Brand safety medium severity avoidance categories. + */ + avoidedMediumSeverityCategories?: string[] | null; + /** + * Unknown or unrateable. + */ + avoidUnknownBrandSafetyCategory?: boolean | null; + } + /** + * Details of DoubleVerify display viewability settings. + */ + export interface Schema$DoubleVerifyDisplayViewability { + /** + * Target web and app inventory to maximize IAB viewable rate. + */ + iab?: string | null; + /** + * Target web and app inventory to maximize 100% viewable duration. + */ + viewableDuring?: string | null; + } + /** + * DoubleVerify Fraud & Invalid Traffic settings. + */ + export interface Schema$DoubleVerifyFraudInvalidTraffic { + /** + * Avoid Sites and Apps with historical Fraud & IVT. + */ + avoidedFraudOption?: string | null; + /** + * Insufficient Historical Fraud & IVT Stats. + */ + avoidInsufficientOption?: boolean | null; + } + /** + * Details of DoubleVerify video viewability settings. + */ + export interface Schema$DoubleVerifyVideoViewability { + /** + * Target inventory to maximize impressions with 400x300 or greater player size. + */ + playerImpressionRate?: string | null; + /** + * Target web inventory to maximize IAB viewable rate. + */ + videoIab?: string | null; + /** + * Target web inventory to maximize fully viewable rate. + */ + videoViewableRate?: string | null; + } + /** + * Request message for LineItemService.DuplicateLineItem. + */ + export interface Schema$DuplicateLineItemRequest { + /** + * The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + targetDisplayName?: string | null; + } + export interface Schema$DuplicateLineItemResponse { + /** + * The ID of the created line item. + */ + duplicateLineItemId?: string | null; + } + /** + * Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers. + */ + export interface Schema$EditCustomerMatchMembersRequest { + /** + * Input only. A list of contact information to define the members to be added. + */ + addedContactInfoList?: Schema$ContactInfoList; + /** + * Input only. A list of mobile device IDs to define the members to be added. + */ + addedMobileDeviceIdList?: Schema$MobileDeviceIdList; + /** + * Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience. + */ + advertiserId?: string | null; + /** + * Input only. A list of contact information to define the members to be removed. + */ + removedContactInfoList?: Schema$ContactInfoList; + /** + * Input only. A list of mobile device IDs to define the members to be removed. + */ + removedMobileDeviceIdList?: Schema$MobileDeviceIdList; + } + /** + * The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers. + */ + export interface Schema$EditCustomerMatchMembersResponse { + /** + * Required. The ID of the updated Customer Match FirstPartyAndPartnerAudience. + */ + firstPartyAndPartnerAudienceId?: string | null; + } + /** + * Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors. + */ + export interface Schema$EditGuaranteedOrderReadAccessorsRequest { + /** + * The advertisers to add as read accessors to the guaranteed order. + */ + addedAdvertisers?: string[] | null; + /** + * Required. The partner context in which the change is being made. + */ + partnerId?: string | null; + /** + * Whether to give all advertisers of the read/write accessor partner read access to the guaranteed order. Only applicable if read_write_partner_id is set in the guaranteed order. + */ + readAccessInherited?: boolean | null; + /** + * The advertisers to remove as read accessors to the guaranteed order. + */ + removedAdvertisers?: string[] | null; + } + export interface Schema$EditGuaranteedOrderReadAccessorsResponse { + /** + * Whether all advertisers of read_write_partner_id have read access to the guaranteed order. + */ + readAccessInherited?: boolean | null; + /** + * The IDs of advertisers with read access to the guaranteed order. + */ + readAdvertiserIds?: string[] | null; + } + /** + * Request message for InventorySourceService.EditInventorySourceReadWriteAccessors. + */ + export interface Schema$EditInventorySourceReadWriteAccessorsRequest { + /** + * The advertisers to add or remove from the list of advertisers that have read/write access to the inventory source. This change will remove an existing partner read/write accessor. + */ + advertisersUpdate?: Schema$EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate; + /** + * Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors. + */ + assignPartner?: boolean | null; + /** + * Required. The partner context by which the accessors change is being made. + */ + partnerId?: string | null; + } + /** + * Update to the list of advertisers with read/write access to the inventory source. + */ + export interface Schema$EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate { + /** + * The advertisers to add. + */ + addedAdvertisers?: string[] | null; + /** + * The advertisers to remove. + */ + removedAdvertisers?: 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 {} + /** + * Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. + */ + export interface Schema$EnvironmentAssignedTargetingOptionDetails { + /** + * Required. The serving environment. + */ + environment?: string | null; + } + /** + * Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. + */ + export interface Schema$EnvironmentTargetingOptionDetails { + /** + * Output only. The serving environment. + */ + environment?: string | null; + } + /** + * Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. + */ + export interface Schema$ExchangeAssignedTargetingOptionDetails { + /** + * Required. The enum value for the exchange. + */ + exchange?: string | null; + } + /** + * Settings that control which exchanges are enabled for a partner. + */ + export interface Schema$ExchangeConfig { + /** + * All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored. + */ + enabledExchanges?: Schema$ExchangeConfigEnabledExchange[]; + } + /** + * An enabled exchange in the partner. + */ + export interface Schema$ExchangeConfigEnabledExchange { + /** + * The enabled exchange. + */ + exchange?: string | null; + /** + * Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange. + */ + googleAdManagerAgencyId?: string | null; + /** + * Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange. + */ + googleAdManagerBuyerNetworkId?: string | null; + /** + * Output only. Seat ID of the enabled exchange. + */ + seatId?: string | null; + } + /** + * Exchange review status for the creative. + */ + export interface Schema$ExchangeReviewStatus { + /** + * The exchange reviewing the creative. + */ + exchange?: string | null; + /** + * Status of the exchange review. + */ + status?: string | null; + } + /** + * Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. + */ + export interface Schema$ExchangeTargetingOptionDetails { + /** + * Output only. The type of exchange. + */ + exchange?: string | null; + } + /** + * Exit event of the creative. + */ + export interface Schema$ExitEvent { + /** + * Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + */ + name?: string | null; + /** + * Optional. The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + */ + reportingName?: string | null; + /** + * Required. The type of the exit event. + */ + type?: string | null; + /** + * Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` + */ + url?: string | null; + } + /** + * Describes a first or partner audience list used for targeting. First party audiences are created via usage of client data. Partner audiences are provided by Third Party data providers and can only be licensed to customers. + */ + export interface Schema$FirstPartyAndPartnerAudience { + /** + * Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request. + */ + activeDisplayAudienceSize?: string | null; + /** + * Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` + */ + appId?: string | null; + /** + * Output only. The source of the audience. + */ + audienceSource?: string | null; + /** + * Output only. The type of the audience. + */ + audienceType?: string | null; + /** + * Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO` + */ + contactInfoList?: Schema$ContactInfoList; + /** + * Output only. The user-provided description of the audience. Only applicable to first party audiences. + */ + description?: string | null; + /** + * Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request. + */ + displayAudienceSize?: string | null; + /** + * Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. + */ + displayDesktopAudienceSize?: string | null; + /** + * Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. + */ + displayMobileAppAudienceSize?: string | null; + /** + * Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. + */ + displayMobileWebAudienceSize?: string | null; + /** + * Output only. The display name of the first party and partner audience. + */ + displayName?: string | null; + /** + * Identifier. The unique ID of the first party and partner audience. Assigned by the system. + */ + firstPartyAndPartnerAudienceId?: string | null; + /** + * Output only. Whether the audience is a first party and partner audience. + */ + firstPartyAndPartnerAudienceType?: string | null; + /** + * Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. + */ + gmailAudienceSize?: string | null; + /** + * Output only. The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). + */ + membershipDurationDays?: string | null; + /** + * Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` + */ + mobileDeviceIdList?: Schema$MobileDeviceIdList; + /** + * Output only. The resource name of the first party and partner audience. + */ + name?: string | null; + /** + * Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. + */ + youtubeAudienceSize?: string | null; + } + /** + * Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$FirstPartyAndPartnerAudienceGroup { + /** + * Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed. + */ + settings?: Schema$FirstPartyAndPartnerAudienceTargetingSetting[]; + } + /** + * Details of first party and partner audience targeting setting. + */ + export interface Schema$FirstPartyAndPartnerAudienceTargetingSetting { + /** + * Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id. + */ + firstPartyAndPartnerAudienceId?: string | null; + /** + * Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + */ + recency?: string | null; + } + /** + * A strategy that uses a fixed bidding price. + */ + export interface Schema$FixedBidStrategy { + /** + * The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. + */ + bidAmountMicros?: string | null; + } + /** + * A single Floodlight activity. + */ + export interface Schema$FloodlightActivity { + /** + * Output only. IDs of the advertisers that have access to the parent Floodlight group. Only advertisers under the provided partner ID will be listed in this field. + */ + advertiserIds?: string[] | null; + /** + * Required. The display name of the Floodlight activity. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the Floodlight activity. Assigned by the system. + */ + floodlightActivityId?: string | null; + /** + * Required. Immutable. The ID of the parent Floodlight group. + */ + floodlightGroupId?: string | null; + /** + * Output only. The resource name of the Floodlight activity. + */ + name?: string | null; + /** + * Output only. A list of configuration objects designating whether remarketing for this Floodlight Activity is enabled and available for a specifc advertiser. If enabled, this Floodlight Activity generates a remarketing user list that is able to be used in targeting under the advertiser. + */ + remarketingConfigs?: Schema$RemarketingConfig[]; + /** + * Optional. Whether the Floodlight activity is served. + */ + servingStatus?: string | null; + /** + * Output only. Whether tags are required to be compliant. + */ + sslRequired?: boolean | null; + } + /** + * A single Floodlight group. + */ + export interface Schema$FloodlightGroup { + /** + * The Active View video viewability metric configuration for the Floodlight group. + */ + activeViewConfig?: Schema$ActiveViewVideoViewabilityMetricConfig; + /** + * User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 \}, "U2": value { string_value: "MyVariable2" \}, "U3": value { string_value: "MyVariable3" \} \} \}` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<\>`. + */ + customVariables?: {[key: string]: any} | null; + /** + * Required. The display name of the Floodlight group. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the Floodlight group. Assigned by the system. + */ + floodlightGroupId?: string | null; + /** + * Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive. + */ + lookbackWindow?: Schema$LookbackWindow; + /** + * Output only. The resource name of the Floodlight group. + */ + name?: string | null; + /** + * Required. The web tag type enabled for the Floodlight group. + */ + webTagType?: string | null; + } + /** + * Settings that control the number of times a user may be shown with the same ad during a given time period. + */ + export interface Schema$FrequencyCap { + /** + * The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. + */ + maxImpressions?: number | null; + /** + * Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. + */ + maxViews?: number | null; + /** + * The time unit in which the frequency cap will be applied. Required when unlimited is `false`. + */ + timeUnit?: string | null; + /** + * The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + */ + timeUnitCount?: number | null; + /** + * Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. + */ + unlimited?: boolean | null; + } + /** + * Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. + */ + export interface Schema$GenderAssignedTargetingOptionDetails { + /** + * Required. The gender of the audience. + */ + gender?: string | null; + } + /** + * Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. + */ + export interface Schema$GenderTargetingOptionDetails { + /** + * Output only. The gender of an audience. + */ + gender?: string | null; + } + /** + * Request message for LineItemService.GenerateDefaultLineItem. + */ + export interface Schema$GenerateDefaultLineItemRequest { + /** + * Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. The unique ID of the insertion order that the line item belongs to. + */ + insertionOrderId?: string | null; + /** + * Required. The type of the line item. + */ + lineItemType?: string | null; + /** + * The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`. + */ + mobileApp?: Schema$MobileApp; + } + /** + * Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + export interface Schema$GeoRegionAssignedTargetingOptionDetails { + /** + * Output only. The display name of the geographic region (e.g., "Ontario, Canada"). + */ + displayName?: string | null; + /** + * Output only. The type of geographic region targeting. + */ + geoRegionType?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. + */ + targetingOptionId?: string | null; + } + /** + * Search terms for geo region targeting options. + */ + export interface Schema$GeoRegionSearchTerms { + /** + * The search query for the desired geo region. The query can be a prefix, e.g. "New Yor", "Seattle", "USA", etc. + */ + geoRegionQuery?: string | null; + } + /** + * Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + export interface Schema$GeoRegionTargetingOptionDetails { + /** + * Output only. The display name of the geographic region (e.g., "Ontario, Canada"). + */ + displayName?: string | null; + /** + * Output only. The type of geographic region targeting. + */ + geoRegionType?: string | null; + } + /** + * Describes a Google audience resource. Includes Google audience lists. + */ + export interface Schema$GoogleAudience { + /** + * Output only. The display name of the Google audience. . + */ + displayName?: string | null; + /** + * Output only. The unique ID of the Google audience. Assigned by the system. + */ + googleAudienceId?: string | null; + /** + * Output only. The type of Google audience. . + */ + googleAudienceType?: string | null; + /** + * Output only. The resource name of the google audience. + */ + name?: string | null; + } + /** + * Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$GoogleAudienceGroup { + /** + * Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored. + */ + settings?: Schema$GoogleAudienceTargetingSetting[]; + } + /** + * Details of Google audience targeting setting. + */ + export interface Schema$GoogleAudienceTargetingSetting { + /** + * Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. + */ + googleAudienceId?: string | null; + } + /** + * Media resource. + */ + export interface Schema$GoogleBytestreamMedia { + /** + * Name of the media resource. + */ + resourceName?: string | null; + } + /** + * A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source. + */ + export interface Schema$GuaranteedOrder { + /** + * Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser. + */ + defaultAdvertiserId?: string | null; + /** + * The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser. + */ + defaultCampaignId?: string | null; + /** + * Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Immutable. The exchange where the guaranteed order originated. + */ + exchange?: string | null; + /** + * Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange\}-{legacy_guaranteed_order_id\}`. + */ + guaranteedOrderId?: string | null; + /** + * Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI. + */ + legacyGuaranteedOrderId?: string | null; + /** + * Output only. The resource name of the guaranteed order. + */ + name?: string | null; + /** + * Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + publisherName?: string | null; + /** + * Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids. + */ + readAccessInherited?: boolean | null; + /** + * The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id. + */ + readAdvertiserIds?: string[] | null; + /** + * The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order. + */ + readWriteAdvertiserId?: string | null; + /** + * The partner with read/write access to the guaranteed order. + */ + readWritePartnerId?: string | null; + /** + * The status settings of the guaranteed order. + */ + status?: Schema$GuaranteedOrderStatus; + /** + * Output only. The timestamp when the guaranteed order was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * The status settings of the guaranteed order. + */ + export interface Schema$GuaranteedOrderStatus { + /** + * Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI. + */ + configStatus?: string | null; + /** + * The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`. + */ + entityPauseReason?: string | null; + /** + * Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`. + */ + entityStatus?: string | null; + } + /** + * Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. + */ + export interface Schema$HouseholdIncomeAssignedTargetingOptionDetails { + /** + * Required. The household income of the audience. + */ + householdIncome?: string | null; + } + /** + * Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. + */ + export interface Schema$HouseholdIncomeTargetingOptionDetails { + /** + * Output only. The household income of an audience. + */ + householdIncome?: string | null; + } + /** + * A filtering option that filters entities by their entity IDs. + */ + export interface Schema$IdFilter { + /** + * YouTube Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + adGroupAdIds?: string[] | null; + /** + * YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + adGroupIds?: string[] | null; + /** + * 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; + /** + * Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + campaignIds?: string[] | null; + /** + * Insertion Orders to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + insertionOrderIds?: string[] | null; + /** + * Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + lineItemIds?: string[] | null; + /** + * 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; + /** + * Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + mediaProductIds?: string[] | null; + } + /** + * Meta data of an image asset. + */ + export interface Schema$ImageAsset { + /** + * File size of the image asset in bytes. + */ + fileSize?: string | null; + /** + * Metadata for this image at its original size. + */ + fullSize?: Schema$Dimensions; + /** + * MIME type of the image asset. + */ + mimeType?: string | null; + } + /** + * A single insertion order. + */ + export interface Schema$InsertionOrder { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string | null; + /** + * Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. + */ + bidStrategy?: Schema$BiddingStrategy; + /** + * Required. The budget allocation settings of the insertion order. + */ + budget?: Schema$InsertionOrderBudget; + /** + * Required. Immutable. The unique ID of the campaign that the insertion order belongs to. + */ + campaignId?: string | null; + /** + * Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. + */ + entityStatus?: string | null; + /** + * Required. The frequency capping setting of the insertion order. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Output only. The unique ID of the insertion order. Assigned by the system. + */ + insertionOrderId?: string | null; + /** + * Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + */ + insertionOrderType?: string | null; + /** + * Optional. Additional integration details of the insertion order. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface. + */ + kpi?: Schema$Kpi; + /** + * Output only. The resource name of the insertion order. + */ + name?: string | null; + /** + * Optional. Required. The optimization objective of the insertion order. + */ + optimizationObjective?: string | null; + /** + * Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`. + */ + pacing?: Schema$Pacing; + /** + * Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + */ + partnerCosts?: Schema$PartnerCost[]; + /** + * Output only. The reservation type of the insertion order. + */ + reservationType?: string | null; + /** + * Output only. The timestamp when the insertion order was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Settings that control how insertion order budget is allocated. + */ + export interface Schema$InsertionOrderBudget { + /** + * Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + */ + automationType?: string | null; + /** + * Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. + */ + budgetSegments?: Schema$InsertionOrderBudgetSegment[]; + /** + * Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. + */ + budgetUnit?: string | null; + } + /** + * Settings that control the budget of a single budget segment. + */ + export interface Schema$InsertionOrderBudgetSegment { + /** + * Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + */ + budgetAmountMicros?: string | null; + /** + * Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. + */ + campaignBudgetId?: string | null; + /** + * Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. + */ + dateRange?: Schema$DateRange; + /** + * Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + */ + description?: string | null; + } + /** + * Details for an in-stream ad. + */ + export interface Schema$InStreamAd { + /** + * Common ad attributes. + */ + commonInStreamAttribute?: Schema$CommonInStreamAttribute; + /** + * The custom parameters to pass custom values to tracking URL template. + */ + customParameters?: {[key: string]: string} | null; + } + /** + * Details of Integral Ad Science settings. + */ + export interface Schema$IntegralAdScience { + /** + * The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. + */ + customSegmentId?: string[] | null; + /** + * Display Viewability section (applicable to display line items only). + */ + displayViewability?: string | null; + /** + * Ad Fraud settings. + */ + excludedAdFraudRisk?: string | null; + /** + * Brand Safety - **Adult content**. + */ + excludedAdultRisk?: string | null; + /** + * Brand Safety - **Alcohol**. + */ + excludedAlcoholRisk?: string | null; + /** + * Brand Safety - **Drugs**. + */ + excludedDrugsRisk?: string | null; + /** + * Brand Safety - **Gambling**. + */ + excludedGamblingRisk?: string | null; + /** + * Brand Safety - **Hate speech**. + */ + excludedHateSpeechRisk?: string | null; + /** + * Brand Safety - **Illegal downloads**. + */ + excludedIllegalDownloadsRisk?: string | null; + /** + * Brand Safety - **Offensive language**. + */ + excludedOffensiveLanguageRisk?: string | null; + /** + * Brand Safety - **Violence**. + */ + excludedViolenceRisk?: string | null; + /** + * Brand Safety - **Unrateable**. + */ + excludeUnrateable?: boolean | null; + /** + * Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive. + */ + qualitySyncCustomSegmentId?: string[] | null; + /** + * True advertising quality (applicable to Display line items only). + */ + traqScoreOption?: string | null; + /** + * Video Viewability Section (applicable to video line items only). + */ + videoViewability?: string | null; + } + /** + * Integration details of an entry. + */ + export interface Schema$IntegrationDetails { + /** + * Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. + */ + details?: string | null; + /** + * An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. + */ + integrationCode?: string | null; + } + /** + * An inventory source. + */ + export interface Schema$InventorySource { + /** + * Whether the inventory source has a guaranteed or non-guaranteed delivery. + */ + commitment?: string | null; + /** + * The creative requirements of the inventory source. Not applicable for auction packages. + */ + creativeConfigs?: Schema$CreativeConfig[]; + /** + * The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges. + */ + dealId?: string | null; + /** + * The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. + */ + deliveryMethod?: string | null; + /** + * The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * The exchange to which the inventory source belongs. + */ + exchange?: string | null; + /** + * Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`. + */ + guaranteedOrderId?: string | null; + /** + * Output only. The unique ID of the inventory source. Assigned by the system. + */ + inventorySourceId?: string | null; + /** + * Output only. The product type of the inventory source, denoting the way through which it sells inventory. + */ + inventorySourceProductType?: string | null; + /** + * Denotes the type of the inventory source. + */ + inventorySourceType?: string | null; + /** + * Output only. The resource name of the inventory source. + */ + name?: string | null; + /** + * The publisher/seller name of the inventory source. + */ + publisherName?: string | null; + /** + * Required. The rate details of the inventory source. + */ + rateDetails?: Schema$RateDetails; + /** + * Output only. The IDs of advertisers with read-only access to the inventory source. + */ + readAdvertiserIds?: string[] | null; + /** + * Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source. + */ + readPartnerIds?: string[] | null; + /** + * The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids. + */ + readWriteAccessors?: Schema$InventorySourceAccessors; + /** + * The status settings of the inventory source. + */ + status?: Schema$InventorySourceStatus; + /** + * The time range when this inventory source starts and stops serving. + */ + timeRange?: Schema$TimeRange; + /** + * Output only. The timestamp when the inventory source was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * The partner or advertisers with access to the inventory source. + */ + export interface Schema$InventorySourceAccessors { + /** + * The advertisers with access to the inventory source. All advertisers must belong to the same partner. + */ + advertisers?: Schema$InventorySourceAccessorsAdvertiserAccessors; + /** + * The partner with access to the inventory source. + */ + partner?: Schema$InventorySourceAccessorsPartnerAccessor; + } + /** + * The advertisers with access to the inventory source. + */ + export interface Schema$InventorySourceAccessorsAdvertiserAccessors { + /** + * The IDs of the advertisers. + */ + advertiserIds?: string[] | null; + } + /** + * The partner with access to the inventory source. + */ + export interface Schema$InventorySourceAccessorsPartnerAccessor { + /** + * The ID of the partner. + */ + partnerId?: string | null; + } + /** + * Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. + */ + export interface Schema$InventorySourceAssignedTargetingOptionDetails { + /** + * Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. + */ + inventorySourceId?: string | null; + } + /** + * The configuration for display creatives. + */ + export interface Schema$InventorySourceDisplayCreativeConfig { + /** + * The size requirements for display creatives that can be assigned to the inventory source. + */ + creativeSize?: Schema$Dimensions; + } + /** + * A filtering option for filtering on Inventory Source entities. + */ + export interface Schema$InventorySourceFilter { + /** + * Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner. + */ + inventorySourceIds?: string[] | null; + } + /** + * A collection of targetable inventory sources. + */ + export interface Schema$InventorySourceGroup { + /** + * Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the inventory source group. Assigned by the system. + */ + inventorySourceGroupId?: string | null; + /** + * Output only. The resource name of the inventory source group. + */ + name?: string | null; + } + /** + * Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + */ + export interface Schema$InventorySourceGroupAssignedTargetingOptionDetails { + /** + * Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. + */ + inventorySourceGroupId?: string | null; + } + /** + * The status related settings of the inventory source. + */ + export interface Schema$InventorySourceStatus { + /** + * Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. + */ + configStatus?: string | null; + /** + * The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`. + */ + entityPauseReason?: string | null; + /** + * Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`. + */ + entityStatus?: string | null; + /** + * Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`. + */ + sellerPauseReason?: string | null; + /** + * Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`. + */ + sellerStatus?: string | null; + } + /** + * The configuration for video creatives. + */ + export interface Schema$InventorySourceVideoCreativeConfig { + /** + * The duration requirements for the video creatives that can be assigned to the inventory source. + */ + duration?: string | null; + } + /** + * A single invoice. + */ + export interface Schema$Invoice { + /** + * The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to "Budget invoice grouping ID". + */ + budgetInvoiceGroupingId?: string | null; + /** + * The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to "Budget level PO". + */ + budgetSummaries?: Schema$BudgetSummary[]; + /** + * The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty. + */ + correctedInvoiceId?: string | null; + /** + * The currency used in the invoice in ISO 4217 format. + */ + currencyCode?: string | null; + /** + * The display name of the invoice. + */ + displayName?: string | null; + /** + * The date when the invoice is due. + */ + dueDate?: Schema$Date; + /** + * The unique ID of the invoice. + */ + invoiceId?: string | null; + /** + * The type of invoice document. + */ + invoiceType?: string | null; + /** + * The date when the invoice was issued. + */ + issueDate?: Schema$Date; + /** + * The resource name of the invoice. + */ + name?: string | null; + /** + * The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. + */ + nonBudgetMicros?: string | null; + /** + * The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`. + */ + paymentsAccountId?: string | null; + /** + * The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`. + */ + paymentsProfileId?: string | null; + /** + * The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again. + */ + pdfUrl?: string | null; + /** + * Purchase order number associated with the invoice. + */ + purchaseOrderNumber?: string | null; + /** + * The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty. + */ + replacedInvoiceIds?: string[] | null; + /** + * The service start and end dates which are covered by this invoice. + */ + serviceDateRange?: Schema$DateRange; + /** + * The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. + */ + subtotalAmountMicros?: string | null; + /** + * The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. + */ + totalAmountMicros?: string | null; + /** + * The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. + */ + totalTaxAmountMicros?: string | null; + } + /** + * Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. + */ + export interface Schema$KeywordAssignedTargetingOptionDetails { + /** + * Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. + */ + keyword?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * Settings that control the key performance indicator, or KPI, of an insertion order. + */ + export interface Schema$Kpi { + /** + * Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected. + */ + kpiAlgorithmId?: string | null; + /** + * The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency. + */ + kpiAmountMicros?: string | null; + /** + * The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07). + */ + kpiPercentageMicros?: string | null; + /** + * A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`. + */ + kpiString?: string | null; + /** + * Required. The type of KPI. + */ + kpiType?: string | null; + } + /** + * Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. + */ + export interface Schema$LanguageAssignedTargetingOptionDetails { + /** + * Output only. The display name of the language (e.g., "French"). + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. + */ + export interface Schema$LanguageTargetingOptionDetails { + /** + * Output only. The display name of the language (e.g., "French"). + */ + displayName?: string | null; + } + /** + * A single line item. + */ + export interface Schema$LineItem { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string | null; + /** + * Required. The bidding strategy of the line item. + */ + bidStrategy?: Schema$BiddingStrategy; + /** + * Required. The budget allocation setting of the line item. + */ + budget?: Schema$LineItemBudget; + /** + * Output only. The unique ID of the campaign that the line item belongs to. + */ + campaignId?: string | null; + /** + * The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + */ + conversionCounting?: Schema$ConversionCountingConfig; + /** + * The IDs of the creatives associated with the line item. + */ + creativeIds?: string[] | null; + /** + * Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. + */ + entityStatus?: string | null; + /** + * Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. + */ + excludeNewExchanges?: boolean | null; + /** + * Required. The start and end time of the line item's flight. + */ + flight?: Schema$LineItemFlight; + /** + * Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Required. Immutable. The unique ID of the insertion order that the line item belongs to. + */ + insertionOrderId?: string | null; + /** + * Integration details of the line item. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * Output only. The unique ID of the line item. Assigned by the system. + */ + lineItemId?: string | null; + /** + * Required. Immutable. The type of the line item. + */ + lineItemType?: string | null; + /** + * The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`. + */ + mobileApp?: Schema$MobileApp; + /** + * Output only. The resource name of the line item. + */ + name?: string | null; + /** + * Required. The budget spending speed setting of the line item. + */ + pacing?: Schema$Pacing; + /** + * The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order. + */ + partnerCosts?: Schema$PartnerCost[]; + /** + * Required. The partner revenue model setting of the line item. + */ + partnerRevenueModel?: Schema$PartnerRevenueModel; + /** + * Output only. The reservation type of the line item. + */ + reservationType?: string | null; + /** + * The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. + */ + targetingExpansion?: Schema$TargetingExpansionConfig; + /** + * Output only. The timestamp when the line item was last updated. Assigned by the system. + */ + updateTime?: string | null; + /** + * Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. + */ + warningMessages?: string[] | null; + /** + * Output only. Settings specific to YouTube and Partners line items. + */ + youtubeAndPartnersSettings?: Schema$YoutubeAndPartnersSettings; + } + /** + * Wrapper object associating an assigned_targeting_option resource and the line item it is assigned to. + */ + export interface Schema$LineItemAssignedTargetingOption { + /** + * The assigned targeting option resource. + */ + assignedTargetingOption?: Schema$AssignedTargetingOption; + /** + * The ID of the line item the assigned targeting option is assigned to. + */ + lineItemId?: string | null; + } + /** + * Settings that control how budget is allocated. + */ + export interface Schema$LineItemBudget { + /** + * Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + */ + budgetAllocationType?: string | null; + /** + * Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. + */ + budgetUnit?: string | null; + /** + * The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. + */ + maxAmount?: string | null; + } + /** + * Settings that control the active duration of a line item. + */ + export interface Schema$LineItemFlight { + /** + * The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. + */ + dateRange?: Schema$DateRange; + /** + * Required. The type of the line item's flight dates. + */ + flightDateType?: string | null; + } + export interface Schema$ListAdGroupAdsResponse { + /** + * The list of ad group ads. This list will be absent if empty. + */ + adGroupAds?: Schema$AdGroupAd[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListAdGroupAssignedTargetingOptions. + */ + export interface Schema$ListAdGroupAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdGroupAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more AssignedTargetingOption resources to return. + */ + nextPageToken?: string | null; + } + export interface Schema$ListAdGroupsResponse { + /** + * The list of ad groups. This list will be absent if empty. + */ + adGroups?: Schema$AdGroup[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroups` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListAdvertiserAssignedTargetingOptions. + */ + export interface Schema$ListAdvertiserAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. + */ + nextPageToken?: string | null; + } + export interface Schema$ListAdvertisersResponse { + /** + * The list of advertisers. This list will be absent if empty. + */ + advertisers?: Schema$Advertiser[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdvertisers` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for AssignedInventorySourceService.ListAssignedInventorySources. + */ + export interface Schema$ListAssignedInventorySourcesResponse { + /** + * The list of assigned inventory sources. This list will be absent if empty. + */ + assignedInventorySources?: Schema$AssignedInventorySource[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedInventorySources` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for AssignedLocationService.ListAssignedLocations. + */ + export interface Schema$ListAssignedLocationsResponse { + /** + * The list of assigned locations. This list will be absent if empty. + */ + assignedLocations?: Schema$AssignedLocation[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedLocations` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCampaignsResponse { + /** + * The list of campaigns. This list will be absent if empty. + */ + campaigns?: Schema$Campaign[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCampaigns` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListChannelsResponse { + /** + * The list of channels. This list will be absent if empty. + */ + channels?: Schema$Channel[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCombinedAudiencesResponse { + /** + * The list of combined audiences. This list will be absent if empty. + */ + combinedAudiences?: Schema$CombinedAudience[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCombinedAudiences` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCreativesResponse { + /** + * The list of creatives. This list will be absent if empty. + */ + creatives?: Schema$Creative[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCreativesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomBiddingAlgorithmRulesResponse { + /** + * The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty. + */ + customBiddingRules?: Schema$CustomBiddingAlgorithmRules[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomBiddingAlgorithmsResponse { + /** + * The list of custom bidding algorithms. This list will be absent if empty. + */ + customBiddingAlgorithms?: Schema$CustomBiddingAlgorithm[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomBiddingScriptsResponse { + /** + * The list of custom bidding scripts. This list will be absent if empty. + */ + customBiddingScripts?: Schema$CustomBiddingScript[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingScriptsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomListsResponse { + /** + * The list of custom lists. This list will be absent if empty. + */ + customLists?: Schema$CustomList[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomLists` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListFirstPartyAndPartnerAudiencesResponse { + /** + * The list of first party and partner audiences. Audience size properties will not be included. This list will be absent if empty. + */ + firstPartyAndPartnerAudiences?: Schema$FirstPartyAndPartnerAudience[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstPartyAndPartnerAudiences` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListFloodlightActivitiesResponse { + /** + * The list of Floodlight activities. This list will be absent if empty. + */ + floodlightActivities?: Schema$FloodlightActivity[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFloodlightActivities` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListGoogleAudiencesResponse { + /** + * The list of Google audiences. This list will be absent if empty. + */ + googleAudiences?: Schema$GoogleAudience[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGoogleAudiences` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListGuaranteedOrdersResponse { + /** + * The list of guaranteed orders. This list will be absent if empty. + */ + guaranteedOrders?: Schema$GuaranteedOrder[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGuaranteedOrders` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInsertionOrdersResponse { + /** + * The list of insertion orders. This list will be absent if empty. + */ + insertionOrders?: Schema$InsertionOrder[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInsertionOrders` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for InventorySourceGroupService.ListInventorySourceGroups. + */ + export interface Schema$ListInventorySourceGroupsResponse { + /** + * The list of inventory source groups. This list will be absent if empty. + */ + inventorySourceGroups?: Schema$InventorySourceGroup[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySourceGroups` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInventorySourcesResponse { + /** + * The list of inventory sources. This list will be absent if empty. + */ + inventorySources?: Schema$InventorySource[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInvoicesResponse { + /** + * The list of invoices. This list will be absent if empty. + */ + invoices?: Schema$Invoice[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInvoices` method to retrieve the next page of results. This token will be absent if there are no more invoices to return. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListLineItemAssignedTargetingOptions. + */ + export interface Schema$ListLineItemAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. + */ + nextPageToken?: string | null; + } + export interface Schema$ListLineItemsResponse { + /** + * The list of line items. This list will be absent if empty. + */ + lineItems?: Schema$LineItem[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLineItems` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListLocationListsResponse { + /** + * The list of location lists. This list will be absent if empty. + */ + locationLists?: Schema$LocationList[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLocationLists` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for NegativeKeywordListService.ListNegativeKeywordLists. + */ + export interface Schema$ListNegativeKeywordListsResponse { + /** + * The list of negative keyword lists. This list will be absent if empty. + */ + negativeKeywordLists?: Schema$NegativeKeywordList[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywordLists` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for NegativeKeywordService.ListNegativeKeywords. + */ + export interface Schema$ListNegativeKeywordsResponse { + /** + * The list of negative keywords. This list will be absent if empty. + */ + negativeKeywords?: Schema$NegativeKeyword[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywords` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListPartnerAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListPartnerAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. + */ + nextPageToken?: string | null; + } + export interface Schema$ListPartnersResponse { + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListPartners` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of partners. This list will be absent if empty. + */ + partners?: Schema$Partner[]; + } + /** + * Response message for SiteService.ListSites. + */ + export interface Schema$ListSitesResponse { + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of sites. This list will be absent if empty. + */ + sites?: Schema$Site[]; + } + /** + * Response message for ListTargetingOptions. + */ + export interface Schema$ListTargetingOptionsResponse { + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListTargetingOptions` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of targeting options. This list will be absent if empty. + */ + targetingOptions?: Schema$TargetingOption[]; + } + export interface Schema$ListUsersResponse { + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return. + */ + nextPageToken?: string | null; + /** + * The list of users. This list will be absent if empty. + */ + users?: Schema$User[]; + } + /** + * A list of locations used for targeting. + */ + export interface Schema$LocationList { + /** + * Required. Immutable. The unique ID of the advertiser the location list belongs to. + */ + advertiserId?: string | null; + /** + * Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the location list. Assigned by the system. + */ + locationListId?: string | null; + /** + * Required. Immutable. The type of location. All locations in the list will share this type. + */ + locationType?: string | null; + /** + * Output only. The resource name of the location list. + */ + name?: string | null; + } + /** + * Specifies how many days into the past to look when determining whether to record a conversion. + */ + export interface Schema$LookbackWindow { + /** + * Lookback window, in days, from the last time a given user clicked on one of your ads. + */ + clickDays?: number | null; + /** + * Lookback window, in days, from the last time a given user viewed one of your ads. + */ + impressionDays?: number | null; + } + export interface Schema$LookupInvoiceCurrencyResponse { + /** + * Currency used by the advertiser in ISO 4217 format. + */ + currencyCode?: string | null; + } + /** + * Details for a Masthead Ad. + */ + export interface Schema$MastheadAd { + /** + * The duration of time the video will autoplay. + */ + autoplayVideoDuration?: string | null; + /** + * The amount of time in milliseconds after which the video will start to play. + */ + autoplayVideoStartMillisecond?: string | null; + /** + * The text on the call-to-action button. + */ + callToActionButtonLabel?: string | null; + /** + * The destination URL for the call-to-action button. + */ + callToActionFinalUrl?: string | null; + /** + * The tracking URL for the call-to-action button. + */ + callToActionTrackingUrl?: string | null; + /** + * The videos that appear next to the Masthead Ad on desktop. Can be no more than two. + */ + companionYoutubeVideos?: Schema$YoutubeVideoDetails[]; + /** + * The description of the ad. + */ + description?: string | null; + /** + * The headline of the ad. + */ + headline?: string | null; + /** + * Whether to show a background or banner that appears at the top of a YouTube page. + */ + showChannelArt?: boolean | null; + /** + * The YouTube video used by the ad. + */ + video?: Schema$YoutubeVideoDetails; + /** + * The aspect ratio of the autoplaying YouTube video on the Masthead. + */ + videoAspectRatio?: string | null; + } + /** + * A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. + */ + export interface Schema$MaximizeSpendBidStrategy { + /** + * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + */ + customBiddingAlgorithmId?: string | null; + /** + * The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. + */ + maxAverageCpmBidAmountMicros?: string | null; + /** + * Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. + */ + performanceGoalType?: string | null; + /** + * Whether the strategy takes deal floor prices into account. + */ + raiseBidForDeals?: boolean | null; + } + /** + * Measurement settings of a partner. + */ + export interface Schema$MeasurementConfig { + /** + * Whether or not to report DV360 cost to CM360. + */ + dv360ToCmCostReportingEnabled?: boolean | null; + /** + * Whether or not to include DV360 data in CM360 data transfer reports. + */ + dv360ToCmDataSharingEnabled?: boolean | null; + } + /** + * A mobile app promoted by a mobile app install line item. + */ + export interface Schema$MobileApp { + /** + * Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`. + */ + appId?: string | null; + /** + * Output only. The app name. + */ + displayName?: string | null; + /** + * Output only. The app platform. + */ + platform?: string | null; + /** + * Output only. The app publisher. + */ + publisher?: string | null; + } + /** + * Wrapper message for a list of mobile device IDs defining Customer Match audience members. + */ + export interface Schema$MobileDeviceIdList { + /** + * Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. + */ + consent?: Schema$Consent; + /** + * A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + */ + mobileDeviceIds?: string[] | null; + } + /** + * 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; + } + /** + * Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. + */ + export interface Schema$NativeContentPositionAssignedTargetingOptionDetails { + /** + * Required. The content position. + */ + contentPosition?: string | null; + } + /** + * Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. + */ + export interface Schema$NativeContentPositionTargetingOptionDetails { + /** + * Output only. The content position. + */ + contentPosition?: string | null; + } + /** + * A negatively targeted keyword that belongs to a negative keyword list. + */ + export interface Schema$NegativeKeyword { + /** + * Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored. + */ + keywordValue?: string | null; + /** + * Output only. The resource name of the negative keyword. + */ + name?: string | null; + } + /** + * A list of negative keywords used for targeting. + */ + export interface Schema$NegativeKeywordList { + /** + * Output only. The unique ID of the advertiser the negative keyword list belongs to. + */ + advertiserId?: string | null; + /** + * Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. + */ + displayName?: string | null; + /** + * Output only. The resource name of the negative keyword list. + */ + name?: string | null; + /** + * Output only. The unique ID of the negative keyword list. Assigned by the system. + */ + negativeKeywordListId?: string | null; + /** + * Output only. Number of line items that are directly targeting this negative keyword list. + */ + targetedLineItemCount?: string | null; + } + /** + * Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. + */ + export interface Schema$NegativeKeywordListAssignedTargetingOptionDetails { + /** + * Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. + */ + negativeKeywordListId?: string | null; + } + /** + * Details for a non-skippable ad. + */ + export interface Schema$NonSkippableAd { + /** + * Common ad attributes. + */ + commonInStreamAttribute?: Schema$CommonInStreamAttribute; + /** + * The custom parameters to pass custom values to tracking URL template. + */ + customParameters?: {[key: string]: string} | null; + } + /** + * OBA Icon for a Creative + */ + export interface Schema$ObaIcon { + /** + * Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + */ + clickTrackingUrl?: string | null; + /** + * Optional. The dimensions of the OBA icon. + */ + dimensions?: Schema$Dimensions; + /** + * Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + */ + landingPageUrl?: string | null; + /** + * Optional. The position of the OBA icon on the creative. + */ + position?: string | null; + /** + * Optional. The program of the OBA icon. For example: “AdChoices”. + */ + program?: string | null; + /** + * Optional. The MIME type of the OBA icon resource. + */ + resourceMimeType?: string | null; + /** + * Optional. The URL of the OBA icon resource. + */ + resourceUrl?: string | null; + /** + * Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com` + */ + viewTrackingUrl?: string | null; + } + /** + * Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. + */ + export interface Schema$OmidAssignedTargetingOptionDetails { + /** + * Required. The type of Open Measurement enabled inventory. + */ + omid?: string | null; + } + /** + * Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. + */ + export interface Schema$OmidTargetingOptionDetails { + /** + * Output only. The type of Open Measurement enabled inventory. + */ + omid?: string | null; + } + /** + * On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + export interface Schema$OnScreenPositionAssignedTargetingOptionDetails { + /** + * Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. + */ + adType?: string | null; + /** + * Output only. The on screen position. + */ + onScreenPosition?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + export interface Schema$OnScreenPositionTargetingOptionDetails { + /** + * Output only. The on screen position. + */ + onScreenPosition?: string | null; + } + /** + * Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + export interface Schema$OperatingSystemAssignedTargetingOptionDetails { + /** + * Output only. The display name of the operating system. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + export interface Schema$OperatingSystemTargetingOptionDetails { + /** + * Output only. The display name of the operating system. + */ + displayName?: 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; + } + /** + * Settings that control the rate at which a budget is spent. + */ + export interface Schema$Pacing { + /** + * Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. + */ + dailyMaxImpressions?: string | null; + /** + * Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. + */ + dailyMaxMicros?: string | null; + /** + * Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. + */ + pacingPeriod?: string | null; + /** + * Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. + */ + pacingType?: string | null; + } + /** + * Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. + */ + export interface Schema$ParentalStatusAssignedTargetingOptionDetails { + /** + * Required. The parental status of the audience. + */ + parentalStatus?: string | null; + } + /** + * Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. + */ + export interface Schema$ParentalStatusTargetingOptionDetails { + /** + * Output only. The parental status of an audience. + */ + parentalStatus?: string | null; + } + /** + * A filtering option that filters on selected file types belonging to a chosen set of filter entities. + */ + export interface Schema$ParentEntityFilter { + /** + * Required. File types that will be returned. + */ + fileType?: string[] | null; + /** + * The IDs of the specified filter type. This is used to filter entities to fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be specified. + */ + filterIds?: string[] | null; + /** + * Required. Filter type used to filter fetched entities. + */ + filterType?: string | null; + } + /** + * A single partner in Display & Video 360 (DV360). + */ + export interface Schema$Partner { + /** + * Ad server related settings of the partner. + */ + adServerConfig?: Schema$PartnerAdServerConfig; + /** + * Billing related settings of the partner. + */ + billingConfig?: Schema$PartnerBillingConfig; + /** + * Settings that control how partner data may be accessed. + */ + dataAccessConfig?: Schema$PartnerDataAccessConfig; + /** + * The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The status of the partner. + */ + entityStatus?: string | null; + /** + * Settings that control which exchanges are enabled for the partner. + */ + exchangeConfig?: Schema$ExchangeConfig; + /** + * General settings of the partner. + */ + generalConfig?: Schema$PartnerGeneralConfig; + /** + * Output only. The resource name of the partner. + */ + name?: string | null; + /** + * Output only. The unique ID of the partner. Assigned by the system. + */ + partnerId?: string | null; + /** + * Output only. The timestamp when the partner was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Ad server related settings of a partner. + */ + export interface Schema$PartnerAdServerConfig { + /** + * Measurement settings of a partner. + */ + measurementConfig?: Schema$MeasurementConfig; + } + /** + * Billing related settings of a partner. + */ + export interface Schema$PartnerBillingConfig { + /** + * The ID of a partner default billing profile. + */ + billingProfileId?: string | null; + } + /** + * Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. + */ + export interface Schema$PartnerCost { + /** + * Required. The type of the partner cost. + */ + costType?: string | null; + /** + * The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. + */ + feeAmount?: string | null; + /** + * The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%. + */ + feePercentageMillis?: string | null; + /** + * Required. The fee type for this partner cost. + */ + feeType?: string | null; + /** + * The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types. + */ + invoiceType?: string | null; + } + /** + * Settings that control how partner related data may be accessed. + */ + export interface Schema$PartnerDataAccessConfig { + /** + * Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner. + */ + sdfConfig?: Schema$SdfConfig; + } + /** + * General settings of a partner. + */ + export interface Schema$PartnerGeneralConfig { + /** + * Immutable. Partner's currency in ISO 4217 format. + */ + currencyCode?: string | null; + /** + * Immutable. The standard TZ database name of the partner's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + */ + timeZone?: string | null; + } + /** + * Settings that control how partner revenue is calculated. + */ + export interface Schema$PartnerRevenueModel { + /** + * Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). + */ + markupAmount?: string | null; + /** + * Required. The markup type of the partner revenue model. + */ + markupType?: string | null; + } + /** + * Settings that control the performance goal of a campaign. + */ + export interface Schema$PerformanceGoal { + /** + * The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency. + */ + performanceGoalAmountMicros?: string | null; + /** + * The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07). + */ + performanceGoalPercentageMicros?: string | null; + /** + * A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`. + */ + performanceGoalString?: string | null; + /** + * Required. The type of the performance goal. + */ + performanceGoalType?: string | null; + } + /** + * A strategy that automatically adjusts the bid to meet or beat a specified performance goal. + */ + export interface Schema$PerformanceGoalBidStrategy { + /** + * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + */ + customBiddingAlgorithmId?: string | null; + /** + * The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. + */ + maxAverageCpmBidAmountMicros?: string | null; + /** + * Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. + */ + performanceGoalAmountMicros?: string | null; + /** + * Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + */ + performanceGoalType?: string | null; + } + /** + * Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. + */ + export interface Schema$PoiAssignedTargetingOptionDetails { + /** + * Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. + */ + displayName?: string | null; + /** + * Output only. Latitude of the POI rounding to 6th decimal place. + */ + latitude?: number | null; + /** + * Output only. Longitude of the POI rounding to 6th decimal place. + */ + longitude?: number | null; + /** + * Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. + */ + proximityRadiusAmount?: number | null; + /** + * Required. The unit of distance by which the targeting radius is measured. + */ + proximityRadiusUnit?: string | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.** + */ + targetingOptionId?: string | null; + } + /** + * Search terms for POI targeting options. + */ + export interface Schema$PoiSearchTerms { + /** + * The search query for the desired POI name, street address, or coordinate of the desired POI. The query can be a prefix, e.g. "Times squar", "40.7505045,-73.99562", "315 W 44th St", etc. + */ + poiQuery?: string | null; + } + /** + * Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. + */ + export interface Schema$PoiTargetingOptionDetails { + /** + * Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available. + */ + displayName?: string | null; + /** + * Output only. Latitude of the POI rounding to 6th decimal place. + */ + latitude?: number | null; + /** + * Output only. Longitude of the POI rounding to 6th decimal place. + */ + longitude?: number | null; + } + /** + * Settings specific to the Mediaocean Prisma tool. + */ + export interface Schema$PrismaConfig { + /** + * Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. + */ + prismaCpeCode?: Schema$PrismaCpeCode; + /** + * Required. The Prisma type. + */ + prismaType?: string | null; + /** + * Required. The entity allocated this budget (DSP, site, etc.). + */ + supplier?: string | null; + } + /** + * Google Payments Center supports searching and filtering on the component fields of this code. + */ + export interface Schema$PrismaCpeCode { + /** + * The Prisma client code. + */ + prismaClientCode?: string | null; + /** + * The Prisma estimate code. + */ + prismaEstimateCode?: string | null; + /** + * The Prisma product code. + */ + prismaProductCode?: string | null; + } + /** + * The details of product feed. + */ + export interface Schema$ProductFeedData { + /** + * Whether the product feed has opted-out of showing products. + */ + isFeedDisabled?: boolean | null; + /** + * A list of dimensions used to match products. + */ + productMatchDimensions?: Schema$ProductMatchDimension[]; + /** + * How products are selected by the product feed. + */ + productMatchType?: string | null; + } + /** + * A dimension used to match products. + */ + export interface Schema$ProductMatchDimension { + /** + * The custom label to match all the products with the label. + */ + customLabel?: Schema$CustomLabel; + /** + * The ID of the product offer to match with a product with the same offer ID. + */ + productOfferId?: string | null; + } + /** + * Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + */ + export interface Schema$ProximityLocationListAssignedTargetingOptionDetails { + /** + * Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`. + */ + proximityLocationListId?: string | null; + /** + * Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers. + */ + proximityRadius?: number | null; + /** + * Required. Radius distance units. + */ + proximityRadiusUnit?: string | null; + } + /** + * The rate related settings of the inventory source. + */ + export interface Schema$RateDetails { + /** + * The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`. + */ + inventorySourceRateType?: string | null; + /** + * Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources. + */ + minimumSpend?: Schema$Money; + /** + * The rate for the inventory source. + */ + rate?: Schema$Money; + /** + * Required for guaranteed inventory sources. The number of impressions guaranteed by the seller. + */ + unitsPurchased?: string | null; + } + /** + * Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + */ + export interface Schema$RegionalLocationListAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. + */ + regionalLocationListId?: string | null; + } + /** + * Settings that control the whether remarketing is enabled for the given identified advertiser. + */ + export interface Schema$RemarketingConfig { + /** + * Output only. The ID of the advertiser. + */ + advertiserId?: string | null; + /** + * Output only. Whether the Floodlight activity remarketing user list is available to the identified advertiser. + */ + remarketingEnabled?: boolean | null; + } + /** + * Request message for NegativeKeywordService.ReplaceNegativeKeywords. + */ + export interface Schema$ReplaceNegativeKeywordsRequest { + /** + * The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of NegativeKeywords. + */ + newNegativeKeywords?: Schema$NegativeKeyword[]; + } + /** + * Response message for NegativeKeywordService.ReplaceNegativeKeywords. + */ + export interface Schema$ReplaceNegativeKeywordsResponse { + /** + * The full list of negative keywords now present in the negative keyword list. + */ + negativeKeywords?: Schema$NegativeKeyword[]; + } + /** + * Request message for SiteService.ReplaceSites. + */ + export interface Schema$ReplaceSitesRequest { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string | null; + /** + * The sites that will replace the existing sites assigned to the channel, specified as a list of Sites. + */ + newSites?: Schema$Site[]; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string | null; + } + /** + * Response message for SiteService.ReplaceSites. + */ + export interface Schema$ReplaceSitesResponse { + /** + * The list of sites in the channel after replacing. + */ + sites?: Schema$Site[]; + } + /** + * Review statuses for the creative. + */ + export interface Schema$ReviewStatusInfo { + /** + * Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status. + */ + approvalStatus?: string | null; + /** + * Content and policy review status for the creative. + */ + contentAndPolicyReviewStatus?: string | null; + /** + * Creative and landing page review status for the creative. + */ + creativeAndLandingPageReviewStatus?: string | null; + /** + * Exchange review statuses for the creative. + */ + exchangeReviewStatuses?: Schema$ExchangeReviewStatus[]; + } + /** + * An error message for a custom bidding script. + */ + export interface Schema$ScriptError { + /** + * The column number in the script where the error was thrown. + */ + column?: string | null; + /** + * The type of error. + */ + errorCode?: string | null; + /** + * The detailed error message. + */ + errorMessage?: string | null; + /** + * The line number in the script where the error was thrown. + */ + line?: string | null; + } + /** + * Structured Data File (SDF) related settings. + */ + export interface Schema$SdfConfig { + /** + * An administrator email address to which the SDF processing status reports will be sent. + */ + adminEmail?: string | null; + /** + * Required. The version of SDF being used. + */ + version?: string | null; + } + /** + * Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$SdfDownloadTask { + /** + * A resource name to be used in media.download to Download the prepared files. Resource names have the format `download/sdfdownloadtasks/media/{media_id\}`. `media_id` will be made available by the long running operation service once the task status is done. + */ + resourceName?: string | null; + } + /** + * Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$SdfDownloadTaskMetadata { + /** + * The time when the operation was created. + */ + createTime?: string | null; + /** + * The time when execution was completed. + */ + endTime?: string | null; + /** + * The SDF version used to execute this download task. + */ + version?: string | null; + } + /** + * Request message for SearchTargetingOptions. + */ + export interface Schema$SearchTargetingOptionsRequest { + /** + * Required. The Advertiser this request is being made in the context of. + */ + advertiserId?: string | null; + /** + * Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. + */ + businessChainSearchTerms?: Schema$BusinessChainSearchTerms; + /** + * Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + geoRegionSearchTerms?: Schema$GeoRegionSearchTerms; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number | null; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string | null; + /** + * Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`. + */ + poiSearchTerms?: Schema$PoiSearchTerms; + } + /** + * Response message for SearchTargetingOptions. + */ + export interface Schema$SearchTargetingOptionsResponse { + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `SearchTargetingOptions` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of targeting options that match the search criteria. This list will be absent if empty. + */ + targetingOptions?: Schema$TargetingOption[]; + } + /** + * Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + */ + export interface Schema$SensitiveCategoryAssignedTargetingOptionDetails { + /** + * Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + */ + excludedSensitiveCategory?: string | null; + } + /** + * Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + */ + export interface Schema$SensitiveCategoryTargetingOptionDetails { + /** + * Output only. An enum for the DV360 Sensitive category content classifier. + */ + sensitiveCategory?: string | null; + } + /** + * Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. + */ + export interface Schema$SessionPositionAssignedTargetingOptionDetails { + /** + * The position where the ad will show in a session. + */ + sessionPosition?: string | null; + } + /** + * A single site. Sites are apps or websites belonging to a channel. + */ + export interface Schema$Site { + /** + * Output only. The resource name of the site. + */ + name?: string | null; + /** + * Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. + */ + urlOrAppId?: 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 { + /** + * 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; + } + /** + * Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. + */ + export interface Schema$SubExchangeAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. + */ + export interface Schema$SubExchangeTargetingOptionDetails { + /** + * Output only. The display name of the sub-exchange. + */ + displayName?: string | null; + } + /** + * Setting that controls the average number of times the ads will show to the same person over a certain period of time. + */ + export interface Schema$TargetFrequency { + /** + * The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count. + */ + targetCount?: string | null; + /** + * The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS` + */ + timeUnit?: string | null; + /** + * The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 + */ + timeUnitCount?: number | null; + } + /** + * Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. + */ + export interface Schema$TargetingExpansionConfig { + /** + * Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. + */ + audienceExpansionLevel?: string | null; + /** + * Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. + */ + audienceExpansionSeedListExcluded?: boolean | null; + /** + * Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + */ + enableOptimizedTargeting?: boolean | null; + } + /** + * Represents a single targeting option, which is a targetable concept in DV360. + */ + export interface Schema$TargetingOption { + /** + * Age range details. + */ + ageRangeDetails?: Schema$AgeRangeTargetingOptionDetails; + /** + * App category details. + */ + appCategoryDetails?: Schema$AppCategoryTargetingOptionDetails; + /** + * Audio content type details. + */ + audioContentTypeDetails?: Schema$AudioContentTypeTargetingOptionDetails; + /** + * Authorized seller status resource details. + */ + authorizedSellerStatusDetails?: Schema$AuthorizedSellerStatusTargetingOptionDetails; + /** + * Browser details. + */ + browserDetails?: Schema$BrowserTargetingOptionDetails; + /** + * Business chain resource details. + */ + businessChainDetails?: Schema$BusinessChainTargetingOptionDetails; + /** + * Carrier and ISP details. + */ + carrierAndIspDetails?: Schema$CarrierAndIspTargetingOptionDetails; + /** + * Category resource details. + */ + categoryDetails?: Schema$CategoryTargetingOptionDetails; + /** + * Content duration resource details. + */ + contentDurationDetails?: Schema$ContentDurationTargetingOptionDetails; + /** + * Content genre resource details. + */ + contentGenreDetails?: Schema$ContentGenreTargetingOptionDetails; + /** + * Content instream position details. + */ + contentInstreamPositionDetails?: Schema$ContentInstreamPositionTargetingOptionDetails; + /** + * Content outstream position details. + */ + contentOutstreamPositionDetails?: Schema$ContentOutstreamPositionTargetingOptionDetails; + /** + * Content stream type resource details. + */ + contentStreamTypeDetails?: Schema$ContentStreamTypeTargetingOptionDetails; + /** + * Device make and model resource details. + */ + deviceMakeModelDetails?: Schema$DeviceMakeModelTargetingOptionDetails; + /** + * Device type details. + */ + deviceTypeDetails?: Schema$DeviceTypeTargetingOptionDetails; + /** + * Digital content label details. + */ + digitalContentLabelDetails?: Schema$DigitalContentLabelTargetingOptionDetails; + /** + * Environment details. + */ + environmentDetails?: Schema$EnvironmentTargetingOptionDetails; + /** + * Exchange details. + */ + exchangeDetails?: Schema$ExchangeTargetingOptionDetails; + /** + * Gender details. + */ + genderDetails?: Schema$GenderTargetingOptionDetails; + /** + * Geographic region resource details. + */ + geoRegionDetails?: Schema$GeoRegionTargetingOptionDetails; + /** + * Household income details. + */ + householdIncomeDetails?: Schema$HouseholdIncomeTargetingOptionDetails; + /** + * Language resource details. + */ + languageDetails?: Schema$LanguageTargetingOptionDetails; + /** + * Output only. The resource name for this targeting option. + */ + name?: string | null; + /** + * Native content position details. + */ + nativeContentPositionDetails?: Schema$NativeContentPositionTargetingOptionDetails; + /** + * Open Measurement enabled inventory details. + */ + omidDetails?: Schema$OmidTargetingOptionDetails; + /** + * On screen position details. + */ + onScreenPositionDetails?: Schema$OnScreenPositionTargetingOptionDetails; + /** + * Operating system resources details. + */ + operatingSystemDetails?: Schema$OperatingSystemTargetingOptionDetails; + /** + * Parental status details. + */ + parentalStatusDetails?: Schema$ParentalStatusTargetingOptionDetails; + /** + * POI resource details. + */ + poiDetails?: Schema$PoiTargetingOptionDetails; + /** + * Sensitive Category details. + */ + sensitiveCategoryDetails?: Schema$SensitiveCategoryTargetingOptionDetails; + /** + * Sub-exchange details. + */ + subExchangeDetails?: Schema$SubExchangeTargetingOptionDetails; + /** + * Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`\} will be unique. + */ + targetingOptionId?: string | null; + /** + * Output only. The type of this targeting option. + */ + targetingType?: string | null; + /** + * User rewarded content details. + */ + userRewardedContentDetails?: Schema$UserRewardedContentTargetingOptionDetails; + /** + * Video player size details. + */ + videoPlayerSizeDetails?: Schema$VideoPlayerSizeTargetingOptionDetails; + /** + * Viewability resource details. + */ + viewabilityDetails?: Schema$ViewabilityTargetingOptionDetails; + } + /** + * Settings that control what third-party vendors are measuring specific line item metrics. + */ + export interface Schema$ThirdPartyMeasurementConfigs { + /** + * Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` + */ + brandLiftVendorConfigs?: Schema$ThirdPartyVendorConfig[]; + /** + * Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` + */ + brandSafetyVendorConfigs?: Schema$ThirdPartyVendorConfig[]; + /** + * Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` + */ + reachVendorConfigs?: Schema$ThirdPartyVendorConfig[]; + /** + * Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + */ + viewabilityVendorConfigs?: Schema$ThirdPartyVendorConfig[]; + } + /** + * Settings for advertisers that use third-party ad servers only. + */ + export interface Schema$ThirdPartyOnlyConfig { + /** + * Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`. + */ + pixelOrderIdReportingEnabled?: boolean | null; + } + /** + * Tracking URLs from third parties to track interactions with an audio or a video creative. + */ + export interface Schema$ThirdPartyUrl { + /** + * Optional. The type of interaction needs to be tracked by the tracking URL + */ + type?: string | null; + /** + * Optional. Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, `https://www.example.com/path` + */ + url?: string | null; + } + /** + * Settings that control how third-party measurement vendors are configured. + */ + export interface Schema$ThirdPartyVendorConfig { + /** + * The ID used by the platform of the third-party vendor to identify the line item. + */ + placementId?: string | null; + /** + * The third-party measurement vendor. + */ + vendor?: string | null; + } + /** + * Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + */ + export interface Schema$ThirdPartyVerifierAssignedTargetingOptionDetails { + /** + * Third party brand verifier -- Adloox. + */ + adloox?: Schema$Adloox; + /** + * Third party brand verifier -- DoubleVerify. + */ + doubleVerify?: Schema$DoubleVerify; + /** + * Third party brand verifier -- Integral Ad Science. + */ + integralAdScience?: Schema$IntegralAdScience; + } + /** + * A time range. + */ + export interface Schema$TimeRange { + /** + * Required. The upper bound of a time range, inclusive. + */ + endTime?: string | null; + /** + * Required. The lower bound of a time range, inclusive. + */ + startTime?: string | null; + } + /** + * Timer event of the creative. + */ + export interface Schema$TimerEvent { + /** + * Required. The name of the timer event. + */ + name?: string | null; + /** + * Required. The name used to identify this timer event in reports. + */ + reportingName?: string | null; + } + /** + * Settings that control the behavior of a single Floodlight activity config. + */ + export interface Schema$TrackingFloodlightActivityConfig { + /** + * Required. The ID of the Floodlight activity. + */ + floodlightActivityId?: string | null; + /** + * Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. + */ + postClickLookbackWindowDays?: number | null; + /** + * Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive. + */ + postViewLookbackWindowDays?: number | null; + } + /** + * Represents information about the transcoded audio or video file. + */ + export interface Schema$Transcode { + /** + * Optional. The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + */ + audioBitRateKbps?: string | null; + /** + * Optional. The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + */ + audioSampleRateHz?: string | null; + /** + * Optional. The transcoding bit rate of the transcoded video, in kilobits per second. + */ + bitRateKbps?: string | null; + /** + * Optional. The dimensions of the transcoded video. + */ + dimensions?: Schema$Dimensions; + /** + * Optional. The size of the transcoded file, in bytes. + */ + fileSizeBytes?: string | null; + /** + * Optional. The frame rate of the transcoded video, in frames per second. + */ + frameRate?: number | null; + /** + * Optional. The MIME type of the transcoded file. + */ + mimeType?: string | null; + /** + * Optional. The name of the transcoded file. + */ + name?: string | null; + /** + * Optional. Indicates if the transcoding was successful. + */ + transcoded?: boolean | null; + } + /** + * A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. + */ + export interface Schema$UniversalAdId { + /** + * Optional. The unique creative identifier. + */ + id?: string | null; + /** + * Optional. The registry provides unique creative identifiers. + */ + registry?: string | null; + } + /** + * Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. + */ + export interface Schema$UrlAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`. + */ + url?: string | null; + } + /** + * A single user in Display & Video 360. + */ + export interface Schema$User { + /** + * The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles. + */ + assignedUserRoles?: Schema$AssignedUserRole[]; + /** + * Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Immutable. The email address used to identify the user. + */ + email?: string | null; + /** + * Output only. The timestamp when the user last logged in DV360 UI. + */ + lastLoginTime?: string | null; + /** + * Output only. The resource name of the user. + */ + name?: string | null; + /** + * Output only. The unique ID of the user. Assigned by the system. + */ + userId?: string | null; + } + /** + * User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + export interface Schema$UserRewardedContentAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + targetingOptionId?: string | null; + /** + * Output only. User rewarded content status for video ads. + */ + userRewardedContent?: string | null; + } + /** + * Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + export interface Schema$UserRewardedContentTargetingOptionDetails { + /** + * Output only. User rewarded content status for video ads. + */ + userRewardedContent?: string | null; + } + /** + * Settings related to VideoAdSequence. + */ + export interface Schema$VideoAdSequenceSettings { + /** + * The minimum time interval before the same user sees this sequence again. + */ + minimumDuration?: string | null; + /** + * The steps of which the sequence consists. + */ + steps?: Schema$VideoAdSequenceStep[]; + } + /** + * The detail of a single step in a VideoAdSequence. + */ + export interface Schema$VideoAdSequenceStep { + /** + * The ID of the corresponding ad group of the step. + */ + adGroupId?: string | null; + /** + * The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type. + */ + interactionType?: string | null; + /** + * The ID of the previous step. The first step does not have previous step. + */ + previousStepId?: string | null; + /** + * The ID of the step. + */ + stepId?: string | null; + } + /** + * Details for a video discovery ad. + */ + export interface Schema$VideoDiscoveryAd { + /** + * First text line for the ad. + */ + description1?: string | null; + /** + * Second text line for the ad. + */ + description2?: string | null; + /** + * The headline of ad. + */ + headline?: string | null; + /** + * Thumbnail image used in the ad. + */ + thumbnail?: string | null; + /** + * The YouTube video the ad promotes. + */ + video?: Schema$YoutubeVideoDetails; + } + /** + * Details for a video performance ad. + */ + export interface Schema$VideoPerformanceAd { + /** + * The list of text assets shown on the call-to-action button. + */ + actionButtonLabels?: string[] | null; + /** + * The list of companion banners used by this ad. + */ + companionBanners?: Schema$ImageAsset[]; + /** + * The custom parameters to pass custom values to tracking URL template. + */ + customParameters?: {[key: string]: string} | null; + /** + * The list of descriptions shown on the call-to-action banner. + */ + descriptions?: string[] | null; + /** + * The first piece after the domain in the display URL. + */ + displayUrlBreadcrumb1?: string | null; + /** + * The second piece after the domain in the display URL. + */ + displayUrlBreadcrumb2?: string | null; + /** + * The domain of the display URL. + */ + domain?: string | null; + /** + * The URL address of the webpage that people reach after they click the ad. + */ + finalUrl?: string | null; + /** + * The list of headlines shown on the call-to-action banner. + */ + headlines?: string[] | null; + /** + * The list of lone headlines shown on the call-to-action banner. + */ + longHeadlines?: string[] | null; + /** + * The URL address loaded in the background for tracking purposes. + */ + trackingUrl?: string | null; + /** + * The list of YouTube video assets used by this ad. + */ + videos?: Schema$YoutubeVideoDetails[]; + } + /** + * Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. + */ + export interface Schema$VideoPlayerSizeAssignedTargetingOptionDetails { + /** + * Required. The video player size. + */ + videoPlayerSize?: string | null; + } + /** + * Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + */ + export interface Schema$VideoPlayerSizeTargetingOptionDetails { + /** + * Output only. The video player size. + */ + videoPlayerSize?: string | null; + } + /** + * Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. + */ + export interface Schema$ViewabilityAssignedTargetingOptionDetails { + /** + * Required. The predicted viewability percentage. + */ + viewability?: string | null; + } + /** + * Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. + */ + export interface Schema$ViewabilityTargetingOptionDetails { + /** + * Output only. The predicted viewability percentage. + */ + viewability?: string | null; + } + /** + * Settings that control the bid strategy for YouTube and Partners resources. + */ + export interface Schema$YoutubeAndPartnersBiddingStrategy { + /** + * Output only. Source of the effective target CPA value for ad group. + */ + adGroupEffectiveTargetCpaSource?: string | null; + /** + * Output only. The effective target CPA for ad group, in micros of advertiser's currency. + */ + adGroupEffectiveTargetCpaValue?: string | null; + /** + * The type of the bidding strategy. + */ + type?: string | null; + /** + * The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0. + */ + value?: string | null; + } + /** + * Settings that control what YouTube related inventories the YouTube and Partners line item will target. + */ + export interface Schema$YoutubeAndPartnersInventorySourceConfig { + /** + * Optional. Whether to target inventory in video apps available with Google TV. + */ + includeGoogleTv?: boolean | null; + /** + * Optional. Whether to target inventory on YouTube. This includes both search, channels and videos. + */ + includeYoutube?: boolean | null; + /** + * Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. + */ + includeYoutubeVideoPartners?: boolean | null; + } + /** + * Settings for YouTube and Partners line items. + */ + export interface Schema$YoutubeAndPartnersSettings { + /** + * The kind of content on which the YouTube and Partners ads will be shown. + */ + contentCategory?: string | null; + /** + * Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item. + */ + effectiveContentCategory?: string | null; + /** + * Settings that control what YouTube and Partners inventories the line item will target. + */ + inventorySourceSettings?: Schema$YoutubeAndPartnersInventorySourceConfig; + /** + * Optional. The ID of the form to generate leads. + */ + leadFormId?: string | null; + /** + * Optional. The ID of the merchant which is linked to the line item for product feed. + */ + linkedMerchantId?: string | null; + /** + * Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. + */ + relatedVideoIds?: string[] | null; + /** + * Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time. + */ + targetFrequency?: Schema$TargetFrequency; + /** + * Optional. The third-party measurement configs of the line item. + */ + thirdPartyMeasurementConfigs?: Schema$ThirdPartyMeasurementConfigs; + /** + * Optional. The settings related to VideoAdSequence. + */ + videoAdSequenceSettings?: Schema$VideoAdSequenceSettings; + /** + * The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + */ + viewFrequencyCap?: Schema$FrequencyCap; + } + /** + * Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. + */ + export interface Schema$YoutubeChannelAssignedTargetingOptionDetails { + /** + * The YouTube uploader channel id or the channel code of a YouTube channel. + */ + channelId?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. + */ + export interface Schema$YoutubeVideoAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * YouTube video id as it appears on the YouTube watch page. + */ + videoId?: string | null; + } + /** + * Details of a YouTube video. + */ + export interface Schema$YoutubeVideoDetails { + /** + * The YouTube video ID which can be searched on YouTube webpage. + */ + id?: string | null; + /** + * The reason why the video data is not available. + */ + unavailableReason?: string | null; + } + + export class Resource$Advertisers { + context: APIRequestContext; + adGroupAds: Resource$Advertisers$Adgroupads; + adGroups: Resource$Advertisers$Adgroups; + assets: Resource$Advertisers$Assets; + campaigns: Resource$Advertisers$Campaigns; + channels: Resource$Advertisers$Channels; + creatives: Resource$Advertisers$Creatives; + insertionOrders: Resource$Advertisers$Insertionorders; + invoices: Resource$Advertisers$Invoices; + lineItems: Resource$Advertisers$Lineitems; + locationLists: Resource$Advertisers$Locationlists; + negativeKeywordLists: Resource$Advertisers$Negativekeywordlists; + targetingTypes: Resource$Advertisers$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.adGroupAds = new Resource$Advertisers$Adgroupads(this.context); + this.adGroups = new Resource$Advertisers$Adgroups(this.context); + this.assets = new Resource$Advertisers$Assets(this.context); + this.campaigns = new Resource$Advertisers$Campaigns(this.context); + this.channels = new Resource$Advertisers$Channels(this.context); + this.creatives = new Resource$Advertisers$Creatives(this.context); + this.insertionOrders = new Resource$Advertisers$Insertionorders( + this.context + ); + this.invoices = new Resource$Advertisers$Invoices(this.context); + this.lineItems = new Resource$Advertisers$Lineitems(this.context); + this.locationLists = new Resource$Advertisers$Locationlists(this.context); + this.negativeKeywordLists = new Resource$Advertisers$Negativekeywordlists( + this.context + ); + this.targetingTypes = new Resource$Advertisers$Targetingtypes( + this.context + ); + } + + /** + * Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + audit( + params: Params$Resource$Advertisers$Audit, + options: StreamMethodOptions + ): GaxiosPromise; + audit( + params?: Params$Resource$Advertisers$Audit, + options?: MethodOptions + ): GaxiosPromise; + audit( + params: Params$Resource$Advertisers$Audit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + audit( + params: Params$Resource$Advertisers$Audit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + audit( + params: Params$Resource$Advertisers$Audit, + callback: BodyResponseCallback + ): void; + audit(callback: BodyResponseCallback): void; + audit( + paramsOrCallback?: + | Params$Resource$Advertisers$Audit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Audit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Audit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}:audit').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid 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$Advertisers$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers').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 an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests . + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + editAssignedTargetingOptions( + params: Params$Resource$Advertisers$Editassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + editAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Editassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + editAssignedTargetingOptions( + params: Params$Resource$Advertisers$Editassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + params: Params$Resource$Advertisers$Editassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + params: Params$Resource$Advertisers$Editassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Editassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Editassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Editassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}:editAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets an advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists assigned targeting options of an advertiser across targeting types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Listassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + listAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Listassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Listassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Listassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Listassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Listassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Listassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Listassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}:listAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing advertiser. Returns the updated advertiser if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Audit + extends StandardParameters { + /** + * Required. The ID of the advertiser to audit. + */ + advertiserId?: string; + /** + * Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount + */ + readMask?: string; + } + export interface Params$Resource$Advertisers$Create + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$Delete + extends StandardParameters { + /** + * The ID of the advertiser we need to delete. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$Editassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAdvertiserAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Advertisers$Get extends StandardParameters { + /** + * Required. The ID of the advertiser to fetch. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$List extends StandardParameters { + /** + * Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Listassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser. Assigned by the system. + */ + advertiserId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + + export class Resource$Advertisers$Adgroupads { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets an ad group ad. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Adgroupads$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Adgroupads$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Adgroupads$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroupads$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroupads$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroupads$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroupads$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Adgroupads$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'adGroupAdId'], + pathParams: ['adGroupAdId', 'advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists ad group ads. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Adgroupads$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Adgroupads$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Adgroupads$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroupads$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroupads$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroupads$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroupads$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Adgroupads$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/adGroupAds' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Adgroupads$Get + extends StandardParameters { + /** + * Required. The ID of the ad group ad to fetch. + */ + adGroupAdId?: string; + /** + * Required. The ID of the advertiser this ad group ad belongs to. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$Adgroupads$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the ad groups belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Adgroups { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Adgroups$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Adgroups$Targetingtypes( + this.context + ); + } + + /** + * Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + bulkListAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets an ad 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$Advertisers$Adgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Adgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Adgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Adgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'adGroupId'], + pathParams: ['adGroupId', 'advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists ad 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$Advertisers$Adgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Adgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Adgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Adgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}/adGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions + extends StandardParameters { + /** + * Required. The IDs of the ad groups to list assigned targeting options for. + */ + adGroupIds?: string[]; + /** + * Required. The ID of the advertiser the line items belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Adgroups$Get + extends StandardParameters { + /** + * Required. The ID of the ad group to fetch. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser this ad group belongs to. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$Adgroups$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the ad groups belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Adgroups$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'adGroupId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'adGroupId', + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'adGroupId', 'targetingType'], + pathParams: ['adGroupId', 'advertiserId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the ad group the assigned targeting option belongs to. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser the ad group belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the ad group to list assigned targeting options for. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser the ad group belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` + */ + targetingType?: string; + } + + export class Resource$Advertisers$Assets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_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. + */ + upload( + params: Params$Resource$Advertisers$Assets$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Advertisers$Assets$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Advertisers$Assets$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Advertisers$Assets$Upload, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Advertisers$Assets$Upload, + callback: BodyResponseCallback + ): void; + upload(callback: BodyResponseCallback): void; + upload( + paramsOrCallback?: + | Params$Resource$Advertisers$Assets$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Assets$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Assets$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}/assets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: ( + rootUrl + '/upload/v4/advertisers/{+advertiserId}/assets' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Assets$Upload + extends StandardParameters { + /** + * Required. The ID of the advertiser this asset belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateAssetRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Advertisers$Campaigns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new campaign. Returns the newly created campaign if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Campaigns$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Campaigns$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Campaigns$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Campaigns$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Campaigns$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid 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$Advertisers$Campaigns$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Campaigns$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a campaign. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Campaigns$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Campaigns$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Campaigns$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Campaigns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Campaigns$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in 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$Advertisers$Campaigns$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Campaigns$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Campaigns$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Campaigns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Campaigns$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing campaign. Returns the updated campaign if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Campaigns$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Campaigns$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Campaigns$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Advertisers$Campaigns$Delete + extends StandardParameters { + /** + * The ID of the advertiser this campaign belongs to. + */ + advertiserId?: string; + /** + * The ID of the campaign we need to delete. + */ + campaignId?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this campaign belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the campaign to fetch. + */ + campaignId?: string; + } + export interface Params$Resource$Advertisers$Campaigns$List + extends StandardParameters { + /** + * The ID of the advertiser to list campaigns for. + */ + advertiserId?: string; + /** + * Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the campaign. Assigned by the system. + */ + campaignId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + + export class Resource$Advertisers$Channels { + context: APIRequestContext; + sites: Resource$Advertisers$Channels$Sites; + constructor(context: APIRequestContext) { + this.context = context; + this.sites = new Resource$Advertisers$Channels$Sites(this.context); + } + + /** + * Creates a new channel. Returns the newly created channel if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Channels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Channels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Channels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Channels$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Channels$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a channel for a partner or advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Channels$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Channels$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Channels$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Channels$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/channels/{+channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists channels for a partner or advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Channels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Channels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Channels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a channel. Returns the updated channel if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Channels$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Channels$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Channels$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Channels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Channels$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/channels/{channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Channels$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + export interface Params$Resource$Advertisers$Channels$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the fetched channel. + */ + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + + export class Resource$Advertisers$Channels$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a site in a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Channels$Sites$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Channels$Sites$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a site from a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Channels$Sites$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Channels$Sites$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId', 'urlOrAppId'], + pathParams: ['advertiserId', 'channelId', 'urlOrAppId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists sites in a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Channels$Sites$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Channels$Sites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid 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. + */ + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + options: StreamMethodOptions + ): GaxiosPromise; + replace( + params?: Params$Resource$Advertisers$Channels$Sites$Replace, + options?: MethodOptions + ): GaxiosPromise; + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + callback: BodyResponseCallback + ): void; + replace(callback: BodyResponseCallback): void; + replace( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Replace + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Replace; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Replace; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Channels$Sites$Bulkedit + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the sites belong. + */ + channelId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditSitesRequest; + } + export interface Params$Resource$Advertisers$Channels$Sites$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel in which the site will be created. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Advertisers$Channels$Sites$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the site belongs. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + /** + * Required. The URL or app ID of the site to delete. + */ + urlOrAppId?: string; + } + export interface Params$Resource$Advertisers$Channels$Sites$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the requested sites belong. + */ + channelId?: string; + /** + * Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$Sites$Replace + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel whose sites will be replaced. + */ + channelId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceSitesRequest; + } + + export class Resource$Advertisers$Creatives { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required 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. + */ + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Creatives$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Creatives$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required 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. + */ + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Creatives$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a creative. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Creatives$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Creatives$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Creatives$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Creatives$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Creatives$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in 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$Advertisers$Creatives$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Creatives$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Creatives$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Creatives$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Creatives$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required 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. + */ + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Creatives$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Creatives$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Advertisers$Creatives$Delete + extends StandardParameters { + /** + * The ID of the advertiser this creative belongs to. + */ + advertiserId?: string; + /** + * The ID of the creative to be deleted. + */ + creativeId?: string; + } + export interface Params$Resource$Advertisers$Creatives$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this creative belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the creative to fetch. + */ + creativeId?: string; + } + export interface Params$Resource$Advertisers$Creatives$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list creatives for. + */ + advertiserId?: string; + /** + * Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width\}x{height\}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange\}-{reviewStatus\}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Creatives$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the creative. Assigned by the system. + */ + creativeId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + + export class Resource$Advertisers$Insertionorders { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new insertion order. Returns the newly created insertion order if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Insertionorders$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Insertionorders$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/insertionOrders' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Insertionorders$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Insertionorders$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order 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$Advertisers$Insertionorders$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Insertionorders$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in 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$Advertisers$Insertionorders$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Insertionorders$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Insertionorders$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Insertionorders$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Insertionorders$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/insertionOrders' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing insertion order. Returns the updated insertion order if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Insertionorders$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Insertionorders$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Insertionorders$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + export interface Params$Resource$Advertisers$Insertionorders$Delete + extends StandardParameters { + /** + * The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * The ID of the insertion order to delete. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the insertion order to fetch. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list insertion orders for. + */ + advertiserId?: string; + /** + * Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the insertion order. Assigned by the system. + */ + insertionOrderId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + + export class Resource$Advertisers$Invoices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this 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$Advertisers$Invoices$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Invoices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Invoices$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Invoices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Invoices$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Invoices$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Invoices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Invoices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/advertisers/{+advertiserId}/invoices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the invoice currency used by an advertiser in a given month. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + options: StreamMethodOptions + ): GaxiosPromise; + lookupInvoiceCurrency( + params?: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + options?: MethodOptions + ): GaxiosPromise; + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( + paramsOrCallback?: + | Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Invoices$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list invoices for. + */ + advertiserId?: string; + /** + * The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM. + */ + issueMonth?: string; + /** + * Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. + */ + loiSapinInvoiceType?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency + extends StandardParameters { + /** + * Required. The ID of the advertiser to lookup currency for. + */ + advertiserId?: string; + /** + * Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM. + */ + invoiceMonth?: string; + } + + export class Resource$Advertisers$Lineitems { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Lineitems$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Lineitems$Targetingtypes( + this.context + ); + } + + /** + * Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEditAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists assigned targeting options for multiple line items across targeting types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + bulkListAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: StreamMethodOptions + ): GaxiosPromise; + bulkUpdate( + params?: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options?: MethodOptions + ): GaxiosPromise; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + callback: BodyResponseCallback + ): void; + bulkUpdate( + callback: BodyResponseCallback + ): void; + bulkUpdate( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulkupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulkupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Bulkupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/lineItems:bulkUpdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Lineitems$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Lineitems$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Lineitems$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Lineitems$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid 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. + */ + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: StreamMethodOptions + ): GaxiosPromise; + duplicate( + params?: Params$Resource$Advertisers$Lineitems$Duplicate, + options?: MethodOptions + ): GaxiosPromise; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + callback: BodyResponseCallback + ): void; + duplicate( + callback: BodyResponseCallback + ): void; + duplicate( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Duplicate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Duplicate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Duplicate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: StreamMethodOptions + ): GaxiosPromise; + generateDefault( + params?: Params$Resource$Advertisers$Lineitems$Generatedefault, + options?: MethodOptions + ): GaxiosPromise; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + callback: BodyResponseCallback + ): void; + generateDefault(callback: BodyResponseCallback): void; + generateDefault( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Generatedefault + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Generatedefault; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Generatedefault; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems:generateDefault' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a line item. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Lineitems$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Lineitems$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in 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$Advertisers$Lineitems$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Lineitems$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid 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. + */ + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Lineitems$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line items belong to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line items belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The IDs of the line items to list assigned targeting options for. + */ + lineItemIds?: string[]; + /** + * Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Bulkupdate + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkUpdateLineItemsRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + export interface Params$Resource$Advertisers$Lineitems$Delete + extends StandardParameters { + /** + * The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * The ID of the line item to delete. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Duplicate + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item to duplicate. + */ + lineItemId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DuplicateLineItemRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Generatedefault + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateDefaultLineItemRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item to fetch. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list line items for. + */ + advertiserId?: string; + /** + * Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the line item. Assigned by the system. + */ + lineItemId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + + export class Resource$Advertisers$Lineitems$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single targeting option assigned to a line item. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to a line item. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item the assigned targeting option will belong to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the line item to list assigned targeting options for. + */ + lineItemId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + */ + targetingType?: string; + } + + export class Resource$Advertisers$Locationlists { + context: APIRequestContext; + assignedLocations: Resource$Advertisers$Locationlists$Assignedlocations; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedLocations = + new Resource$Advertisers$Locationlists$Assignedlocations(this.context); + } + + /** + * Creates a new location list. Returns the newly created location list if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Locationlists$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Locationlists$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/locationLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a location list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Locationlists$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Locationlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/locationLists/{+locationListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists location lists based on a given advertiser 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. + */ + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Locationlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/locationLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a location list. Returns the updated location list if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Locationlists$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Locationlists$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/locationLists/{locationListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Locationlists$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LocationList; + } + export interface Params$Resource$Advertisers$Locationlists$Get + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list to fetch. + */ + locationListId?: string; + } + export interface Params$Resource$Advertisers$Locationlists$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched location lists belong. + */ + advertiserId?: string; + /** + * Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Locationlists$Patch + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location lists belongs. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the location list. Assigned by the system. + */ + locationListId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LocationList; + } + + export class Resource$Advertisers$Locationlists$Assignedlocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates an assignment between a location and a location list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Locationlists$Assignedlocations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the assignment between a location and a location list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Locationlists$Assignedlocations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'locationListId', + 'assignedLocationId', + ], + pathParams: ['advertiserId', 'assignedLocationId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists locations assigned to a location list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Locationlists$Assignedlocations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list to which these assignments are assigned. + */ + locationListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedLocationsRequest; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list for which the assignment will be created. + */ + locationListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedLocation; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned location to delete. + */ + assignedLocationId?: string; + /** + * Required. The ID of the location list to which this assignment is assigned. + */ + locationListId?: string; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the location list to which these assignments are assigned. + */ + locationListId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedLocationId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Negativekeywordlists { + context: APIRequestContext; + negativeKeywords: Resource$Advertisers$Negativekeywordlists$Negativekeywords; + constructor(context: APIRequestContext) { + this.context = context; + this.negativeKeywords = + new Resource$Advertisers$Negativekeywordlists$Negativekeywords( + this.context + ); + } + + /** + * Creates a new negative keyword list. Returns the newly created negative keyword list if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Negativekeywordlists$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Negativekeywordlists$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/negativeKeywordLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a negative keyword list given an advertiser ID and a negative keyword list 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. + */ + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a negative keyword list given an advertiser ID and a negative keyword list 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$Advertisers$Negativekeywordlists$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Negativekeywordlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists negative keyword lists based on a given advertiser 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. + */ + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Negativekeywordlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/negativeKeywordLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a negative keyword list. Returns the updated negative keyword list if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Negativekeywordlists$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Negativekeywordlists$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list will belong. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeywordList; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the negative keyword list to delete. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Get + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the negative keyword list to fetch. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. + */ + advertiserId?: string; + /** + * Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Patch + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the negative keyword list. Assigned by the system. + */ + negativeKeywordListId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeywordList; + } + + export class Resource$Advertisers$Negativekeywordlists$Negativekeywords { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a negative keyword in a negative keyword list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a negative keyword from a negative keyword list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'negativeKeywordListId', + 'keywordValue', + ], + pathParams: ['advertiserId', 'keywordValue', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists negative keywords in a negative keyword list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + replace( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + options: StreamMethodOptions + ): GaxiosPromise; + replace( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + options?: MethodOptions + ): GaxiosPromise; + replace( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + callback: BodyResponseCallback + ): void; + replace( + callback: BodyResponseCallback + ): void; + replace( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the parent negative keyword list to which the negative keywords belong. + */ + negativeKeywordListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditNegativeKeywordsRequest; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the parent negative keyword list in which the negative keyword will be created. + */ + negativeKeywordListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeyword; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The keyword value of the negative keyword to delete. + */ + keywordValue?: string; + /** + * Required. The ID of the parent negative keyword list to which the negative keyword belongs. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the parent negative keyword list to which the requested negative keywords belong. + */ + negativeKeywordListId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the parent negative keyword list to which the negative keywords belong. + */ + negativeKeywordListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceNegativeKeywordsRequest; + } + + export class Resource$Advertisers$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'targetingType'], + pathParams: ['advertiserId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an assigned targeting option from an advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single targeting option assigned to an advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to an advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'targetingType'], + pathParams: ['advertiserId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` + */ + targetingType?: string; + } + + export class Resource$Combinedaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a combined audience. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Combinedaudiences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Combinedaudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Combinedaudiences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Combinedaudiences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Combinedaudiences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Combinedaudiences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Combinedaudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Combinedaudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/combinedAudiences/{+combinedAudienceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['combinedAudienceId'], + pathParams: ['combinedAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists combined audiences. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Combinedaudiences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Combinedaudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Combinedaudiences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Combinedaudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Combinedaudiences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Combinedaudiences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Combinedaudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Combinedaudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/combinedAudiences').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$Combinedaudiences$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched combined audience. + */ + advertiserId?: string; + /** + * Required. The ID of the combined audience to fetch. + */ + combinedAudienceId?: string; + /** + * The ID of the partner that has access to the fetched combined audience. + */ + partnerId?: string; + } + export interface Params$Resource$Combinedaudiences$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched combined audiences. + */ + advertiserId?: string; + /** + * Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched combined audiences. + */ + partnerId?: string; + } + + export class Resource$Custombiddingalgorithms { + context: APIRequestContext; + rules: Resource$Custombiddingalgorithms$Rules; + scripts: Resource$Custombiddingalgorithms$Scripts; + constructor(context: APIRequestContext) { + this.context = context; + this.rules = new Resource$Custombiddingalgorithms$Rules(this.context); + this.scripts = new Resource$Custombiddingalgorithms$Scripts(this.context); + } + + /** + * Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Custombiddingalgorithms$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Custombiddingalgorithms$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/customBiddingAlgorithms').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a custom bidding algorithm. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Custombiddingalgorithms$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Custombiddingalgorithms$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Custombiddingalgorithms$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Custombiddingalgorithms$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/customBiddingAlgorithms').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Custombiddingalgorithms$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Custombiddingalgorithms$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Custombiddingalgorithms$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Custombiddingalgorithms$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules 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. + */ + uploadRules( + params: Params$Resource$Custombiddingalgorithms$Uploadrules, + options: StreamMethodOptions + ): GaxiosPromise; + uploadRules( + params?: Params$Resource$Custombiddingalgorithms$Uploadrules, + options?: MethodOptions + ): GaxiosPromise; + uploadRules( + params: Params$Resource$Custombiddingalgorithms$Uploadrules, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadRules( + params: Params$Resource$Custombiddingalgorithms$Uploadrules, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadRules( + params: Params$Resource$Custombiddingalgorithms$Uploadrules, + callback: BodyResponseCallback + ): void; + uploadRules( + callback: BodyResponseCallback + ): void; + uploadRules( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Uploadrules + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Uploadrules; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Uploadrules; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + uploadScript( + params: Params$Resource$Custombiddingalgorithms$Uploadscript, + options: StreamMethodOptions + ): GaxiosPromise; + uploadScript( + params?: Params$Resource$Custombiddingalgorithms$Uploadscript, + options?: MethodOptions + ): GaxiosPromise; + uploadScript( + params: Params$Resource$Custombiddingalgorithms$Uploadscript, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadScript( + params: Params$Resource$Custombiddingalgorithms$Uploadscript, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadScript( + params: Params$Resource$Custombiddingalgorithms$Uploadscript, + callback: BodyResponseCallback + ): void; + uploadScript( + callback: BodyResponseCallback + ): void; + uploadScript( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Uploadscript + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Uploadscript; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Uploadscript; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Custombiddingalgorithms$Create + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$CustomBiddingAlgorithm; + } + export interface Params$Resource$Custombiddingalgorithms$Get + extends StandardParameters { + /** + * The ID of the DV360 partner that has access to the custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm to fetch. + */ + customBiddingAlgorithmId?: string; + /** + * The ID of the DV360 partner that has access to the custom bidding algorithm. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$List + extends StandardParameters { + /** + * The ID of the DV360 advertiser that has access to the custom bidding algorithm. + */ + advertiserId?: string; + /** + * Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the DV360 partner that has access to the custom bidding algorithm. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the custom bidding algorithm. Assigned by the system. + */ + customBiddingAlgorithmId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomBiddingAlgorithm; + } + export interface Params$Resource$Custombiddingalgorithms$Uploadrules + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the rules resource. + */ + customBiddingAlgorithmId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$Uploadscript + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm owns the script. + */ + customBiddingAlgorithmId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. + */ + partnerId?: string; + } + + export class Resource$Custombiddingalgorithms$Rules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$Rules$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Custombiddingalgorithms$Rules$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Custombiddingalgorithms$Rules$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Rules$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Rules$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Rules$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Rules$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Rules$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a rules 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$Custombiddingalgorithms$Rules$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Custombiddingalgorithms$Rules$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Custombiddingalgorithms$Rules$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Rules$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Rules$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Rules$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Rules$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Rules$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'customBiddingAlgorithmId', + 'customBiddingAlgorithmRulesId', + ], + pathParams: [ + 'customBiddingAlgorithmId', + 'customBiddingAlgorithmRulesId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$Rules$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Custombiddingalgorithms$Rules$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Custombiddingalgorithms$Rules$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$Rules$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$Rules$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Rules$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Rules$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Rules$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Custombiddingalgorithms$Rules$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the rules resource. + */ + customBiddingAlgorithmId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomBiddingAlgorithmRules; + } + export interface Params$Resource$Custombiddingalgorithms$Rules$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the rules resource. + */ + customBiddingAlgorithmId?: string; + /** + * Required. The ID of the rules resource to fetch. + */ + customBiddingAlgorithmRulesId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$Rules$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the rules resource. + */ + customBiddingAlgorithmId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. + */ + partnerId?: string; + } + + export class Resource$Custombiddingalgorithms$Scripts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$Scripts$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Custombiddingalgorithms$Scripts$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Custombiddingalgorithms$Scripts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Scripts$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Scripts$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Scripts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Scripts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Scripts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a custom bidding script. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$Scripts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Custombiddingalgorithms$Scripts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Custombiddingalgorithms$Scripts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Scripts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Scripts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Scripts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Scripts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Scripts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId', 'customBiddingScriptId'], + pathParams: ['customBiddingAlgorithmId', 'customBiddingScriptId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Custombiddingalgorithms$Scripts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Custombiddingalgorithms$Scripts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Custombiddingalgorithms$Scripts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$Scripts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$Scripts$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Scripts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Scripts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Scripts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Custombiddingalgorithms$Scripts$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the script. + */ + customBiddingAlgorithmId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomBiddingScript; + } + export interface Params$Resource$Custombiddingalgorithms$Scripts$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm owns the script. + */ + customBiddingAlgorithmId?: string; + /** + * Required. The ID of the custom bidding script to fetch. + */ + customBiddingScriptId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$Scripts$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm owns the script. + */ + customBiddingAlgorithmId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. + */ + partnerId?: string; + } + + export class Resource$Customlists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a custom list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Customlists$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Customlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customlists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customlists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/customLists/{+customListId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['customListId'], + pathParams: ['customListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists custom lists. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Customlists$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Customlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customlists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customlists$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Customlists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/customLists').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$Customlists$Get extends StandardParameters { + /** + * The ID of the DV360 advertiser that has access to the fetched custom lists. + */ + advertiserId?: string; + /** + * Required. The ID of the custom list to fetch. + */ + customListId?: string; + } + export interface Params$Resource$Customlists$List extends StandardParameters { + /** + * The ID of the DV360 advertiser that has access to the fetched custom lists. + */ + advertiserId?: string; + /** + * Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Firstpartyandpartneraudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_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. + */ + create( + params: Params$Resource$Firstpartyandpartneraudiences$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Firstpartyandpartneraudiences$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Firstpartyandpartneraudiences$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Firstpartyandpartneraudiences$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Firstpartyandpartneraudiences$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Firstpartyandpartneraudiences$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstpartyandpartneraudiences$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstpartyandpartneraudiences$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/firstPartyAndPartnerAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_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. + */ + editCustomerMatchMembers( + params: Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers, + options: StreamMethodOptions + ): GaxiosPromise; + editCustomerMatchMembers( + params?: Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers, + options?: MethodOptions + ): GaxiosPromise; + editCustomerMatchMembers( + params: Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editCustomerMatchMembers( + params: Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editCustomerMatchMembers( + params: Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers, + callback: BodyResponseCallback + ): void; + editCustomerMatchMembers( + callback: BodyResponseCallback + ): void; + editCustomerMatchMembers( + paramsOrCallback?: + | Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}:editCustomerMatchMembers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firstPartyAndPartnerAudienceId'], + pathParams: ['firstPartyAndPartnerAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a first party or partner audience. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Firstpartyandpartneraudiences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Firstpartyandpartneraudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Firstpartyandpartneraudiences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Firstpartyandpartneraudiences$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Firstpartyandpartneraudiences$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Firstpartyandpartneraudiences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstpartyandpartneraudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstpartyandpartneraudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firstPartyAndPartnerAudienceId'], + pathParams: ['firstPartyAndPartnerAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists first party and partner audiences. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Firstpartyandpartneraudiences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Firstpartyandpartneraudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Firstpartyandpartneraudiences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Firstpartyandpartneraudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Firstpartyandpartneraudiences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Firstpartyandpartneraudiences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstpartyandpartneraudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstpartyandpartneraudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/firstPartyAndPartnerAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_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. + */ + patch( + params: Params$Resource$Firstpartyandpartneraudiences$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Firstpartyandpartneraudiences$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Firstpartyandpartneraudiences$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Firstpartyandpartneraudiences$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Firstpartyandpartneraudiences$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Firstpartyandpartneraudiences$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstpartyandpartneraudiences$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstpartyandpartneraudiences$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firstPartyAndPartnerAudienceId'], + pathParams: ['firstPartyAndPartnerAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Firstpartyandpartneraudiences$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirstPartyAndPartnerAudience; + } + export interface Params$Resource$Firstpartyandpartneraudiences$Editcustomermatchmembers + extends StandardParameters { + /** + * Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited. + */ + firstPartyAndPartnerAudienceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EditCustomerMatchMembersRequest; + } + export interface Params$Resource$Firstpartyandpartneraudiences$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched first party and partner audience. + */ + advertiserId?: string; + /** + * Required. The ID of the first party and partner audience to fetch. + */ + firstPartyAndPartnerAudienceId?: string; + /** + * The ID of the partner that has access to the fetched first party and partner audience. + */ + partnerId?: string; + } + export interface Params$Resource$Firstpartyandpartneraudiences$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched first party and partner audiences. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first party and partner audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched first party and partner audiences. + */ + partnerId?: string; + } + export interface Params$Resource$Firstpartyandpartneraudiences$Patch + extends StandardParameters { + /** + * Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience. + */ + advertiserId?: string; + /** + * Identifier. The unique ID of the first party and partner audience. Assigned by the system. + */ + firstPartyAndPartnerAudienceId?: string; + /** + * Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirstPartyAndPartnerAudience; + } + + export class Resource$Floodlightgroups { + context: APIRequestContext; + floodlightActivities: Resource$Floodlightgroups$Floodlightactivities; + constructor(context: APIRequestContext) { + this.context = context; + this.floodlightActivities = + new Resource$Floodlightgroups$Floodlightactivities(this.context); + } + + /** + * Gets a Floodlight 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$Floodlightgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Floodlightgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Floodlightgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/floodlightGroups/{+floodlightGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing Floodlight group. Returns the updated Floodlight group if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Floodlightgroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Floodlightgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Floodlightgroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightgroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/floodlightGroups/{floodlightGroupId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightgroups$Get + extends StandardParameters { + /** + * Required. The ID of the Floodlight group to fetch. + */ + floodlightGroupId?: string; + /** + * Required. The partner context by which the Floodlight group is being accessed. + */ + partnerId?: string; + } + export interface Params$Resource$Floodlightgroups$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the Floodlight group. Assigned by the system. + */ + floodlightGroupId?: string; + /** + * Required. The partner context by which the Floodlight group is being accessed. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightGroup; + } + + export class Resource$Floodlightgroups$Floodlightactivities { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Floodlight activity. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Floodlightgroups$Floodlightactivities$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Floodlightgroups$Floodlightactivities$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Floodlightgroups$Floodlightactivities$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightgroups$Floodlightactivities$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightgroups$Floodlightactivities$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightgroups$Floodlightactivities$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightgroups$Floodlightactivities$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Floodlightgroups$Floodlightactivities$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['floodlightGroupId', 'floodlightActivityId'], + pathParams: ['floodlightActivityId', 'floodlightGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Floodlight activities in a Floodlight 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. + */ + list( + params: Params$Resource$Floodlightgroups$Floodlightactivities$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Floodlightgroups$Floodlightactivities$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Floodlightgroups$Floodlightactivities$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightgroups$Floodlightactivities$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightgroups$Floodlightactivities$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Floodlightgroups$Floodlightactivities$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightgroups$Floodlightactivities$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Floodlightgroups$Floodlightactivities$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Floodlightgroups$Floodlightactivities$Get + extends StandardParameters { + /** + * Required. The ID of the Floodlight activity to fetch. + */ + floodlightActivityId?: string; + /** + * Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs. + */ + floodlightGroupId?: string; + /** + * Required. The ID of the partner through which the Floodlight activity is being accessed. + */ + partnerId?: string; + } + export interface Params$Resource$Floodlightgroups$Floodlightactivities$List + extends StandardParameters { + /** + * Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong. + */ + floodlightGroupId?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFloodlightActivities` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. The ID of the partner through which the Floodlight activities are being accessed. + */ + partnerId?: string; + } + + export class Resource$Googleaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Google audience. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Googleaudiences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Googleaudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Googleaudiences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Googleaudiences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Googleaudiences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Googleaudiences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Googleaudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Googleaudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/googleAudiences/{+googleAudienceId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['googleAudienceId'], + pathParams: ['googleAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Google audiences. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Googleaudiences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Googleaudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Googleaudiences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Googleaudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Googleaudiences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Googleaudiences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Googleaudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Googleaudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/googleAudiences').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$Googleaudiences$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched Google audience. + */ + advertiserId?: string; + /** + * Required. The ID of the Google audience to fetch. + */ + googleAudienceId?: string; + /** + * The ID of the partner that has access to the fetched Google audience. + */ + partnerId?: string; + } + export interface Params$Resource$Googleaudiences$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched Google audiences. + */ + advertiserId?: string; + /** + * Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched Google audiences. + */ + partnerId?: string; + } + + export class Resource$Guaranteedorders { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new guaranteed order. Returns the newly created guaranteed order if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Guaranteedorders$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Guaranteedorders$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Guaranteedorders$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Guaranteedorders$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Guaranteedorders$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Guaranteedorders$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/guaranteedOrders').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Edits read advertisers of a guaranteed order. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + editGuaranteedOrderReadAccessors( + params: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + options: StreamMethodOptions + ): GaxiosPromise; + editGuaranteedOrderReadAccessors( + params?: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + options?: MethodOptions + ): GaxiosPromise; + editGuaranteedOrderReadAccessors( + params: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editGuaranteedOrderReadAccessors( + params: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editGuaranteedOrderReadAccessors( + params: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + callback: BodyResponseCallback + ): void; + editGuaranteedOrderReadAccessors( + callback: BodyResponseCallback + ): void; + editGuaranteedOrderReadAccessors( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['guaranteedOrderId'], + pathParams: ['guaranteedOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a guaranteed order. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Guaranteedorders$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Guaranteedorders$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Guaranteedorders$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Guaranteedorders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Guaranteedorders$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Guaranteedorders$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/guaranteedOrders/{+guaranteedOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['guaranteedOrderId'], + pathParams: ['guaranteedOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in 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$Guaranteedorders$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Guaranteedorders$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Guaranteedorders$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Guaranteedorders$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Guaranteedorders$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Guaranteedorders$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/guaranteedOrders').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing guaranteed order. Returns the updated guaranteed order if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Guaranteedorders$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Guaranteedorders$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Guaranteedorders$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Guaranteedorders$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Guaranteedorders$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Guaranteedorders$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/guaranteedOrders/{+guaranteedOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['guaranteedOrderId'], + pathParams: ['guaranteedOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Guaranteedorders$Create + extends StandardParameters { + /** + * The ID of the advertiser that the request is being made within. + */ + advertiserId?: string; + /** + * The ID of the partner that the request is being made within. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GuaranteedOrder; + } + export interface Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors + extends StandardParameters { + /** + * Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange\}-{legacy_guaranteed_order_id\}` + */ + guaranteedOrderId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EditGuaranteedOrderReadAccessorsRequest; + } + export interface Params$Resource$Guaranteedorders$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the guaranteed order. + */ + advertiserId?: string; + /** + * Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange\}-{legacy_guaranteed_order_id\}` + */ + guaranteedOrderId?: string; + /** + * The ID of the partner that has access to the guaranteed order. + */ + partnerId?: string; + } + export interface Params$Resource$Guaranteedorders$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the guaranteed order. + */ + advertiserId?: string; + /** + * Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGuaranteedOrders` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the guaranteed order. + */ + partnerId?: string; + } + export interface Params$Resource$Guaranteedorders$Patch + extends StandardParameters { + /** + * The ID of the advertiser that the request is being made within. + */ + advertiserId?: string; + /** + * Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange\}-{legacy_guaranteed_order_id\}`. + */ + guaranteedOrderId?: string; + /** + * The ID of the partner that the request is being made within. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GuaranteedOrder; + } + + export class Resource$Inventorysourcegroups { + context: APIRequestContext; + assignedInventorySources: Resource$Inventorysourcegroups$Assignedinventorysources; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedInventorySources = + new Resource$Inventorysourcegroups$Assignedinventorysources( + this.context + ); + } + + /** + * Creates a new inventory source group. Returns the newly created inventory source group if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Inventorysourcegroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Inventorysourcegroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Inventorysourcegroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/inventorySourceGroups').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 an inventory source 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. + */ + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Inventorysourcegroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/inventorySourceGroups/{+inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an inventory source 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$Inventorysourcegroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Inventorysourcegroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Inventorysourcegroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysourcegroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysourcegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/inventorySourceGroups/{+inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Inventorysourcegroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Inventorysourcegroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysourcegroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/inventorySourceGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an inventory source group. Returns the updated inventory source group if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Inventorysourcegroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Inventorysourcegroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Inventorysourcegroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Inventorysourcegroups$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Inventorysourcegroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/inventorySourceGroups/{inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Inventorysourcegroups$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group. + */ + advertiserId?: string; + /** + * The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySourceGroup; + } + export interface Params$Resource$Inventorysourcegroups$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to delete. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to this group. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to fetch. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + */ + advertiserId?: string; + /** + * Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the inventory source group. Assigned by the system. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to this group. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySourceGroup; + } + + export class Resource$Inventorysourcegroups$Assignedinventorysources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates an assignment between an inventory source and an inventory source 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. + */ + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the assignment between an inventory source and an inventory source 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. + */ + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId', 'assignedInventorySourceId'], + pathParams: ['assignedInventorySourceId', 'inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists inventory sources assigned to an inventory source 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. + */ + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the inventory source group to which the assignments are assigned. + */ + inventorySourceGroupId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedInventorySourcesRequest; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to which the assignment will be assigned. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedInventorySource; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned inventory source to delete. + */ + assignedInventorySourceId?: string; + /** + * Required. The ID of the inventory source group to which this assignment is assigned. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source. + */ + advertiserId?: string; + /** + * Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the inventory source group to which these assignments are assigned. + */ + inventorySourceGroupId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner. + */ + partnerId?: string; + } + + export class Resource$Inventorysources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new inventory source. Returns the newly created inventory source if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Inventorysources$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Inventorysources$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Inventorysources$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysources$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysources$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Inventorysources$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/inventorySources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory 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. + */ + editInventorySourceReadWriteAccessors( + params: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + options: StreamMethodOptions + ): GaxiosPromise; + editInventorySourceReadWriteAccessors( + params?: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + options?: MethodOptions + ): GaxiosPromise; + editInventorySourceReadWriteAccessors( + params: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editInventorySourceReadWriteAccessors( + params: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editInventorySourceReadWriteAccessors( + params: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + callback: BodyResponseCallback + ): void; + editInventorySourceReadWriteAccessors( + callback: BodyResponseCallback + ): void; + editInventorySourceReadWriteAccessors( + paramsOrCallback?: + | Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceId'], + pathParams: ['inventorySourceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an inventory 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. + */ + get( + params: Params$Resource$Inventorysources$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Inventorysources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Inventorysources$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysources$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Inventorysources$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/inventorySources/{+inventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceId'], + pathParams: ['inventorySourceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Inventorysources$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Inventorysources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysources$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysources$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventorysources$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/inventorySources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing inventory source. Returns the updated inventory source if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Inventorysources$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Inventorysources$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Inventorysources$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Inventorysources$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Inventorysources$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Inventorysources$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/inventorySources/{+inventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['inventorySourceId'], + pathParams: ['inventorySourceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Inventorysources$Create + extends StandardParameters { + /** + * The ID of the advertiser that the request is being made within. + */ + advertiserId?: string; + /** + * The ID of the partner that the request is being made within. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySource; + } + export interface Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors + extends StandardParameters { + /** + * Required. The ID of inventory source to update. + */ + inventorySourceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EditInventorySourceReadWriteAccessorsRequest; + } + export interface Params$Resource$Inventorysources$Get + extends StandardParameters { + /** + * Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source to fetch. + */ + inventorySourceId?: string; + /** + * Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysources$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the inventory source. + */ + advertiserId?: string; + /** + * Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the inventory source. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysources$Patch + extends StandardParameters { + /** + * The ID of the advertiser that the request is being made within. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the inventory source. Assigned by the system. + */ + inventorySourceId?: string; + /** + * The ID of the partner that the request is being made within. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySource; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Downloads media. Download is supported on the URI `/download/{resource_name=**\}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/download/{+resourceName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resourceName'], + pathParams: ['resourceName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**\}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Media$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + callback: BodyResponseCallback + ): void; + upload(callback: BodyResponseCallback): void; + upload( + paramsOrCallback?: + | Params$Resource$Media$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/media/{+resourceName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: (rootUrl + '/upload/media/{+resourceName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + requiredParams: ['resourceName'], + pathParams: ['resourceName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Media$Download extends StandardParameters { + /** + * Name of the media that is being downloaded. See ReadRequest.resource_name. + */ + resourceName?: string; + } + export interface Params$Resource$Media$Upload extends StandardParameters { + /** + * Name of the media that is being downloaded. See ReadRequest.resource_name. + */ + resourceName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleBytestreamMedia; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Partners { + context: APIRequestContext; + channels: Resource$Partners$Channels; + targetingTypes: Resource$Partners$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.channels = new Resource$Partners$Channels(this.context); + this.targetingTypes = new Resource$Partners$Targetingtypes(this.context); + } + + /** + * Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests . + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + editAssignedTargetingOptions( + params: Params$Resource$Partners$Editassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + editAssignedTargetingOptions( + params?: Params$Resource$Partners$Editassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + editAssignedTargetingOptions( + params: Params$Resource$Partners$Editassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + params: Params$Resource$Partners$Editassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + params: Params$Resource$Partners$Editassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Partners$Editassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Editassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Editassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/partners/{+partnerId}:editAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId'], + pathParams: ['partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a partner. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Partners$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Partners$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Partners$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Partners$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/partners/{+partnerId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId'], + pathParams: ['partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists partners that are accessible to the current user. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Partners$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Partners$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Partners$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/partners').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$Partners$Editassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the partner. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditPartnerAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Partners$Get extends StandardParameters { + /** + * Required. The ID of the partner to fetch. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$List extends StandardParameters { + /** + * Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Partners$Channels { + context: APIRequestContext; + sites: Resource$Partners$Channels$Sites; + constructor(context: APIRequestContext) { + this.context = context; + this.sites = new Resource$Partners$Channels$Sites(this.context); + } + + /** + * Creates a new channel. Returns the newly created channel if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Channels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Partners$Channels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Partners$Channels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Channels$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Channels$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/partners/{+partnerId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId'], + pathParams: ['partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a channel for a partner or advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Channels$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Partners$Channels$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Partners$Channels$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Channels$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/partners/{+partnerId}/channels/{+channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists channels for a partner or advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Channels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Partners$Channels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$Channels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Channels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Channels$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Partners$Channels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/partners/{+partnerId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId'], + pathParams: ['partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a channel. Returns the updated channel if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Channels$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Partners$Channels$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Partners$Channels$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Partners$Channels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Partners$Channels$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/partners/{+partnerId}/channels/{channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Partners$Channels$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + export interface Params$Resource$Partners$Channels$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the fetched channel. + */ + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + + export class Resource$Partners$Channels$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Partners$Channels$Sites$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a site in a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Channels$Sites$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Partners$Channels$Sites$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Partners$Channels$Sites$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Channels$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Channels$Sites$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/partners/{partnerId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a site from a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Channels$Sites$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Partners$Channels$Sites$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId', 'urlOrAppId'], + pathParams: ['channelId', 'partnerId', 'urlOrAppId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists sites in a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Channels$Sites$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Partners$Channels$Sites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$Channels$Sites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Channels$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Channels$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/partners/{+partnerId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid 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. + */ + replace( + params: Params$Resource$Partners$Channels$Sites$Replace, + options: StreamMethodOptions + ): GaxiosPromise; + replace( + params?: Params$Resource$Partners$Channels$Sites$Replace, + options?: MethodOptions + ): GaxiosPromise; + replace( + params: Params$Resource$Partners$Channels$Sites$Replace, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Partners$Channels$Sites$Replace, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Partners$Channels$Sites$Replace, + callback: BodyResponseCallback + ): void; + replace(callback: BodyResponseCallback): void; + replace( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$Replace + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Replace; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$Replace; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/partners/{partnerId}/channels/{+channelId}/sites:replace' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Partners$Channels$Sites$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the parent channel to which the sites belong. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditSitesRequest; + } + export interface Params$Resource$Partners$Channels$Sites$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel in which the site will be created. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Partners$Channels$Sites$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the site belongs. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + /** + * Required. The URL or app ID of the site to delete. + */ + urlOrAppId?: string; + } + export interface Params$Resource$Partners$Channels$Sites$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the requested sites belong. + */ + channelId?: string; + /** + * Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$Sites$Replace + extends StandardParameters { + /** + * Required. The ID of the parent channel whose sites will be replaced. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceSitesRequest; + } + + export class Resource$Partners$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Partners$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Partners$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Partners$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Assigns a targeting option to a partner. Returns the assigned targeting option if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'targetingType'], + pathParams: ['partnerId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an assigned targeting option from a partner. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'partnerId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: ['assignedTargetingOptionId', 'partnerId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single targeting option assigned to a partner. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'partnerId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: ['assignedTargetingOptionId', 'partnerId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to a partner. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Partners$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['partnerId', 'targetingType'], + pathParams: ['partnerId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the partner. + */ + partnerId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the partner. + */ + partnerId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + targetingType?: string; + } + export interface Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the partner. + */ + partnerId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + targetingType?: string; + } + export interface Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. The ID of the partner. + */ + partnerId?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + targetingType?: string; + } + + export class Resource$Sdfdownloadtasks { + context: APIRequestContext; + operations: Resource$Sdfdownloadtasks$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Sdfdownloadtasks$Operations(this.context); + } + + /** + * Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Sdfdownloadtasks$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Sdfdownloadtasks$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Sdfdownloadtasks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Sdfdownloadtasks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Sdfdownloadtasks$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Sdfdownloadtasks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sdfdownloadtasks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sdfdownloadtasks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/sdfdownloadtasks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sdfdownloadtasks$Create + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$CreateSdfDownloadTaskRequest; + } + + export class Resource$Sdfdownloadtasks$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Sdfdownloadtasks$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Sdfdownloadtasks$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sdfdownloadtasks$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sdfdownloadtasks$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sdfdownloadtasks$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sdfdownloadtasks$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sdfdownloadtasks$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sdfdownloadtasks$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/{+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$Sdfdownloadtasks$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Sdfuploadtasks { + context: APIRequestContext; + operations: Resource$Sdfuploadtasks$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Sdfuploadtasks$Operations(this.context); + } + } + + export class Resource$Sdfuploadtasks$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Sdfuploadtasks$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Sdfuploadtasks$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sdfuploadtasks$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sdfuploadtasks$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sdfuploadtasks$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sdfuploadtasks$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sdfuploadtasks$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sdfuploadtasks$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/{+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$Sdfuploadtasks$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Targetingtypes { + context: APIRequestContext; + targetingOptions: Resource$Targetingtypes$Targetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingOptions = new Resource$Targetingtypes$Targetingoptions( + this.context + ); + } + } + + export class Resource$Targetingtypes$Targetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a single targeting option. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Targetingtypes$Targetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Targetingtypes$Targetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetingtypes$Targetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtypes$Targetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtypes$Targetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['targetingType', 'targetingOptionId'], + pathParams: ['targetingOptionId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists targeting options of a given 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. + */ + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Targetingtypes$Targetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Targetingtypes$Targetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtypes$Targetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtypes$Targetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/targetingTypes/{+targetingType}/targetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['targetingType'], + pathParams: ['targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Searches for targeting options of a given type based on the given search 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. + */ + search( + params: Params$Resource$Targetingtypes$Targetingoptions$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Targetingtypes$Targetingoptions$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Targetingtypes$Targetingoptions$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Targetingtypes$Targetingoptions$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Targetingtypes$Targetingoptions$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Targetingtypes$Targetingoptions$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtypes$Targetingoptions$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtypes$Targetingoptions$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/targetingTypes/{+targetingType}/targetingOptions:search' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['targetingType'], + pathParams: ['targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Targetingtypes$Targetingoptions$Get + extends StandardParameters { + /** + * Required. The Advertiser this request is being made in the context of. + */ + advertiserId?: string; + /** + * Required. The ID of the of targeting option to retrieve. + */ + targetingOptionId?: string; + /** + * Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` + */ + targetingType?: string; + } + export interface Params$Resource$Targetingtypes$Targetingoptions$List + extends StandardParameters { + /** + * Required. The Advertiser this request is being made in the context of. + */ + advertiserId?: string; + /** + * Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` + */ + targetingType?: string; + } + export interface Params$Resource$Targetingtypes$Targetingoptions$Search + extends StandardParameters { + /** + * Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchTargetingOptionsRequest; + } + + export class Resource$Users { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this 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. + */ + bulkEditAssignedUserRoles( + params: Params$Resource$Users$Bulkeditassigneduserroles, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEditAssignedUserRoles( + params?: Params$Resource$Users$Bulkeditassigneduserroles, + options?: MethodOptions + ): GaxiosPromise; + bulkEditAssignedUserRoles( + params: Params$Resource$Users$Bulkeditassigneduserroles, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEditAssignedUserRoles( + params: Params$Resource$Users$Bulkeditassigneduserroles, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEditAssignedUserRoles( + params: Params$Resource$Users$Bulkeditassigneduserroles, + callback: BodyResponseCallback + ): void; + bulkEditAssignedUserRoles( + callback: BodyResponseCallback + ): void; + bulkEditAssignedUserRoles( + paramsOrCallback?: + | Params$Resource$Users$Bulkeditassigneduserroles + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Bulkeditassigneduserroles; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Bulkeditassigneduserroles; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/users/{+userId}:bulkEditAssignedUserRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['userId'], + pathParams: ['userId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this 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. + */ + create( + params: Params$Resource$Users$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Users$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Users$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Users$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Users$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Users$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/users').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Downloads media. Download is supported on the URI `/download/{resource_name=**\}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string. + * Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this 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. */ - download( - params: Params$Resource$Media$Download, + delete( + params: Params$Resource$Users$Delete, options: StreamMethodOptions ): GaxiosPromise; - download( - params?: Params$Resource$Media$Download, + delete( + params?: Params$Resource$Users$Delete, options?: MethodOptions - ): GaxiosPromise; - download( - params: Params$Resource$Media$Download, + ): GaxiosPromise; + delete( + params: Params$Resource$Users$Delete, 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 + delete( + params: Params$Resource$Users$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - download( - callback: BodyResponseCallback + delete( + params: Params$Resource$Users$Delete, + callback: BodyResponseCallback ): void; - download( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Media$Download - | BodyResponseCallback + | Params$Resource$Users$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Media$Download; + params = {} as Params$Resource$Users$Delete; options = {}; } @@ -254,85 +23300,81 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: (rootUrl + '/download/{+resourceName}').replace( + url: (rootUrl + '/v4/users/{+userId}').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'DELETE', + apiVersion: '', }, options ), params, - requiredParams: ['resourceName'], - pathParams: ['resourceName'], + requiredParams: ['userId'], + pathParams: ['userId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**\}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string. + * Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this 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. */ - upload( - params: Params$Resource$Media$Upload, + get( + params: Params$Resource$Users$Get, options: StreamMethodOptions ): GaxiosPromise; - upload( - params?: Params$Resource$Media$Upload, + get( + params?: Params$Resource$Users$Get, options?: MethodOptions - ): GaxiosPromise; - upload( - params: Params$Resource$Media$Upload, + ): GaxiosPromise; + get( + params: Params$Resource$Users$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Media$Upload, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Users$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Media$Upload, - callback: BodyResponseCallback + get( + params: Params$Resource$Users$Get, + callback: BodyResponseCallback ): void; - upload(callback: BodyResponseCallback): void; - upload( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Media$Upload - | BodyResponseCallback + | Params$Resource$Users$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Media$Upload; + params = {} as Params$Resource$Users$Get; options = {}; } @@ -345,134 +23387,168 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: (rootUrl + '/media/{+resourceName}').replace( + url: (rootUrl + '/v4/users/{+userId}').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', + apiVersion: '', }, options ), params, - mediaUrl: (rootUrl + '/upload/media/{+resourceName}').replace( - /([^:]\/)\/+/g, - '$1' - ), - requiredParams: ['resourceName'], - pathParams: ['resourceName'], + requiredParams: ['userId'], + pathParams: ['userId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Media$Download extends StandardParameters { - /** - * Name of the media that is being downloaded. See ReadRequest.resource_name. - */ - resourceName?: string; - } - export interface Params$Resource$Media$Upload extends StandardParameters { - /** - * Name of the media that is being downloaded. See ReadRequest.resource_name. - */ - resourceName?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleBytestreamMedia; /** - * Media metadata + * Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this 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. */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; + list( + params: Params$Resource$Users$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Users$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Users$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Users$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Users$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Users$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$List; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Media body contents - */ - body?: any; - }; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$List; + options = {}; + } - export class Resource$Sdfdownloadtasks { - context: APIRequestContext; - operations: Resource$Sdfdownloadtasks$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Sdfdownloadtasks$Operations(this.context); - } - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Sdfdownloadtasks$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v4/users').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds. + * Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this 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. */ - get( - params: Params$Resource$Sdfdownloadtasks$Operations$Get, + patch( + params: Params$Resource$Users$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Sdfdownloadtasks$Operations$Get, + patch( + params?: Params$Resource$Users$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Sdfdownloadtasks$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Users$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Sdfdownloadtasks$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Users$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Sdfdownloadtasks$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Users$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Sdfdownloadtasks$Operations$Get - | BodyResponseCallback + | Params$Resource$Users$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Sdfdownloadtasks$Operations$Get; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Sdfdownloadtasks$Operations$Get; + params = {} as Params$Resource$Users$Patch; options = {}; } @@ -485,32 +23561,92 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v4/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v4/users/{+userId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['userId'], + pathParams: ['userId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Sdfdownloadtasks$Operations$Get + export interface Params$Resource$Users$Bulkeditassigneduserroles extends StandardParameters { /** - * The name of the operation resource. + * Required. The ID of the user to which the assigned user roles belong. */ - name?: string; + userId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedUserRolesRequest; + } + export interface Params$Resource$Users$Create extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$User; + } + export interface Params$Resource$Users$Delete extends StandardParameters { + /** + * Required. The ID of the user to delete. + */ + userId?: string; + } + export interface Params$Resource$Users$Get extends StandardParameters { + /** + * Required. The ID of the user to fetch. + */ + userId?: string; + } + export interface Params$Resource$Users$List extends StandardParameters { + /** + * Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (\>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime\>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Users$Patch extends StandardParameters { + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + /** + * Output only. The unique ID of the user. Assigned by the system. + */ + userId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$User; } } From a62e682270f8242ace3e0ea1ecf1520f448f8933 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:44 +0000 Subject: [PATCH 058/144] feat(dlp): update the API #### dlp:v2 The following keys were added: - resources.organizations.resources.locations.resources.infoTypes.methods.list.description - resources.organizations.resources.locations.resources.infoTypes.methods.list.flatPath - resources.organizations.resources.locations.resources.infoTypes.methods.list.httpMethod - resources.organizations.resources.locations.resources.infoTypes.methods.list.id - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameterOrder - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.filter.description - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.filter.location - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.filter.type - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.languageCode.description - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.languageCode.location - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.languageCode.type - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.locationId.description - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.locationId.location - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.locationId.type - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.parent.description - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.parent.location - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.parent.pattern - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.parent.required - resources.organizations.resources.locations.resources.infoTypes.methods.list.parameters.parent.type - resources.organizations.resources.locations.resources.infoTypes.methods.list.path - resources.organizations.resources.locations.resources.infoTypes.methods.list.response.$ref - resources.organizations.resources.locations.resources.infoTypes.methods.list.scopes - resources.projects.resources.locations.resources.infoTypes.methods.list.description - resources.projects.resources.locations.resources.infoTypes.methods.list.flatPath - resources.projects.resources.locations.resources.infoTypes.methods.list.httpMethod - resources.projects.resources.locations.resources.infoTypes.methods.list.id - resources.projects.resources.locations.resources.infoTypes.methods.list.parameterOrder - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.languageCode.description - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.languageCode.location - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.languageCode.type - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.locationId.description - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.locationId.location - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.locationId.type - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.infoTypes.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.infoTypes.methods.list.path - resources.projects.resources.locations.resources.infoTypes.methods.list.response.$ref - resources.projects.resources.locations.resources.infoTypes.methods.list.scopes - schemas.GooglePrivacyDlpV2DataProfileFinding.description - schemas.GooglePrivacyDlpV2DataProfileFinding.id - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.dataProfileResourceName.description - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.dataProfileResourceName.type - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.findingId.description - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.findingId.type - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.infotype.$ref - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.infotype.description - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.location.$ref - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.location.description - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.quote.description - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.quote.type - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.quoteInfo.$ref - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.quoteInfo.description - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.resourceVisibility.description - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.resourceVisibility.enum - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.resourceVisibility.enumDescriptions - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.resourceVisibility.type - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.timestamp.description - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.timestamp.format - schemas.GooglePrivacyDlpV2DataProfileFinding.properties.timestamp.type - schemas.GooglePrivacyDlpV2DataProfileFinding.type - schemas.GooglePrivacyDlpV2DataProfileFindingLocation.description - schemas.GooglePrivacyDlpV2DataProfileFindingLocation.id - schemas.GooglePrivacyDlpV2DataProfileFindingLocation.properties.containerName.description - schemas.GooglePrivacyDlpV2DataProfileFindingLocation.properties.containerName.type - schemas.GooglePrivacyDlpV2DataProfileFindingLocation.properties.dataProfileFindingRecordLocation.$ref - schemas.GooglePrivacyDlpV2DataProfileFindingLocation.properties.dataProfileFindingRecordLocation.description - schemas.GooglePrivacyDlpV2DataProfileFindingLocation.type - schemas.GooglePrivacyDlpV2DataProfileFindingRecordLocation.description - schemas.GooglePrivacyDlpV2DataProfileFindingRecordLocation.id - schemas.GooglePrivacyDlpV2DataProfileFindingRecordLocation.properties.field.$ref - schemas.GooglePrivacyDlpV2DataProfileFindingRecordLocation.properties.field.description - schemas.GooglePrivacyDlpV2DataProfileFindingRecordLocation.type - schemas.GooglePrivacyDlpV2DiscoveryConfig.properties.processingLocation.$ref - schemas.GooglePrivacyDlpV2DiscoveryConfig.properties.processingLocation.description - schemas.GooglePrivacyDlpV2DiscoveryTarget.properties.vertexDatasetTarget.$ref - schemas.GooglePrivacyDlpV2DiscoveryTarget.properties.vertexDatasetTarget.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.id - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.properties.createdAfter.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.properties.createdAfter.format - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.properties.createdAfter.type - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.properties.minAge.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.properties.minAge.format - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.properties.minAge.type - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetConditions.type - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.id - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.properties.collection.$ref - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.properties.collection.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.properties.others.$ref - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.properties.others.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.properties.vertexDatasetResourceReference.$ref - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.properties.vertexDatasetResourceReference.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetFilter.type - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.id - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.properties.inspectTemplateModifiedCadence.$ref - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.properties.inspectTemplateModifiedCadence.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.properties.refreshFrequency.description - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.properties.refreshFrequency.enum - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.properties.refreshFrequency.enumDescriptions - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.properties.refreshFrequency.type - schemas.GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence.type - schemas.GooglePrivacyDlpV2Export.properties.sampleFindingsTable.$ref - schemas.GooglePrivacyDlpV2Export.properties.sampleFindingsTable.description - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.relatedResources.description - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.relatedResources.items.$ref - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.relatedResources.type - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.sampleFindingsTable.$ref - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.sampleFindingsTable.description - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.tags.description - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.tags.items.$ref - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.tags.type - schemas.GooglePrivacyDlpV2GlobalProcessing.description - schemas.GooglePrivacyDlpV2GlobalProcessing.id - schemas.GooglePrivacyDlpV2GlobalProcessing.type - schemas.GooglePrivacyDlpV2ImageFallbackLocation.description - schemas.GooglePrivacyDlpV2ImageFallbackLocation.id - schemas.GooglePrivacyDlpV2ImageFallbackLocation.properties.globalProcessing.$ref - schemas.GooglePrivacyDlpV2ImageFallbackLocation.properties.globalProcessing.description - schemas.GooglePrivacyDlpV2ImageFallbackLocation.properties.multiRegionProcessing.$ref - schemas.GooglePrivacyDlpV2ImageFallbackLocation.properties.multiRegionProcessing.description - schemas.GooglePrivacyDlpV2ImageFallbackLocation.type - schemas.GooglePrivacyDlpV2InfoTypeDescription.properties.specificInfoTypes.description - schemas.GooglePrivacyDlpV2InfoTypeDescription.properties.specificInfoTypes.items.type - schemas.GooglePrivacyDlpV2InfoTypeDescription.properties.specificInfoTypes.type - schemas.GooglePrivacyDlpV2MultiRegionProcessing.description - schemas.GooglePrivacyDlpV2MultiRegionProcessing.id - schemas.GooglePrivacyDlpV2MultiRegionProcessing.type - schemas.GooglePrivacyDlpV2ProcessingLocation.description - schemas.GooglePrivacyDlpV2ProcessingLocation.id - schemas.GooglePrivacyDlpV2ProcessingLocation.properties.imageFallbackLocation.$ref - schemas.GooglePrivacyDlpV2ProcessingLocation.properties.imageFallbackLocation.description - schemas.GooglePrivacyDlpV2ProcessingLocation.type - schemas.GooglePrivacyDlpV2RelatedResource.description - schemas.GooglePrivacyDlpV2RelatedResource.id - schemas.GooglePrivacyDlpV2RelatedResource.properties.fullResource.description - schemas.GooglePrivacyDlpV2RelatedResource.properties.fullResource.type - schemas.GooglePrivacyDlpV2RelatedResource.type - schemas.GooglePrivacyDlpV2TableDataProfile.properties.relatedResources.description - schemas.GooglePrivacyDlpV2TableDataProfile.properties.relatedResources.items.$ref - schemas.GooglePrivacyDlpV2TableDataProfile.properties.relatedResources.type - schemas.GooglePrivacyDlpV2TableDataProfile.properties.sampleFindingsTable.$ref - schemas.GooglePrivacyDlpV2TableDataProfile.properties.sampleFindingsTable.description - schemas.GooglePrivacyDlpV2TableDataProfile.properties.tags.description - schemas.GooglePrivacyDlpV2TableDataProfile.properties.tags.items.$ref - schemas.GooglePrivacyDlpV2TableDataProfile.properties.tags.type - schemas.GooglePrivacyDlpV2Tag.description - schemas.GooglePrivacyDlpV2Tag.id - schemas.GooglePrivacyDlpV2Tag.properties.key.description - schemas.GooglePrivacyDlpV2Tag.properties.key.type - schemas.GooglePrivacyDlpV2Tag.properties.namespacedTagValue.description - schemas.GooglePrivacyDlpV2Tag.properties.namespacedTagValue.type - schemas.GooglePrivacyDlpV2Tag.properties.value.description - schemas.GooglePrivacyDlpV2Tag.properties.value.type - schemas.GooglePrivacyDlpV2Tag.type - schemas.GooglePrivacyDlpV2VertexDatasetCollection.description - schemas.GooglePrivacyDlpV2VertexDatasetCollection.id - schemas.GooglePrivacyDlpV2VertexDatasetCollection.properties.vertexDatasetRegexes.$ref - schemas.GooglePrivacyDlpV2VertexDatasetCollection.properties.vertexDatasetRegexes.description - schemas.GooglePrivacyDlpV2VertexDatasetCollection.type - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.description - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.id - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.properties.conditions.$ref - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.properties.conditions.description - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.properties.disabled.$ref - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.properties.disabled.description - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.properties.filter.$ref - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.properties.filter.description - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.properties.generationCadence.$ref - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.properties.generationCadence.description - schemas.GooglePrivacyDlpV2VertexDatasetDiscoveryTarget.type - schemas.GooglePrivacyDlpV2VertexDatasetRegex.description - schemas.GooglePrivacyDlpV2VertexDatasetRegex.id - schemas.GooglePrivacyDlpV2VertexDatasetRegex.properties.projectIdRegex.description - schemas.GooglePrivacyDlpV2VertexDatasetRegex.properties.projectIdRegex.type - schemas.GooglePrivacyDlpV2VertexDatasetRegex.type - schemas.GooglePrivacyDlpV2VertexDatasetRegexes.description - schemas.GooglePrivacyDlpV2VertexDatasetRegexes.id - schemas.GooglePrivacyDlpV2VertexDatasetRegexes.properties.patterns.description - schemas.GooglePrivacyDlpV2VertexDatasetRegexes.properties.patterns.items.$ref - schemas.GooglePrivacyDlpV2VertexDatasetRegexes.properties.patterns.type - schemas.GooglePrivacyDlpV2VertexDatasetRegexes.type - schemas.GooglePrivacyDlpV2VertexDatasetResourceReference.description - schemas.GooglePrivacyDlpV2VertexDatasetResourceReference.id - schemas.GooglePrivacyDlpV2VertexDatasetResourceReference.properties.datasetResourceName.description - schemas.GooglePrivacyDlpV2VertexDatasetResourceReference.properties.datasetResourceName.type - schemas.GooglePrivacyDlpV2VertexDatasetResourceReference.type The following keys were changed: - endpoints - resources.projects.resources.image.methods.redact.description - resources.projects.resources.locations.resources.image.methods.redact.description - schemas.GooglePrivacyDlpV2FileStoreDataProfile.properties.fileStorePath.description - schemas.GooglePrivacyDlpV2InfoTypeCategory.properties.locationCategory.enum - schemas.GooglePrivacyDlpV2InfoTypeCategory.properties.locationCategory.enumDescriptions - schemas.GooglePrivacyDlpV2InfoTypeCategory.properties.typeCategory.enum - schemas.GooglePrivacyDlpV2InfoTypeCategory.properties.typeCategory.enumDescriptions --- discovery/dlp-v2.json | 448 +++++++++++++++++++++++++++++++++++- src/apis/dlp/v2.ts | 515 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 954 insertions(+), 9 deletions(-) diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 8201f390a7c..8b855a10978 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -230,6 +230,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://dlp.us-west8.rep.googleapis.com/", "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1470,6 +1480,50 @@ } } }, + "infoTypes": { + "methods": { + "list": { + "description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/infoTypes", + "httpMethod": "GET", + "id": "dlp.organizations.locations.infoTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.", + "location": "query", + "type": "string" + }, + "languageCode": { + "description": "BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.", + "location": "query", + "type": "string" + }, + "locationId": { + "description": "Deprecated. This field has no effect.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/infoTypes", + "response": { + "$ref": "GooglePrivacyDlpV2ListInfoTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "inspectTemplates": { "methods": { "create": { @@ -2718,7 +2772,7 @@ "image": { "methods": { "redact": { - "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", + "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.", "flatPath": "v2/projects/{projectsId}/image:redact", "httpMethod": "POST", "id": "dlp.projects.image.redact", @@ -4106,7 +4160,7 @@ "image": { "methods": { "redact": { - "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.", + "description": "Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/image:redact", "httpMethod": "POST", "id": "dlp.projects.locations.image.redact", @@ -4135,6 +4189,50 @@ } } }, + "infoTypes": { + "methods": { + "list": { + "description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/infoTypes", + "httpMethod": "GET", + "id": "dlp.projects.locations.infoTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.", + "location": "query", + "type": "string" + }, + "languageCode": { + "description": "BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.", + "location": "query", + "type": "string" + }, + "locationId": { + "description": "Deprecated. This field has no effect.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/infoTypes", + "response": { + "$ref": "GooglePrivacyDlpV2ListInfoTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "inspectTemplates": { "methods": { "create": { @@ -5015,7 +5113,7 @@ } } }, - "revision": "20250119", + "revision": "20250309", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6706,6 +6804,84 @@ }, "type": "object" }, + "GooglePrivacyDlpV2DataProfileFinding": { + "description": "Details about a piece of potentially sensitive information that was detected when the data resource was profiled.", + "id": "GooglePrivacyDlpV2DataProfileFinding", + "properties": { + "dataProfileResourceName": { + "description": "Resource name of the data profile associated with the finding.", + "type": "string" + }, + "findingId": { + "description": "A unique identifier for the finding.", + "type": "string" + }, + "infotype": { + "$ref": "GooglePrivacyDlpV2InfoType", + "description": "The [type of content](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference) that might have been found." + }, + "location": { + "$ref": "GooglePrivacyDlpV2DataProfileFindingLocation", + "description": "Where the content was found." + }, + "quote": { + "description": "The content that was found. Even if the content is not textual, it may be converted to a textual representation here. If the finding exceeds 4096 bytes in length, the quote may be omitted.", + "type": "string" + }, + "quoteInfo": { + "$ref": "GooglePrivacyDlpV2QuoteInfo", + "description": "Contains data parsed from quotes. Currently supported infoTypes: DATE, DATE_OF_BIRTH, and TIME." + }, + "resourceVisibility": { + "description": "How broadly a resource has been shared.", + "enum": [ + "RESOURCE_VISIBILITY_UNSPECIFIED", + "RESOURCE_VISIBILITY_PUBLIC", + "RESOURCE_VISIBILITY_INCONCLUSIVE", + "RESOURCE_VISIBILITY_RESTRICTED" + ], + "enumDescriptions": [ + "Unused.", + "Visible to any user.", + "May contain public items. For example, if a Cloud Storage bucket has uniform bucket level access disabled, some objects inside it may be public, but none are known yet.", + "Visible only to specific users." + ], + "type": "string" + }, + "timestamp": { + "description": "Timestamp when the finding was detected.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DataProfileFindingLocation": { + "description": "Location of a data profile finding within a resource.", + "id": "GooglePrivacyDlpV2DataProfileFindingLocation", + "properties": { + "containerName": { + "description": "Name of the container where the finding is located. The top-level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}`", + "type": "string" + }, + "dataProfileFindingRecordLocation": { + "$ref": "GooglePrivacyDlpV2DataProfileFindingRecordLocation", + "description": "Location of a finding within a resource that produces a table data profile." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DataProfileFindingRecordLocation": { + "description": "Location of a finding within a resource that produces a table data profile.", + "id": "GooglePrivacyDlpV2DataProfileFindingRecordLocation", + "properties": { + "field": { + "$ref": "GooglePrivacyDlpV2FieldId", + "description": "Field ID of the column containing the finding." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2DataProfileJobConfig": { "description": "Configuration for setting up a job to scan resources for profile generation. Only one data profile 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": "GooglePrivacyDlpV2DataProfileJobConfig", @@ -7621,6 +7797,10 @@ "$ref": "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation", "description": "Must be set only when scanning other clouds." }, + "processingLocation": { + "$ref": "GooglePrivacyDlpV2ProcessingLocation", + "description": "Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default." + }, "status": { "description": "Required. A status for this configuration.", "enum": [ @@ -7910,6 +8090,73 @@ "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." + }, + "vertexDatasetTarget": { + "$ref": "GooglePrivacyDlpV2VertexDatasetDiscoveryTarget", + "description": "Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DiscoveryVertexDatasetConditions": { + "description": "Requirements that must be true before a dataset is profiled for the first time.", + "id": "GooglePrivacyDlpV2DiscoveryVertexDatasetConditions", + "properties": { + "createdAfter": { + "description": "Vertex AI dataset must have been created after this date. Used to avoid backfilling.", + "format": "google-datetime", + "type": "string" + }, + "minAge": { + "description": "Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DiscoveryVertexDatasetFilter": { + "description": "Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex.", + "id": "GooglePrivacyDlpV2DiscoveryVertexDatasetFilter", + "properties": { + "collection": { + "$ref": "GooglePrivacyDlpV2VertexDatasetCollection", + "description": "A specific set of Vertex AI datasets for this filter to apply to." + }, + "others": { + "$ref": "GooglePrivacyDlpV2AllOtherResources", + "description": "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." + }, + "vertexDatasetResourceReference": { + "$ref": "GooglePrivacyDlpV2VertexDatasetResourceReference", + "description": "The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference)." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence": { + "description": "How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity.", + "id": "GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence", + "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 be updated." + }, + "refreshFrequency": { + "description": "If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets 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" @@ -8138,6 +8385,10 @@ "profileTable": { "$ref": "GooglePrivacyDlpV2BigQueryTable", "description": "Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Looker reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary." + }, + "sampleFindingsTable": { + "$ref": "GooglePrivacyDlpV2BigQueryTable", + "description": "Store sample data profile findings in an existing table or a new table in an existing dataset. Each regeneration will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished." } }, "type": "object" @@ -8378,7 +8629,7 @@ "type": "string" }, "fileStorePath": { - "description": "The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}`", + "description": "The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}`", "type": "string" }, "fullResource": { @@ -8415,6 +8666,13 @@ "description": "The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.", "type": "string" }, + "relatedResources": { + "description": "Resources related to this profile.", + "items": { + "$ref": "GooglePrivacyDlpV2RelatedResource" + }, + "type": "array" + }, "resourceAttributes": { "additionalProperties": { "$ref": "GooglePrivacyDlpV2Value" @@ -8445,6 +8703,10 @@ ], "type": "string" }, + "sampleFindingsTable": { + "$ref": "GooglePrivacyDlpV2BigQueryTable", + "description": "The BigQuery table to which the sample findings are written." + }, "sensitivityScore": { "$ref": "GooglePrivacyDlpV2SensitivityScore", "description": "The sensitivity score of this resource." @@ -8462,6 +8724,13 @@ "The profile is no longer generating. If profile_status.status.code is 0, the profile succeeded, otherwise, it failed." ], "type": "string" + }, + "tags": { + "description": "The tags attached to the resource, including any tags attached during profiling.", + "items": { + "$ref": "GooglePrivacyDlpV2Tag" + }, + "type": "array" } }, "type": "object" @@ -8632,6 +8901,12 @@ }, "type": "object" }, + "GooglePrivacyDlpV2GlobalProcessing": { + "description": "Processing will happen in the global region.", + "id": "GooglePrivacyDlpV2GlobalProcessing", + "properties": {}, + "type": "object" + }, "GooglePrivacyDlpV2HotwordRule": { "description": "The rule that adjusts the likelihood of findings within a certain proximity of hotwords.", "id": "GooglePrivacyDlpV2HotwordRule", @@ -8777,6 +9052,21 @@ }, "type": "object" }, + "GooglePrivacyDlpV2ImageFallbackLocation": { + "description": "Configure image processing to fall back to the configured processing option below if unavailable in the request location.", + "id": "GooglePrivacyDlpV2ImageFallbackLocation", + "properties": { + "globalProcessing": { + "$ref": "GooglePrivacyDlpV2GlobalProcessing", + "description": "Processing will happen in the global region." + }, + "multiRegionProcessing": { + "$ref": "GooglePrivacyDlpV2MultiRegionProcessing", + "description": "Processing will happen in a multi-region that contains the current region if available." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2ImageLocation": { "description": "Location of the finding within an image.", "id": "GooglePrivacyDlpV2ImageLocation", @@ -8903,6 +9193,7 @@ "CHINA", "COLOMBIA", "CROATIA", + "CZECHIA", "DENMARK", "FRANCE", "FINLAND", @@ -8956,6 +9247,7 @@ "The infoType is typically used in China.", "The infoType is typically used in Colombia.", "The infoType is typically used in Croatia.", + "The infoType is typically used in Czechia.", "The infoType is typically used in Denmark.", "The infoType is typically used in France.", "The infoType is typically used in Finland.", @@ -9006,7 +9298,8 @@ "CREDENTIAL", "GOVERNMENT_ID", "DOCUMENT", - "CONTEXTUAL_INFORMATION" + "CONTEXTUAL_INFORMATION", + "CUSTOM" ], "enumDescriptions": [ "Unused type", @@ -9016,7 +9309,8 @@ "Confidential or secret information, for example, a password.", "An identification document issued by a government.", "A document, for example, a resume or source code.", - "Information that is not sensitive on its own, but provides details about the circumstances surrounding an entity or an event." + "Information that is not sensitive on its own, but provides details about the circumstances surrounding an entity or an event.", + "Category for `CustomInfoType` types." ], "type": "string" } @@ -9054,6 +9348,13 @@ "$ref": "GooglePrivacyDlpV2SensitivityScore", "description": "The default sensitivity of the infoType." }, + "specificInfoTypes": { + "description": "If this field is set, this infoType is a general infoType and these specific infoTypes are contained within it. General infoTypes are infoTypes that encompass multiple specific infoTypes. For example, the \"GEOGRAPHIC_DATA\" general infoType would have set for this field \"LOCATION\", \"LOCATION_COORDINATES\", and \"STREET_ADDRESS\".", + "items": { + "type": "string" + }, + "type": "array" + }, "supportedBy": { "description": "Which parts of the API supports this InfoType.", "items": { @@ -10175,6 +10476,12 @@ }, "type": "object" }, + "GooglePrivacyDlpV2MultiRegionProcessing": { + "description": "Processing will happen in a multi-region that contains the current region if available.", + "id": "GooglePrivacyDlpV2MultiRegionProcessing", + "properties": {}, + "type": "object" + }, "GooglePrivacyDlpV2NumericalStatsConfig": { "description": "Compute numerical stats over an individual column, including min, max, and quantiles.", "id": "GooglePrivacyDlpV2NumericalStatsConfig", @@ -10497,6 +10804,17 @@ }, "type": "object" }, + "GooglePrivacyDlpV2ProcessingLocation": { + "description": "Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided.", + "id": "GooglePrivacyDlpV2ProcessingLocation", + "properties": { + "imageFallbackLocation": { + "$ref": "GooglePrivacyDlpV2ImageFallbackLocation", + "description": "Image processing will fall back using this configuration." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2ProfileStatus": { "description": "Success or errors for the profile generation.", "id": "GooglePrivacyDlpV2ProfileStatus", @@ -11031,6 +11349,17 @@ }, "type": "object" }, + "GooglePrivacyDlpV2RelatedResource": { + "description": "A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset.", + "id": "GooglePrivacyDlpV2RelatedResource", + "properties": { + "fullResource": { + "description": "The full resource name of the related resource.", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2ReplaceDictionaryConfig": { "description": "Replace each input value with a value randomly selected from the dictionary.", "id": "GooglePrivacyDlpV2ReplaceDictionaryConfig", @@ -11649,6 +11978,13 @@ "description": "The resource name of the project data profile for this table.", "type": "string" }, + "relatedResources": { + "description": "Resources related to this profile.", + "items": { + "$ref": "GooglePrivacyDlpV2RelatedResource" + }, + "type": "array" + }, "resourceLabels": { "additionalProperties": { "type": "string" @@ -11677,6 +12013,10 @@ "format": "int64", "type": "string" }, + "sampleFindingsTable": { + "$ref": "GooglePrivacyDlpV2BigQueryTable", + "description": "The BigQuery table to which the sample findings are written." + }, "scannedColumnCount": { "description": "The number of columns profiled in the table.", "format": "int64", @@ -11708,6 +12048,13 @@ "description": "The size of the table when the profile was generated.", "format": "int64", "type": "string" + }, + "tags": { + "description": "The tags attached to the table, including any tags attached during profiling. Because tags are attached to Cloud SQL instances rather than Cloud SQL tables, this field is empty for Cloud SQL table profiles.", + "items": { + "$ref": "GooglePrivacyDlpV2Tag" + }, + "type": "array" } }, "type": "object" @@ -11753,6 +12100,25 @@ }, "type": "object" }, + "GooglePrivacyDlpV2Tag": { + "description": "A tag associated with a resource.", + "id": "GooglePrivacyDlpV2Tag", + "properties": { + "key": { + "description": "The key of a tag key-value pair. For Google Cloud resources, this is the resource name of the key, for example, \"tagKeys/123456\".", + "type": "string" + }, + "namespacedTagValue": { + "description": "The namespaced name for the tag value to attach to Google Cloud resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\". This is only set for Google Cloud resources.", + "type": "string" + }, + "value": { + "description": "The value of a tag key-value pair. For Google Cloud resources, this is the resource name of the value, for example, \"tagValues/123456\".", + "type": "string" + } + }, + "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", @@ -12394,6 +12760,76 @@ }, "type": "object" }, + "GooglePrivacyDlpV2VertexDatasetCollection": { + "description": "Match dataset resources using regex filters.", + "id": "GooglePrivacyDlpV2VertexDatasetCollection", + "properties": { + "vertexDatasetRegexes": { + "$ref": "GooglePrivacyDlpV2VertexDatasetRegexes", + "description": "The regex used to filter dataset resources." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2VertexDatasetDiscoveryTarget": { + "description": "Target used to match against for discovery with Vertex AI datasets.", + "id": "GooglePrivacyDlpV2VertexDatasetDiscoveryTarget", + "properties": { + "conditions": { + "$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetConditions", + "description": "In addition to matching the filter, these conditions must be true before a profile is generated." + }, + "disabled": { + "$ref": "GooglePrivacyDlpV2Disabled", + "description": "Disable profiling for datasets that match this filter." + }, + "filter": { + "$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetFilter", + "description": "Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset." + }, + "generationCadence": { + "$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence", + "description": "How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2VertexDatasetRegex": { + "description": "A pattern to match against one or more dataset resources.", + "id": "GooglePrivacyDlpV2VertexDatasetRegex", + "properties": { + "projectIdRegex": { + "description": "For organizations, if unset, will match all projects. Has no effect for configurations created within a project.", + "type": "string" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2VertexDatasetRegexes": { + "description": "A collection of regular expressions to determine what datasets to match against.", + "id": "GooglePrivacyDlpV2VertexDatasetRegexes", + "properties": { + "patterns": { + "description": "Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB.", + "items": { + "$ref": "GooglePrivacyDlpV2VertexDatasetRegex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2VertexDatasetResourceReference": { + "description": "Identifies a single Vertex AI dataset.", + "id": "GooglePrivacyDlpV2VertexDatasetResourceReference", + "properties": { + "datasetResourceName": { + "description": "Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project.", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2WordList": { "description": "Message defining a list of words or phrases to search for in the data.", "id": "GooglePrivacyDlpV2WordList", diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 140307992c8..fd3aac28a9e 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -1350,6 +1350,65 @@ export namespace dlp_v2 { */ inspectTemplateName?: string | null; } + /** + * Details about a piece of potentially sensitive information that was detected when the data resource was profiled. + */ + export interface Schema$GooglePrivacyDlpV2DataProfileFinding { + /** + * Resource name of the data profile associated with the finding. + */ + dataProfileResourceName?: string | null; + /** + * A unique identifier for the finding. + */ + findingId?: string | null; + /** + * The [type of content](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference) that might have been found. + */ + infotype?: Schema$GooglePrivacyDlpV2InfoType; + /** + * Where the content was found. + */ + location?: Schema$GooglePrivacyDlpV2DataProfileFindingLocation; + /** + * The content that was found. Even if the content is not textual, it may be converted to a textual representation here. If the finding exceeds 4096 bytes in length, the quote may be omitted. + */ + quote?: string | null; + /** + * Contains data parsed from quotes. Currently supported infoTypes: DATE, DATE_OF_BIRTH, and TIME. + */ + quoteInfo?: Schema$GooglePrivacyDlpV2QuoteInfo; + /** + * How broadly a resource has been shared. + */ + resourceVisibility?: string | null; + /** + * Timestamp when the finding was detected. + */ + timestamp?: string | null; + } + /** + * Location of a data profile finding within a resource. + */ + export interface Schema$GooglePrivacyDlpV2DataProfileFindingLocation { + /** + * Name of the container where the finding is located. The top-level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id\}:{dataset_id\}.{table_id\}` * Cloud Storage files: `gs://{bucket\}/{path\}` + */ + containerName?: string | null; + /** + * Location of a finding within a resource that produces a table data profile. + */ + dataProfileFindingRecordLocation?: Schema$GooglePrivacyDlpV2DataProfileFindingRecordLocation; + } + /** + * Location of a finding within a resource that produces a table data profile. + */ + export interface Schema$GooglePrivacyDlpV2DataProfileFindingRecordLocation { + /** + * Field ID of the column containing the finding. + */ + field?: Schema$GooglePrivacyDlpV2FieldId; + } /** * Configuration for setting up a job to scan resources for profile generation. Only one data profile 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). */ @@ -1897,6 +1956,10 @@ export namespace dlp_v2 { * Must be set only when scanning other clouds. */ otherCloudStartingLocation?: Schema$GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation; + /** + * Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + */ + processingLocation?: Schema$GooglePrivacyDlpV2ProcessingLocation; /** * Required. A status for this configuration. */ @@ -2063,6 +2126,53 @@ export namespace dlp_v2 { * 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. */ secretsTarget?: Schema$GooglePrivacyDlpV2SecretsDiscoveryTarget; + /** + * Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured. + */ + vertexDatasetTarget?: Schema$GooglePrivacyDlpV2VertexDatasetDiscoveryTarget; + } + /** + * Requirements that must be true before a dataset is profiled for the first time. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryVertexDatasetConditions { + /** + * Vertex AI dataset must have been created after this date. Used to avoid backfilling. + */ + createdAfter?: string | null; + /** + * Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater. + */ + minAge?: string | null; + } + /** + * Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryVertexDatasetFilter { + /** + * A specific set of Vertex AI datasets for this filter to apply to. + */ + collection?: Schema$GooglePrivacyDlpV2VertexDatasetCollection; + /** + * 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; + /** + * The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + */ + vertexDatasetResourceReference?: Schema$GooglePrivacyDlpV2VertexDatasetResourceReference; + } + /** + * How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence { + /** + * 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 be updated. + */ + inspectTemplateModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence; + /** + * If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never. + */ + refreshFrequency?: string | null; } /** * Combines all of the information about a DLP job. @@ -2207,6 +2317,10 @@ export namespace dlp_v2 { * Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Looker reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary. */ profileTable?: Schema$GooglePrivacyDlpV2BigQueryTable; + /** + * Store sample data profile findings in an existing table or a new table in an existing dataset. Each regeneration will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. + */ + sampleFindingsTable?: Schema$GooglePrivacyDlpV2BigQueryTable; } /** * An expression, consisting of an operator and conditions. @@ -2369,7 +2483,7 @@ export namespace dlp_v2 { */ fileStoreLocation?: string | null; /** - * The file store path. * Cloud Storage: `gs://{bucket\}` * Amazon S3: `s3://{bucket\}` + * The file store path. * Cloud Storage: `gs://{bucket\}` * Amazon S3: `s3://{bucket\}` * Vertex AI dataset: `projects/{project_number\}/locations/{location\}/datasets/{dataset_id\}` */ fileStorePath?: string | null; /** @@ -2404,6 +2518,10 @@ export namespace dlp_v2 { * The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id. */ projectId?: string | null; + /** + * Resources related to this profile. + */ + relatedResources?: Schema$GooglePrivacyDlpV2RelatedResource[]; /** * 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. */ @@ -2416,6 +2534,10 @@ export namespace dlp_v2 { * How broadly a resource has been shared. */ resourceVisibility?: string | null; + /** + * The BigQuery table to which the sample findings are written. + */ + sampleFindingsTable?: Schema$GooglePrivacyDlpV2BigQueryTable; /** * The sensitivity score of this resource. */ @@ -2424,6 +2546,10 @@ export namespace dlp_v2 { * State of a profile. */ state?: string | null; + /** + * The tags attached to the resource, including any tags attached during profiling. + */ + tags?: Schema$GooglePrivacyDlpV2Tag[]; } /** * Information regarding the discovered InfoType. @@ -2547,6 +2673,10 @@ export namespace dlp_v2 { */ upperBound?: Schema$GooglePrivacyDlpV2Value; } + /** + * Processing will happen in the global region. + */ + export interface Schema$GooglePrivacyDlpV2GlobalProcessing {} /** * The rule that adjusts the likelihood of findings within a certain proximity of hotwords. */ @@ -2662,6 +2792,19 @@ export namespace dlp_v2 { */ tableOptions?: Schema$GooglePrivacyDlpV2TableOptions; } + /** + * Configure image processing to fall back to the configured processing option below if unavailable in the request location. + */ + export interface Schema$GooglePrivacyDlpV2ImageFallbackLocation { + /** + * Processing will happen in the global region. + */ + globalProcessing?: Schema$GooglePrivacyDlpV2GlobalProcessing; + /** + * Processing will happen in a multi-region that contains the current region if available. + */ + multiRegionProcessing?: Schema$GooglePrivacyDlpV2MultiRegionProcessing; + } /** * Location of the finding within an image. */ @@ -2780,6 +2923,10 @@ export namespace dlp_v2 { * The default sensitivity of the infoType. */ sensitivityScore?: Schema$GooglePrivacyDlpV2SensitivityScore; + /** + * If this field is set, this infoType is a general infoType and these specific infoTypes are contained within it. General infoTypes are infoTypes that encompass multiple specific infoTypes. For example, the "GEOGRAPHIC_DATA" general infoType would have set for this field "LOCATION", "LOCATION_COORDINATES", and "STREET_ADDRESS". + */ + specificInfoTypes?: string[] | null; /** * Which parts of the API supports this InfoType. */ @@ -3545,6 +3692,10 @@ export namespace dlp_v2 { */ type?: string | null; } + /** + * Processing will happen in a multi-region that contains the current region if available. + */ + export interface Schema$GooglePrivacyDlpV2MultiRegionProcessing {} /** * Compute numerical stats over an individual column, including min, max, and quantiles. */ @@ -3809,6 +3960,15 @@ export namespace dlp_v2 { */ numericalStatsConfig?: Schema$GooglePrivacyDlpV2NumericalStatsConfig; } + /** + * Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. + */ + export interface Schema$GooglePrivacyDlpV2ProcessingLocation { + /** + * Image processing will fall back using this configuration. + */ + imageFallbackLocation?: Schema$GooglePrivacyDlpV2ImageFallbackLocation; + } /** * Success or errors for the profile generation. */ @@ -4200,6 +4360,15 @@ export namespace dlp_v2 { */ overview?: Schema$GooglePrivacyDlpV2TransformationOverview; } + /** + * A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. + */ + export interface Schema$GooglePrivacyDlpV2RelatedResource { + /** + * The full resource name of the related resource. + */ + fullResource?: string | null; + } /** * Replace each input value with a value randomly selected from the dictionary. */ @@ -4641,6 +4810,10 @@ export namespace dlp_v2 { * The resource name of the project data profile for this table. */ projectDataProfile?: string | null; + /** + * Resources related to this profile. + */ + relatedResources?: Schema$GooglePrivacyDlpV2RelatedResource[]; /** * The labels applied to the resource at the time the profile was generated. */ @@ -4653,6 +4826,10 @@ export namespace dlp_v2 { * Number of rows in the table when the profile was generated. This will not be populated for BigLake tables. */ rowCount?: string | null; + /** + * The BigQuery table to which the sample findings are written. + */ + sampleFindingsTable?: Schema$GooglePrivacyDlpV2BigQueryTable; /** * The number of columns profiled in the table. */ @@ -4673,6 +4850,10 @@ export namespace dlp_v2 { * The size of the table when the profile was generated. */ tableSizeBytes?: string | null; + /** + * The tags attached to the table, including any tags attached during profiling. Because tags are attached to Cloud SQL instances rather than Cloud SQL tables, this field is empty for Cloud SQL table profiles. + */ + tags?: Schema$GooglePrivacyDlpV2Tag[]; } /** * Location of a finding within a table. @@ -4705,6 +4886,23 @@ export namespace dlp_v2 { */ tableId?: string | null; } + /** + * A tag associated with a resource. + */ + export interface Schema$GooglePrivacyDlpV2Tag { + /** + * The key of a tag key-value pair. For Google Cloud resources, this is the resource name of the key, for example, "tagKeys/123456". + */ + key?: string | null; + /** + * The namespaced name for the tag value to attach to Google Cloud resources. Must be in the format `{parent_id\}/{tag_key_short_name\}/{short_name\}`, for example, "123456/environment/prod". This is only set for Google Cloud resources. + */ + namespacedTagValue?: string | null; + /** + * The value of a tag key-value pair. For Google Cloud resources, this is the resource name of the value, for example, "tagValues/123456". + */ + value?: string | null; + } /** * The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. */ @@ -5145,6 +5343,63 @@ export namespace dlp_v2 { */ version?: string | null; } + /** + * Match dataset resources using regex filters. + */ + export interface Schema$GooglePrivacyDlpV2VertexDatasetCollection { + /** + * The regex used to filter dataset resources. + */ + vertexDatasetRegexes?: Schema$GooglePrivacyDlpV2VertexDatasetRegexes; + } + /** + * Target used to match against for discovery with Vertex AI datasets. + */ + export interface Schema$GooglePrivacyDlpV2VertexDatasetDiscoveryTarget { + /** + * In addition to matching the filter, these conditions must be true before a profile is generated. + */ + conditions?: Schema$GooglePrivacyDlpV2DiscoveryVertexDatasetConditions; + /** + * Disable profiling for datasets that match this filter. + */ + disabled?: Schema$GooglePrivacyDlpV2Disabled; + /** + * Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset. + */ + filter?: Schema$GooglePrivacyDlpV2DiscoveryVertexDatasetFilter; + /** + * How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + */ + generationCadence?: Schema$GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence; + } + /** + * A pattern to match against one or more dataset resources. + */ + export interface Schema$GooglePrivacyDlpV2VertexDatasetRegex { + /** + * For organizations, if unset, will match all projects. Has no effect for configurations created within a project. + */ + projectIdRegex?: string | null; + } + /** + * A collection of regular expressions to determine what datasets to match against. + */ + export interface Schema$GooglePrivacyDlpV2VertexDatasetRegexes { + /** + * Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB. + */ + patterns?: Schema$GooglePrivacyDlpV2VertexDatasetRegex[]; + } + /** + * Identifies a single Vertex AI dataset. + */ + export interface Schema$GooglePrivacyDlpV2VertexDatasetResourceReference { + /** + * Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + */ + datasetResourceName?: string | null; + } /** * Message defining a list of words or phrases to search for in the data. */ @@ -6573,6 +6828,7 @@ export namespace dlp_v2 { discoveryConfigs: Resource$Organizations$Locations$Discoveryconfigs; dlpJobs: Resource$Organizations$Locations$Dlpjobs; fileStoreDataProfiles: Resource$Organizations$Locations$Filestoredataprofiles; + infoTypes: Resource$Organizations$Locations$Infotypes; inspectTemplates: Resource$Organizations$Locations$Inspecttemplates; jobTriggers: Resource$Organizations$Locations$Jobtriggers; projectDataProfiles: Resource$Organizations$Locations$Projectdataprofiles; @@ -6594,6 +6850,9 @@ export namespace dlp_v2 { new Resource$Organizations$Locations$Filestoredataprofiles( this.context ); + this.infoTypes = new Resource$Organizations$Locations$Infotypes( + this.context + ); this.inspectTemplates = new Resource$Organizations$Locations$Inspecttemplates(this.context); this.jobTriggers = new Resource$Organizations$Locations$Jobtriggers( @@ -9041,6 +9300,130 @@ export namespace dlp_v2 { parent?: string; } + export class Resource$Organizations$Locations$Infotypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Infotypes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Infotypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Infotypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Infotypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Infotypes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Infotypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Infotypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$Infotypes$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}/infoTypes').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$Organizations$Locations$Infotypes$List + extends StandardParameters { + /** + * filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. + */ + filter?: string; + /** + * BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. + */ + languageCode?: string; + /** + * Deprecated. This field has no effect. + */ + locationId?: string; + /** + * The parent resource name. The format of this value is as follows: `locations/{location_id\}` + */ + parent?: string; + } + export class Resource$Organizations$Locations$Inspecttemplates { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -13221,7 +13604,7 @@ export namespace dlp_v2 { } /** - * Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14534,6 +14917,7 @@ export namespace dlp_v2 { dlpJobs: Resource$Projects$Locations$Dlpjobs; fileStoreDataProfiles: Resource$Projects$Locations$Filestoredataprofiles; image: Resource$Projects$Locations$Image; + infoTypes: Resource$Projects$Locations$Infotypes; inspectTemplates: Resource$Projects$Locations$Inspecttemplates; jobTriggers: Resource$Projects$Locations$Jobtriggers; projectDataProfiles: Resource$Projects$Locations$Projectdataprofiles; @@ -14556,6 +14940,7 @@ export namespace dlp_v2 { this.fileStoreDataProfiles = new Resource$Projects$Locations$Filestoredataprofiles(this.context); this.image = new Resource$Projects$Locations$Image(this.context); + this.infoTypes = new Resource$Projects$Locations$Infotypes(this.context); this.inspectTemplates = new Resource$Projects$Locations$Inspecttemplates( this.context ); @@ -17949,7 +18334,7 @@ export namespace dlp_v2 { } /** - * Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18059,6 +18444,130 @@ export namespace dlp_v2 { requestBody?: Schema$GooglePrivacyDlpV2RedactImageRequest; } + export class Resource$Projects$Locations$Infotypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Infotypes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Infotypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Infotypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Infotypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Infotypes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Infotypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Infotypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Infotypes$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}/infoTypes').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$Infotypes$List + extends StandardParameters { + /** + * filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. + */ + filter?: string; + /** + * BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. + */ + languageCode?: string; + /** + * Deprecated. This field has no effect. + */ + locationId?: string; + /** + * The parent resource name. The format of this value is as follows: `locations/{location_id\}` + */ + parent?: string; + } + export class Resource$Projects$Locations$Inspecttemplates { context: APIRequestContext; constructor(context: APIRequestContext) { From a40a114addc594a20e324f587cd8433fadb082cf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 059/144] fix(dns): update the API #### dns:v1beta2 The following keys were changed: - schemas.RRSetRoutingPolicy.properties.healthCheck.description - schemas.RRSetRoutingPolicyGeoPolicyGeoPolicyItem.properties.signatureRrdatas.description - schemas.RRSetRoutingPolicyHealthCheckTargets.description - schemas.RRSetRoutingPolicyWrrPolicyWrrPolicyItem.properties.signatureRrdatas.description #### dns:v1 The following keys were changed: - schemas.RRSetRoutingPolicy.properties.healthCheck.description - schemas.RRSetRoutingPolicyGeoPolicyGeoPolicyItem.properties.signatureRrdatas.description - schemas.RRSetRoutingPolicyHealthCheckTargets.description - schemas.RRSetRoutingPolicyWrrPolicyWrrPolicyItem.properties.signatureRrdatas.description --- discovery/dns-v1.json | 10 +++++----- discovery/dns-v1beta2.json | 10 +++++----- src/apis/dns/v1.ts | 8 ++++---- src/apis/dns/v1beta2.ts | 8 ++++---- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/discovery/dns-v1.json b/discovery/dns-v1.json index 3f1e023497c..f3cad301c99 100644 --- a/discovery/dns-v1.json +++ b/discovery/dns-v1.json @@ -1824,7 +1824,7 @@ } } }, - "revision": "20250102", + "revision": "20250227", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -3047,7 +3047,7 @@ "$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", + "description": "The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", "type": "string" }, "kind": { @@ -3108,7 +3108,7 @@ "type": "array" }, "signatureRrdatas": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, @@ -3118,7 +3118,7 @@ "type": "object" }, "RRSetRoutingPolicyHealthCheckTargets": { - "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", + "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both.", "id": "RRSetRoutingPolicyHealthCheckTargets", "properties": { "externalEndpoints": { @@ -3259,7 +3259,7 @@ "type": "array" }, "signatureRrdatas": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, diff --git a/discovery/dns-v1beta2.json b/discovery/dns-v1beta2.json index 86f209f50c4..7667dfcbbf0 100644 --- a/discovery/dns-v1beta2.json +++ b/discovery/dns-v1beta2.json @@ -1821,7 +1821,7 @@ } } }, - "revision": "20250102", + "revision": "20250227", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -3048,7 +3048,7 @@ "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", + "description": "The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", "type": "string" }, "kind": { @@ -3113,7 +3113,7 @@ "type": "array" }, "signatureRrdatas": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, @@ -3123,7 +3123,7 @@ "type": "object" }, "RRSetRoutingPolicyHealthCheckTargets": { - "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", + "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both.", "id": "RRSetRoutingPolicyHealthCheckTargets", "properties": { "externalEndpoints": { @@ -3264,7 +3264,7 @@ "type": "array" }, "signatureRrdatas": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index d7c5a25b3b7..1cd70b9eb8f 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -1057,7 +1057,7 @@ 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 + * The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project\}/global/healthChecks/{healthCheck\}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks */ healthCheck?: string | null; kind?: string | null; @@ -1093,12 +1093,12 @@ export namespace dns_v1 { location?: string | null; rrdatas?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdatas?: string[] | null; } /** - * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. + * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. */ export interface Schema$RRSetRoutingPolicyHealthCheckTargets { /** @@ -1180,7 +1180,7 @@ export namespace dns_v1 { kind?: string | null; rrdatas?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdatas?: string[] | null; /** diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index f19c1b9ed6f..22c47be14a0 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -1057,7 +1057,7 @@ export namespace dns_v1beta2 { 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 + * The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project\}/global/healthChecks/{healthCheck\}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks */ healthCheck?: string | null; kind?: string | null; @@ -1094,12 +1094,12 @@ export namespace dns_v1beta2 { location?: string | null; rrdatas?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdatas?: string[] | null; } /** - * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. + * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. */ export interface Schema$RRSetRoutingPolicyHealthCheckTargets { /** @@ -1181,7 +1181,7 @@ export namespace dns_v1beta2 { kind?: string | null; rrdatas?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdatas?: string[] | null; /** From 0a00cd9b35c0f43a3e71007208912311c1096ff7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 060/144] fix(docs): update the API #### docs:v1 The following keys were changed: - schemas.CropProperties.description - schemas.DocumentStyle.properties.useCustomHeaderFooterMargins.description - schemas.NestingLevel.properties.glyphSymbol.description - schemas.NestingLevel.properties.glyphType.description --- discovery/docs-v1.json | 10 +++++----- src/apis/docs/v1.ts | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/docs-v1.json b/discovery/docs-v1.json index 3035a2b40e8..a8c1dbf9285 100644 --- a/discovery/docs-v1.json +++ b/discovery/docs-v1.json @@ -221,7 +221,7 @@ } } }, - "revision": "20240730", + "revision": "20250218", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -615,7 +615,7 @@ "type": "object" }, "CropProperties": { - "description": "The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped.", + "description": "The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angles are 0, the image is not cropped.", "id": "CropProperties", "properties": { "angle": { @@ -992,7 +992,7 @@ "description": "The size of a page in the document." }, "useCustomHeaderFooterMargins": { - "description": "Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.", + "description": "Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only.", "type": "boolean" }, "useEvenPageHeaderFooter": { @@ -2176,11 +2176,11 @@ "type": "string" }, "glyphSymbol": { - "description": "A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.", + "description": "A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.", "type": "string" }, "glyphType": { - "description": "The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.", + "description": "The type of glyph used by bullets when paragraphs at this level of nesting is ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to the list item's order within the list.", "enum": [ "GLYPH_TYPE_UNSPECIFIED", "NONE", diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index 5188deca3dd..4b9f66fafbb 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -389,7 +389,7 @@ export namespace docs_v1 { range?: Schema$Range; } /** - * The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. + * The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angles are 0, the image is not cropped. */ export interface Schema$CropProperties { /** @@ -689,7 +689,7 @@ export namespace docs_v1 { */ pageSize?: Schema$Size; /** - * Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + * Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. */ useCustomHeaderFooterMargins?: boolean | null; /** @@ -1599,11 +1599,11 @@ export namespace docs_v1 { */ glyphFormat?: string | null; /** - * A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + * A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. */ glyphSymbol?: string | null; /** - * The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + * The type of glyph used by bullets when paragraphs at this level of nesting is ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to the list item's order within the list. */ glyphType?: string | null; /** From a311f2338742d2a080e33308cbfafaa4e32f6a66 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 061/144] fix(documentai): update the API #### documentai:v1beta3 The following keys were changed: - schemas.GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig.properties.breakpointPercentileThreshold.description - schemas.GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig.properties.semanticChunkingGroupSize.description --- discovery/documentai-v1beta3.json | 6 +++--- src/apis/documentai/v1beta3.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index 095ee2566ef..90a772c3d60 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -1284,7 +1284,7 @@ } } }, - "revision": "20250117", + "revision": "20250210", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -5713,7 +5713,7 @@ "id": "GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig", "properties": { "breakpointPercentileThreshold": { - "description": "Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated.", + "description": "Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated. THIS FIELD IS NOT YET USED.", "format": "int32", "type": "integer" }, @@ -5727,7 +5727,7 @@ "type": "boolean" }, "semanticChunkingGroupSize": { - "description": "Optional. The number of tokens to group together when evaluating semantic similarity.", + "description": "Optional. The number of tokens to group together when evaluating semantic similarity. THIS FIELD IS NOT YET USED.", "type": "boolean" } }, diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index 16b25441c29..f24750fa6de 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -3127,7 +3127,7 @@ export namespace documentai_v1beta3 { */ export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig { /** - * Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated. + * Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated. THIS FIELD IS NOT YET USED. */ breakpointPercentileThreshold?: number | null; /** @@ -3139,7 +3139,7 @@ export namespace documentai_v1beta3 { */ includeAncestorHeadings?: boolean | null; /** - * Optional. The number of tokens to group together when evaluating semantic similarity. + * Optional. The number of tokens to group together when evaluating semantic similarity. THIS FIELD IS NOT YET USED. */ semanticChunkingGroupSize?: boolean | null; } From 4030394be85c216f6c5056c7c015609fd2dc034f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 062/144] fix(domains): update the API #### domains:v1alpha2 The following keys were changed: - schemas.GeoPolicyItem.properties.signatureRrdata.description - schemas.HealthCheckTargets.description - schemas.RRSetRoutingPolicy.properties.healthCheck.description - schemas.WrrPolicyItem.properties.signatureRrdata.description #### domains:v1beta1 The following keys were changed: - schemas.GeoPolicyItem.properties.signatureRrdata.description - schemas.HealthCheckTargets.description - schemas.RRSetRoutingPolicy.properties.healthCheck.description - schemas.WrrPolicyItem.properties.signatureRrdata.description #### domains:v1 The following keys were changed: - schemas.GeoPolicyItem.properties.signatureRrdata.description - schemas.HealthCheckTargets.description - schemas.RRSetRoutingPolicy.properties.healthCheck.description - schemas.WrrPolicyItem.properties.signatureRrdata.description --- discovery/domains-v1.json | 10 +++++----- discovery/domains-v1alpha2.json | 10 +++++----- discovery/domains-v1beta1.json | 10 +++++----- src/apis/domains/v1.ts | 8 ++++---- src/apis/domains/v1alpha2.ts | 8 ++++---- src/apis/domains/v1beta1.ts | 8 ++++---- 6 files changed, 27 insertions(+), 27 deletions(-) diff --git a/discovery/domains-v1.json b/discovery/domains-v1.json index a692133b1d5..331f60f2c27 100644 --- a/discovery/domains-v1.json +++ b/discovery/domains-v1.json @@ -965,7 +965,7 @@ } } }, - "revision": "20241209", + "revision": "20250225", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1469,7 +1469,7 @@ "type": "array" }, "signatureRrdata": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, @@ -1542,7 +1542,7 @@ "type": "object" }, "HealthCheckTargets": { - "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", + "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both.", "id": "HealthCheckTargets", "properties": { "externalEndpoints": { @@ -2028,7 +2028,7 @@ "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", + "description": "The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", "type": "string" }, "primaryBackup": { @@ -2736,7 +2736,7 @@ "type": "array" }, "signatureRrdata": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, diff --git a/discovery/domains-v1alpha2.json b/discovery/domains-v1alpha2.json index ed3d04a6d0a..9354a7729f1 100644 --- a/discovery/domains-v1alpha2.json +++ b/discovery/domains-v1alpha2.json @@ -965,7 +965,7 @@ } } }, - "revision": "20241209", + "revision": "20250225", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1469,7 +1469,7 @@ "type": "array" }, "signatureRrdata": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, @@ -1542,7 +1542,7 @@ "type": "object" }, "HealthCheckTargets": { - "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", + "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both.", "id": "HealthCheckTargets", "properties": { "externalEndpoints": { @@ -2028,7 +2028,7 @@ "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", + "description": "The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", "type": "string" }, "primaryBackup": { @@ -2751,7 +2751,7 @@ "type": "array" }, "signatureRrdata": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, diff --git a/discovery/domains-v1beta1.json b/discovery/domains-v1beta1.json index 4d88f27e176..dc87582f732 100644 --- a/discovery/domains-v1beta1.json +++ b/discovery/domains-v1beta1.json @@ -965,7 +965,7 @@ } } }, - "revision": "20241209", + "revision": "20250225", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1469,7 +1469,7 @@ "type": "array" }, "signatureRrdata": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, @@ -1542,7 +1542,7 @@ "type": "object" }, "HealthCheckTargets": { - "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", + "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both.", "id": "HealthCheckTargets", "properties": { "externalEndpoints": { @@ -2028,7 +2028,7 @@ "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", + "description": "The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", "type": "string" }, "primaryBackup": { @@ -2736,7 +2736,7 @@ "type": "array" }, "signatureRrdata": { - "description": "DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.", + "description": "DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item.", "items": { "type": "string" }, diff --git a/src/apis/domains/v1.ts b/src/apis/domains/v1.ts index eb9855220fa..d79fb0bf36a 100644 --- a/src/apis/domains/v1.ts +++ b/src/apis/domains/v1.ts @@ -435,7 +435,7 @@ export namespace domains_v1 { location?: string | null; rrdata?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdata?: string[] | null; } @@ -474,7 +474,7 @@ export namespace domains_v1 { nameServers?: string[] | null; } /** - * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. + * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. */ export interface Schema$HealthCheckTargets { /** @@ -1009,7 +1009,7 @@ export namespace domains_v1 { 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 + * The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project\}/global/healthChecks/{healthCheck\}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks */ healthCheck?: string | null; primaryBackup?: Schema$PrimaryBackupPolicy; @@ -1147,7 +1147,7 @@ export namespace domains_v1 { healthCheckedTargets?: Schema$HealthCheckTargets; rrdata?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdata?: string[] | null; /** diff --git a/src/apis/domains/v1alpha2.ts b/src/apis/domains/v1alpha2.ts index bd953baffd5..1174ea7604c 100644 --- a/src/apis/domains/v1alpha2.ts +++ b/src/apis/domains/v1alpha2.ts @@ -435,7 +435,7 @@ export namespace domains_v1alpha2 { location?: string | null; rrdata?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdata?: string[] | null; } @@ -474,7 +474,7 @@ export namespace domains_v1alpha2 { nameServers?: string[] | null; } /** - * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. + * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. */ export interface Schema$HealthCheckTargets { /** @@ -1013,7 +1013,7 @@ export namespace domains_v1alpha2 { 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 + * The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project\}/global/healthChecks/{healthCheck\}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks */ healthCheck?: string | null; primaryBackup?: Schema$PrimaryBackupPolicy; @@ -1151,7 +1151,7 @@ export namespace domains_v1alpha2 { healthCheckedTargets?: Schema$HealthCheckTargets; rrdata?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdata?: string[] | null; /** diff --git a/src/apis/domains/v1beta1.ts b/src/apis/domains/v1beta1.ts index 950ce801411..e4de7b0006f 100644 --- a/src/apis/domains/v1beta1.ts +++ b/src/apis/domains/v1beta1.ts @@ -435,7 +435,7 @@ export namespace domains_v1beta1 { location?: string | null; rrdata?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdata?: string[] | null; } @@ -474,7 +474,7 @@ export namespace domains_v1beta1 { nameServers?: string[] | null; } /** - * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. + * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either `internal_load_balancer` or `external_endpoints`. Do not set both. */ export interface Schema$HealthCheckTargets { /** @@ -1009,7 +1009,7 @@ export namespace domains_v1beta1 { 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 + * The fully qualified URL of the HealthCheck to use for this RRSetRoutingPolicy. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project\}/global/healthChecks/{healthCheck\}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks */ healthCheck?: string | null; primaryBackup?: Schema$PrimaryBackupPolicy; @@ -1147,7 +1147,7 @@ export namespace domains_v1beta1 { healthCheckedTargets?: Schema$HealthCheckTargets; rrdata?: string[] | null; /** - * DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. + * DNSSEC generated signatures for all the `rrdata` within this item. When using health-checked targets for DNSSEC-enabled zones, you can only use at most one health-checked IP address per item. */ signatureRrdata?: string[] | null; /** From b5ef47311b7ec66e02429f1097345a2899cb4013 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 063/144] feat(drive)!: update the API BREAKING CHANGE: This release has breaking changes. #### drive:v2 The following keys were added: - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.default - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.description - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.location - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.type - resources.permissions.methods.patch.parameters.enforceExpansiveAccess.default - resources.permissions.methods.patch.parameters.enforceExpansiveAccess.description - resources.permissions.methods.patch.parameters.enforceExpansiveAccess.location - resources.permissions.methods.patch.parameters.enforceExpansiveAccess.type - resources.permissions.methods.update.parameters.enforceExpansiveAccess.default - resources.permissions.methods.update.parameters.enforceExpansiveAccess.description - resources.permissions.methods.update.parameters.enforceExpansiveAccess.location - resources.permissions.methods.update.parameters.enforceExpansiveAccess.type - schemas.File.properties.capabilities.properties.canDisableInheritedPermissions.description - schemas.File.properties.capabilities.properties.canDisableInheritedPermissions.readOnly - schemas.File.properties.capabilities.properties.canDisableInheritedPermissions.type - schemas.File.properties.capabilities.properties.canEnableInheritedPermissions.description - schemas.File.properties.capabilities.properties.canEnableInheritedPermissions.readOnly - schemas.File.properties.capabilities.properties.canEnableInheritedPermissions.type - schemas.File.properties.inheritedPermissionsDisabled.description - schemas.File.properties.inheritedPermissionsDisabled.type - schemas.Permission.properties.inheritedPermissionsDisabled.description - schemas.Permission.properties.inheritedPermissionsDisabled.type The following keys were changed: - schemas.Permission.properties.permissionDetails.description - schemas.Permission.properties.permissionDetails.items.properties.inherited.description - schemas.Permission.properties.permissionDetails.items.properties.inheritedFrom.description - schemas.Permission.properties.view.description #### drive:v3 The following keys were deleted: - resources.operation.methods.cancel.description - resources.operation.methods.cancel.flatPath - resources.operation.methods.cancel.httpMethod - resources.operation.methods.cancel.id - resources.operation.methods.cancel.parameterOrder - resources.operation.methods.cancel.parameters.name.description - resources.operation.methods.cancel.parameters.name.location - resources.operation.methods.cancel.parameters.name.required - resources.operation.methods.cancel.parameters.name.type - resources.operation.methods.cancel.path - resources.operation.methods.cancel.scopes - resources.operation.methods.delete.description - resources.operation.methods.delete.flatPath - resources.operation.methods.delete.httpMethod - resources.operation.methods.delete.id - resources.operation.methods.delete.parameterOrder - resources.operation.methods.delete.parameters.name.description - resources.operation.methods.delete.parameters.name.location - resources.operation.methods.delete.parameters.name.required - resources.operation.methods.delete.parameters.name.type - resources.operation.methods.delete.path - resources.operation.methods.delete.scopes The following keys were added: - resources.operations.methods.cancel.description - resources.operations.methods.cancel.flatPath - resources.operations.methods.cancel.httpMethod - resources.operations.methods.cancel.id - resources.operations.methods.cancel.parameterOrder - resources.operations.methods.cancel.parameters.name.description - resources.operations.methods.cancel.parameters.name.location - resources.operations.methods.cancel.parameters.name.required - resources.operations.methods.cancel.parameters.name.type - resources.operations.methods.cancel.path - resources.operations.methods.cancel.scopes - resources.operations.methods.delete.description - resources.operations.methods.delete.flatPath - resources.operations.methods.delete.httpMethod - resources.operations.methods.delete.id - resources.operations.methods.delete.parameterOrder - resources.operations.methods.delete.parameters.name.description - resources.operations.methods.delete.parameters.name.location - resources.operations.methods.delete.parameters.name.required - resources.operations.methods.delete.parameters.name.type - resources.operations.methods.delete.path - resources.operations.methods.delete.scopes - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.default - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.description - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.location - resources.permissions.methods.delete.parameters.enforceExpansiveAccess.type - resources.permissions.methods.update.parameters.enforceExpansiveAccess.default - resources.permissions.methods.update.parameters.enforceExpansiveAccess.description - resources.permissions.methods.update.parameters.enforceExpansiveAccess.location - resources.permissions.methods.update.parameters.enforceExpansiveAccess.type - schemas.DownloadRestriction.description - schemas.DownloadRestriction.id - schemas.DownloadRestriction.properties.restrictedForReaders.description - schemas.DownloadRestriction.properties.restrictedForReaders.type - schemas.DownloadRestriction.properties.restrictedForWriters.description - schemas.DownloadRestriction.properties.restrictedForWriters.type - schemas.DownloadRestriction.type - schemas.Drive.properties.restrictions.properties.downloadRestriction.$ref - schemas.Drive.properties.restrictions.properties.downloadRestriction.description - schemas.File.properties.capabilities.properties.canDisableInheritedPermissions.description - schemas.File.properties.capabilities.properties.canDisableInheritedPermissions.type - schemas.File.properties.capabilities.properties.canEnableInheritedPermissions.description - schemas.File.properties.capabilities.properties.canEnableInheritedPermissions.type - schemas.File.properties.inheritedPermissionsDisabled.description - schemas.File.properties.inheritedPermissionsDisabled.type - schemas.Permission.properties.inheritedPermissionsDisabled.description - schemas.Permission.properties.inheritedPermissionsDisabled.type - schemas.TeamDrive.properties.restrictions.properties.downloadRestriction.$ref - schemas.TeamDrive.properties.restrictions.properties.downloadRestriction.description The following keys were changed: - schemas.Permission.properties.permissionDetails.description - schemas.Permission.properties.permissionDetails.items.properties.inheritedFrom.description - schemas.Permission.properties.permissionDetails.items.properties.role.description - schemas.Permission.properties.view.description --- discovery/drive-v2.json | 46 ++++++++++++++-- discovery/drive-v3.json | 81 ++++++++++++++++++++++------ src/apis/drive/v2.ts | 26 ++++++++- src/apis/drive/v3.ts | 113 +++++++++++++++++++++++++--------------- 4 files changed, 199 insertions(+), 67 deletions(-) diff --git a/discovery/drive-v2.json b/discovery/drive-v2.json index cecdd003b8a..e61ede4c1bf 100644 --- a/discovery/drive-v2.json +++ b/discovery/drive-v2.json @@ -2632,6 +2632,12 @@ "permissionId" ], "parameters": { + "enforceExpansiveAccess": { + "default": "false", + "description": "Whether the request should enforce expansive access rules.", + "location": "query", + "type": "boolean" + }, "fileId": { "description": "The ID for the file or shared drive.", "location": "path", @@ -2905,6 +2911,12 @@ "permissionId" ], "parameters": { + "enforceExpansiveAccess": { + "default": "false", + "description": "Whether the request should enforce expansive access rules.", + "location": "query", + "type": "boolean" + }, "fileId": { "description": "The ID for the file or shared drive.", "location": "path", @@ -2971,6 +2983,12 @@ "permissionId" ], "parameters": { + "enforceExpansiveAccess": { + "default": "false", + "description": "Whether the request should enforce expansive access rules.", + "location": "query", + "type": "boolean" + }, "fileId": { "description": "The ID for the file or shared drive.", "location": "path", @@ -3869,7 +3887,7 @@ } } }, - "revision": "20250122", + "revision": "20250216", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -5056,6 +5074,11 @@ "description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, + "canDisableInheritedPermissions": { + "description": "Output only. Whether a user can disable inherited permissions.", + "readOnly": true, + "type": "boolean" + }, "canDownload": { "description": "Output only. Whether the current user can download this file.", "type": "boolean" @@ -5064,6 +5087,11 @@ "description": "Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.", "type": "boolean" }, + "canEnableInheritedPermissions": { + "description": "Output only. Whether a user can re-enable inherited permissions.", + "readOnly": true, + "type": "boolean" + }, "canListChildren": { "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" @@ -5413,6 +5441,10 @@ }, "type": "object" }, + "inheritedPermissionsDisabled": { + "description": "Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.", + "type": "boolean" + }, "isAppAuthorized": { "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" @@ -6122,6 +6154,10 @@ "description": "The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.", "type": "string" }, + "inheritedPermissionsDisabled": { + "description": "When true, only organizers, owners, and users with permissions added directly on the item can access it.", + "type": "boolean" + }, "kind": { "default": "drive#permission", "description": "Output only. This is always `drive#permission`.", @@ -6136,7 +6172,7 @@ "type": "boolean" }, "permissionDetails": { - "description": "Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", + "description": "Output only. Details of whether the permissions on this item are inherited or directly on this item.", "items": { "properties": { "additionalRoles": { @@ -6147,11 +6183,11 @@ "type": "array" }, "inherited": { - "description": "Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.", + "description": "Output only. Whether this permission is inherited. This field is always populated.", "type": "boolean" }, "inheritedFrom": { - "description": "Output only. The ID of the item from which this permission is inherited. This is an output-only field.", + "description": "Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.", "type": "string" }, "permissionType": { @@ -6238,7 +6274,7 @@ "type": "string" }, "view": { - "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.", + "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. ", "type": "string" }, "withLink": { diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index 7bcfd144c76..b35abfb3be9 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -1814,13 +1814,13 @@ } } }, - "operation": { + "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": "operation/{name}:cancel", + "flatPath": "operations/{name}:cancel", "httpMethod": "POST", - "id": "drive.operation.cancel", + "id": "drive.operations.cancel", "parameterOrder": [ "name" ], @@ -1832,7 +1832,7 @@ "type": "string" } }, - "path": "operation/{name}:cancel", + "path": "operations/{name}:cancel", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", @@ -1842,9 +1842,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "operation/{name}", + "flatPath": "operations/{name}", "httpMethod": "DELETE", - "id": "drive.operation.delete", + "id": "drive.operations.delete", "parameterOrder": [ "name" ], @@ -1856,18 +1856,14 @@ "type": "string" } }, - "path": "operation/{name}", + "path": "operations/{name}", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.readonly" ] - } - } - }, - "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": "operations/{name}", @@ -2025,6 +2021,12 @@ "permissionId" ], "parameters": { + "enforceExpansiveAccess": { + "default": "false", + "description": "Whether the request should enforce expansive access rules.", + "location": "query", + "type": "boolean" + }, "fileId": { "description": "The ID of the file or shared drive.", "location": "path", @@ -2196,6 +2198,12 @@ "permissionId" ], "parameters": { + "enforceExpansiveAccess": { + "default": "false", + "description": "Whether the request should enforce expansive access rules.", + "location": "query", + "type": "boolean" + }, "fileId": { "description": "The ID of the file or shared drive.", "location": "path", @@ -2792,7 +2800,7 @@ } } }, - "revision": "20250122", + "revision": "20250220", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3429,6 +3437,21 @@ }, "type": "object" }, + "DownloadRestriction": { + "description": "A restriction for copy and download of the file.", + "id": "DownloadRestriction", + "properties": { + "restrictedForReaders": { + "description": "Whether download and copy is restricted for readers.", + "type": "boolean" + }, + "restrictedForWriters": { + "description": "Whether download and copy is restricted for writers. If true, download is also restricted for readers.", + "type": "boolean" + } + }, + "type": "object" + }, "Drive": { "description": "Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.", "id": "Drive", @@ -3593,6 +3616,10 @@ "description": "Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.", "type": "boolean" }, + "downloadRestriction": { + "$ref": "DownloadRestriction", + "description": "Download restrictions applied by shared drive managers." + }, "driveMembersOnly": { "description": "Whether access to items inside this shared drive is restricted to its members.", "type": "boolean" @@ -3693,6 +3720,10 @@ "description": "Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, + "canDisableInheritedPermissions": { + "description": "Whether a user can disable inherited permissions.", + "type": "boolean" + }, "canDownload": { "description": "Output only. Whether the current user can download this file.", "type": "boolean" @@ -3701,6 +3732,10 @@ "description": "Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.", "type": "boolean" }, + "canEnableInheritedPermissions": { + "description": "Whether a user can re-enable inherited permissions.", + "type": "boolean" + }, "canListChildren": { "description": "Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" @@ -4034,6 +4069,10 @@ }, "type": "object" }, + "inheritedPermissionsDisabled": { + "description": "Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.", + "type": "boolean" + }, "isAppAuthorized": { "description": "Output only. Whether the file was created or opened by the requesting app.", "type": "boolean" @@ -4670,6 +4709,10 @@ "description": "Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.", "type": "string" }, + "inheritedPermissionsDisabled": { + "description": "When true, only organizers, owners, and users with permissions added directly on the item can access it.", + "type": "boolean" + }, "kind": { "default": "drive#permission", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`.", @@ -4680,7 +4723,7 @@ "type": "boolean" }, "permissionDetails": { - "description": "Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", + "description": "Output only. Details of whether the permissions on this item are inherited or directly on this item.", "items": { "properties": { "inherited": { @@ -4688,7 +4731,7 @@ "type": "boolean" }, "inheritedFrom": { - "description": "Output only. The ID of the item from which this permission is inherited. This is an output-only field.", + "description": "Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.", "type": "string" }, "permissionType": { @@ -4696,7 +4739,7 @@ "type": "string" }, "role": { - "description": "Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`", + "description": "Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`", "type": "string" } }, @@ -4759,7 +4802,7 @@ "type": "string" }, "view": { - "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.", + "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. ", "type": "string" } }, @@ -5197,6 +5240,10 @@ "description": "Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.", "type": "boolean" }, + "downloadRestriction": { + "$ref": "DownloadRestriction", + "description": "Download restrictions applied by shared drive managers." + }, "sharingFoldersRequiresOrganizerPermission": { "description": "If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.", "type": "boolean" diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 31dd6aa5b67..482dfd31425 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -922,8 +922,10 @@ export namespace drive_v2 { canCopy?: boolean; canDelete?: boolean; canDeleteChildren?: boolean; + canDisableInheritedPermissions?: boolean; canDownload?: boolean; canEdit?: boolean; + canEnableInheritedPermissions?: boolean; canListChildren?: boolean; canModifyContent?: boolean; canModifyContentRestriction?: boolean; @@ -1071,6 +1073,10 @@ export namespace drive_v2 { * Indexable text attributes for the file (can only be written) */ indexableText?: {text?: string} | null; + /** + * Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. + */ + inheritedPermissionsDisabled?: boolean | null; /** * Output only. Whether the file was created or opened by the requesting app. */ @@ -1565,6 +1571,10 @@ export namespace drive_v2 { * The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. */ id?: string | null; + /** + * When true, only organizers, owners, and users with permissions added directly on the item can access it. + */ + inheritedPermissionsDisabled?: boolean | null; /** * Output only. This is always `drive#permission`. */ @@ -1578,7 +1588,7 @@ export namespace drive_v2 { */ pendingOwner?: boolean | null; /** - * Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + * Output only. Details of whether the permissions on this item are inherited or directly on this item. */ permissionDetails?: Array<{ additionalRoles?: string[]; @@ -1618,7 +1628,7 @@ export namespace drive_v2 { */ value?: string | null; /** - * Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. + * Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. */ view?: string | null; /** @@ -7639,6 +7649,10 @@ export namespace drive_v2 { export interface Params$Resource$Permissions$Delete extends StandardParameters { + /** + * Whether the request should enforce expansive access rules. + */ + enforceExpansiveAccess?: boolean; /** * The ID for the file or shared drive. */ @@ -7761,6 +7775,10 @@ export namespace drive_v2 { } export interface Params$Resource$Permissions$Patch extends StandardParameters { + /** + * Whether the request should enforce expansive access rules. + */ + enforceExpansiveAccess?: boolean; /** * The ID for the file or shared drive. */ @@ -7797,6 +7815,10 @@ export namespace drive_v2 { } export interface Params$Resource$Permissions$Update extends StandardParameters { + /** + * Whether the request should enforce expansive access rules. + */ + enforceExpansiveAccess?: boolean; /** * The ID for the file or shared drive. */ diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 26bf3830c46..c19b345348f 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -120,7 +120,6 @@ export namespace drive_v3 { comments: Resource$Comments; drives: Resource$Drives; files: Resource$Files; - operation: Resource$Operation; operations: Resource$Operations; permissions: Resource$Permissions; replies: Resource$Replies; @@ -141,7 +140,6 @@ export namespace drive_v3 { this.comments = new Resource$Comments(this.context); this.drives = new Resource$Drives(this.context); this.files = new Resource$Files(this.context); - this.operation = new Resource$Operation(this.context); this.operations = new Resource$Operations(this.context); this.permissions = new Resource$Permissions(this.context); this.replies = new Resource$Replies(this.context); @@ -620,6 +618,19 @@ export namespace drive_v3 { */ type?: string | null; } + /** + * A restriction for copy and download of the file. + */ + export interface Schema$DownloadRestriction { + /** + * Whether download and copy is restricted for readers. + */ + restrictedForReaders?: boolean | null; + /** + * Whether download and copy is restricted for writers. If true, download is also restricted for readers. + */ + restrictedForWriters?: boolean | null; + } /** * Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive. */ @@ -697,6 +708,7 @@ export namespace drive_v3 { adminManagedRestrictions?: boolean; copyRequiresWriterPermission?: boolean; domainUsersOnly?: boolean; + downloadRestriction?: Schema$DownloadRestriction; driveMembersOnly?: boolean; sharingFoldersRequiresOrganizerPermission?: boolean; } | null; @@ -746,8 +758,10 @@ export namespace drive_v3 { canCopy?: boolean; canDelete?: boolean; canDeleteChildren?: boolean; + canDisableInheritedPermissions?: boolean; canDownload?: boolean; canEdit?: boolean; + canEnableInheritedPermissions?: boolean; canListChildren?: boolean; canModifyContent?: boolean; canModifyContentRestriction?: boolean; @@ -870,6 +884,10 @@ export namespace drive_v3 { whiteBalance?: string; width?: number; } | null; + /** + * Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. + */ + inheritedPermissionsDisabled?: boolean | null; /** * Output only. Whether the file was created or opened by the requesting app. */ @@ -1335,6 +1353,10 @@ export namespace drive_v3 { * Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values. */ id?: string | null; + /** + * When true, only organizers, owners, and users with permissions added directly on the item can access it. + */ + inheritedPermissionsDisabled?: boolean | null; /** * Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. */ @@ -1344,7 +1366,7 @@ export namespace drive_v3 { */ pendingOwner?: boolean | null; /** - * Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + * Output only. Details of whether the permissions on this item are inherited or directly on this item. */ permissionDetails?: Array<{ inherited?: boolean; @@ -1374,7 +1396,7 @@ export namespace drive_v3 { */ type?: string | null; /** - * Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. + * Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders. */ view?: string | null; } @@ -1653,6 +1675,7 @@ export namespace drive_v3 { adminManagedRestrictions?: boolean; copyRequiresWriterPermission?: boolean; domainUsersOnly?: boolean; + downloadRestriction?: Schema$DownloadRestriction; sharingFoldersRequiresOrganizerPermission?: boolean; teamMembersOnly?: boolean; } | null; @@ -5548,7 +5571,7 @@ export namespace drive_v3 { requestBody?: Schema$Channel; } - export class Resource$Operation { + export class Resource$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -5563,31 +5586,31 @@ export namespace drive_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Operation$Cancel, + params: Params$Resource$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Operation$Cancel, + params?: Params$Resource$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Operation$Cancel, + params: Params$Resource$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Operation$Cancel, + params: Params$Resource$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Operation$Cancel, + params: Params$Resource$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Operation$Cancel + | Params$Resource$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5597,12 +5620,13 @@ export namespace drive_v3 { | BodyResponseCallback, callback?: BodyResponseCallback | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Operation$Cancel; + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operation$Cancel; + params = {} as Params$Resource$Operations$Cancel; options = {}; } @@ -5615,7 +5639,7 @@ export namespace drive_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/drive/v3/operation/{name}:cancel').replace( + url: (rootUrl + '/drive/v3/operations/{name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), @@ -5648,31 +5672,31 @@ export namespace drive_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Operation$Delete, + params: Params$Resource$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Operation$Delete, + params?: Params$Resource$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Operation$Delete, + params: Params$Resource$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Operation$Delete, + params: Params$Resource$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Operation$Delete, + params: Params$Resource$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Operation$Delete + | Params$Resource$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5682,12 +5706,13 @@ export namespace drive_v3 { | BodyResponseCallback, callback?: BodyResponseCallback | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Operation$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operation$Delete; + params = {} as Params$Resource$Operations$Delete; options = {}; } @@ -5700,7 +5725,7 @@ export namespace drive_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/drive/v3/operation/{name}').replace( + url: (rootUrl + '/drive/v3/operations/{name}').replace( /([^:]\/)\/+/g, '$1' ), @@ -5723,26 +5748,6 @@ export namespace drive_v3 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Operation$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Operation$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - - export class Resource$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. @@ -5924,6 +5929,20 @@ export namespace drive_v3 { } } + export interface Params$Resource$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } export interface Params$Resource$Operations$Get extends StandardParameters { /** * The name of the operation resource. @@ -6435,6 +6454,10 @@ export namespace drive_v3 { } export interface Params$Resource$Permissions$Delete extends StandardParameters { + /** + * Whether the request should enforce expansive access rules. + */ + enforceExpansiveAccess?: boolean; /** * The ID of the file or shared drive. */ @@ -6510,6 +6533,10 @@ export namespace drive_v3 { } export interface Params$Resource$Permissions$Update extends StandardParameters { + /** + * Whether the request should enforce expansive access rules. + */ + enforceExpansiveAccess?: boolean; /** * The ID of the file or shared drive. */ From d9641a32c188b4f89983dd954e75feb5d998642c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 064/144] feat(eventarc): update the API #### eventarc:v1 The following keys were added: - schemas.GoogleChannelConfig.properties.labels.additionalProperties.type - schemas.GoogleChannelConfig.properties.labels.description - schemas.GoogleChannelConfig.properties.labels.type - schemas.Pipeline.properties.etag.readOnly The following keys were changed: - resources.projects.resources.locations.methods.getGoogleChannelConfig.description - resources.projects.resources.locations.methods.updateGoogleChannelConfig.parameters.name.description - schemas.GoogleChannelConfig.properties.name.description - schemas.GoogleCloudEventarcV1PipelineDestinationHttpEndpoint.properties.uri.description - schemas.HttpEndpoint.properties.uri.description --- discovery/eventarc-v1.json | 20 ++++++++++++++------ src/apis/eventarc/v1.ts | 14 +++++++++----- 2 files changed, 23 insertions(+), 11 deletions(-) diff --git a/discovery/eventarc-v1.json b/discovery/eventarc-v1.json index 658742825b9..0f65c762920 100644 --- a/discovery/eventarc-v1.json +++ b/discovery/eventarc-v1.json @@ -135,7 +135,7 @@ ] }, "getGoogleChannelConfig": { - "description": "Get a GoogleChannelConfig", + "description": "Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleChannelConfig", "httpMethod": "GET", "id": "eventarc.projects.locations.getGoogleChannelConfig", @@ -210,7 +210,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`.", + "description": "Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/googleChannelConfig$", "required": true, @@ -2460,7 +2460,7 @@ } } }, - "revision": "20250103", + "revision": "20250307", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { @@ -2967,8 +2967,15 @@ "description": "Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels.", + "type": "object" + }, "name": { - "description": "Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`.", + "description": "Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.", "type": "string" }, "updateTime": { @@ -3069,7 +3076,7 @@ "type": "string" }, "uri": { - "description": "Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `https://svc.us-central1.p.local:8080/route`. Only the HTTPS protocol is supported.", + "description": "Required. The URI of the HTTP endpoint. The value must be a RFC2396 URI string. Examples: `https://svc.us-central1.p.local:8080/route`. Only the HTTPS protocol is supported.", "type": "string" } }, @@ -3268,7 +3275,7 @@ "id": "HttpEndpoint", "properties": { "uri": { - "description": "Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.", + "description": "Required. The URI of the HTTP endpoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.", "type": "string" } }, @@ -3734,6 +3741,7 @@ }, "etag": { "description": "Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.", + "readOnly": true, "type": "string" }, "inputPayloadFormat": { diff --git a/src/apis/eventarc/v1.ts b/src/apis/eventarc/v1.ts index a6174410d0b..084436f5c47 100644 --- a/src/apis/eventarc/v1.ts +++ b/src/apis/eventarc/v1.ts @@ -511,7 +511,11 @@ export namespace eventarc_v1 { */ cryptoKeyName?: string | null; /** - * Required. The resource name of the config. Must be in the format of, `projects/{project\}/locations/{location\}/googleChannelConfig`. + * Optional. Resource labels. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The resource name of the config. Must be in the format of, `projects/{project\}/locations/{location\}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided. */ name?: string | null; /** @@ -600,7 +604,7 @@ export namespace eventarc_v1 { */ messageBindingTemplate?: string | null; /** - * Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `https://svc.us-central1.p.local:8080/route`. Only the HTTPS protocol is supported. + * Required. The URI of the HTTP endpoint. The value must be a RFC2396 URI string. Examples: `https://svc.us-central1.p.local:8080/route`. Only the HTTPS protocol is supported. */ uri?: string | null; } @@ -751,7 +755,7 @@ export namespace eventarc_v1 { */ export interface Schema$HttpEndpoint { /** - * Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS. + * Required. The URI of the HTTP endpoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS. */ uri?: string | null; } @@ -1401,7 +1405,7 @@ export namespace eventarc_v1 { } /** - * Get a GoogleChannelConfig + * Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1712,7 +1716,7 @@ export namespace eventarc_v1 { export interface Params$Resource$Projects$Locations$Updategooglechannelconfig extends StandardParameters { /** - * Required. The resource name of the config. Must be in the format of, `projects/{project\}/locations/{location\}/googleChannelConfig`. + * Required. The resource name of the config. Must be in the format of, `projects/{project\}/locations/{location\}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided. */ name?: string; /** From 3abf6141481f7af507b42a36646757be7d0d5e53 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 065/144] feat(fcm): update the API #### fcm:v1 The following keys were added: - schemas.AndroidConfig.properties.bandwidthConstrainedOk.description - schemas.AndroidConfig.properties.bandwidthConstrainedOk.type The following keys were changed: - description - resources.projects.resources.messages.methods.send.parameters.parent.description --- discovery/fcm-v1.json | 10 +++++++--- src/apis/fcm/v1.ts | 8 ++++++-- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/discovery/fcm-v1.json b/discovery/fcm-v1.json index 2030fdf36ce..d881a923b86 100644 --- a/discovery/fcm-v1.json +++ b/discovery/fcm-v1.json @@ -15,7 +15,7 @@ "baseUrl": "https://fcm.googleapis.com/", "batchPath": "batch", "canonicalName": "Firebase Cloud Messaging", - "description": "FCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost.", + "description": "FCM send API that provides a cross-platform messaging solution to reliably deliver messages.", "discoveryVersion": "v1", "documentationLink": "https://firebase.google.com/docs/cloud-messaging", "fullyEncodeReservedExpansion": true, @@ -122,7 +122,7 @@ ], "parameters": { "parent": { - "description": "Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of `projects/{project_id}`. For legacy support, the numeric project number with no padding is also supported in the format of `projects/{project_number}`.", + "description": "Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of `projects/{project_id}`. The numeric project number with no padding is also supported in the format of `projects/{project_number}`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -146,13 +146,17 @@ } } }, - "revision": "20241112", + "revision": "20250311", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { "description": "Android specific options for messages sent through [FCM connection server](https://goo.gl/4GLdUl).", "id": "AndroidConfig", "properties": { + "bandwidthConstrainedOk": { + "description": "Optional. If set to true, messages will be allowed to be delivered to the app while the device is in bandwidth constrained mode.", + "type": "boolean" + }, "collapseKey": { "description": "An identifier of a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed. A maximum of 4 different collapse keys is allowed at any given time.", "type": "string" diff --git a/src/apis/fcm/v1.ts b/src/apis/fcm/v1.ts index 71efa5a2812..12f94284bd6 100644 --- a/src/apis/fcm/v1.ts +++ b/src/apis/fcm/v1.ts @@ -102,7 +102,7 @@ export namespace fcm_v1 { /** * Firebase Cloud Messaging API * - * FCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost. + * FCM send API that provides a cross-platform messaging solution to reliably deliver messages. * * @example * ```js @@ -128,6 +128,10 @@ export namespace fcm_v1 { * Android specific options for messages sent through [FCM connection server](https://goo.gl/4GLdUl). */ export interface Schema$AndroidConfig { + /** + * Optional. If set to true, messages will be allowed to be delivered to the app while the device is in bandwidth constrained mode. + */ + bandwidthConstrainedOk?: boolean | null; /** * An identifier of a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed. A maximum of 4 different collapse keys is allowed at any given time. */ @@ -581,7 +585,7 @@ export namespace fcm_v1 { export interface Params$Resource$Projects$Messages$Send extends StandardParameters { /** - * Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of `projects/{project_id\}`. For legacy support, the numeric project number with no padding is also supported in the format of `projects/{project_number\}`. + * Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of `projects/{project_id\}`. The numeric project number with no padding is also supported in the format of `projects/{project_number\}`. */ parent?: string; From a19ce028bb6e339d6ca5aeb366b19e4a62f9183a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 066/144] feat(file): update the API #### file:v1beta1 The following keys were added: - schemas.PromoteReplicaRequest.properties.peerInstance.description - schemas.PromoteReplicaRequest.properties.peerInstance.type The following keys were changed: - schemas.PerformanceConfig.properties.iopsPerTb.description - schemas.ReplicaConfig.properties.stateReasons.items.enum - schemas.ReplicaConfig.properties.stateReasons.items.enumDescriptions #### file:v1 The following keys were added: - schemas.PromoteReplicaRequest.properties.peerInstance.description - schemas.PromoteReplicaRequest.properties.peerInstance.type The following keys were changed: - schemas.PerformanceConfig.properties.iopsPerTb.description - schemas.ReplicaConfig.properties.stateReasons.items.enum - schemas.ReplicaConfig.properties.stateReasons.items.enumDescriptions --- discovery/file-v1.json | 17 ++++++++++++----- discovery/file-v1beta1.json | 17 ++++++++++++----- src/apis/file/v1.ts | 9 +++++++-- src/apis/file/v1beta1.ts | 9 +++++++-- 4 files changed, 38 insertions(+), 14 deletions(-) diff --git a/discovery/file-v1.json b/discovery/file-v1.json index 6c677a80c34..34f976f3a66 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -907,7 +907,7 @@ } } }, - "revision": "20250106", + "revision": "20250205", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -2035,7 +2035,7 @@ }, "iopsPerTb": { "$ref": "IOPSPerTB", - "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. 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." + "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. 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" @@ -2080,7 +2080,12 @@ "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", - "properties": {}, + "properties": { + "peerInstance": { + "description": "Optional. The resource name of the peer instance to promote, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. The peer instance is required if the operation is called on an active instance.", + "type": "string" + } + }, "type": "object" }, "ReplicaConfig": { @@ -2121,11 +2126,13 @@ "items": { "enum": [ "STATE_REASON_UNSPECIFIED", - "PEER_INSTANCE_UNREACHABLE" + "PEER_INSTANCE_UNREACHABLE", + "REMOVE_FAILED" ], "enumDescriptions": [ "Reason not specified.", - "The peer instance is unreachable." + "The peer instance is unreachable.", + "The remove replica peer instance operation failed." ], "type": "string" }, diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index 225fee228fe..f7da26ff4b4 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -1074,7 +1074,7 @@ } } }, - "revision": "20250106", + "revision": "20250205", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -2304,7 +2304,7 @@ }, "iopsPerTb": { "$ref": "IOPSPerTB", - "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. 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." + "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. 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" @@ -2349,7 +2349,12 @@ "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", - "properties": {}, + "properties": { + "peerInstance": { + "description": "Optional. The resource name of the peer instance to promote, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. The peer instance is required if the operation is called on an active instance.", + "type": "string" + } + }, "type": "object" }, "ReplicaConfig": { @@ -2388,11 +2393,13 @@ "items": { "enum": [ "STATE_REASON_UNSPECIFIED", - "PEER_INSTANCE_UNREACHABLE" + "PEER_INSTANCE_UNREACHABLE", + "REMOVE_FAILED" ], "enumDescriptions": [ "Reason not specified.", - "The peer instance is unreachable." + "The peer instance is unreachable.", + "The remove replica peer instance operation failed." ], "type": "string" }, diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 9b0b9ccbbdd..62ed744400b 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -850,7 +850,7 @@ export namespace file_v1 { */ fixedIops?: Schema$FixedIOPS; /** - * Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. 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. + * Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. 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. */ iopsPerTb?: Schema$IOPSPerTB; } @@ -882,7 +882,12 @@ export namespace file_v1 { /** * PromoteReplicaRequest promotes a Filestore standby instance (replica). */ - export interface Schema$PromoteReplicaRequest {} + export interface Schema$PromoteReplicaRequest { + /** + * Optional. The resource name of the peer instance to promote, in the format `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. The peer instance is required if the operation is called on an active instance. + */ + peerInstance?: string | null; + } /** * Replica configuration for the instance. */ diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index d6b530b1a74..7898bfabee2 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -917,7 +917,7 @@ export namespace file_v1beta1 { */ fixedIops?: Schema$FixedIOPS; /** - * Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. 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. + * Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. 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. */ iopsPerTb?: Schema$IOPSPerTB; } @@ -949,7 +949,12 @@ export namespace file_v1beta1 { /** * PromoteReplicaRequest promotes a Filestore standby instance (replica). */ - export interface Schema$PromoteReplicaRequest {} + export interface Schema$PromoteReplicaRequest { + /** + * Optional. The resource name of the peer instance to promote, in the format `projects/{project_id\}/locations/{location_id\}/instances/{instance_id\}`. The peer instance is required if the operation is called on an active instance. + */ + peerInstance?: string | null; + } /** * Replica configuration for the instance. */ From 1cabcab245e451ed59cae1f9f04cd5ae9c682eb3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 067/144] fix(firebase): update the API #### firebase:v1beta1 The following keys were changed: - schemas.StatusProto.properties.canonicalCode.description - schemas.StatusProto.properties.space.description --- discovery/firebase-v1beta1.json | 6 +++--- src/apis/firebase/v1beta1.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/discovery/firebase-v1beta1.json b/discovery/firebase-v1beta1.json index 782d6fddaff..63241f801b2 100644 --- a/discovery/firebase-v1beta1.json +++ b/discovery/firebase-v1beta1.json @@ -1324,7 +1324,7 @@ } } }, - "revision": "20250113", + "revision": "20250303", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { @@ -2152,7 +2152,7 @@ "id": "StatusProto", "properties": { "canonicalCode": { - "description": "The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", "format": "int32", "type": "integer" }, @@ -2170,7 +2170,7 @@ "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" }, "space": { - "description": "The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2;", + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", "type": "string" } }, diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index 022363976e4..bc3e5b81560 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -672,7 +672,7 @@ export namespace firebase_v1beta1 { */ export interface Schema$StatusProto { /** - * The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; */ canonicalCode?: number | null; /** @@ -688,7 +688,7 @@ export namespace firebase_v1beta1 { */ messageSet?: Schema$MessageSet; /** - * The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2; + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs */ space?: string | null; } From 20db3b52df9048ab0fbdbc8b517b6a221d82d289 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 068/144] feat(firebaseappdistribution)!: update the API BREAKING CHANGE: This release has breaking changes. #### firebaseappdistribution:v1alpha The following keys were deleted: - schemas.GoogleFirebaseAppdistroV1alphaAiInstructions.properties.appDescription.deprecated - schemas.GoogleFirebaseAppdistroV1alphaAiInstructions.properties.appDescription.description - schemas.GoogleFirebaseAppdistroV1alphaAiInstructions.properties.appDescription.type The following keys were added: - resources.projects.methods.getTestQuota.description - resources.projects.methods.getTestQuota.flatPath - resources.projects.methods.getTestQuota.httpMethod - resources.projects.methods.getTestQuota.id - resources.projects.methods.getTestQuota.parameterOrder - resources.projects.methods.getTestQuota.parameters.name.description - resources.projects.methods.getTestQuota.parameters.name.location - resources.projects.methods.getTestQuota.parameters.name.pattern - resources.projects.methods.getTestQuota.parameters.name.required - resources.projects.methods.getTestQuota.parameters.name.type - resources.projects.methods.getTestQuota.path - resources.projects.methods.getTestQuota.response.$ref - resources.projects.methods.getTestQuota.scopes - resources.projects.resources.apps.resources.testCases.methods.batchDelete.description - resources.projects.resources.apps.resources.testCases.methods.batchDelete.flatPath - resources.projects.resources.apps.resources.testCases.methods.batchDelete.httpMethod - resources.projects.resources.apps.resources.testCases.methods.batchDelete.id - resources.projects.resources.apps.resources.testCases.methods.batchDelete.parameterOrder - resources.projects.resources.apps.resources.testCases.methods.batchDelete.parameters.parent.description - resources.projects.resources.apps.resources.testCases.methods.batchDelete.parameters.parent.location - resources.projects.resources.apps.resources.testCases.methods.batchDelete.parameters.parent.pattern - resources.projects.resources.apps.resources.testCases.methods.batchDelete.parameters.parent.required - resources.projects.resources.apps.resources.testCases.methods.batchDelete.parameters.parent.type - resources.projects.resources.apps.resources.testCases.methods.batchDelete.path - resources.projects.resources.apps.resources.testCases.methods.batchDelete.request.$ref - resources.projects.resources.apps.resources.testCases.methods.batchDelete.response.$ref - resources.projects.resources.apps.resources.testCases.methods.batchDelete.scopes - schemas.GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest.description - schemas.GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest.id - schemas.GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest.properties.names.description - schemas.GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest.properties.names.items.type - schemas.GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest.properties.names.type - schemas.GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest.type - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.description - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.id - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.limit.description - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.limit.format - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.limit.readOnly - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.limit.type - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.name.description - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.name.type - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.usage.description - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.usage.format - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.usage.readOnly - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.properties.usage.type - schemas.GoogleFirebaseAppdistroV1alphaTestQuota.type The following keys were changed: - schemas.GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse.properties.errorCode.enum - schemas.GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse.properties.errorCode.enumDescriptions - schemas.GoogleFirebaseAppdistroV1alphaTerminalAction.properties.reason.enumDescriptions --- .../firebaseappdistribution-v1alpha.json | 107 +++++++- src/apis/firebaseappdistribution/v1alpha.ts | 239 +++++++++++++++++- 2 files changed, 333 insertions(+), 13 deletions(-) diff --git a/discovery/firebaseappdistribution-v1alpha.json b/discovery/firebaseappdistribution-v1alpha.json index 5d05ff90b43..bc6b1c39319 100644 --- a/discovery/firebaseappdistribution-v1alpha.json +++ b/discovery/firebaseappdistribution-v1alpha.json @@ -380,6 +380,33 @@ } }, "projects": { + "methods": { + "getTestQuota": { + "description": "Get information about the quota for `ReleaseTests`.", + "flatPath": "v1alpha/projects/{projectsId}/testQuota", + "httpMethod": "GET", + "id": "firebaseappdistribution.projects.getTestQuota", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `TestQuota` resource to retrieve. Format: `projects/{project_number}/testQuota`", + "location": "path", + "pattern": "^projects/[^/]+/testQuota$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleFirebaseAppdistroV1alphaTestQuota" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "apps": { "methods": { @@ -588,6 +615,34 @@ }, "testCases": { "methods": { + "batchDelete": { + "description": "Delete test cases.", + "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases:batchDelete", + "httpMethod": "POST", + "id": "firebaseappdistribution.projects.apps.testCases.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where these test cases will be deleted. Format: `projects/{project_number}/apps/{app_id}`", + "location": "path", + "pattern": "^projects/[^/]+/apps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/testCases:batchDelete", + "request": { + "$ref": "GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Create a new test case.", "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases", @@ -776,7 +831,7 @@ } } }, - "revision": "20250123", + "revision": "20250314", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -907,11 +962,6 @@ "description": "Instructions for AI driven test", "id": "GoogleFirebaseAppdistroV1alphaAiInstructions", "properties": { - "appDescription": { - "deprecated": true, - "description": "Optional. Describes the app to give the AI some context", - "type": "string" - }, "steps": { "description": "Required. Steps to be accomplished by the AI", "items": { @@ -1079,6 +1129,20 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest": { + "description": "The request message for `DeleteTestCase`.", + "id": "GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest", + "properties": { + "names": { + "description": "Required. The name of the test cases to delete. A maximum number of 1000 test cases can be deleted in one batch Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse": { "description": "The (empty) response message for `CancelReleaseTest`.", "id": "GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse", @@ -1402,7 +1466,8 @@ "APP_NAME_TOO_LONG", "AAB_DEVELOPER_ACCOUNT_NOT_LINKED", "AAB_NO_APP_WITH_GIVEN_PACKAGE_NAME_IN_ACCOUNT", - "AAB_UPLOAD_ERROR" + "AAB_UPLOAD_ERROR", + "APP_NOT_FOUND" ], "enumDescriptions": [ "", @@ -1426,7 +1491,8 @@ "", "", "", - "" + "", + "Happens if the Firebase app no longer exists by the time of extraction" ], "type": "string" }, @@ -1819,7 +1885,7 @@ ], "enumDescriptions": [ "Reason unspecified.", - "The goal was impossible to accomplish.", + "The goal failed to be completed. Note that \"impossible\" is a legacy term and the goal is reported to the customer as having \"failed\".", "The goal was completed successfully." ], "readOnly": true, @@ -1907,6 +1973,29 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaTestQuota": { + "description": "Customer quota information for `ReleaseTests`. Note: This quota only applies to tests with `AiInstructions` and is separate from the quota which might apply to the device time used by any tests.", + "id": "GoogleFirebaseAppdistroV1alphaTestQuota", + "properties": { + "limit": { + "description": "Output only. Maximum number of `ReleaseTests` allotted for the current month.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the `TestQuota` resource. Format: `projects/{project_number}/testQuota`", + "type": "string" + }, + "usage": { + "description": "Output only. Number of `ReleaseTests` run in the current month", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaTesterUdid": { "description": "The UDIDs of a tester's iOS device", "id": "GoogleFirebaseAppdistroV1alphaTesterUdid", diff --git a/src/apis/firebaseappdistribution/v1alpha.ts b/src/apis/firebaseappdistribution/v1alpha.ts index 87f5f8f856e..52bc8e891b3 100644 --- a/src/apis/firebaseappdistribution/v1alpha.ts +++ b/src/apis/firebaseappdistribution/v1alpha.ts @@ -154,10 +154,6 @@ export namespace firebaseappdistribution_v1alpha { * Instructions for AI driven test */ export interface Schema$GoogleFirebaseAppdistroV1alphaAiInstructions { - /** - * Optional. Describes the app to give the AI some context - */ - appDescription?: string | null; /** * Required. Steps to be accomplished by the AI */ @@ -268,6 +264,15 @@ export namespace firebaseappdistribution_v1alpha { */ screenshot?: Schema$GoogleFirebaseAppdistroV1alphaScreenshot; } + /** + * The request message for `DeleteTestCase`. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest { + /** + * Required. The name of the test cases to delete. A maximum number of 1000 test cases can be deleted in one batch Format: `projects/{project_number\}/apps/{app_id\}/testCases/{test_case_id\}` + */ + names?: string[] | null; + } /** * The (empty) response message for `CancelReleaseTest`. */ @@ -817,6 +822,23 @@ export namespace firebaseappdistribution_v1alpha { */ udid?: string | null; } + /** + * Customer quota information for `ReleaseTests`. Note: This quota only applies to tests with `AiInstructions` and is separate from the quota which might apply to the device time used by any tests. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaTestQuota { + /** + * Output only. Maximum number of `ReleaseTests` allotted for the current month. + */ + limit?: string | null; + /** + * Identifier. The name of the `TestQuota` resource. Format: `projects/{project_number\}/testQuota` + */ + name?: string | null; + /** + * Output only. Number of `ReleaseTests` run in the current month + */ + usage?: string | null; + } /** * A release of a Firebase app. */ @@ -1821,6 +1843,109 @@ export namespace firebaseappdistribution_v1alpha { this.apps = new Resource$Projects$Apps(this.context); this.testers = new Resource$Projects$Testers(this.context); } + + /** + * Get information about the quota for `ReleaseTests`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getTestQuota( + params: Params$Resource$Projects$Gettestquota, + options: StreamMethodOptions + ): GaxiosPromise; + getTestQuota( + params?: Params$Resource$Projects$Gettestquota, + options?: MethodOptions + ): GaxiosPromise; + getTestQuota( + params: Params$Resource$Projects$Gettestquota, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getTestQuota( + params: Params$Resource$Projects$Gettestquota, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getTestQuota( + params: Params$Resource$Projects$Gettestquota, + callback: BodyResponseCallback + ): void; + getTestQuota( + callback: BodyResponseCallback + ): void; + getTestQuota( + paramsOrCallback?: + | Params$Resource$Projects$Gettestquota + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Gettestquota; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Gettestquota; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappdistribution.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 interface Params$Resource$Projects$Gettestquota + extends StandardParameters { + /** + * Required. The name of the `TestQuota` resource to retrieve. Format: `projects/{project_number\}/testQuota` + */ + name?: string; } export class Resource$Projects$Apps { @@ -2509,6 +2634,100 @@ export namespace firebaseappdistribution_v1alpha { this.context = context; } + /** + * Delete test cases. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Projects$Apps$Testcases$Batchdelete, + options: StreamMethodOptions + ): GaxiosPromise; + batchDelete( + params?: Params$Resource$Projects$Apps$Testcases$Batchdelete, + options?: MethodOptions + ): GaxiosPromise; + batchDelete( + params: Params$Resource$Projects$Apps$Testcases$Batchdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Apps$Testcases$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Projects$Apps$Testcases$Batchdelete, + callback: BodyResponseCallback + ): void; + batchDelete( + callback: BodyResponseCallback + ): void; + batchDelete( + paramsOrCallback?: + | Params$Resource$Projects$Apps$Testcases$Batchdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Apps$Testcases$Batchdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Apps$Testcases$Batchdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappdistribution.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/testCases: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); + } + } + /** * Create a new test case. * @@ -2985,6 +3204,18 @@ export namespace firebaseappdistribution_v1alpha { } } + export interface Params$Resource$Projects$Apps$Testcases$Batchdelete + extends StandardParameters { + /** + * Required. The parent resource where these test cases will be deleted. Format: `projects/{project_number\}/apps/{app_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirebaseAppdistroV1alphaBatchDeleteTestCasesRequest; + } export interface Params$Resource$Projects$Apps$Testcases$Create extends StandardParameters { /** From 1fcb03759ac0302be7b18c0a2dfee0bebeeebec9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 069/144] feat(firebaseml)!: update the API BREAKING CHANGE: This release has breaking changes. #### firebaseml:v2beta The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.thinkingConfig.$ref - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.thinkingConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig.id - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig.properties.includeThoughts.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig.properties.includeThoughts.type - schemas.GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig.type The following keys were added: - schemas.GoogleCloudAiplatformV1beta1EnterpriseWebSearch.description - schemas.GoogleCloudAiplatformV1beta1EnterpriseWebSearch.id - schemas.GoogleCloudAiplatformV1beta1EnterpriseWebSearch.type - schemas.GoogleCloudAiplatformV1beta1FunctionCall.properties.id.description - schemas.GoogleCloudAiplatformV1beta1FunctionCall.properties.id.type - schemas.GoogleCloudAiplatformV1beta1FunctionResponse.properties.id.description - schemas.GoogleCloudAiplatformV1beta1FunctionResponse.properties.id.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.format - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.thoughtsTokenCount.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.format - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokenCount.type - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.description - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.items.$ref - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.readOnly - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.toolUsePromptTokensDetails.type - schemas.GoogleCloudAiplatformV1beta1GroundingChunkWeb.properties.domain.description - schemas.GoogleCloudAiplatformV1beta1GroundingChunkWeb.properties.domain.type - schemas.GoogleCloudAiplatformV1beta1Tool.properties.enterpriseWebSearch.$ref - schemas.GoogleCloudAiplatformV1beta1Tool.properties.enterpriseWebSearch.description - schemas.GoogleCloudAiplatformV1beta1VertexAISearch.properties.engine.description - schemas.GoogleCloudAiplatformV1beta1VertexAISearch.properties.engine.type The following keys were changed: - schemas.GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata.properties.totalTokenCount.description - schemas.GoogleCloudAiplatformV1beta1Tool.properties.codeExecution.description - schemas.GoogleCloudAiplatformV1beta1VertexAISearch.description - schemas.GoogleCloudAiplatformV1beta1VertexAISearch.properties.datastore.description --- discovery/firebaseml-v2beta.json | 71 +++++++++++++++++++++++--------- src/apis/firebaseml/v2beta.ts | 57 +++++++++++++++++-------- 2 files changed, 91 insertions(+), 37 deletions(-) diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index 8680cf381b8..609e6f68518 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20250122", + "revision": "20250312", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -520,6 +520,12 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EnterpriseWebSearch": { + "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", + "id": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ExecutableCode": { "description": "Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [FunctionDeclaration] tool and [FunctionCallingConfig] mode is set to [Mode.CODE].", "id": "GoogleCloudAiplatformV1beta1ExecutableCode", @@ -574,6 +580,10 @@ "description": "Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", "type": "object" }, + "id": { + "description": "Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.", + "type": "string" + }, "name": { "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].", "type": "string" @@ -638,6 +648,10 @@ "description": "The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.", "id": "GoogleCloudAiplatformV1beta1FunctionResponse", "properties": { + "id": { + "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.", + "type": "string" + }, "name": { "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].", "type": "string" @@ -827,8 +841,28 @@ "readOnly": true, "type": "array" }, + "thoughtsTokenCount": { + "description": "Output only. Number of tokens present in thoughts output.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokenCount": { + "description": "Output only. Number of tokens present in tool-use prompt(s).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokensDetails": { + "description": "Output only. List of modalities that were processed for tool-use request inputs.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, "totalTokenCount": { - "description": "Total token count for prompt and response candidates.", + "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", "format": "int32", "type": "integer" } @@ -940,10 +974,6 @@ "format": "float", "type": "number" }, - "thinkingConfig": { - "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", - "description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." - }, "topK": { "description": "Optional. If specified, top-k sampling will be used.", "format": "float", @@ -1006,17 +1036,6 @@ }, "type": "object" }, - "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { - "description": "Config for thinking features.", - "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", - "properties": { - "includeThoughts": { - "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", - "type": "boolean" - } - }, - "type": "object" - }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", @@ -1066,6 +1085,10 @@ "description": "Chunk from the web.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", "properties": { + "domain": { + "description": "Domain of the (original) URI.", + "type": "string" + }, "title": { "description": "Title of the chunk.", "type": "string" @@ -1775,7 +1798,11 @@ "properties": { "codeExecution": { "$ref": "GoogleCloudAiplatformV1beta1ToolCodeExecution", - "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services." + "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." + }, + "enterpriseWebSearch": { + "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", + "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, "functionDeclarations": { "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.", @@ -1827,11 +1854,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VertexAISearch": { - "description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder", + "description": "Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder", "id": "GoogleCloudAiplatformV1beta1VertexAISearch", "properties": { "datastore": { - "description": "Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "type": "string" + }, + "engine": { + "description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" } }, diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index c98385f3196..a6f23039bed 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -322,6 +322,10 @@ export namespace firebaseml_v2beta { */ mode?: string | null; } + /** + * Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. + */ + export interface Schema$GoogleCloudAiplatformV1beta1EnterpriseWebSearch {} /** * Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [FunctionDeclaration] tool and [FunctionCallingConfig] mode is set to [Mode.CODE]. */ @@ -360,6 +364,10 @@ export namespace firebaseml_v2beta { * Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. */ args?: {[key: string]: any} | null; + /** + * Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + */ + id?: string | null; /** * Required. The name of the function to call. Matches [FunctionDeclaration.name]. */ @@ -403,6 +411,10 @@ export namespace firebaseml_v2beta { * The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. */ export interface Schema$GoogleCloudAiplatformV1beta1FunctionResponse { + /** + * Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + */ + id?: string | null; /** * Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. */ @@ -524,7 +536,19 @@ export namespace firebaseml_v2beta { */ promptTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; /** - * Total token count for prompt and response candidates. + * Output only. Number of tokens present in thoughts output. + */ + thoughtsTokenCount?: number | null; + /** + * Output only. Number of tokens present in tool-use prompt(s). + */ + toolUsePromptTokenCount?: number | null; + /** + * Output only. List of modalities that were processed for tool-use request inputs. + */ + toolUsePromptTokensDetails?: Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount[]; + /** + * Total token count for prompt, response candidates, and tool-use prompts (if present). */ totalTokenCount?: number | null; } @@ -596,10 +620,6 @@ export namespace firebaseml_v2beta { * Optional. Controls the randomness of predictions. */ temperature?: number | null; - /** - * Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - */ - thinkingConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig; /** * Optional. If specified, top-k sampling will be used. */ @@ -640,15 +660,6 @@ export namespace firebaseml_v2beta { */ modelName?: string | null; } - /** - * Config for thinking features. - */ - export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig { - /** - * Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - */ - includeThoughts?: boolean | null; - } /** * Tool to retrieve public web data for grounding, powered by Google. */ @@ -692,6 +703,10 @@ export namespace firebaseml_v2beta { * Chunk from the web. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkWeb { + /** + * Domain of the (original) URI. + */ + domain?: string | null; /** * Title of the chunk. */ @@ -1155,9 +1170,13 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1Tool { /** - * Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services. + * Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */ codeExecution?: Schema$GoogleCloudAiplatformV1beta1ToolCodeExecution; + /** + * Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + */ + enterpriseWebSearch?: Schema$GoogleCloudAiplatformV1beta1EnterpriseWebSearch; /** * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. */ @@ -1197,13 +1216,17 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1ToolGoogleSearch {} /** - * Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder + * Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */ export interface Schema$GoogleCloudAiplatformV1beta1VertexAISearch { /** - * Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` + * Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` */ datastore?: string | null; + /** + * Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + engine?: string | null; } /** * Retrieve from Vertex RAG Store for grounding. From 1550a14856edabf4e39cef32600c3092d59d7157 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:45 +0000 Subject: [PATCH 070/144] feat(firestore)!: update the API BREAKING CHANGE: This release has breaking changes. #### firestore:v1beta1 The following keys were changed: - schemas.FindNearest.properties.distanceThreshold.description - schemas.Target.properties.targetId.description #### firestore:v1 The following keys were deleted: - schemas.GoogleFirestoreAdminV1Index.properties.density.description - schemas.GoogleFirestoreAdminV1Index.properties.density.enum - schemas.GoogleFirestoreAdminV1Index.properties.density.enumDescriptions - schemas.GoogleFirestoreAdminV1Index.properties.density.type - schemas.GoogleFirestoreAdminV1Index.properties.multikey.description - schemas.GoogleFirestoreAdminV1Index.properties.multikey.type The following keys were changed: - schemas.FindNearest.properties.distanceThreshold.description - schemas.GoogleFirestoreAdminV1Index.properties.apiScope.enum - schemas.GoogleFirestoreAdminV1Index.properties.apiScope.enumDescriptions - schemas.Target.properties.targetId.description --- discovery/firestore-v1.json | 32 +++++--------------------------- discovery/firestore-v1beta1.json | 6 +++--- src/apis/firestore/v1.ts | 12 ++---------- src/apis/firestore/v1beta1.ts | 4 ++-- 4 files changed, 12 insertions(+), 42 deletions(-) diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index 079e1cab25f..c495b88a7a3 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1711,7 +1711,7 @@ } } }, - "revision": "20250120", + "revision": "20250307", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2417,7 +2417,7 @@ "type": "string" }, "distanceThreshold": { - "description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold", + "description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold` * For DOT_PRODUCT: `WHERE distance >= distance_threshold`", "format": "double", "type": "number" }, @@ -3150,29 +3150,11 @@ "description": "The API scope supported by this index.", "enum": [ "ANY_API", - "DATASTORE_MODE_API", - "IGNITE_API" + "DATASTORE_MODE_API" ], "enumDescriptions": [ "The index can only be used by the Firestore Native query API. This is the default.", - "The index can only be used by the Firestore in Datastore Mode query API.", - "The index can only be used by Ignite." - ], - "type": "string" - }, - "density": { - "description": "Immutable. The density configuration of the index.", - "enum": [ - "DENSITY_UNSPECIFIED", - "SPARSE_ALL", - "SPARSE_ANY", - "DENSE" - ], - "enumDescriptions": [ - "Unspecified. It will use database default setting. This value is input only.", - "In order for an index entry to be added, the document must contain all fields specified in the index. This is the only allowed value for indexes having ApiScope `ANY_API` and `DATASTORE_MODE_API`.", - "In order for an index entry to be added, the document must contain at least one of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.", - "An index entry will be added regardless of whether the document contains any of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries." + "The index can only be used by the Firestore in Datastore Mode query API." ], "type": "string" }, @@ -3183,10 +3165,6 @@ }, "type": "array" }, - "multikey": { - "description": "Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.", - "type": "boolean" - }, "name": { "description": "Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.", "type": "string" @@ -4379,7 +4357,7 @@ "type": "string" }, "targetId": { - "description": "The target ID that identifies the target on the stream. Must be a positive number and non-zero. If `target_id` is 0 (or unspecified), the server will assign an ID for this target and return that in a `TargetChange::ADD` event. Once a target with `target_id=0` is added, all subsequent targets must also have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to the server after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without an ID, the order of IDs returned in `TargetChage.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the same ID.", + "description": "The target ID that identifies the target on the stream. Must be a positive number and non-zero. If `target_id` is 0 (or unspecified), the server will assign an ID for this target and return that in a `TargetChange::ADD` event. Once a target with `target_id=0` is added, all subsequent targets must also have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to the server after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without an ID, the order of IDs returned in `TargetChange.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the same ID.", "format": "int32", "type": "integer" } diff --git a/discovery/firestore-v1beta1.json b/discovery/firestore-v1beta1.json index 475eed53999..f0bec0d6fe9 100644 --- a/discovery/firestore-v1beta1.json +++ b/discovery/firestore-v1beta1.json @@ -950,7 +950,7 @@ } } }, - "revision": "20241018", + "revision": "20250307", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1656,7 +1656,7 @@ "type": "string" }, "distanceThreshold": { - "description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold", + "description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold` * For DOT_PRODUCT: `WHERE distance >= distance_threshold`", "format": "double", "type": "number" }, @@ -2747,7 +2747,7 @@ "type": "string" }, "targetId": { - "description": "The target ID that identifies the target on the stream. Must be a positive number and non-zero. If `target_id` is 0 (or unspecified), the server will assign an ID for this target and return that in a `TargetChange::ADD` event. Once a target with `target_id=0` is added, all subsequent targets must also have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to the server after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without an ID, the order of IDs returned in `TargetChage.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the same ID.", + "description": "The target ID that identifies the target on the stream. Must be a positive number and non-zero. If `target_id` is 0 (or unspecified), the server will assign an ID for this target and return that in a `TargetChange::ADD` event. Once a target with `target_id=0` is added, all subsequent targets must also have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to the server after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without an ID, the order of IDs returned in `TargetChange.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the same ID.", "format": "int32", "type": "integer" } diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 993925a06aa..7343e1d32fa 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -618,7 +618,7 @@ export namespace firestore_v1 { */ distanceResultField?: string | null; /** - * Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance \>= distance_threshold + * Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold` * For DOT_PRODUCT: `WHERE distance \>= distance_threshold` */ distanceThreshold?: number | null; /** @@ -1078,18 +1078,10 @@ export namespace firestore_v1 { * The API scope supported by this index. */ apiScope?: string | null; - /** - * Immutable. The density configuration of the index. - */ - density?: string | null; /** * The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. */ fields?: Schema$GoogleFirestoreAdminV1IndexField[]; - /** - * Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope. - */ - multikey?: boolean | null; /** * Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/indexes/{composite_index_id\}` For single field indexes, this field will be empty. */ @@ -1907,7 +1899,7 @@ export namespace firestore_v1 { */ resumeToken?: string | null; /** - * The target ID that identifies the target on the stream. Must be a positive number and non-zero. If `target_id` is 0 (or unspecified), the server will assign an ID for this target and return that in a `TargetChange::ADD` event. Once a target with `target_id=0` is added, all subsequent targets must also have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to the server after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without an ID, the order of IDs returned in `TargetChage.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the same ID. + * The target ID that identifies the target on the stream. Must be a positive number and non-zero. If `target_id` is 0 (or unspecified), the server will assign an ID for this target and return that in a `TargetChange::ADD` event. Once a target with `target_id=0` is added, all subsequent targets must also have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to the server after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without an ID, the order of IDs returned in `TargetChange.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the same ID. */ targetId?: number | null; } diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index baa074c79e1..d388c8ed7ac 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -618,7 +618,7 @@ export namespace firestore_v1beta1 { */ distanceResultField?: string | null; /** - * Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance \>= distance_threshold + * Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold` * For DOT_PRODUCT: `WHERE distance \>= distance_threshold` */ distanceThreshold?: number | null; /** @@ -1382,7 +1382,7 @@ export namespace firestore_v1beta1 { */ resumeToken?: string | null; /** - * The target ID that identifies the target on the stream. Must be a positive number and non-zero. If `target_id` is 0 (or unspecified), the server will assign an ID for this target and return that in a `TargetChange::ADD` event. Once a target with `target_id=0` is added, all subsequent targets must also have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to the server after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without an ID, the order of IDs returned in `TargetChage.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the same ID. + * The target ID that identifies the target on the stream. Must be a positive number and non-zero. If `target_id` is 0 (or unspecified), the server will assign an ID for this target and return that in a `TargetChange::ADD` event. Once a target with `target_id=0` is added, all subsequent targets must also have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to the server after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without an ID, the order of IDs returned in `TargetChange.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the same ID. */ targetId?: number | null; } From 8c73626132b8f3179bf49326c9a7e9efdb0ee82e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 071/144] feat(forms): update the API #### forms:v1 The following keys were added: - resources.forms.methods.create.parameters.unpublished.description - resources.forms.methods.create.parameters.unpublished.location - resources.forms.methods.create.parameters.unpublished.type - resources.forms.methods.setPublishSettings.description - resources.forms.methods.setPublishSettings.flatPath - resources.forms.methods.setPublishSettings.httpMethod - resources.forms.methods.setPublishSettings.id - resources.forms.methods.setPublishSettings.parameterOrder - resources.forms.methods.setPublishSettings.parameters.formId.description - resources.forms.methods.setPublishSettings.parameters.formId.location - resources.forms.methods.setPublishSettings.parameters.formId.required - resources.forms.methods.setPublishSettings.parameters.formId.type - resources.forms.methods.setPublishSettings.path - resources.forms.methods.setPublishSettings.request.$ref - resources.forms.methods.setPublishSettings.response.$ref - resources.forms.methods.setPublishSettings.scopes - schemas.Form.properties.publishSettings.$ref - schemas.Form.properties.publishSettings.description - schemas.Form.properties.publishSettings.readOnly - schemas.FormSettings.properties.emailCollectionType.description - schemas.FormSettings.properties.emailCollectionType.enum - schemas.FormSettings.properties.emailCollectionType.enumDescriptions - schemas.FormSettings.properties.emailCollectionType.type - schemas.PublishSettings.description - schemas.PublishSettings.id - schemas.PublishSettings.properties.publishState.$ref - schemas.PublishSettings.properties.publishState.description - schemas.PublishSettings.type - schemas.PublishState.description - schemas.PublishState.id - schemas.PublishState.properties.isAcceptingResponses.description - schemas.PublishState.properties.isAcceptingResponses.type - schemas.PublishState.properties.isPublished.description - schemas.PublishState.properties.isPublished.type - schemas.PublishState.type - schemas.SetPublishSettingsRequest.description - schemas.SetPublishSettingsRequest.id - schemas.SetPublishSettingsRequest.properties.publishSettings.$ref - schemas.SetPublishSettingsRequest.properties.publishSettings.description - schemas.SetPublishSettingsRequest.properties.updateMask.description - schemas.SetPublishSettingsRequest.properties.updateMask.format - schemas.SetPublishSettingsRequest.properties.updateMask.type - schemas.SetPublishSettingsRequest.type - schemas.SetPublishSettingsResponse.description - schemas.SetPublishSettingsResponse.id - schemas.SetPublishSettingsResponse.properties.formId.description - schemas.SetPublishSettingsResponse.properties.formId.type - schemas.SetPublishSettingsResponse.properties.publishSettings.$ref - schemas.SetPublishSettingsResponse.properties.publishSettings.description - schemas.SetPublishSettingsResponse.type The following keys were changed: - documentationLink --- discovery/forms-v1.json | 119 +++++++++++++++++++++++++++- src/apis/forms/v1.ts | 168 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 284 insertions(+), 3 deletions(-) diff --git a/discovery/forms-v1.json b/discovery/forms-v1.json index c218c16f429..6d89209c289 100644 --- a/discovery/forms-v1.json +++ b/discovery/forms-v1.json @@ -29,7 +29,7 @@ "canonicalName": "Forms", "description": "Reads and writes Google Forms and responses.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/forms/api", + "documentationLink": "https://developers.google.com/workspace/forms/api", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -157,7 +157,13 @@ "httpMethod": "POST", "id": "forms.forms.create", "parameterOrder": [], - "parameters": {}, + "parameters": { + "unpublished": { + "description": "Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses.", + "location": "query", + "type": "boolean" + } + }, "path": "v1/forms", "request": { "$ref": "Form" @@ -198,6 +204,35 @@ "https://www.googleapis.com/auth/forms.body", "https://www.googleapis.com/auth/forms.body.readonly" ] + }, + "setPublishSettings": { + "description": "Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field.", + "flatPath": "v1/forms/{formId}:setPublishSettings", + "httpMethod": "POST", + "id": "forms.forms.setPublishSettings", + "parameterOrder": [ + "formId" + ], + "parameters": { + "formId": { + "description": "Required. The ID of the form. You can get the id from `Form.form_id` field.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/forms/{formId}:setPublishSettings", + "request": { + "$ref": "SetPublishSettingsRequest" + }, + "response": { + "$ref": "SetPublishSettingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/forms.body" + ] } }, "resources": { @@ -423,7 +458,7 @@ } } }, - "revision": "20241112", + "revision": "20250304", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { @@ -794,6 +829,11 @@ "readOnly": true, "type": "string" }, + "publishSettings": { + "$ref": "PublishSettings", + "description": "Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.", + "readOnly": true + }, "responderUri": { "description": "Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions.", "readOnly": true, @@ -863,6 +903,22 @@ "description": "A form's settings.", "id": "FormSettings", "properties": { + "emailCollectionType": { + "description": "Optional. The setting that determines whether the form collects email addresses from respondents.", + "enum": [ + "EMAIL_COLLECTION_TYPE_UNSPECIFIED", + "DO_NOT_COLLECT", + "VERIFIED", + "RESPONDER_INPUT" + ], + "enumDescriptions": [ + "Unspecified. This value is unused.", + "The form doesn't collect email addresses. Default value if the form owner uses a Google account.", + "The form collects email addresses automatically based on the account of the signed-in user. Default value if the form owner uses a Google Workspace account.", + "The form collects email addresses using a field that the respondent completes on the form." + ], + "type": "string" + }, "quizSettings": { "$ref": "QuizSettings", "description": "Settings related to quiz forms and grading." @@ -1166,6 +1222,32 @@ "properties": {}, "type": "object" }, + "PublishSettings": { + "description": "The publishing settings of a form.", + "id": "PublishSettings", + "properties": { + "publishState": { + "$ref": "PublishState", + "description": "Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn't supported and returns an error." + } + }, + "type": "object" + }, + "PublishState": { + "description": "The publishing state of a form.", + "id": "PublishState", + "properties": { + "isAcceptingResponses": { + "description": "Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.", + "type": "boolean" + }, + "isPublished": { + "description": "Required. Whether the form is published and visible to others.", + "type": "boolean" + } + }, + "type": "object" + }, "Question": { "description": "Any question. The specific type of question is known by its `kind`.", "id": "Question", @@ -1377,6 +1459,37 @@ }, "type": "object" }, + "SetPublishSettingsRequest": { + "description": "Updates the publish settings of a Form.", + "id": "SetPublishSettingsRequest", + "properties": { + "publishSettings": { + "$ref": "PublishSettings", + "description": "Required. The desired publish settings to apply to the form." + }, + "updateMask": { + "description": "Optional. The `publish_settings` fields to update. This field mask accepts the following values: * `publish_state`: Updates or replaces all `publish_state` settings. * `\"*\"`: Updates or replaces all `publish_settings` fields.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "SetPublishSettingsResponse": { + "description": "The response of a `SetPublishSettings` request.", + "id": "SetPublishSettingsResponse", + "properties": { + "formId": { + "description": "Required. The ID of the Form. This is same as the `Form.form_id` field.", + "type": "string" + }, + "publishSettings": { + "$ref": "PublishSettings", + "description": "The publish settings of the form." + } + }, + "type": "object" + }, "TextAnswer": { "description": "An answer to a question represented as text.", "id": "TextAnswer", diff --git a/src/apis/forms/v1.ts b/src/apis/forms/v1.ts index bb96594a8c4..1e6e7e3c378 100644 --- a/src/apis/forms/v1.ts +++ b/src/apis/forms/v1.ts @@ -381,6 +381,10 @@ export namespace forms_v1 { * Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists). */ linkedSheetId?: string | null; + /** + * Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form. + */ + publishSettings?: Schema$PublishSettings; /** * Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. */ @@ -431,6 +435,10 @@ export namespace forms_v1 { * A form's settings. */ export interface Schema$FormSettings { + /** + * Optional. The setting that determines whether the form collects email addresses from respondents. + */ + emailCollectionType?: string | null; /** * Settings related to quiz forms and grading. */ @@ -665,6 +673,28 @@ export namespace forms_v1 { * A page break. The title and description of this item are shown at the top of the new page. */ export interface Schema$PageBreakItem {} + /** + * The publishing settings of a form. + */ + export interface Schema$PublishSettings { + /** + * Optional. The publishing state of a form. When updating `publish_state`, both `is_published` and `is_accepting_responses` must be set. However, setting `is_accepting_responses` to `true` and `is_published` to `false` isn't supported and returns an error. + */ + publishState?: Schema$PublishState; + } + /** + * The publishing state of a form. + */ + export interface Schema$PublishState { + /** + * Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`. + */ + isAcceptingResponses?: boolean | null; + /** + * Required. Whether the form is published and visible to others. + */ + isPublished?: boolean | null; + } /** * Any question. The specific type of question is known by its `kind`. */ @@ -838,6 +868,32 @@ export namespace forms_v1 { */ lowLabel?: string | null; } + /** + * Updates the publish settings of a Form. + */ + export interface Schema$SetPublishSettingsRequest { + /** + * Required. The desired publish settings to apply to the form. + */ + publishSettings?: Schema$PublishSettings; + /** + * Optional. The `publish_settings` fields to update. This field mask accepts the following values: * `publish_state`: Updates or replaces all `publish_state` settings. * `"*"`: Updates or replaces all `publish_settings` fields. + */ + updateMask?: string | null; + } + /** + * The response of a `SetPublishSettings` request. + */ + export interface Schema$SetPublishSettingsResponse { + /** + * Required. The ID of the Form. This is same as the `Form.form_id` field. + */ + formId?: string | null; + /** + * The publish settings of the form. + */ + publishSettings?: Schema$PublishSettings; + } /** * An answer to a question represented as text. */ @@ -1301,6 +1357,101 @@ export namespace forms_v1 { return createAPIRequest(parameters); } } + + /** + * Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setPublishSettings( + params: Params$Resource$Forms$Setpublishsettings, + options: StreamMethodOptions + ): GaxiosPromise; + setPublishSettings( + params?: Params$Resource$Forms$Setpublishsettings, + options?: MethodOptions + ): GaxiosPromise; + setPublishSettings( + params: Params$Resource$Forms$Setpublishsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPublishSettings( + params: Params$Resource$Forms$Setpublishsettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPublishSettings( + params: Params$Resource$Forms$Setpublishsettings, + callback: BodyResponseCallback + ): void; + setPublishSettings( + callback: BodyResponseCallback + ): void; + setPublishSettings( + paramsOrCallback?: + | Params$Resource$Forms$Setpublishsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forms$Setpublishsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forms$Setpublishsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://forms.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/forms/{formId}:setPublishSettings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['formId'], + pathParams: ['formId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Forms$Batchupdate @@ -1316,6 +1467,11 @@ export namespace forms_v1 { requestBody?: Schema$BatchUpdateFormRequest; } export interface Params$Resource$Forms$Create extends StandardParameters { + /** + * Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses. + */ + unpublished?: boolean; + /** * Request body metadata */ @@ -1327,6 +1483,18 @@ export namespace forms_v1 { */ formId?: string; } + export interface Params$Resource$Forms$Setpublishsettings + extends StandardParameters { + /** + * Required. The ID of the form. You can get the id from `Form.form_id` field. + */ + formId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetPublishSettingsRequest; + } export class Resource$Forms$Responses { context: APIRequestContext; From f7885c4f96039d80f2c65f665b9927e8df73b024 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 072/144] feat(gkebackup): update the API #### gkebackup:v1 The following keys were added: - resources.projects.resources.locations.resources.backupPlans.resources.backups.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.backupPlans.resources.backups.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.backupPlans.resources.backups.methods.list.parameters.returnPartialSuccess.type - schemas.Backup.properties.satisfiesPzi.description - schemas.Backup.properties.satisfiesPzi.readOnly - schemas.Backup.properties.satisfiesPzi.type - schemas.Backup.properties.satisfiesPzs.description - schemas.Backup.properties.satisfiesPzs.readOnly - schemas.Backup.properties.satisfiesPzs.type - schemas.BackupPlan.properties.lastSuccessfulBackupTime.description - schemas.BackupPlan.properties.lastSuccessfulBackupTime.format - schemas.BackupPlan.properties.lastSuccessfulBackupTime.readOnly - schemas.BackupPlan.properties.lastSuccessfulBackupTime.type - schemas.ListBackupsResponse.properties.unreachable.description - schemas.ListBackupsResponse.properties.unreachable.items.type - schemas.ListBackupsResponse.properties.unreachable.type - schemas.VolumeBackup.properties.satisfiesPzi.description - schemas.VolumeBackup.properties.satisfiesPzi.readOnly - schemas.VolumeBackup.properties.satisfiesPzi.type - schemas.VolumeBackup.properties.satisfiesPzs.description - schemas.VolumeBackup.properties.satisfiesPzs.readOnly - schemas.VolumeBackup.properties.satisfiesPzs.type The following keys were changed: - schemas.Restore.properties.filter.description - schemas.VolumeBackup.properties.state.enum - schemas.VolumeBackup.properties.state.enumDescriptions --- discovery/gkebackup-v1.json | 48 +++++++++++++++++++++++++++++++++---- src/apis/gkebackup/v1.ts | 30 ++++++++++++++++++++++- 2 files changed, 73 insertions(+), 5 deletions(-) diff --git a/discovery/gkebackup-v1.json b/discovery/gkebackup-v1.json index ae6df4a4db1..6735ae03eaa 100644 --- a/discovery/gkebackup-v1.json +++ b/discovery/gkebackup-v1.json @@ -623,6 +623,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", "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 will be populated.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/backups", @@ -1713,7 +1718,7 @@ } } }, - "revision": "20250101", + "revision": "20250305", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -1876,6 +1881,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. [Output Only] Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. [Output Only] Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "selectedApplications": { "$ref": "NamespacedNames", "description": "Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.", @@ -2015,6 +2030,12 @@ "description": "Optional. A set of custom labels supplied by user.", "type": "object" }, + "lastSuccessfulBackupTime": { + "description": "Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. This field is added to maintain consistency with BackupPlanBinding to display last successful backup time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "name": { "description": "Output only. The full name of the BackupPlan resource. Format: `projects/*/locations/*/backupPlans/*`", "readOnly": true, @@ -2479,6 +2500,13 @@ "nextPageToken": { "description": "A token which may be sent as page_token in a subsequent `ListBackups` 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" @@ -2826,7 +2854,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 everything 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": { @@ -3396,6 +3424,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. [Output Only] Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. [Output Only] Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "sourcePvc": { "$ref": "NamespacedName", "description": "Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.", @@ -3410,7 +3448,8 @@ "UPLOADING", "SUCCEEDED", "FAILED", - "DELETING" + "DELETING", + "CLEANED_UP" ], "enumDescriptions": [ "This is an illegal state and should not be encountered.", @@ -3419,7 +3458,8 @@ "The snapshot phase of the volume backup operation has completed and the snapshot is now being uploaded to backup storage.", "The volume backup operation has completed successfully.", "The volume backup operation has failed.", - "This VolumeBackup resource (and its associated artifacts) is in the process of being deleted." + "This VolumeBackup resource (and its associated artifacts) is in the process of being deleted.", + "The underlying artifacts of a volume backup (eg: persistent disk snapshots) are deleted." ], "readOnly": true, "type": "string" diff --git a/src/apis/gkebackup/v1.ts b/src/apis/gkebackup/v1.ts index 37d98efb050..6494c9da6fc 100644 --- a/src/apis/gkebackup/v1.ts +++ b/src/apis/gkebackup/v1.ts @@ -234,6 +234,14 @@ export namespace gkebackup_v1 { * Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days). */ retainExpireTime?: string | null; + /** + * Output only. [Output Only] Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. [Output Only] Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. If set, the list of ProtectedApplications whose resources were included in the Backup. */ @@ -336,6 +344,10 @@ export namespace gkebackup_v1 { * Optional. A set of custom labels supplied by user. */ labels?: {[key: string]: string} | null; + /** + * Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. This field is added to maintain consistency with BackupPlanBinding to display last successful backup time. + */ + lastSuccessfulBackupTime?: string | null; /** * Output only. The full name of the BackupPlan resource. Format: `projects/x/locations/x/backupPlans/x` */ @@ -654,6 +666,10 @@ export namespace gkebackup_v1 { * A token which may be sent as page_token in a subsequent `ListBackups` 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; } /** * The response message for Locations.ListLocations. @@ -905,7 +921,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 everything 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; /** @@ -1270,6 +1286,14 @@ export namespace gkebackup_v1 { * Output only. The full name of the VolumeBackup resource. Format: `projects/x/locations/x/backupPlans/x/backups/x/volumeBackups/x`. */ name?: string | null; + /** + * Output only. [Output Only] Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. [Output Only] Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created. */ @@ -3385,6 +3409,10 @@ export namespace gkebackup_v1 { * Required. The BackupPlan that contains the Backups to list. Format: `projects/x/locations/x/backupPlans/x` */ parent?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Backupplans$Backups$Patch extends StandardParameters { From d04d00c08f5eccf221206729b36220703ae3544a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 073/144] feat(gkehub): update the API #### gkehub:v1alpha The following keys were added: - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.description - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.items.$ref - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.type - schemas.ConfigManagementContainerOverride.description - schemas.ConfigManagementContainerOverride.id - schemas.ConfigManagementContainerOverride.properties.containerName.description - schemas.ConfigManagementContainerOverride.properties.containerName.type - schemas.ConfigManagementContainerOverride.properties.cpuLimit.description - schemas.ConfigManagementContainerOverride.properties.cpuLimit.type - schemas.ConfigManagementContainerOverride.properties.cpuRequest.description - schemas.ConfigManagementContainerOverride.properties.cpuRequest.type - schemas.ConfigManagementContainerOverride.properties.memoryLimit.description - schemas.ConfigManagementContainerOverride.properties.memoryLimit.type - schemas.ConfigManagementContainerOverride.properties.memoryRequest.description - schemas.ConfigManagementContainerOverride.properties.memoryRequest.type - schemas.ConfigManagementContainerOverride.type - schemas.ConfigManagementDeploymentOverride.description - schemas.ConfigManagementDeploymentOverride.id - schemas.ConfigManagementDeploymentOverride.properties.containers.description - schemas.ConfigManagementDeploymentOverride.properties.containers.items.$ref - schemas.ConfigManagementDeploymentOverride.properties.containers.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.type - schemas.ConfigManagementDeploymentOverride.type - schemas.ServiceMeshFeatureCondition.description - schemas.ServiceMeshFeatureCondition.id - schemas.ServiceMeshFeatureCondition.properties.code.description - schemas.ServiceMeshFeatureCondition.properties.code.enum - schemas.ServiceMeshFeatureCondition.properties.code.enumDescriptions - schemas.ServiceMeshFeatureCondition.properties.code.type - schemas.ServiceMeshFeatureCondition.properties.details.description - schemas.ServiceMeshFeatureCondition.properties.details.type - schemas.ServiceMeshFeatureCondition.properties.documentationLink.description - schemas.ServiceMeshFeatureCondition.properties.documentationLink.type - schemas.ServiceMeshFeatureCondition.properties.severity.description - schemas.ServiceMeshFeatureCondition.properties.severity.enum - schemas.ServiceMeshFeatureCondition.properties.severity.enumDescriptions - schemas.ServiceMeshFeatureCondition.properties.severity.type - schemas.ServiceMeshFeatureCondition.type - schemas.ServiceMeshFeatureState.properties.conditions.description - schemas.ServiceMeshFeatureState.properties.conditions.items.$ref - schemas.ServiceMeshFeatureState.properties.conditions.readOnly - schemas.ServiceMeshFeatureState.properties.conditions.type The following keys were changed: - schemas.ServiceMeshCondition.description - schemas.ServiceMeshCondition.properties.code.enum - schemas.ServiceMeshCondition.properties.code.enumDescriptions - schemas.ServiceMeshMembershipState.properties.conditions.description #### gkehub:v2alpha The following keys were added: - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.description - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.items.$ref - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.type - schemas.ConfigManagementContainerOverride.description - schemas.ConfigManagementContainerOverride.id - schemas.ConfigManagementContainerOverride.properties.containerName.description - schemas.ConfigManagementContainerOverride.properties.containerName.type - schemas.ConfigManagementContainerOverride.properties.cpuLimit.description - schemas.ConfigManagementContainerOverride.properties.cpuLimit.type - schemas.ConfigManagementContainerOverride.properties.cpuRequest.description - schemas.ConfigManagementContainerOverride.properties.cpuRequest.type - schemas.ConfigManagementContainerOverride.properties.memoryLimit.description - schemas.ConfigManagementContainerOverride.properties.memoryLimit.type - schemas.ConfigManagementContainerOverride.properties.memoryRequest.description - schemas.ConfigManagementContainerOverride.properties.memoryRequest.type - schemas.ConfigManagementContainerOverride.type - schemas.ConfigManagementDeploymentOverride.description - schemas.ConfigManagementDeploymentOverride.id - schemas.ConfigManagementDeploymentOverride.properties.containers.description - schemas.ConfigManagementDeploymentOverride.properties.containers.items.$ref - schemas.ConfigManagementDeploymentOverride.properties.containers.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.type - schemas.ConfigManagementDeploymentOverride.type The following keys were changed: - schemas.ServiceMeshCondition.properties.code.enum - schemas.ServiceMeshCondition.properties.code.enumDescriptions #### gkehub:v1beta The following keys were added: - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.description - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.items.$ref - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.type - schemas.ConfigManagementContainerOverride.description - schemas.ConfigManagementContainerOverride.id - schemas.ConfigManagementContainerOverride.properties.containerName.description - schemas.ConfigManagementContainerOverride.properties.containerName.type - schemas.ConfigManagementContainerOverride.properties.cpuLimit.description - schemas.ConfigManagementContainerOverride.properties.cpuLimit.type - schemas.ConfigManagementContainerOverride.properties.cpuRequest.description - schemas.ConfigManagementContainerOverride.properties.cpuRequest.type - schemas.ConfigManagementContainerOverride.properties.memoryLimit.description - schemas.ConfigManagementContainerOverride.properties.memoryLimit.type - schemas.ConfigManagementContainerOverride.properties.memoryRequest.description - schemas.ConfigManagementContainerOverride.properties.memoryRequest.type - schemas.ConfigManagementContainerOverride.type - schemas.ConfigManagementDeploymentOverride.description - schemas.ConfigManagementDeploymentOverride.id - schemas.ConfigManagementDeploymentOverride.properties.containers.description - schemas.ConfigManagementDeploymentOverride.properties.containers.items.$ref - schemas.ConfigManagementDeploymentOverride.properties.containers.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.type - schemas.ConfigManagementDeploymentOverride.type The following keys were changed: - schemas.ServiceMeshCondition.description - schemas.ServiceMeshCondition.properties.code.enum - schemas.ServiceMeshCondition.properties.code.enumDescriptions - schemas.ServiceMeshMembershipState.properties.conditions.description #### gkehub:v2beta The following keys were added: - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.description - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.items.$ref - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.type - schemas.ConfigManagementContainerOverride.description - schemas.ConfigManagementContainerOverride.id - schemas.ConfigManagementContainerOverride.properties.containerName.description - schemas.ConfigManagementContainerOverride.properties.containerName.type - schemas.ConfigManagementContainerOverride.properties.cpuLimit.description - schemas.ConfigManagementContainerOverride.properties.cpuLimit.type - schemas.ConfigManagementContainerOverride.properties.cpuRequest.description - schemas.ConfigManagementContainerOverride.properties.cpuRequest.type - schemas.ConfigManagementContainerOverride.properties.memoryLimit.description - schemas.ConfigManagementContainerOverride.properties.memoryLimit.type - schemas.ConfigManagementContainerOverride.properties.memoryRequest.description - schemas.ConfigManagementContainerOverride.properties.memoryRequest.type - schemas.ConfigManagementContainerOverride.type - schemas.ConfigManagementDeploymentOverride.description - schemas.ConfigManagementDeploymentOverride.id - schemas.ConfigManagementDeploymentOverride.properties.containers.description - schemas.ConfigManagementDeploymentOverride.properties.containers.items.$ref - schemas.ConfigManagementDeploymentOverride.properties.containers.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.type - schemas.ConfigManagementDeploymentOverride.type The following keys were changed: - schemas.ServiceMeshCondition.properties.code.enum - schemas.ServiceMeshCondition.properties.code.enumDescriptions #### gkehub:v1 The following keys were added: - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.description - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.items.$ref - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.type - schemas.ConfigManagementContainerOverride.description - schemas.ConfigManagementContainerOverride.id - schemas.ConfigManagementContainerOverride.properties.containerName.description - schemas.ConfigManagementContainerOverride.properties.containerName.type - schemas.ConfigManagementContainerOverride.properties.cpuLimit.description - schemas.ConfigManagementContainerOverride.properties.cpuLimit.type - schemas.ConfigManagementContainerOverride.properties.cpuRequest.description - schemas.ConfigManagementContainerOverride.properties.cpuRequest.type - schemas.ConfigManagementContainerOverride.properties.memoryLimit.description - schemas.ConfigManagementContainerOverride.properties.memoryLimit.type - schemas.ConfigManagementContainerOverride.properties.memoryRequest.description - schemas.ConfigManagementContainerOverride.properties.memoryRequest.type - schemas.ConfigManagementContainerOverride.type - schemas.ConfigManagementDeploymentOverride.description - schemas.ConfigManagementDeploymentOverride.id - schemas.ConfigManagementDeploymentOverride.properties.containers.description - schemas.ConfigManagementDeploymentOverride.properties.containers.items.$ref - schemas.ConfigManagementDeploymentOverride.properties.containers.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.type - schemas.ConfigManagementDeploymentOverride.type The following keys were changed: - schemas.ServiceMeshCondition.description - schemas.ServiceMeshCondition.properties.code.enum - schemas.ServiceMeshCondition.properties.code.enumDescriptions - schemas.ServiceMeshMembershipState.properties.conditions.description #### gkehub:v2 The following keys were added: - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.description - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.items.$ref - schemas.ConfigManagementConfigSync.properties.deploymentOverrides.type - schemas.ConfigManagementContainerOverride.description - schemas.ConfigManagementContainerOverride.id - schemas.ConfigManagementContainerOverride.properties.containerName.description - schemas.ConfigManagementContainerOverride.properties.containerName.type - schemas.ConfigManagementContainerOverride.properties.cpuLimit.description - schemas.ConfigManagementContainerOverride.properties.cpuLimit.type - schemas.ConfigManagementContainerOverride.properties.cpuRequest.description - schemas.ConfigManagementContainerOverride.properties.cpuRequest.type - schemas.ConfigManagementContainerOverride.properties.memoryLimit.description - schemas.ConfigManagementContainerOverride.properties.memoryLimit.type - schemas.ConfigManagementContainerOverride.properties.memoryRequest.description - schemas.ConfigManagementContainerOverride.properties.memoryRequest.type - schemas.ConfigManagementContainerOverride.type - schemas.ConfigManagementDeploymentOverride.description - schemas.ConfigManagementDeploymentOverride.id - schemas.ConfigManagementDeploymentOverride.properties.containers.description - schemas.ConfigManagementDeploymentOverride.properties.containers.items.$ref - schemas.ConfigManagementDeploymentOverride.properties.containers.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentName.type - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.description - schemas.ConfigManagementDeploymentOverride.properties.deploymentNamespace.type - schemas.ConfigManagementDeploymentOverride.type The following keys were changed: - schemas.ServiceMeshCondition.properties.code.enum - schemas.ServiceMeshCondition.properties.code.enumDescriptions --- discovery/gkehub-v1.json | 68 +++++++++++- discovery/gkehub-v1alpha.json | 189 +++++++++++++++++++++++++++++++++- discovery/gkehub-v1beta.json | 68 +++++++++++- discovery/gkehub-v2.json | 64 +++++++++++- discovery/gkehub-v2alpha.json | 64 +++++++++++- discovery/gkehub-v2beta.json | 64 +++++++++++- src/apis/gkehub/v1.ts | 50 ++++++++- src/apis/gkehub/v1alpha.ts | 75 +++++++++++++- src/apis/gkehub/v1beta.ts | 50 ++++++++- src/apis/gkehub/v2.ts | 46 +++++++++ src/apis/gkehub/v2alpha.ts | 46 +++++++++ src/apis/gkehub/v2beta.ts | 46 +++++++++ 12 files changed, 800 insertions(+), 30 deletions(-) diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index 018fa7ebd30..ab2e6e63042 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -2111,7 +2111,7 @@ } } }, - "revision": "20250116", + "revision": "20250302", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2645,6 +2645,13 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "deploymentOverrides": { + "description": "Optional. Configuration for deployment overrides.", + "items": { + "$ref": "ConfigManagementDeploymentOverride" + }, + "type": "array" + }, "enabled": { "description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.", "type": "boolean" @@ -3010,6 +3017,55 @@ }, "type": "object" }, + "ConfigManagementContainerOverride": { + "description": "Configuration for a container override.", + "id": "ConfigManagementContainerOverride", + "properties": { + "containerName": { + "description": "Required. The name of the container.", + "type": "string" + }, + "cpuLimit": { + "description": "Optional. The cpu limit of the container.", + "type": "string" + }, + "cpuRequest": { + "description": "Optional. The cpu request of the container.", + "type": "string" + }, + "memoryLimit": { + "description": "Optional. The memory limit of the container.", + "type": "string" + }, + "memoryRequest": { + "description": "Optional. The memory request of the container.", + "type": "string" + } + }, + "type": "object" + }, + "ConfigManagementDeploymentOverride": { + "description": "Configuration for a deployment override.", + "id": "ConfigManagementDeploymentOverride", + "properties": { + "containers": { + "description": "Optional. The containers of the deployment resource to be overridden.", + "items": { + "$ref": "ConfigManagementContainerOverride" + }, + "type": "array" + }, + "deploymentName": { + "description": "Required. The name of the deployment resource to be overridden.", + "type": "string" + }, + "deploymentNamespace": { + "description": "Required. The namespace of the deployment resource to be overridden..", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementErrorResource": { "description": "Model for a config file in the git repo with an associated Sync error", "id": "ConfigManagementErrorResource", @@ -6151,7 +6207,7 @@ "type": "object" }, "ServiceMeshCondition": { - "description": "Condition being reported.", + "description": "Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message.", "id": "ServiceMeshCondition", "properties": { "code": { @@ -6192,7 +6248,8 @@ "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", - "MODERNIZATION_ABORTED" + "MODERNIZATION_ABORTED", + "MODERNIZATION_WILL_BE_SCHEDULED" ], "enumDescriptions": [ "Default Unspecified code", @@ -6230,7 +6287,8 @@ "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", - "Modernization is aborted for a cluster." + "Modernization is aborted for a cluster.", + "Modernization will be scheduled for a fleet." ], "type": "string" }, @@ -6409,7 +6467,7 @@ "id": "ServiceMeshMembershipState", "properties": { "conditions": { - "description": "Output only. List of conditions reported for this membership.", + "description": "Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message.", "items": { "$ref": "ServiceMeshCondition" }, diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 4f62b446965..ab4c23c3fca 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -2255,7 +2255,7 @@ } } }, - "revision": "20250116", + "revision": "20250302", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2956,6 +2956,13 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "deploymentOverrides": { + "description": "Optional. Configuration for deployment overrides.", + "items": { + "$ref": "ConfigManagementDeploymentOverride" + }, + "type": "array" + }, "enabled": { "description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.", "type": "boolean" @@ -3321,6 +3328,55 @@ }, "type": "object" }, + "ConfigManagementContainerOverride": { + "description": "Configuration for a container override.", + "id": "ConfigManagementContainerOverride", + "properties": { + "containerName": { + "description": "Required. The name of the container.", + "type": "string" + }, + "cpuLimit": { + "description": "Optional. The cpu limit of the container.", + "type": "string" + }, + "cpuRequest": { + "description": "Optional. The cpu request of the container.", + "type": "string" + }, + "memoryLimit": { + "description": "Optional. The memory limit of the container.", + "type": "string" + }, + "memoryRequest": { + "description": "Optional. The memory request of the container.", + "type": "string" + } + }, + "type": "object" + }, + "ConfigManagementDeploymentOverride": { + "description": "Configuration for a deployment override.", + "id": "ConfigManagementDeploymentOverride", + "properties": { + "containers": { + "description": "Optional. The containers of the deployment resource to be overridden.", + "items": { + "$ref": "ConfigManagementContainerOverride" + }, + "type": "array" + }, + "deploymentName": { + "description": "Required. The name of the deployment resource to be overridden.", + "type": "string" + }, + "deploymentNamespace": { + "description": "Required. The namespace of the deployment resource to be overridden..", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementErrorResource": { "description": "Model for a config file in the git repo with an associated Sync error", "id": "ConfigManagementErrorResource", @@ -6723,7 +6779,7 @@ "type": "object" }, "ServiceMeshCondition": { - "description": "Condition being reported.", + "description": "Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message.", "id": "ServiceMeshCondition", "properties": { "code": { @@ -6764,7 +6820,8 @@ "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", - "MODERNIZATION_ABORTED" + "MODERNIZATION_ABORTED", + "MODERNIZATION_WILL_BE_SCHEDULED" ], "enumDescriptions": [ "Default Unspecified code", @@ -6802,7 +6859,8 @@ "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", - "Modernization is aborted for a cluster." + "Modernization is aborted for a cluster.", + "Modernization will be scheduled for a fleet." ], "type": "string" }, @@ -6926,6 +6984,119 @@ }, "type": "object" }, + "ServiceMeshFeatureCondition": { + "description": "Condition being reported. TODO b/395151419: This message should be used to replace the membership-level Condition message.", + "id": "ServiceMeshFeatureCondition", + "properties": { + "code": { + "description": "Unique identifier of the condition which describes the condition recognizable to the user.", + "enum": [ + "CODE_UNSPECIFIED", + "MESH_IAM_PERMISSION_DENIED", + "MESH_IAM_CROSS_PROJECT_PERMISSION_DENIED", + "CNI_CONFIG_UNSUPPORTED", + "GKE_SANDBOX_UNSUPPORTED", + "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", + "CNI_INSTALLATION_FAILED", + "CNI_POD_UNSCHEDULABLE", + "CLUSTER_HAS_ZERO_NODES", + "CANONICAL_SERVICE_ERROR", + "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", + "VPCSC_GA_SUPPORTED", + "DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT", + "DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT_SAFE", + "CONFIG_APPLY_INTERNAL_ERROR", + "CONFIG_VALIDATION_ERROR", + "CONFIG_VALIDATION_WARNING", + "QUOTA_EXCEEDED_BACKEND_SERVICES", + "QUOTA_EXCEEDED_HEALTH_CHECKS", + "QUOTA_EXCEEDED_HTTP_ROUTES", + "QUOTA_EXCEEDED_TCP_ROUTES", + "QUOTA_EXCEEDED_TLS_ROUTES", + "QUOTA_EXCEEDED_TRAFFIC_POLICIES", + "QUOTA_EXCEEDED_ENDPOINT_POLICIES", + "QUOTA_EXCEEDED_GATEWAYS", + "QUOTA_EXCEEDED_MESHES", + "QUOTA_EXCEEDED_SERVER_TLS_POLICIES", + "QUOTA_EXCEEDED_CLIENT_TLS_POLICIES", + "QUOTA_EXCEEDED_SERVICE_LB_POLICIES", + "QUOTA_EXCEEDED_HTTP_FILTERS", + "QUOTA_EXCEEDED_TCP_FILTERS", + "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "MODERNIZATION_SCHEDULED", + "MODERNIZATION_IN_PROGRESS", + "MODERNIZATION_COMPLETED", + "MODERNIZATION_ABORTED", + "MODERNIZATION_WILL_BE_SCHEDULED" + ], + "enumDescriptions": [ + "Default Unspecified code", + "Mesh IAM permission denied error code", + "Permission denied error code for cross-project", + "CNI config unsupported error code", + "GKE sandbox unsupported error code", + "Nodepool workload identity federation required error code", + "CNI installation failed error code", + "CNI pod unschedulable error code", + "Cluster has zero node code", + "Failure to reconcile CanonicalServices", + "Multiple control planes unsupported error code", + "VPC-SC GA is supported for this control plane.", + "User is using deprecated ControlPlaneManagement and they have not yet set Management.", + "User is using deprecated ControlPlaneManagement and they have already set Management.", + "Configuration (Istio/k8s resources) failed to apply due to internal error.", + "Configuration failed to be applied due to being invalid.", + "Encountered configuration(s) with possible unintended behavior or invalid configuration. These configs may not have been applied.", + "BackendService quota exceeded error code.", + "HealthCheck quota exceeded error code.", + "HTTPRoute quota exceeded error code.", + "TCPRoute quota exceeded error code.", + "TLS routes quota exceeded error code.", + "TrafficPolicy quota exceeded error code.", + "EndpointPolicy quota exceeded error code.", + "Gateway quota exceeded error code.", + "Mesh quota exceeded error code.", + "ServerTLSPolicy quota exceeded error code.", + "ClientTLSPolicy quota exceeded error code.", + "ServiceLBPolicy quota exceeded error code.", + "HTTPFilter quota exceeded error code.", + "TCPFilter quota exceeded error code.", + "NetworkEndpointGroup quota exceeded error code.", + "Modernization is scheduled for a cluster.", + "Modernization is in progress for a cluster.", + "Modernization is completed for a cluster.", + "Modernization is aborted for a cluster.", + "Modernization will be scheduled for a fleet." + ], + "type": "string" + }, + "details": { + "description": "A short summary about the issue.", + "type": "string" + }, + "documentationLink": { + "description": "Links contains actionable information.", + "type": "string" + }, + "severity": { + "description": "Severity level of the condition.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "ERROR", + "WARNING", + "INFO" + ], + "enumDescriptions": [ + "Unspecified severity", + "Indicates an issue that prevents the mesh from operating correctly", + "Indicates a setting is likely wrong, but the mesh is still able to operate", + "An informational message, not requiring any action" + ], + "type": "string" + } + }, + "type": "object" + }, "ServiceMeshFeatureState": { "description": "**Service Mesh**: State for the whole Hub, as analyzed by the Service Mesh Hub Controller.", "id": "ServiceMeshFeatureState", @@ -6937,6 +7108,14 @@ }, "readOnly": true, "type": "array" + }, + "conditions": { + "description": "Output only. List of conditions reported for this feature.", + "items": { + "$ref": "ServiceMeshFeatureCondition" + }, + "readOnly": true, + "type": "array" } }, "type": "object" @@ -7021,7 +7200,7 @@ "type": "array" }, "conditions": { - "description": "Output only. List of conditions reported for this membership.", + "description": "Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message.", "items": { "$ref": "ServiceMeshCondition" }, diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index 2aabd0630e0..f468a68ce3f 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -2111,7 +2111,7 @@ } } }, - "revision": "20250116", + "revision": "20250302", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2696,6 +2696,13 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "deploymentOverrides": { + "description": "Optional. Configuration for deployment overrides.", + "items": { + "$ref": "ConfigManagementDeploymentOverride" + }, + "type": "array" + }, "enabled": { "description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.", "type": "boolean" @@ -3061,6 +3068,55 @@ }, "type": "object" }, + "ConfigManagementContainerOverride": { + "description": "Configuration for a container override.", + "id": "ConfigManagementContainerOverride", + "properties": { + "containerName": { + "description": "Required. The name of the container.", + "type": "string" + }, + "cpuLimit": { + "description": "Optional. The cpu limit of the container.", + "type": "string" + }, + "cpuRequest": { + "description": "Optional. The cpu request of the container.", + "type": "string" + }, + "memoryLimit": { + "description": "Optional. The memory limit of the container.", + "type": "string" + }, + "memoryRequest": { + "description": "Optional. The memory request of the container.", + "type": "string" + } + }, + "type": "object" + }, + "ConfigManagementDeploymentOverride": { + "description": "Configuration for a deployment override.", + "id": "ConfigManagementDeploymentOverride", + "properties": { + "containers": { + "description": "Optional. The containers of the deployment resource to be overridden.", + "items": { + "$ref": "ConfigManagementContainerOverride" + }, + "type": "array" + }, + "deploymentName": { + "description": "Required. The name of the deployment resource to be overridden.", + "type": "string" + }, + "deploymentNamespace": { + "description": "Required. The namespace of the deployment resource to be overridden..", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementErrorResource": { "description": "Model for a config file in the git repo with an associated Sync error", "id": "ConfigManagementErrorResource", @@ -6277,7 +6333,7 @@ "type": "object" }, "ServiceMeshCondition": { - "description": "Condition being reported.", + "description": "Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message.", "id": "ServiceMeshCondition", "properties": { "code": { @@ -6318,7 +6374,8 @@ "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", - "MODERNIZATION_ABORTED" + "MODERNIZATION_ABORTED", + "MODERNIZATION_WILL_BE_SCHEDULED" ], "enumDescriptions": [ "Default Unspecified code", @@ -6356,7 +6413,8 @@ "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", - "Modernization is aborted for a cluster." + "Modernization is aborted for a cluster.", + "Modernization will be scheduled for a fleet." ], "type": "string" }, @@ -6535,7 +6593,7 @@ "id": "ServiceMeshMembershipState", "properties": { "conditions": { - "description": "Output only. List of conditions reported for this membership.", + "description": "Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message.", "items": { "$ref": "ServiceMeshCondition" }, diff --git a/discovery/gkehub-v2.json b/discovery/gkehub-v2.json index 4f322ea45b0..757cd19c241 100644 --- a/discovery/gkehub-v2.json +++ b/discovery/gkehub-v2.json @@ -471,7 +471,7 @@ } } }, - "revision": "20250116", + "revision": "20250302", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -700,6 +700,13 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "deploymentOverrides": { + "description": "Optional. Configuration for deployment overrides.", + "items": { + "$ref": "ConfigManagementDeploymentOverride" + }, + "type": "array" + }, "enabled": { "description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.", "type": "boolean" @@ -1065,6 +1072,55 @@ }, "type": "object" }, + "ConfigManagementContainerOverride": { + "description": "Configuration for a container override.", + "id": "ConfigManagementContainerOverride", + "properties": { + "containerName": { + "description": "Required. The name of the container.", + "type": "string" + }, + "cpuLimit": { + "description": "Optional. The cpu limit of the container.", + "type": "string" + }, + "cpuRequest": { + "description": "Optional. The cpu request of the container.", + "type": "string" + }, + "memoryLimit": { + "description": "Optional. The memory limit of the container.", + "type": "string" + }, + "memoryRequest": { + "description": "Optional. The memory request of the container.", + "type": "string" + } + }, + "type": "object" + }, + "ConfigManagementDeploymentOverride": { + "description": "Configuration for a deployment override.", + "id": "ConfigManagementDeploymentOverride", + "properties": { + "containers": { + "description": "Optional. The containers of the deployment resource to be overridden.", + "items": { + "$ref": "ConfigManagementContainerOverride" + }, + "type": "array" + }, + "deploymentName": { + "description": "Required. The name of the deployment resource to be overridden.", + "type": "string" + }, + "deploymentNamespace": { + "description": "Required. The namespace of the deployment resource to be overridden..", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementErrorResource": { "description": "Model for a config file in the git repo with an associated Sync error.", "id": "ConfigManagementErrorResource", @@ -2935,7 +2991,8 @@ "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", - "MODERNIZATION_ABORTED" + "MODERNIZATION_ABORTED", + "MODERNIZATION_WILL_BE_SCHEDULED" ], "enumDescriptions": [ "Default Unspecified code", @@ -2973,7 +3030,8 @@ "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", - "Modernization is aborted for a cluster." + "Modernization is aborted for a cluster.", + "Modernization will be scheduled for a fleet." ], "type": "string" }, diff --git a/discovery/gkehub-v2alpha.json b/discovery/gkehub-v2alpha.json index 767ee6314e0..1484f80a8fb 100644 --- a/discovery/gkehub-v2alpha.json +++ b/discovery/gkehub-v2alpha.json @@ -471,7 +471,7 @@ } } }, - "revision": "20250116", + "revision": "20250302", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -700,6 +700,13 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "deploymentOverrides": { + "description": "Optional. Configuration for deployment overrides.", + "items": { + "$ref": "ConfigManagementDeploymentOverride" + }, + "type": "array" + }, "enabled": { "description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.", "type": "boolean" @@ -1065,6 +1072,55 @@ }, "type": "object" }, + "ConfigManagementContainerOverride": { + "description": "Configuration for a container override.", + "id": "ConfigManagementContainerOverride", + "properties": { + "containerName": { + "description": "Required. The name of the container.", + "type": "string" + }, + "cpuLimit": { + "description": "Optional. The cpu limit of the container.", + "type": "string" + }, + "cpuRequest": { + "description": "Optional. The cpu request of the container.", + "type": "string" + }, + "memoryLimit": { + "description": "Optional. The memory limit of the container.", + "type": "string" + }, + "memoryRequest": { + "description": "Optional. The memory request of the container.", + "type": "string" + } + }, + "type": "object" + }, + "ConfigManagementDeploymentOverride": { + "description": "Configuration for a deployment override.", + "id": "ConfigManagementDeploymentOverride", + "properties": { + "containers": { + "description": "Optional. The containers of the deployment resource to be overridden.", + "items": { + "$ref": "ConfigManagementContainerOverride" + }, + "type": "array" + }, + "deploymentName": { + "description": "Required. The name of the deployment resource to be overridden.", + "type": "string" + }, + "deploymentNamespace": { + "description": "Required. The namespace of the deployment resource to be overridden..", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementErrorResource": { "description": "Model for a config file in the git repo with an associated Sync error.", "id": "ConfigManagementErrorResource", @@ -2935,7 +2991,8 @@ "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", - "MODERNIZATION_ABORTED" + "MODERNIZATION_ABORTED", + "MODERNIZATION_WILL_BE_SCHEDULED" ], "enumDescriptions": [ "Default Unspecified code", @@ -2973,7 +3030,8 @@ "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", - "Modernization is aborted for a cluster." + "Modernization is aborted for a cluster.", + "Modernization will be scheduled for a fleet." ], "type": "string" }, diff --git a/discovery/gkehub-v2beta.json b/discovery/gkehub-v2beta.json index 7cf46cb8a9c..b940f7619aa 100644 --- a/discovery/gkehub-v2beta.json +++ b/discovery/gkehub-v2beta.json @@ -471,7 +471,7 @@ } } }, - "revision": "20250116", + "revision": "20250302", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -700,6 +700,13 @@ "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", "properties": { + "deploymentOverrides": { + "description": "Optional. Configuration for deployment overrides.", + "items": { + "$ref": "ConfigManagementDeploymentOverride" + }, + "type": "array" + }, "enabled": { "description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.", "type": "boolean" @@ -1065,6 +1072,55 @@ }, "type": "object" }, + "ConfigManagementContainerOverride": { + "description": "Configuration for a container override.", + "id": "ConfigManagementContainerOverride", + "properties": { + "containerName": { + "description": "Required. The name of the container.", + "type": "string" + }, + "cpuLimit": { + "description": "Optional. The cpu limit of the container.", + "type": "string" + }, + "cpuRequest": { + "description": "Optional. The cpu request of the container.", + "type": "string" + }, + "memoryLimit": { + "description": "Optional. The memory limit of the container.", + "type": "string" + }, + "memoryRequest": { + "description": "Optional. The memory request of the container.", + "type": "string" + } + }, + "type": "object" + }, + "ConfigManagementDeploymentOverride": { + "description": "Configuration for a deployment override.", + "id": "ConfigManagementDeploymentOverride", + "properties": { + "containers": { + "description": "Optional. The containers of the deployment resource to be overridden.", + "items": { + "$ref": "ConfigManagementContainerOverride" + }, + "type": "array" + }, + "deploymentName": { + "description": "Required. The name of the deployment resource to be overridden.", + "type": "string" + }, + "deploymentNamespace": { + "description": "Required. The namespace of the deployment resource to be overridden..", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementErrorResource": { "description": "Model for a config file in the git repo with an associated Sync error.", "id": "ConfigManagementErrorResource", @@ -2935,7 +2991,8 @@ "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", - "MODERNIZATION_ABORTED" + "MODERNIZATION_ABORTED", + "MODERNIZATION_WILL_BE_SCHEDULED" ], "enumDescriptions": [ "Default Unspecified code", @@ -2973,7 +3030,8 @@ "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", - "Modernization is aborted for a cluster." + "Modernization is aborted for a cluster.", + "Modernization will be scheduled for a fleet." ], "type": "string" }, diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index fa20464b4f6..89fd0f11f02 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -503,6 +503,10 @@ export namespace gkehub_v1 { * Configuration for Config Sync */ export interface Schema$ConfigManagementConfigSync { + /** + * Optional. Configuration for deployment overrides. + */ + deploymentOverrides?: Schema$ConfigManagementDeploymentOverride[]; /** * Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. */ @@ -664,6 +668,48 @@ export namespace gkehub_v1 { */ syncer?: string | null; } + /** + * Configuration for a container override. + */ + export interface Schema$ConfigManagementContainerOverride { + /** + * Required. The name of the container. + */ + containerName?: string | null; + /** + * Optional. The cpu limit of the container. + */ + cpuLimit?: string | null; + /** + * Optional. The cpu request of the container. + */ + cpuRequest?: string | null; + /** + * Optional. The memory limit of the container. + */ + memoryLimit?: string | null; + /** + * Optional. The memory request of the container. + */ + memoryRequest?: string | null; + } + /** + * Configuration for a deployment override. + */ + export interface Schema$ConfigManagementDeploymentOverride { + /** + * Optional. The containers of the deployment resource to be overridden. + */ + containers?: Schema$ConfigManagementContainerOverride[]; + /** + * Required. The name of the deployment resource to be overridden. + */ + deploymentName?: string | null; + /** + * Required. The namespace of the deployment resource to be overridden.. + */ + deploymentNamespace?: string | null; + } /** * Model for a config file in the git repo with an associated Sync error */ @@ -2823,7 +2869,7 @@ export namespace gkehub_v1 { vulnerabilityMode?: string | null; } /** - * Condition being reported. + * Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message. */ export interface Schema$ServiceMeshCondition { /** @@ -2895,7 +2941,7 @@ export namespace gkehub_v1 { */ export interface Schema$ServiceMeshMembershipState { /** - * Output only. List of conditions reported for this membership. + * Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message. */ conditions?: Schema$ServiceMeshCondition[]; /** diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index 077871a1008..1c68026c04f 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -614,6 +614,10 @@ export namespace gkehub_v1alpha { * Configuration for Config Sync */ export interface Schema$ConfigManagementConfigSync { + /** + * Optional. Configuration for deployment overrides. + */ + deploymentOverrides?: Schema$ConfigManagementDeploymentOverride[]; /** * Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. */ @@ -775,6 +779,48 @@ export namespace gkehub_v1alpha { */ syncer?: string | null; } + /** + * Configuration for a container override. + */ + export interface Schema$ConfigManagementContainerOverride { + /** + * Required. The name of the container. + */ + containerName?: string | null; + /** + * Optional. The cpu limit of the container. + */ + cpuLimit?: string | null; + /** + * Optional. The cpu request of the container. + */ + cpuRequest?: string | null; + /** + * Optional. The memory limit of the container. + */ + memoryLimit?: string | null; + /** + * Optional. The memory request of the container. + */ + memoryRequest?: string | null; + } + /** + * Configuration for a deployment override. + */ + export interface Schema$ConfigManagementDeploymentOverride { + /** + * Optional. The containers of the deployment resource to be overridden. + */ + containers?: Schema$ConfigManagementContainerOverride[]; + /** + * Required. The name of the deployment resource to be overridden. + */ + deploymentName?: string | null; + /** + * Required. The namespace of the deployment resource to be overridden.. + */ + deploymentNamespace?: string | null; + } /** * Model for a config file in the git repo with an associated Sync error */ @@ -3099,7 +3145,7 @@ export namespace gkehub_v1alpha { type?: Schema$ServiceMeshType; } /** - * Condition being reported. + * Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message. */ export interface Schema$ServiceMeshCondition { /** @@ -3149,6 +3195,27 @@ export namespace gkehub_v1alpha { */ state?: string | null; } + /** + * Condition being reported. TODO b/395151419: This message should be used to replace the membership-level Condition message. + */ + export interface Schema$ServiceMeshFeatureCondition { + /** + * Unique identifier of the condition which describes the condition recognizable to the user. + */ + code?: string | null; + /** + * A short summary about the issue. + */ + details?: string | null; + /** + * Links contains actionable information. + */ + documentationLink?: string | null; + /** + * Severity level of the condition. + */ + severity?: string | null; + } /** * **Service Mesh**: State for the whole Hub, as analyzed by the Service Mesh Hub Controller. */ @@ -3157,6 +3224,10 @@ export namespace gkehub_v1alpha { * Output only. Results of running Service Mesh analyzers. */ analysisMessages?: Schema$ServiceMeshAnalysisMessage[]; + /** + * Output only. List of conditions reported for this feature. + */ + conditions?: Schema$ServiceMeshFeatureCondition[]; } /** * **Service Mesh**: Spec for a single Membership for the servicemesh feature @@ -3188,7 +3259,7 @@ export namespace gkehub_v1alpha { */ analysisMessages?: Schema$ServiceMeshAnalysisMessage[]; /** - * Output only. List of conditions reported for this membership. + * Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message. */ conditions?: Schema$ServiceMeshCondition[]; /** diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index 2eed49e156e..ff0201e12ca 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -534,6 +534,10 @@ export namespace gkehub_v1beta { * Configuration for Config Sync */ export interface Schema$ConfigManagementConfigSync { + /** + * Optional. Configuration for deployment overrides. + */ + deploymentOverrides?: Schema$ConfigManagementDeploymentOverride[]; /** * Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. */ @@ -695,6 +699,48 @@ export namespace gkehub_v1beta { */ syncer?: string | null; } + /** + * Configuration for a container override. + */ + export interface Schema$ConfigManagementContainerOverride { + /** + * Required. The name of the container. + */ + containerName?: string | null; + /** + * Optional. The cpu limit of the container. + */ + cpuLimit?: string | null; + /** + * Optional. The cpu request of the container. + */ + cpuRequest?: string | null; + /** + * Optional. The memory limit of the container. + */ + memoryLimit?: string | null; + /** + * Optional. The memory request of the container. + */ + memoryRequest?: string | null; + } + /** + * Configuration for a deployment override. + */ + export interface Schema$ConfigManagementDeploymentOverride { + /** + * Optional. The containers of the deployment resource to be overridden. + */ + containers?: Schema$ConfigManagementContainerOverride[]; + /** + * Required. The name of the deployment resource to be overridden. + */ + deploymentName?: string | null; + /** + * Required. The namespace of the deployment resource to be overridden.. + */ + deploymentNamespace?: string | null; + } /** * Model for a config file in the git repo with an associated Sync error */ @@ -2900,7 +2946,7 @@ export namespace gkehub_v1beta { vulnerabilityMode?: string | null; } /** - * Condition being reported. + * Condition being reported. TODO b/395151419: Remove this message once the membership-level conditions field uses the common Condition message. */ export interface Schema$ServiceMeshCondition { /** @@ -2972,7 +3018,7 @@ export namespace gkehub_v1beta { */ export interface Schema$ServiceMeshMembershipState { /** - * Output only. List of conditions reported for this membership. + * Output only. List of conditions reported for this membership. TODO b/395151419: Use the common Condition message. */ conditions?: Schema$ServiceMeshCondition[]; /** diff --git a/src/apis/gkehub/v2.ts b/src/apis/gkehub/v2.ts index f752e7782e0..ae15d88983f 100644 --- a/src/apis/gkehub/v2.ts +++ b/src/apis/gkehub/v2.ts @@ -267,6 +267,10 @@ export namespace gkehub_v2 { * Configuration for Config Sync */ export interface Schema$ConfigManagementConfigSync { + /** + * Optional. Configuration for deployment overrides. + */ + deploymentOverrides?: Schema$ConfigManagementDeploymentOverride[]; /** * Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. */ @@ -428,6 +432,48 @@ export namespace gkehub_v2 { */ syncer?: string | null; } + /** + * Configuration for a container override. + */ + export interface Schema$ConfigManagementContainerOverride { + /** + * Required. The name of the container. + */ + containerName?: string | null; + /** + * Optional. The cpu limit of the container. + */ + cpuLimit?: string | null; + /** + * Optional. The cpu request of the container. + */ + cpuRequest?: string | null; + /** + * Optional. The memory limit of the container. + */ + memoryLimit?: string | null; + /** + * Optional. The memory request of the container. + */ + memoryRequest?: string | null; + } + /** + * Configuration for a deployment override. + */ + export interface Schema$ConfigManagementDeploymentOverride { + /** + * Optional. The containers of the deployment resource to be overridden. + */ + containers?: Schema$ConfigManagementContainerOverride[]; + /** + * Required. The name of the deployment resource to be overridden. + */ + deploymentName?: string | null; + /** + * Required. The namespace of the deployment resource to be overridden.. + */ + deploymentNamespace?: string | null; + } /** * Model for a config file in the git repo with an associated Sync error. */ diff --git a/src/apis/gkehub/v2alpha.ts b/src/apis/gkehub/v2alpha.ts index 4207008a83a..40594893036 100644 --- a/src/apis/gkehub/v2alpha.ts +++ b/src/apis/gkehub/v2alpha.ts @@ -267,6 +267,10 @@ export namespace gkehub_v2alpha { * Configuration for Config Sync */ export interface Schema$ConfigManagementConfigSync { + /** + * Optional. Configuration for deployment overrides. + */ + deploymentOverrides?: Schema$ConfigManagementDeploymentOverride[]; /** * Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. */ @@ -428,6 +432,48 @@ export namespace gkehub_v2alpha { */ syncer?: string | null; } + /** + * Configuration for a container override. + */ + export interface Schema$ConfigManagementContainerOverride { + /** + * Required. The name of the container. + */ + containerName?: string | null; + /** + * Optional. The cpu limit of the container. + */ + cpuLimit?: string | null; + /** + * Optional. The cpu request of the container. + */ + cpuRequest?: string | null; + /** + * Optional. The memory limit of the container. + */ + memoryLimit?: string | null; + /** + * Optional. The memory request of the container. + */ + memoryRequest?: string | null; + } + /** + * Configuration for a deployment override. + */ + export interface Schema$ConfigManagementDeploymentOverride { + /** + * Optional. The containers of the deployment resource to be overridden. + */ + containers?: Schema$ConfigManagementContainerOverride[]; + /** + * Required. The name of the deployment resource to be overridden. + */ + deploymentName?: string | null; + /** + * Required. The namespace of the deployment resource to be overridden.. + */ + deploymentNamespace?: string | null; + } /** * Model for a config file in the git repo with an associated Sync error. */ diff --git a/src/apis/gkehub/v2beta.ts b/src/apis/gkehub/v2beta.ts index 65a3bdfbb56..126bb21d5b2 100644 --- a/src/apis/gkehub/v2beta.ts +++ b/src/apis/gkehub/v2beta.ts @@ -267,6 +267,10 @@ export namespace gkehub_v2beta { * Configuration for Config Sync */ export interface Schema$ConfigManagementConfigSync { + /** + * Optional. Configuration for deployment overrides. + */ + deploymentOverrides?: Schema$ConfigManagementDeploymentOverride[]; /** * Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. */ @@ -428,6 +432,48 @@ export namespace gkehub_v2beta { */ syncer?: string | null; } + /** + * Configuration for a container override. + */ + export interface Schema$ConfigManagementContainerOverride { + /** + * Required. The name of the container. + */ + containerName?: string | null; + /** + * Optional. The cpu limit of the container. + */ + cpuLimit?: string | null; + /** + * Optional. The cpu request of the container. + */ + cpuRequest?: string | null; + /** + * Optional. The memory limit of the container. + */ + memoryLimit?: string | null; + /** + * Optional. The memory request of the container. + */ + memoryRequest?: string | null; + } + /** + * Configuration for a deployment override. + */ + export interface Schema$ConfigManagementDeploymentOverride { + /** + * Optional. The containers of the deployment resource to be overridden. + */ + containers?: Schema$ConfigManagementContainerOverride[]; + /** + * Required. The name of the deployment resource to be overridden. + */ + deploymentName?: string | null; + /** + * Required. The namespace of the deployment resource to be overridden.. + */ + deploymentNamespace?: string | null; + } /** * Model for a config file in the git repo with an associated Sync error. */ From 852b4c507ea93e549a945ec06a16f17d358722fc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 074/144] fix(gkeonprem): update the API #### gkeonprem:v1 The following keys were changed: - title --- discovery/gkeonprem-v1.json | 4 ++-- src/apis/gkeonprem/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/gkeonprem-v1.json b/discovery/gkeonprem-v1.json index ac4ac87d071..6ee1801bef1 100644 --- a/discovery/gkeonprem-v1.json +++ b/discovery/gkeonprem-v1.json @@ -3094,7 +3094,7 @@ } } }, - "revision": "20241204", + "revision": "20250224", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -6878,7 +6878,7 @@ } }, "servicePath": "", - "title": "GDC Virtual API", + "title": "GKE On-Prem API", "version": "v1", "version_module": true } \ No newline at end of file diff --git a/src/apis/gkeonprem/v1.ts b/src/apis/gkeonprem/v1.ts index 19b4f699541..fdf4b628f09 100644 --- a/src/apis/gkeonprem/v1.ts +++ b/src/apis/gkeonprem/v1.ts @@ -100,7 +100,7 @@ export namespace gkeonprem_v1 { } /** - * GDC Virtual API + * GKE On-Prem API * * * From 88a22144f0576dbc6544d310891a5b48ebd00267 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 075/144] feat(healthcare): update the API #### healthcare:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveRendered.parameters.viewport.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveRendered.parameters.viewport.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveRendered.parameters.viewport.type - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveRendered.parameters.viewport.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveRendered.parameters.viewport.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveRendered.parameters.viewport.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._since.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._since.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._since.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._type.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._type.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._type.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.organizeOutputBy.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.organizeOutputBy.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.organizeOutputBy.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.outputFormat.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.outputFormat.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.outputFormat.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._since.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._since.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._since.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._type.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._type.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._type.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.outputFormat.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.outputFormat.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.outputFormat.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.scopes - schemas.BulkExportGcsDestination.description - schemas.BulkExportGcsDestination.id - schemas.BulkExportGcsDestination.properties.uriPrefix.description - schemas.BulkExportGcsDestination.properties.uriPrefix.type - schemas.BulkExportGcsDestination.type - schemas.Dataset.properties.satisfiesPzi.description - schemas.Dataset.properties.satisfiesPzi.readOnly - schemas.Dataset.properties.satisfiesPzi.type - schemas.Dataset.properties.satisfiesPzs.description - schemas.Dataset.properties.satisfiesPzs.readOnly - schemas.Dataset.properties.satisfiesPzs.type - schemas.FhirStore.properties.bulkExportGcsDestination.$ref - schemas.FhirStore.properties.bulkExportGcsDestination.description - schemas.GoogleCloudHealthcareV1beta1DicomBigQueryDestination.properties.changeDataCaptureConfig.$ref - schemas.GoogleCloudHealthcareV1beta1DicomBigQueryDestination.properties.changeDataCaptureConfig.description - schemas.GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig.description - schemas.GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig.id - schemas.GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig.type The following keys were changed: - schemas.ConsentAccessorScope.properties.environment.description - schemas.ConsentAccessorScope.properties.purpose.description #### healthcare:v1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveRendered.parameters.viewport.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveRendered.parameters.viewport.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveRendered.parameters.viewport.type - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveRendered.parameters.viewport.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveRendered.parameters.viewport.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveRendered.parameters.viewport.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._since.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._since.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._since.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._type.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._type.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters._type.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.organizeOutputBy.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.organizeOutputBy.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.organizeOutputBy.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.outputFormat.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.outputFormat.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.parameters.outputFormat.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._since.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._since.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._since.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._type.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._type.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters._type.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.outputFormat.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.outputFormat.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.parameters.outputFormat.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.bulk-export.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.delete-fhir-operation.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.flatPath - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.httpMethod - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.id - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.path - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.response.$ref - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.operations.methods.get-fhir-operation-status.scopes - schemas.BulkExportGcsDestination.description - schemas.BulkExportGcsDestination.id - schemas.BulkExportGcsDestination.properties.uriPrefix.description - schemas.BulkExportGcsDestination.properties.uriPrefix.type - schemas.BulkExportGcsDestination.type - schemas.Dataset.properties.satisfiesPzi.description - schemas.Dataset.properties.satisfiesPzi.readOnly - schemas.Dataset.properties.satisfiesPzi.type - schemas.Dataset.properties.satisfiesPzs.description - schemas.Dataset.properties.satisfiesPzs.readOnly - schemas.Dataset.properties.satisfiesPzs.type - schemas.FhirStore.properties.bulkExportGcsDestination.$ref - schemas.FhirStore.properties.bulkExportGcsDestination.description The following keys were changed: - schemas.ConsentAccessorScope.properties.environment.description - schemas.ConsentAccessorScope.properties.purpose.description --- discovery/healthcare-v1.json | 184 +++++++++++- discovery/healthcare-v1beta1.json | 194 ++++++++++++- src/apis/healthcare/v1.ts | 454 ++++++++++++++++++++++++++++- src/apis/healthcare/v1beta1.ts | 462 +++++++++++++++++++++++++++++- 4 files changed, 1284 insertions(+), 10 deletions(-) diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 0b9915a8f9b..0c4d328c3e2 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -2847,6 +2847,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", "required": true, "type": "string" + }, + "viewport": { + "description": "Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3", + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/dicomWeb/{+dicomWebPath}", @@ -2919,6 +2924,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", "required": true, "type": "string" + }, + "viewport": { + "description": "Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3", + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/dicomWeb/{+dicomWebPath}", @@ -3000,6 +3010,52 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "bulk-export-group": { + "description": "Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Group/{GroupId}/$export", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.bulk-export-group", + "parameterOrder": [ + "name" + ], + "parameters": { + "_since": { + "description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", + "location": "query", + "type": "string" + }, + "_type": { + "description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the Group resource that is exported, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Group/[^/]+$", + "required": true, + "type": "string" + }, + "organizeOutputBy": { + "description": "Optional. Required. The FHIR resource type used to organize exported resources. Only supports \"Patient\". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.", + "location": "query", + "type": "string" + }, + "outputFormat": { + "description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/$export", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a new FHIR store within the parent dataset.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", @@ -3728,6 +3784,47 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "bulk-export": { + "description": "Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$export", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.bulk-export", + "parameterOrder": [ + "name" + ], + "parameters": { + "_since": { + "description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", + "location": "query", + "type": "string" + }, + "_type": { + "description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the FHIR store to export resources from, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", + "required": true, + "type": "string" + }, + "outputFormat": { + "description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/fhir/$export", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "capabilities": { "description": "Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", @@ -4177,6 +4274,62 @@ ] } } + }, + "operations": { + "methods": { + "delete-fhir-operation": { + "description": "Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "healthcare.projects.locations.datasets.fhirStores.operations.delete-fhir-operation", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the operation to be deleted, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get-fhir-operation-status": { + "description": "Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the error.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.operations.get-fhir-operation-status", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the operation to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -4935,7 +5088,7 @@ } } }, - "revision": "20241226", + "revision": "20250219", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5377,6 +5530,17 @@ }, "type": "object" }, + "BulkExportGcsDestination": { + "description": "The configuration for exporting to Cloud Storage using the bulk export API.", + "id": "BulkExportGcsDestination", + "properties": { + "uriPrefix": { + "description": "Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`.", + "type": "string" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -5531,11 +5695,11 @@ "type": "string" }, "environment": { - "description": "An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be \"*\" if it applies to all environments.", + "description": "An abstract identifier that describes the environment or conditions under which the accessor is acting. If it's not specified, it applies to all environments.", "type": "string" }, "purpose": { - "description": "The intent of data use. Can be \"*\" if it applies to all purposes.", + "description": "The intent of data use. If it's not specified, it applies to all purposes.", "type": "string" } }, @@ -5766,6 +5930,16 @@ "description": "Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. For future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. For future use.", + "readOnly": true, + "type": "boolean" + }, "timeZone": { "description": "Optional. The default timezone used by this dataset. Must be a either a valid IANA time zone name such as \"America/New_York\" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified.", "type": "string" @@ -6488,6 +6662,10 @@ "description": "Represents a FHIR store.", "id": "FhirStore", "properties": { + "bulkExportGcsDestination": { + "$ref": "BulkExportGcsDestination", + "description": "Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination." + }, "complexDataTypeReferenceParsing": { "description": "Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.", "enum": [ diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 5fac42ae5df..1a5554d1d6b 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -3370,6 +3370,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", "required": true, "type": "string" + }, + "viewport": { + "description": "Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3", + "location": "query", + "type": "string" } }, "path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}", @@ -3480,6 +3485,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", "required": true, "type": "string" + }, + "viewport": { + "description": "Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3", + "location": "query", + "type": "string" } }, "path": "v1beta1/{+parent}/dicomWeb/{+dicomWebPath}", @@ -3561,6 +3571,52 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "bulk-export-group": { + "description": "Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Group/{GroupId}/$export", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.bulk-export-group", + "parameterOrder": [ + "name" + ], + "parameters": { + "_since": { + "description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", + "location": "query", + "type": "string" + }, + "_type": { + "description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the `Group` resource that is exported, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Group/[^/]+$", + "required": true, + "type": "string" + }, + "organizeOutputBy": { + "description": "Optional. Required. The FHIR resource type used to organize exported resources. Only supports \"Patient\". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.", + "location": "query", + "type": "string" + }, + "outputFormat": { + "description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/$export", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "configureSearch": { "description": "Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:configureSearch", @@ -4598,6 +4654,47 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "bulk-export": { + "description": "Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$export", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.bulk-export", + "parameterOrder": [ + "name" + ], + "parameters": { + "_since": { + "description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", + "location": "query", + "type": "string" + }, + "_type": { + "description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the FHIR store to export resources from, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", + "required": true, + "type": "string" + }, + "outputFormat": { + "description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/fhir/$export", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "capabilities": { "description": "Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", @@ -5047,6 +5144,62 @@ ] } } + }, + "operations": { + "methods": { + "delete-fhir-operation": { + "description": "Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "healthcare.projects.locations.datasets.fhirStores.operations.delete-fhir-operation", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the operation to be deleted, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get-fhir-operation-status": { + "description": "Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the error.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.operations.get-fhir-operation-status", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the operation to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -5858,7 +6011,7 @@ } } }, - "revision": "20250116", + "revision": "20250306", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6456,6 +6609,17 @@ }, "type": "object" }, + "BulkExportGcsDestination": { + "description": "The configuration for exporting to Cloud Storage using the bulk export API.", + "id": "BulkExportGcsDestination", + "properties": { + "uriPrefix": { + "description": "Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`.", + "type": "string" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -6663,11 +6827,11 @@ "type": "string" }, "environment": { - "description": "An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be \"*\" if it applies to all environments.", + "description": "An abstract identifier that describes the environment or conditions under which the accessor is acting. If it's not specified, it applies to all environments.", "type": "string" }, "purpose": { - "description": "The intent of data use. Can be \"*\" if it applies to all purposes.", + "description": "The intent of data use. If it's not specified, it applies to all purposes.", "type": "string" } }, @@ -6910,6 +7074,16 @@ "description": "Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. For future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. For future use.", + "readOnly": true, + "type": "boolean" + }, "timeZone": { "description": "The default timezone used by this dataset. Must be a either a valid IANA time zone name such as \"America/New_York\" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified.", "type": "string" @@ -7856,6 +8030,10 @@ "description": "Represents a FHIR store.", "id": "FhirStore", "properties": { + "bulkExportGcsDestination": { + "$ref": "BulkExportGcsDestination", + "description": "Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination." + }, "complexDataTypeReferenceParsing": { "description": "Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.", "enum": [ @@ -8316,6 +8494,10 @@ "description": "The BigQuery table where the server writes output.", "id": "GoogleCloudHealthcareV1beta1DicomBigQueryDestination", "properties": { + "changeDataCaptureConfig": { + "$ref": "GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig", + "description": "Optional. Setting this field will enable BigQuery's Change Data Capture (CDC) on the destination tables. Set this field if you want to only keep the latest version of each instance. Updates and deletes to an existing' instance will overwrite the corresponding row. See https://cloud.google.com/bigquery/docs/change-data-capture for details." + }, "force": { "description": "Use `write_disposition` instead. 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" @@ -8343,6 +8525,12 @@ }, "type": "object" }, + "GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig": { + "description": "BigQuery Change Data Capture configuration.", + "id": "GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudHealthcareV1beta1DicomGcsDestination": { "description": "The Cloud Storage location where the server writes the output and the export configuration.", "id": "GoogleCloudHealthcareV1beta1DicomGcsDestination", diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index a6a2f4e256a..518bb37ae57 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -397,6 +397,15 @@ export namespace healthcare_v1 { */ blobStorageClass?: string | null; } + /** + * The configuration for exporting to Cloud Storage using the bulk export API. + */ + export interface Schema$BulkExportGcsDestination { + /** + * Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id\}/{path/to/destination/dir\}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + */ + uriPrefix?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -498,11 +507,11 @@ export namespace healthcare_v1 { */ actor?: string | null; /** - * An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be "*" if it applies to all environments. + * An abstract identifier that describes the environment or conditions under which the accessor is acting. If it's not specified, it applies to all environments. */ environment?: string | null; /** - * The intent of data use. Can be "*" if it applies to all purposes. + * The intent of data use. If it's not specified, it applies to all purposes. */ purpose?: string | null; } @@ -663,6 +672,14 @@ export namespace healthcare_v1 { * Identifier. Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string | null; + /** + * Output only. For future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. For future use. + */ + satisfiesPzs?: boolean | null; /** * Optional. The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified. */ @@ -1208,6 +1225,10 @@ export namespace healthcare_v1 { * Represents a FHIR store. */ export interface Schema$FhirStore { + /** + * Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + */ + bulkExportGcsDestination?: Schema$BulkExportGcsDestination; /** * Optional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. */ @@ -11585,6 +11606,10 @@ export namespace healthcare_v1 { * Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}`. */ parent?: string; + /** + * Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3 + */ + viewport?: string; } export class Resource$Projects$Locations$Datasets$Dicomstores$Studies$Series$Instances$Frames { @@ -11793,16 +11818,25 @@ export namespace healthcare_v1 { * Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}`. */ parent?: string; + /** + * Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3 + */ + viewport?: string; } export class Resource$Projects$Locations$Datasets$Fhirstores { context: APIRequestContext; fhir: Resource$Projects$Locations$Datasets$Fhirstores$Fhir; + operations: Resource$Projects$Locations$Datasets$Fhirstores$Operations; constructor(context: APIRequestContext) { this.context = context; this.fhir = new Resource$Projects$Locations$Datasets$Fhirstores$Fhir( this.context ); + this.operations = + new Resource$Projects$Locations$Datasets$Fhirstores$Operations( + this.context + ); } /** @@ -11983,6 +12017,95 @@ export namespace healthcare_v1 { } } + /** + * Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id\}/{path/to/destination/dir\}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id\}_{resource_type\}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/operations/{export_id\}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the 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. + */ + bulkExportGroup( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + options: StreamMethodOptions + ): GaxiosPromise; + bulkExportGroup( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + options?: MethodOptions + ): GaxiosPromise; + bulkExportGroup( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkExportGroup( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkExportGroup( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + callback: BodyResponseCallback + ): void; + bulkExportGroup(callback: BodyResponseCallback): void; + bulkExportGroup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup; + 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}/$export').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); + } + } + /** * Creates a new FHIR store within the parent dataset. * @@ -13260,6 +13383,29 @@ export namespace healthcare_v1 { */ requestBody?: Schema$ApplyConsentsRequest; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup + extends StandardParameters { + /** + * Required. Name of the Group resource that is exported, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. + */ + name?: string; + /** + * Optional. Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files. + */ + organizeOutputBy?: string; + /** + * Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported. + */ + outputFormat?: string; + /** + * Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. + */ + _since?: string; + /** + * Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. + */ + _type?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Create extends StandardParameters { /** @@ -13780,6 +13926,95 @@ export namespace healthcare_v1 { } } + /** + * Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id\}/{path/to/destination/dir\}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id\}_{resource_type\}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/operations/{export_id\}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the 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. + */ + bulkExport( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + options: StreamMethodOptions + ): GaxiosPromise; + bulkExport( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + options?: MethodOptions + ): GaxiosPromise; + bulkExport( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkExport( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkExport( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + callback: BodyResponseCallback + ): void; + bulkExport(callback: BodyResponseCallback): void; + bulkExport( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport; + 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}/fhir/$export').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 FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. * @@ -15492,6 +15727,25 @@ export namespace healthcare_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport + extends StandardParameters { + /** + * Required. The name of the FHIR store to export resources from, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}`. + */ + name?: string; + /** + * Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported. + */ + outputFormat?: string; + /** + * Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. + */ + _since?: string; + /** + * Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. + */ + _type?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities extends StandardParameters { /** @@ -15747,6 +16001,202 @@ export namespace healthcare_v1 { name?: string; } + export class Resource$Projects$Locations$Datasets$Fhirstores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deleteFhirOperation( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + options: StreamMethodOptions + ): GaxiosPromise; + deleteFhirOperation( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + options?: MethodOptions + ): GaxiosPromise; + deleteFhirOperation( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteFhirOperation( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteFhirOperation( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + callback: BodyResponseCallback + ): void; + deleteFhirOperation(callback: BodyResponseCallback): void; + deleteFhirOperation( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation; + 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}').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 status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the 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. + */ + getFhirOperationStatus( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + options: StreamMethodOptions + ): GaxiosPromise; + getFhirOperationStatus( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + options?: MethodOptions + ): GaxiosPromise; + getFhirOperationStatus( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getFhirOperationStatus( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getFhirOperationStatus( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + callback: BodyResponseCallback + ): void; + getFhirOperationStatus( + callback: BodyResponseCallback + ): void; + getFhirOperationStatus( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus; + 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}').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$Datasets$Fhirstores$Operations$Deletefhiroperation + extends StandardParameters { + /** + * Required. Name of the operation to be deleted, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/operations/{operation_id\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus + extends StandardParameters { + /** + * Required. Name of the operation to query, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/operations/{operation_id\}`. + */ + name?: string; + } + export class Resource$Projects$Locations$Datasets$Hl7v2stores { context: APIRequestContext; messages: Resource$Projects$Locations$Datasets$Hl7v2stores$Messages; diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 4087ad071fc..479a8075fe2 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -524,6 +524,15 @@ export namespace healthcare_v1beta1 { */ vertices?: Schema$Vertex[]; } + /** + * The configuration for exporting to Cloud Storage using the bulk export API. + */ + export interface Schema$BulkExportGcsDestination { + /** + * Optional. URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id\}/{path/to/destination/dir\}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + */ + uriPrefix?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -663,11 +672,11 @@ export namespace healthcare_v1beta1 { */ actor?: string | null; /** - * An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be "*" if it applies to all environments. + * An abstract identifier that describes the environment or conditions under which the accessor is acting. If it's not specified, it applies to all environments. */ environment?: string | null; /** - * The intent of data use. Can be "*" if it applies to all purposes. + * The intent of data use. If it's not specified, it applies to all purposes. */ purpose?: string | null; } @@ -836,6 +845,14 @@ export namespace healthcare_v1beta1 { * Identifier. Resource name of the dataset, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}`. */ name?: string | null; + /** + * Output only. For future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. For future use. + */ + satisfiesPzs?: boolean | null; /** * The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified. */ @@ -1531,6 +1548,10 @@ export namespace healthcare_v1beta1 { * Represents a FHIR store. */ export interface Schema$FhirStore { + /** + * Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM role on the destination. + */ + bulkExportGcsDestination?: Schema$BulkExportGcsDestination; /** * Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. */ @@ -1844,6 +1865,10 @@ export namespace healthcare_v1beta1 { * The BigQuery table where the server writes output. */ export interface Schema$GoogleCloudHealthcareV1beta1DicomBigQueryDestination { + /** + * Optional. Setting this field will enable BigQuery's Change Data Capture (CDC) on the destination tables. Set this field if you want to only keep the latest version of each instance. Updates and deletes to an existing' instance will overwrite the corresponding row. See https://cloud.google.com/bigquery/docs/change-data-capture for details. + */ + changeDataCaptureConfig?: Schema$GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig; /** * Use `write_disposition` instead. 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. */ @@ -1857,6 +1882,10 @@ export namespace healthcare_v1beta1 { */ writeDisposition?: string | null; } + /** + * BigQuery Change Data Capture configuration. + */ + export interface Schema$GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig {} /** * The Cloud Storage location where the server writes the output and the export configuration. */ @@ -13916,6 +13945,10 @@ export namespace healthcare_v1beta1 { * Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}`. */ parent?: string; + /** + * Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3 + */ + viewport?: string; } export class Resource$Projects$Locations$Datasets$Dicomstores$Studies$Series$Instances$Bulkdata { @@ -14229,16 +14262,25 @@ export namespace healthcare_v1beta1 { * Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}`. */ parent?: string; + /** + * Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3 + */ + viewport?: string; } export class Resource$Projects$Locations$Datasets$Fhirstores { context: APIRequestContext; fhir: Resource$Projects$Locations$Datasets$Fhirstores$Fhir; + operations: Resource$Projects$Locations$Datasets$Fhirstores$Operations; constructor(context: APIRequestContext) { this.context = context; this.fhir = new Resource$Projects$Locations$Datasets$Fhirstores$Fhir( this.context ); + this.operations = + new Resource$Projects$Locations$Datasets$Fhirstores$Operations( + this.context + ); } /** @@ -14419,6 +14461,95 @@ export namespace healthcare_v1beta1 { } } + /** + * Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id\}/{path/to/destination/dir\}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id\}_{resource_type\}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/operations/{export_id\}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the 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. + */ + bulkExportGroup( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + options: StreamMethodOptions + ): GaxiosPromise; + bulkExportGroup( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + options?: MethodOptions + ): GaxiosPromise; + bulkExportGroup( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkExportGroup( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkExportGroup( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup, + callback: BodyResponseCallback + ): void; + bulkExportGroup(callback: BodyResponseCallback): void; + bulkExportGroup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup; + 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}/$export').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); + } + } + /** * Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation. * @@ -15969,6 +16100,29 @@ export namespace healthcare_v1beta1 { */ requestBody?: Schema$ApplyConsentsRequest; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Bulkexportgroup + extends StandardParameters { + /** + * Required. Name of the `Group` resource that is exported, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. + */ + name?: string; + /** + * Optional. Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files. + */ + organizeOutputBy?: string; + /** + * Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported. + */ + outputFormat?: string; + /** + * Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. + */ + _since?: string; + /** + * Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. + */ + _type?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Configuresearch extends StandardParameters { /** @@ -16525,6 +16679,95 @@ export namespace healthcare_v1beta1 { } } + /** + * Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id\}/{path/to/destination/dir\}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id\}_{resource_type\}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/operations/{export_id\}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the 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. + */ + bulkExport( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + options: StreamMethodOptions + ): GaxiosPromise; + bulkExport( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + options?: MethodOptions + ): GaxiosPromise; + bulkExport( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkExport( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkExport( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport, + callback: BodyResponseCallback + ): void; + bulkExport(callback: BodyResponseCallback): void; + bulkExport( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport; + 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}/fhir/$export').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 FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. * @@ -18687,6 +18930,25 @@ export namespace healthcare_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Bulkexport + extends StandardParameters { + /** + * Required. The name of the FHIR store to export resources from, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}`. + */ + name?: string; + /** + * Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported. + */ + outputFormat?: string; + /** + * Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. + */ + _since?: string; + /** + * Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. + */ + _type?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities extends StandardParameters { /** @@ -19049,6 +19311,202 @@ export namespace healthcare_v1beta1 { name?: string; } + export class Resource$Projects$Locations$Datasets$Fhirstores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data delete request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deleteFhirOperation( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + options: StreamMethodOptions + ): GaxiosPromise; + deleteFhirOperation( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + options?: MethodOptions + ): GaxiosPromise; + deleteFhirOperation( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteFhirOperation( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteFhirOperation( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation, + callback: BodyResponseCallback + ): void; + deleteFhirOperation(callback: BodyResponseCallback): void; + deleteFhirOperation( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Deletefhiroperation; + 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}').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 status of operations as defined in the FHIR specification. Implements the FHIR implementation guide [bulk data status request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). Operations can have one of these states: * in-progress: response status code is `202` and `X-Progress` header is set to `in progress`. * complete: response status code is `200` and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is `5XX`, and the body is a JSON-encoded `OperationOutcome` resource describing the reason for the 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. + */ + getFhirOperationStatus( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + options: StreamMethodOptions + ): GaxiosPromise; + getFhirOperationStatus( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + options?: MethodOptions + ): GaxiosPromise; + getFhirOperationStatus( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getFhirOperationStatus( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getFhirOperationStatus( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus, + callback: BodyResponseCallback + ): void; + getFhirOperationStatus( + callback: BodyResponseCallback + ): void; + getFhirOperationStatus( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus; + 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}').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$Datasets$Fhirstores$Operations$Deletefhiroperation + extends StandardParameters { + /** + * Required. Name of the operation to be deleted, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/operations/{operation_id\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Operations$Getfhiroperationstatus + extends StandardParameters { + /** + * Required. Name of the operation to query, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/operations/{operation_id\}`. + */ + name?: string; + } + export class Resource$Projects$Locations$Datasets$Hl7v2stores { context: APIRequestContext; messages: Resource$Projects$Locations$Datasets$Hl7v2stores$Messages; From 3190d05be8fade7c50983785b659d6b849d35fdd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 076/144] fix(iam): update the API #### iam:v2beta The following keys were changed: - schemas.GoogleIamV2betaDenyRule.properties.deniedPrincipals.description #### iam:v1 The following keys were changed: - schemas.GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client.properties.attributesType.enum - schemas.GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client.properties.attributesType.enumDescriptions #### iam:v2 The following keys were changed: - schemas.GoogleIamV2DenyRule.properties.deniedPrincipals.description --- discovery/iam-v1.json | 8 +++++--- discovery/iam-v2.json | 4 ++-- discovery/iam-v2beta.json | 4 ++-- src/apis/iam/v2.ts | 2 +- src/apis/iam/v2beta.ts | 2 +- 5 files changed, 11 insertions(+), 9 deletions(-) diff --git a/discovery/iam-v1.json b/discovery/iam-v1.json index 1c32dbb98d0..c32659ba187 100644 --- a/discovery/iam-v1.json +++ b/discovery/iam-v1.json @@ -3188,7 +3188,7 @@ } } }, - "revision": "20250116", + "revision": "20250213", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -3551,11 +3551,13 @@ "description": "Required. Represents the IdP and type of claims that should be fetched.", "enum": [ "ATTRIBUTES_TYPE_UNSPECIFIED", - "AZURE_AD_GROUPS_MAIL" + "AZURE_AD_GROUPS_MAIL", + "AZURE_AD_GROUPS_ID" ], "enumDescriptions": [ "No AttributesType specified.", - "Used to get the user's group claims from the Microsoft Entra ID identity provider using configuration provided in ExtraAttributesOAuth2Client and `mail` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The attributes obtained from idntity provider are mapped to `assertion.groups`." + "Used to get the user's group claims from the Microsoft Entra ID identity provider using configuration provided in ExtraAttributesOAuth2Client and `mail` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The attributes obtained from idntity provider are mapped to `assertion.groups`.", + "Used to get the user's group claims from the Microsoft Entra ID identity provider using configuration provided in ExtraAttributesOAuth2Client and `id` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The group IDs obtained from Microsoft Entra ID are present in `assertion. groups` for OIDC providers and `assertion.attributes.groups` for SAML providers for attribute mapping." ], "type": "string" }, diff --git a/discovery/iam-v2.json b/discovery/iam-v2.json index 38640c33fb9..dfcc4a85696 100644 --- a/discovery/iam-v2.json +++ b/discovery/iam-v2.json @@ -293,7 +293,7 @@ } } }, - "revision": "20241114", + "revision": "20250213", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -483,7 +483,7 @@ "type": "array" }, "deniedPrincipals": { - "description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `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:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `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`.", + "description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `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. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `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" }, diff --git a/discovery/iam-v2beta.json b/discovery/iam-v2beta.json index 4bec41fbcb1..f1cbadc2fe1 100644 --- a/discovery/iam-v2beta.json +++ b/discovery/iam-v2beta.json @@ -293,7 +293,7 @@ } } }, - "revision": "20241114", + "revision": "20250213", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -483,7 +483,7 @@ "type": "array" }, "deniedPrincipals": { - "description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `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:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `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`.", + "description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `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. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `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" }, diff --git a/src/apis/iam/v2.ts b/src/apis/iam/v2.ts index bf8e670935e..2b64209d9d6 100644 --- a/src/apis/iam/v2.ts +++ b/src/apis/iam/v2.ts @@ -248,7 +248,7 @@ export namespace iam_v2 { */ deniedPermissions?: string[] | null; /** - * The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id\}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id\}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id\}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `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:principal://goog/subject/{email_id\}?uid={uid\}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id\}?uid={uid\}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}?uid={uid\}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `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`. + * The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id\}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id\}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id\}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `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. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id\}?uid={uid\}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id\}?uid={uid\}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}?uid={uid\}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `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`. */ deniedPrincipals?: string[] | null; /** diff --git a/src/apis/iam/v2beta.ts b/src/apis/iam/v2beta.ts index 4406b672b0b..0331b940537 100644 --- a/src/apis/iam/v2beta.ts +++ b/src/apis/iam/v2beta.ts @@ -248,7 +248,7 @@ export namespace iam_v2beta { */ deniedPermissions?: string[] | null; /** - * The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id\}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id\}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id\}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `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:principal://goog/subject/{email_id\}?uid={uid\}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id\}?uid={uid\}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}?uid={uid\}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `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`. + * The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id\}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id\}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id\}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `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. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id\}?uid={uid\}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id\}?uid={uid\}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}?uid={uid\}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `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`. */ deniedPrincipals?: string[] | null; /** From 150260b72a9e9c3af2c6e8aaa72140fea082bdee Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 077/144] feat(identitytoolkit)!: update the API BREAKING CHANGE: This release has breaking changes. #### identitytoolkit:v1 The following keys were deleted: - schemas.GoogleCloudIdentitytoolkitV1GetAccountInfoRequest.properties.federatedUserId.description - schemas.GoogleCloudIdentitytoolkitV1IdpConfig.properties.provider.description - schemas.GoogleCloudIdentitytoolkitV1QueryUserInfoRequest.properties.expression.description - schemas.GoogleCloudIdentitytoolkitV1QueryUserInfoRequest.properties.order.description - schemas.GoogleCloudIdentitytoolkitV1QueryUserInfoRequest.properties.sortBy.description - schemas.GoogleCloudIdentitytoolkitV1SetAccountInfoRequest.properties.deleteAttribute.description - schemas.GoogleCloudIdentitytoolkitV1UploadAccountRequest.properties.passwordHashOrder.description The following keys were added: - schemas.GoogleCloudIdentitytoolkitV1GetOobCodeRequest.properties.linkDomain.description - schemas.GoogleCloudIdentitytoolkitV1GetOobCodeRequest.properties.linkDomain.type #### identitytoolkit:v2 The following keys were added: - schemas.GoogleCloudIdentitytoolkitAdminV2Config.properties.defaultHostingSite.description - schemas.GoogleCloudIdentitytoolkitAdminV2Config.properties.defaultHostingSite.readOnly - schemas.GoogleCloudIdentitytoolkitAdminV2Config.properties.defaultHostingSite.type - schemas.GoogleCloudIdentitytoolkitAdminV2Config.properties.mobileLinksConfig.$ref - schemas.GoogleCloudIdentitytoolkitAdminV2Config.properties.mobileLinksConfig.description - schemas.GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig.description - schemas.GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig.id - schemas.GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig.properties.domain.description - schemas.GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig.properties.domain.enum - schemas.GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig.properties.domain.enumDescriptions - schemas.GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig.properties.domain.type - schemas.GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig.type - schemas.GoogleCloudIdentitytoolkitAdminV2Tenant.properties.mobileLinksConfig.$ref - schemas.GoogleCloudIdentitytoolkitAdminV2Tenant.properties.mobileLinksConfig.deprecated - schemas.GoogleCloudIdentitytoolkitAdminV2Tenant.properties.mobileLinksConfig.description --- discovery/identitytoolkit-v1.json | 13 +++++------ discovery/identitytoolkit-v2.json | 37 ++++++++++++++++++++++++++++++- src/apis/identitytoolkit/v2.ts | 21 ++++++++++++++++++ 3 files changed, 62 insertions(+), 9 deletions(-) diff --git a/discovery/identitytoolkit-v1.json b/discovery/identitytoolkit-v1.json index 4d77c254663..1be564ea364 100644 --- a/discovery/identitytoolkit-v1.json +++ b/discovery/identitytoolkit-v1.json @@ -1239,7 +1239,7 @@ } } }, - "revision": "20241205", + "revision": "20250130", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { @@ -1694,7 +1694,6 @@ "type": "array" }, "federatedUserId": { - "description": "The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "items": { "$ref": "GoogleCloudIdentitytoolkitV1FederatedUserIdentifier" }, @@ -1822,6 +1821,10 @@ "description": "An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true.", "type": "string" }, + "linkDomain": { + "description": "Optional. In order to ensure that the url used can be easily opened in iOS or Android, we create a Hosting link '/__/auth/links'. This optional field contains the domain to use when constructing a Hosting link. If not set, '.firebaseapp.com' domain will be used.", + "type": "string" + }, "newEmail": { "description": "The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests.", "type": "string" @@ -2037,7 +2040,6 @@ "type": "integer" }, "provider": { - "description": "Name of the identity provider.", "enum": [ "PROVIDER_UNSPECIFIED", "MSLIVE", @@ -2276,7 +2278,6 @@ "id": "GoogleCloudIdentitytoolkitV1QueryUserInfoRequest", "properties": { "expression": { - "description": "Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1SqlExpression" }, @@ -2293,7 +2294,6 @@ "type": "string" }, "order": { - "description": "The order for sorting query result. Defaults to __ascending__ order. Only valid when `return_user_info` is set to `true`.", "enum": [ "ORDER_UNSPECIFIED", "ASC", @@ -2311,7 +2311,6 @@ "type": "boolean" }, "sortBy": { - "description": "The field to use for sorting user accounts. Defaults to `USER_ID`. Note: when `phone_number` is specified in `expression`, the result ignores the sorting. Only valid when `return_user_info` is set to `true`.", "enum": [ "SORT_BY_FIELD_UNSPECIFIED", "USER_ID", @@ -2549,7 +2548,6 @@ "type": "string" }, "deleteAttribute": { - "description": "The account's attributes to be deleted.", "items": { "enum": [ "USER_ATTRIBUTE_NAME_UNSPECIFIED", @@ -3638,7 +3636,6 @@ "type": "integer" }, "passwordHashOrder": { - "description": "Password and salt order when verify password.", "enum": [ "UNSPECIFIED_ORDER", "SALT_AND_PASSWORD", diff --git a/discovery/identitytoolkit-v2.json b/discovery/identitytoolkit-v2.json index ff0906cb47f..86dc9d6e76a 100644 --- a/discovery/identitytoolkit-v2.json +++ b/discovery/identitytoolkit-v2.json @@ -1655,7 +1655,7 @@ } } }, - "revision": "20241024", + "revision": "20250130", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": { @@ -1822,6 +1822,11 @@ "$ref": "GoogleCloudIdentitytoolkitAdminV2ClientConfig", "description": "Options related to how clients making requests on behalf of a project should be configured." }, + "defaultHostingSite": { + "description": "Output only. Default Firebase hosting site name", + "readOnly": true, + "type": "string" + }, "emailPrivacyConfig": { "$ref": "GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig", "description": "Configuration for settings related to email privacy and public visibility." @@ -1830,6 +1835,10 @@ "$ref": "GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig", "description": "Configuration for this project's multi-factor authentication, including whether it is active and what factors can be used for the second factor" }, + "mobileLinksConfig": { + "$ref": "GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig", + "description": "Configuration for settings related to univeral links (iOS) and app links (Android)." + }, "monitoring": { "$ref": "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig", "description": "Configuration related to monitoring project activity." @@ -2340,6 +2349,27 @@ }, "type": "object" }, + "GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig": { + "description": "Configuration mobile links.", + "id": "GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig", + "properties": { + "domain": { + "description": "Open code in app domain to use for app links and universal links.", + "enum": [ + "DOMAIN_UNSPECIFIED", + "FIREBASE_DYNAMIC_LINK_DOMAIN", + "HOSTING_DOMAIN" + ], + "enumDescriptions": [ + "Default value. The default domain is the Firebase Dynamic Link domain before the FDL deprecation and the hosting domain after the FDL deprecation.", + "Use Firebase Dynamic Link domain as app link domain. Default value.", + "Use hosting domain as app link domain." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig": { "description": "Configuration related to monitoring project activity.", "id": "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig", @@ -3045,6 +3075,11 @@ "$ref": "GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig", "description": "The tenant-level configuration of MFA options." }, + "mobileLinksConfig": { + "$ref": "GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig", + "deprecated": true, + "description": "Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android)." + }, "monitoring": { "$ref": "GoogleCloudIdentitytoolkitAdminV2MonitoringConfig", "description": "Configuration related to monitoring project activity." diff --git a/src/apis/identitytoolkit/v2.ts b/src/apis/identitytoolkit/v2.ts index 250b1b210b1..6becfd32115 100644 --- a/src/apis/identitytoolkit/v2.ts +++ b/src/apis/identitytoolkit/v2.ts @@ -263,6 +263,10 @@ export namespace identitytoolkit_v2 { * Options related to how clients making requests on behalf of a project should be configured. */ client?: Schema$GoogleCloudIdentitytoolkitAdminV2ClientConfig; + /** + * Output only. Default Firebase hosting site name + */ + defaultHostingSite?: string | null; /** * Configuration for settings related to email privacy and public visibility. */ @@ -271,6 +275,10 @@ export namespace identitytoolkit_v2 { * Configuration for this project's multi-factor authentication, including whether it is active and what factors can be used for the second factor */ mfa?: Schema$GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig; + /** + * Configuration for settings related to univeral links (iOS) and app links (Android). + */ + mobileLinksConfig?: Schema$GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig; /** * Configuration related to monitoring project activity. */ @@ -638,6 +646,15 @@ export namespace identitytoolkit_v2 { */ tenants?: Schema$GoogleCloudIdentitytoolkitAdminV2Tenant[]; } + /** + * Configuration mobile links. + */ + export interface Schema$GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig { + /** + * Open code in app domain to use for app links and universal links. + */ + domain?: string | null; + } /** * Configuration related to monitoring project activity. */ @@ -1136,6 +1153,10 @@ export namespace identitytoolkit_v2 { * The tenant-level configuration of MFA options. */ mfaConfig?: Schema$GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig; + /** + * Optional. Deprecated. Never launched. Configuration for settings related to univeral links (iOS) and app links (Android). + */ + mobileLinksConfig?: Schema$GoogleCloudIdentitytoolkitAdminV2MobileLinksConfig; /** * Configuration related to monitoring project activity. */ From 156a7df56724d899538621c36a723c0dbd1f5eed Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 078/144] feat(ids)!: update the API BREAKING CHANGE: This release has breaking changes. #### ids:v1 The following keys were deleted: - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.description - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.flatPath - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.httpMethod - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.id - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameterOrder - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.path - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.response.$ref - resources.projects.resources.locations.resources.endpoints.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.description - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.flatPath - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.httpMethod - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.id - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.parameterOrder - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.path - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.request.$ref - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.response.$ref - resources.projects.resources.locations.resources.endpoints.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.description - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.id - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.path - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.request.$ref - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.endpoints.methods.testIamPermissions.scopes - schemas.AuditConfig.description - schemas.AuditConfig.id - schemas.AuditConfig.properties.auditLogConfigs.description - schemas.AuditConfig.properties.auditLogConfigs.items.$ref - schemas.AuditConfig.properties.auditLogConfigs.type - schemas.AuditConfig.properties.service.description - schemas.AuditConfig.properties.service.type - schemas.AuditConfig.type - schemas.AuditLogConfig.description - schemas.AuditLogConfig.id - schemas.AuditLogConfig.properties.exemptedMembers.description - schemas.AuditLogConfig.properties.exemptedMembers.items.type - schemas.AuditLogConfig.properties.exemptedMembers.type - schemas.AuditLogConfig.properties.logType.description - schemas.AuditLogConfig.properties.logType.enum - schemas.AuditLogConfig.properties.logType.enumDescriptions - schemas.AuditLogConfig.properties.logType.type - schemas.AuditLogConfig.type - schemas.Binding.description - schemas.Binding.id - schemas.Binding.properties.condition.$ref - schemas.Binding.properties.condition.description - schemas.Binding.properties.members.description - schemas.Binding.properties.members.items.type - schemas.Binding.properties.members.type - schemas.Binding.properties.role.description - schemas.Binding.properties.role.type - schemas.Binding.type - schemas.Expr.description - schemas.Expr.id - schemas.Expr.properties.description.description - schemas.Expr.properties.description.type - schemas.Expr.properties.expression.description - schemas.Expr.properties.expression.type - schemas.Expr.properties.location.description - schemas.Expr.properties.location.type - schemas.Expr.properties.title.description - schemas.Expr.properties.title.type - schemas.Expr.type - schemas.Policy.description - schemas.Policy.id - schemas.Policy.properties.auditConfigs.description - schemas.Policy.properties.auditConfigs.items.$ref - schemas.Policy.properties.auditConfigs.type - schemas.Policy.properties.bindings.description - schemas.Policy.properties.bindings.items.$ref - schemas.Policy.properties.bindings.type - schemas.Policy.properties.etag.description - schemas.Policy.properties.etag.format - schemas.Policy.properties.etag.type - schemas.Policy.properties.version.description - schemas.Policy.properties.version.format - schemas.Policy.properties.version.type - schemas.Policy.type - schemas.SetIamPolicyRequest.description - schemas.SetIamPolicyRequest.id - schemas.SetIamPolicyRequest.properties.policy.$ref - schemas.SetIamPolicyRequest.properties.policy.description - schemas.SetIamPolicyRequest.properties.updateMask.description - schemas.SetIamPolicyRequest.properties.updateMask.format - schemas.SetIamPolicyRequest.properties.updateMask.type - schemas.SetIamPolicyRequest.type - schemas.TestIamPermissionsRequest.description - schemas.TestIamPermissionsRequest.id - schemas.TestIamPermissionsRequest.properties.permissions.description - schemas.TestIamPermissionsRequest.properties.permissions.items.type - schemas.TestIamPermissionsRequest.properties.permissions.type - schemas.TestIamPermissionsRequest.type - schemas.TestIamPermissionsResponse.description - schemas.TestIamPermissionsResponse.id - schemas.TestIamPermissionsResponse.properties.permissions.description - schemas.TestIamPermissionsResponse.properties.permissions.items.type - schemas.TestIamPermissionsResponse.properties.permissions.type - schemas.TestIamPermissionsResponse.type The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description - schemas.OperationMetadata.properties.requestedCancellation.description --- discovery/ids-v1.json | 261 +------------------------ src/apis/ids/v1.ts | 429 +----------------------------------------- 2 files changed, 5 insertions(+), 685 deletions(-) diff --git a/discovery/ids-v1.json b/discovery/ids-v1.json index 28bb64ee321..96f0969d92f 100644 --- a/discovery/ids-v1.json +++ b/discovery/ids-v1.json @@ -272,37 +272,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}/endpoints/{endpointsId}:getIamPolicy", - "httpMethod": "GET", - "id": "ids.projects.locations.endpoints.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/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Endpoints in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", @@ -387,69 +356,13 @@ "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}/endpoints/{endpointsId}:setIamPolicy", - "httpMethod": "POST", - "id": "ids.projects.locations.endpoints.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/[^/]+/endpoints/[^/]+$", - "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}/endpoints/{endpointsId}:testIamPermissions", - "httpMethod": "POST", - "id": "ids.projects.locations.endpoints.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/[^/]+/endpoints/[^/]+$", - "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`.", + "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": "ids.projects.locations.operations.cancel", @@ -574,79 +487,9 @@ } } }, - "revision": "20240514", + "revision": "20250304", "rootUrl": "https://ids.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", - "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" - }, - "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" - }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -768,29 +611,6 @@ }, "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" - }, "ListEndpointsResponse": { "id": "ListEndpointsResponse", "properties": { @@ -942,7 +762,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 google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, @@ -964,53 +784,6 @@ }, "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", - "properties": { - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "items": { - "$ref": "AuditConfig" - }, - "type": "array" - }, - "bindings": { - "description": "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`.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "etag": { - "description": "`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.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "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).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "Policy", - "description": "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." - }, - "updateMask": { - "description": "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\"`", - "format": "google-fieldmask", - "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", @@ -1037,34 +810,6 @@ } }, "type": "object" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "TestIamPermissionsRequest", - "properties": { - "permissions": { - "description": "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).", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "TestIamPermissionsResponse", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" } }, "servicePath": "", diff --git a/src/apis/ids/v1.ts b/src/apis/ids/v1.ts index 8256aac48a3..3046d41df72 100644 --- a/src/apis/ids/v1.ts +++ b/src/apis/ids/v1.ts @@ -124,49 +124,6 @@ export namespace ids_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. - */ - export interface Schema$AuditConfig { - /** - * The configuration for logging of each type of permission. - */ - auditLogConfigs?: Schema$AuditLogConfig[]; - /** - * 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. - */ - service?: 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. - */ - export interface Schema$AuditLogConfig { - /** - * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. - */ - exemptedMembers?: string[] | null; - /** - * The log type that this config enables. - */ - logType?: string | 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; - } /** * The request message for Operations.CancelOperation. */ @@ -236,27 +193,6 @@ export namespace ids_v1 { */ 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. - */ - 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; - } export interface Schema$ListEndpointsResponse { /** * The list of endpoints response. @@ -364,7 +300,7 @@ export namespace ids_v1 { */ 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`. + * Output only. 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`. */ requestedCancellation?: boolean | null; /** @@ -380,40 +316,6 @@ export namespace ids_v1 { */ 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 { - /** - * 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; - } - /** - * 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; - } /** * 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). */ @@ -431,24 +333,6 @@ export namespace ids_v1 { */ message?: 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; - } export class Resource$Projects { context: APIRequestContext; @@ -941,95 +825,6 @@ export namespace ids_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$Endpoints$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Endpoints$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpoints$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpoints$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpoints$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://ids.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 Endpoints in a given project and location. * @@ -1207,191 +1002,6 @@ export namespace ids_v1 { 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$Endpoints$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Endpoints$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpoints$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpoints$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpoints$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://ids.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$Endpoints$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Endpoints$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpoints$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpoints$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpoints$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://ids.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$Endpoints$Create @@ -1432,17 +1042,6 @@ export namespace ids_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$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$Endpoints$List extends StandardParameters { /** @@ -1486,30 +1085,6 @@ export namespace ids_v1 { */ requestBody?: Schema$Endpoint; } - export interface Params$Resource$Projects$Locations$Endpoints$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$Endpoints$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; @@ -1518,7 +1093,7 @@ export namespace ids_v1 { } /** - * 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`. + * 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`. From 91cfefe291401cf3658f12505d7286fea91f7676 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 079/144] fix(language): update the API #### language:v1beta2 The following keys were changed: - schemas.CpuMetric.properties.machineSpec.enum - schemas.CpuMetric.properties.machineSpec.enumDescriptions - schemas.GpuMetric.properties.gpuType.enum - schemas.GpuMetric.properties.gpuType.enumDescriptions - schemas.GpuMetric.properties.machineSpec.enum - schemas.GpuMetric.properties.machineSpec.enumDescriptions - schemas.InfraUsage.description - schemas.RamMetric.properties.machineSpec.enum - schemas.RamMetric.properties.machineSpec.enumDescriptions #### language:v1 The following keys were changed: - schemas.CpuMetric.properties.machineSpec.enum - schemas.CpuMetric.properties.machineSpec.enumDescriptions - schemas.GpuMetric.properties.gpuType.enum - schemas.GpuMetric.properties.gpuType.enumDescriptions - schemas.GpuMetric.properties.machineSpec.enum - schemas.GpuMetric.properties.machineSpec.enumDescriptions - schemas.InfraUsage.description - schemas.RamMetric.properties.machineSpec.enum - schemas.RamMetric.properties.machineSpec.enumDescriptions #### language:v2 The following keys were changed: - schemas.CpuMetric.properties.machineSpec.enum - schemas.CpuMetric.properties.machineSpec.enumDescriptions - schemas.GpuMetric.properties.gpuType.enum - schemas.GpuMetric.properties.gpuType.enumDescriptions - schemas.GpuMetric.properties.machineSpec.enum - schemas.GpuMetric.properties.machineSpec.enumDescriptions - schemas.InfraUsage.description - schemas.RamMetric.properties.machineSpec.enum - schemas.RamMetric.properties.machineSpec.enumDescriptions --- discovery/language-v1.json | 14 +++++++++++--- discovery/language-v1beta2.json | 14 +++++++++++--- discovery/language-v2.json | 14 +++++++++++--- src/apis/language/v1.ts | 2 +- src/apis/language/v1beta2.ts | 2 +- src/apis/language/v2.ts | 2 +- 6 files changed, 36 insertions(+), 12 deletions(-) diff --git a/discovery/language-v1.json b/discovery/language-v1.json index dd35bd4e466..9c05a45b031 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250105", + "revision": "20250309", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -762,6 +762,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1052,6 +1053,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1433,7 +1435,8 @@ "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_V100", - "NVIDIA_H100_80GB" + "NVIDIA_H100_80GB", + "NVIDIA_H200_141GB" ], "enumDescriptions": [ "", @@ -1445,6 +1448,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1489,6 +1493,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1779,6 +1784,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1794,7 +1800,7 @@ "type": "object" }, "InfraUsage": { - "description": "Infra Usage of billing metrics.", + "description": "LINT: LEGACY_NAMES Infra Usage of billing metrics.", "id": "InfraUsage", "properties": { "cpuMetrics": { @@ -2175,6 +2181,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2465,6 +2472,7 @@ "", "", "", + "", "" ], "type": "string" diff --git a/discovery/language-v1beta2.json b/discovery/language-v1beta2.json index 01812cee23f..2ac1904ec00 100644 --- a/discovery/language-v1beta2.json +++ b/discovery/language-v1beta2.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250105", + "revision": "20250309", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -762,6 +762,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1052,6 +1053,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1451,7 +1453,8 @@ "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_V100", - "NVIDIA_H100_80GB" + "NVIDIA_H100_80GB", + "NVIDIA_H200_141GB" ], "enumDescriptions": [ "", @@ -1463,6 +1466,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1507,6 +1511,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1797,6 +1802,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1812,7 +1818,7 @@ "type": "object" }, "InfraUsage": { - "description": "Infra Usage of billing metrics.", + "description": "LINT: LEGACY_NAMES Infra Usage of billing metrics.", "id": "InfraUsage", "properties": { "cpuMetrics": { @@ -2193,6 +2199,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2483,6 +2490,7 @@ "", "", "", + "", "" ], "type": "string" diff --git a/discovery/language-v2.json b/discovery/language-v2.json index e70969ae703..6140066c3eb 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20250105", + "revision": "20250309", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -587,6 +587,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -877,6 +878,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1072,7 +1074,8 @@ "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_V100", - "NVIDIA_H100_80GB" + "NVIDIA_H100_80GB", + "NVIDIA_H200_141GB" ], "enumDescriptions": [ "", @@ -1084,6 +1087,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1128,6 +1132,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1418,6 +1423,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1433,7 +1439,7 @@ "type": "object" }, "InfraUsage": { - "description": "Infra Usage of billing metrics.", + "description": "LINT: LEGACY_NAMES Infra Usage of billing metrics.", "id": "InfraUsage", "properties": { "cpuMetrics": { @@ -1569,6 +1575,7 @@ "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "A3_ULTRAGPU_8G", + "A3_EDGEGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1859,6 +1866,7 @@ "", "", "", + "", "" ], "type": "string" diff --git a/src/apis/language/v1.ts b/src/apis/language/v1.ts index 631e353045d..5468fec9387 100644 --- a/src/apis/language/v1.ts +++ b/src/apis/language/v1.ts @@ -535,7 +535,7 @@ export namespace language_v1 { trackingLabels?: {[key: string]: string} | null; } /** - * Infra Usage of billing metrics. + * LINT: LEGACY_NAMES Infra Usage of billing metrics. */ export interface Schema$InfraUsage { /** diff --git a/src/apis/language/v1beta2.ts b/src/apis/language/v1beta2.ts index f233ef47128..90f2749b849 100644 --- a/src/apis/language/v1beta2.ts +++ b/src/apis/language/v1beta2.ts @@ -543,7 +543,7 @@ export namespace language_v1beta2 { trackingLabels?: {[key: string]: string} | null; } /** - * Infra Usage of billing metrics. + * LINT: LEGACY_NAMES Infra Usage of billing metrics. */ export interface Schema$InfraUsage { /** diff --git a/src/apis/language/v2.ts b/src/apis/language/v2.ts index 4d83fb1ec95..ef74e4f1e38 100644 --- a/src/apis/language/v2.ts +++ b/src/apis/language/v2.ts @@ -444,7 +444,7 @@ export namespace language_v2 { trackingLabels?: {[key: string]: string} | null; } /** - * Infra Usage of billing metrics. + * LINT: LEGACY_NAMES Infra Usage of billing metrics. */ export interface Schema$InfraUsage { /** From 737d9096b9f1651763f9d757c1cd2f529a691b73 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 080/144] feat(logging)!: update the API BREAKING CHANGE: This release has breaking changes. #### logging:v2 The following keys were deleted: - schemas.AuditConfig.description - schemas.AuditConfig.id - schemas.AuditConfig.properties.auditLogConfigs.description - schemas.AuditConfig.properties.auditLogConfigs.items.$ref - schemas.AuditConfig.properties.auditLogConfigs.type - schemas.AuditConfig.properties.service.description - schemas.AuditConfig.properties.service.type - schemas.AuditConfig.type - schemas.AuditLogConfig.description - schemas.AuditLogConfig.id - schemas.AuditLogConfig.properties.exemptedMembers.description - schemas.AuditLogConfig.properties.exemptedMembers.items.type - schemas.AuditLogConfig.properties.exemptedMembers.type - schemas.AuditLogConfig.properties.logType.description - schemas.AuditLogConfig.properties.logType.enum - schemas.AuditLogConfig.properties.logType.enumDescriptions - schemas.AuditLogConfig.properties.logType.type - schemas.AuditLogConfig.type - schemas.Policy.properties.auditConfigs.description - schemas.Policy.properties.auditConfigs.items.$ref - schemas.Policy.properties.auditConfigs.type The following keys were added: - schemas.AppHub.description - schemas.AppHub.id - schemas.AppHub.properties.application.$ref - schemas.AppHub.properties.application.description - schemas.AppHub.properties.service.$ref - schemas.AppHub.properties.service.description - schemas.AppHub.properties.workload.$ref - schemas.AppHub.properties.workload.description - schemas.AppHub.type - schemas.AppHubApplication.description - schemas.AppHubApplication.id - schemas.AppHubApplication.properties.container.description - schemas.AppHubApplication.properties.container.type - schemas.AppHubApplication.properties.id.description - schemas.AppHubApplication.properties.id.type - schemas.AppHubApplication.properties.location.description - schemas.AppHubApplication.properties.location.type - schemas.AppHubApplication.type - schemas.AppHubService.description - schemas.AppHubService.id - schemas.AppHubService.properties.criticalityType.description - schemas.AppHubService.properties.criticalityType.type - schemas.AppHubService.properties.environmentType.description - schemas.AppHubService.properties.environmentType.type - schemas.AppHubService.properties.id.description - schemas.AppHubService.properties.id.type - schemas.AppHubService.type - schemas.AppHubWorkload.description - schemas.AppHubWorkload.id - schemas.AppHubWorkload.properties.criticalityType.description - schemas.AppHubWorkload.properties.criticalityType.type - schemas.AppHubWorkload.properties.environmentType.description - schemas.AppHubWorkload.properties.environmentType.type - schemas.AppHubWorkload.properties.id.description - schemas.AppHubWorkload.properties.id.type - schemas.AppHubWorkload.type - schemas.LogEntry.properties.apphub.$ref - schemas.LogEntry.properties.apphub.description - schemas.LogEntry.properties.apphub.readOnly The following keys were changed: - resources.billingAccounts.resources.locations.resources.buckets.resources.views.methods.create.parameters.viewId.description - resources.folders.resources.locations.resources.buckets.resources.views.methods.create.parameters.viewId.description - resources.locations.resources.buckets.resources.views.methods.create.parameters.viewId.description - resources.organizations.resources.locations.resources.buckets.resources.views.methods.create.parameters.viewId.description - resources.projects.resources.locations.resources.buckets.resources.views.methods.create.parameters.viewId.description --- discovery/logging-v2.json | 118 +++++++++++++++++++++++--------------- src/apis/logging/v2.ts | 84 ++++++++++++++++++++------- 2 files changed, 135 insertions(+), 67 deletions(-) diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index bd1bbaf697c..8072e267211 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -910,7 +910,7 @@ "type": "string" }, "viewId": { - "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "location": "query", "type": "string" } @@ -2736,7 +2736,7 @@ "type": "string" }, "viewId": { - "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "location": "query", "type": "string" } @@ -4317,7 +4317,7 @@ "type": "string" }, "viewId": { - "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "location": "query", "type": "string" } @@ -5554,7 +5554,7 @@ "type": "string" }, "viewId": { - "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "location": "query", "type": "string" } @@ -7356,7 +7356,7 @@ "type": "string" }, "viewId": { - "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", + "description": "Required. A client-assigned identifier such as \"my-view\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens.", "location": "query", "type": "string" } @@ -8922,52 +8922,80 @@ } } }, - "revision": "20250110", + "revision": "20250307", "rootUrl": "https://logging.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", + "AppHub": { + "description": "Metadata associated with App Hub.", + "id": "AppHub", "properties": { - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.", - "items": { - "$ref": "AuditLogConfig" - }, - "type": "array" + "application": { + "$ref": "AppHubApplication", + "description": "Metadata associated with the application." }, "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.", + "$ref": "AppHubService", + "description": "Metadata associated with the service." + }, + "workload": { + "$ref": "AppHubWorkload", + "description": "Metadata associated with the workload." + } + }, + "type": "object" + }, + "AppHubApplication": { + "description": "Resource identifiers associated with an AppHub application AppHub resources are of the form projects//locations//applications/ projects//locations//applications//services/ projects//locations//applications//workloads/ These resources can be reconstructed from the components below.", + "id": "AppHubApplication", + "properties": { + "container": { + "description": "Resource container that owns the application. Example: \"projects/management_project\"", + "type": "string" + }, + "id": { + "description": "Application Id. Example: \"my-app\"", + "type": "string" + }, + "location": { + "description": "Location associated with the Application. Example: \"us-east1\"", "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", + "AppHubService": { + "description": "Metadata associated with an App Hub service.", + "id": "AppHubService", "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" + "criticalityType": { + "description": "Service criticality type Example: \"CRITICAL\"", + "type": "string" }, - "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" - ], + "environmentType": { + "description": "Service environment type Example: \"DEV\"", + "type": "string" + }, + "id": { + "description": "Service Id. Example: \"my-service\"", + "type": "string" + } + }, + "type": "object" + }, + "AppHubWorkload": { + "description": "Metadata associated with an App Hub workload.", + "id": "AppHubWorkload", + "properties": { + "criticalityType": { + "description": "Workload criticality type Example: \"CRITICAL\"", + "type": "string" + }, + "environmentType": { + "description": "Workload environment type Example: \"DEV\"", + "type": "string" + }, + "id": { + "description": "Workload Id. Example: \"my-workload\"", "type": "string" } }, @@ -10082,6 +10110,11 @@ "description": "An individual entry in a log.", "id": "LogEntry", "properties": { + "apphub": { + "$ref": "AppHub", + "description": "Output only. AppHub application metadata associated with this LogEntry. May be empty if there is no associated AppHub application or multiple associated applications (such as for VPC flow logs)", + "readOnly": true + }, "errorGroups": { "description": "Output only. The Error Reporting (https://cloud.google.com/error-reporting) error groups associated with this LogEntry. Error Reporting sets the values for this field during error group creation.For more information, see View error details( https://cloud.google.com/error-reporting/docs/viewing-errors#view_error_details)This field isn't available during log routing (https://cloud.google.com/logging/docs/routing/overview)", "items": { @@ -10927,13 +10960,6 @@ "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", "properties": { - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "items": { - "$ref": "AuditConfig" - }, - "type": "array" - }, "bindings": { "description": "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.", "items": { diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index bbac6def15d..26806fd2000 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -146,30 +146,72 @@ export namespace logging_v2 { } /** - * 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. + * Metadata associated with App Hub. */ - export interface Schema$AuditConfig { + export interface Schema$AppHub { /** - * The configuration for logging of each type of permission. + * Metadata associated with the application. */ - auditLogConfigs?: Schema$AuditLogConfig[]; + application?: Schema$AppHubApplication; /** - * 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. + * Metadata associated with the service. */ - service?: string | null; + service?: Schema$AppHubService; + /** + * Metadata associated with the workload. + */ + workload?: Schema$AppHubWorkload; + } + /** + * Resource identifiers associated with an AppHub application AppHub resources are of the form projects//locations//applications/ projects//locations//applications//services/ projects//locations//applications//workloads/ These resources can be reconstructed from the components below. + */ + export interface Schema$AppHubApplication { + /** + * Resource container that owns the application. Example: "projects/management_project" + */ + container?: string | null; + /** + * Application Id. Example: "my-app" + */ + id?: string | null; + /** + * Location associated with the Application. Example: "us-east1" + */ + location?: string | null; + } + /** + * Metadata associated with an App Hub service. + */ + export interface Schema$AppHubService { + /** + * Service criticality type Example: "CRITICAL" + */ + criticalityType?: string | null; + /** + * Service environment type Example: "DEV" + */ + environmentType?: string | null; + /** + * Service Id. Example: "my-service" + */ + id?: 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. + * Metadata associated with an App Hub workload. */ - export interface Schema$AuditLogConfig { + export interface Schema$AppHubWorkload { /** - * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + * Workload criticality type Example: "CRITICAL" */ - exemptedMembers?: string[] | null; + criticalityType?: string | null; /** - * The log type that this config enables. + * Workload environment type Example: "DEV" */ - logType?: string | null; + environmentType?: string | null; + /** + * Workload Id. Example: "my-workload" + */ + id?: string | null; } /** * Describes a BigQuery dataset that was created by a link. @@ -949,6 +991,10 @@ export namespace logging_v2 { * An individual entry in a log. */ export interface Schema$LogEntry { + /** + * Output only. AppHub application metadata associated with this LogEntry. May be empty if there is no associated AppHub application or multiple associated applications (such as for VPC flow logs) + */ + apphub?: Schema$AppHub; /** * Output only. The Error Reporting (https://cloud.google.com/error-reporting) error groups associated with this LogEntry. Error Reporting sets the values for this field during error group creation.For more information, see View error details( https://cloud.google.com/error-reporting/docs/viewing-errors#view_error_details)This field isn't available during log routing (https://cloud.google.com/logging/docs/routing/overview) */ @@ -1492,10 +1538,6 @@ export namespace logging_v2 { * 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. */ @@ -4546,7 +4588,7 @@ export namespace logging_v2 { */ parent?: string; /** - * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. */ viewId?: string; @@ -10352,7 +10394,7 @@ export namespace logging_v2 { */ parent?: string; /** - * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. */ viewId?: string; @@ -14982,7 +15024,7 @@ export namespace logging_v2 { */ parent?: string; /** - * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. */ viewId?: string; @@ -18803,7 +18845,7 @@ export namespace logging_v2 { */ parent?: string; /** - * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. */ viewId?: string; @@ -24170,7 +24212,7 @@ export namespace logging_v2 { */ parent?: string; /** - * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. */ viewId?: string; From 491be14145365c40fb8d880a837e1009a515a8e0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 081/144] feat(looker)!: update the API BREAKING CHANGE: This release has breaking changes. #### looker:v1 The following keys were deleted: - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.description - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.flatPath - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.httpMethod - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.id - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameterOrder - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.path - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.response.$ref - resources.projects.resources.locations.resources.instances.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.description - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.flatPath - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.httpMethod - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.id - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.parameterOrder - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.path - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.request.$ref - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.response.$ref - resources.projects.resources.locations.resources.instances.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.description - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.id - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.path - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.request.$ref - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.instances.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.description - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.flatPath - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.httpMethod - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.id - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameterOrder - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.path - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.response.$ref - resources.projects.resources.locations.resources.instances.resources.backups.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.description - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.flatPath - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.httpMethod - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.id - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.parameterOrder - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.path - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.request.$ref - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.response.$ref - resources.projects.resources.locations.resources.instances.resources.backups.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.description - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.id - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.path - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.request.$ref - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.instances.resources.backups.methods.testIamPermissions.scopes - schemas.AuditConfig.description - schemas.AuditConfig.id - schemas.AuditConfig.properties.auditLogConfigs.description - schemas.AuditConfig.properties.auditLogConfigs.items.$ref - schemas.AuditConfig.properties.auditLogConfigs.type - schemas.AuditConfig.properties.service.description - schemas.AuditConfig.properties.service.type - schemas.AuditConfig.type - schemas.AuditLogConfig.description - schemas.AuditLogConfig.id - schemas.AuditLogConfig.properties.exemptedMembers.description - schemas.AuditLogConfig.properties.exemptedMembers.items.type - schemas.AuditLogConfig.properties.exemptedMembers.type - schemas.AuditLogConfig.properties.logType.description - schemas.AuditLogConfig.properties.logType.enum - schemas.AuditLogConfig.properties.logType.enumDescriptions - schemas.AuditLogConfig.properties.logType.type - schemas.AuditLogConfig.type - schemas.Binding.description - schemas.Binding.id - schemas.Binding.properties.condition.$ref - schemas.Binding.properties.condition.description - schemas.Binding.properties.members.description - schemas.Binding.properties.members.items.type - schemas.Binding.properties.members.type - schemas.Binding.properties.role.description - schemas.Binding.properties.role.type - schemas.Binding.type - schemas.Expr.description - schemas.Expr.id - schemas.Expr.properties.description.description - schemas.Expr.properties.description.type - schemas.Expr.properties.expression.description - schemas.Expr.properties.expression.type - schemas.Expr.properties.location.description - schemas.Expr.properties.location.type - schemas.Expr.properties.title.description - schemas.Expr.properties.title.type - schemas.Expr.type - schemas.Policy.description - schemas.Policy.id - schemas.Policy.properties.auditConfigs.description - schemas.Policy.properties.auditConfigs.items.$ref - schemas.Policy.properties.auditConfigs.type - schemas.Policy.properties.bindings.description - schemas.Policy.properties.bindings.items.$ref - schemas.Policy.properties.bindings.type - schemas.Policy.properties.etag.description - schemas.Policy.properties.etag.format - schemas.Policy.properties.etag.type - schemas.Policy.properties.version.description - schemas.Policy.properties.version.format - schemas.Policy.properties.version.type - schemas.Policy.type - schemas.SetIamPolicyRequest.description - schemas.SetIamPolicyRequest.id - schemas.SetIamPolicyRequest.properties.policy.$ref - schemas.SetIamPolicyRequest.properties.policy.description - schemas.SetIamPolicyRequest.properties.updateMask.description - schemas.SetIamPolicyRequest.properties.updateMask.format - schemas.SetIamPolicyRequest.properties.updateMask.type - schemas.SetIamPolicyRequest.type - schemas.TestIamPermissionsRequest.description - schemas.TestIamPermissionsRequest.id - schemas.TestIamPermissionsRequest.properties.permissions.description - schemas.TestIamPermissionsRequest.properties.permissions.items.type - schemas.TestIamPermissionsRequest.properties.permissions.type - schemas.TestIamPermissionsRequest.type - schemas.TestIamPermissionsResponse.description - schemas.TestIamPermissionsResponse.id - schemas.TestIamPermissionsResponse.properties.permissions.description - schemas.TestIamPermissionsResponse.properties.permissions.items.type - schemas.TestIamPermissionsResponse.properties.permissions.type - schemas.TestIamPermissionsResponse.type The following keys were added: - schemas.Instance.properties.satisfiesPzi.description - schemas.Instance.properties.satisfiesPzi.readOnly - schemas.Instance.properties.satisfiesPzi.type - schemas.Instance.properties.satisfiesPzs.description - schemas.Instance.properties.satisfiesPzs.readOnly - schemas.Instance.properties.satisfiesPzs.type --- discovery/looker-v1.json | 360 +------------------ src/apis/looker/v1.ts | 754 +-------------------------------------- 2 files changed, 19 insertions(+), 1095 deletions(-) diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index cbac3791481..b761fc417ab 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -295,37 +295,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}/instances/{instancesId}:getIamPolicy", - "httpMethod": "GET", - "id": "looker.projects.locations.instances.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/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "import": { "description": "Import instance.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import", @@ -451,155 +420,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}/instances/{instancesId}:setIamPolicy", - "httpMethod": "POST", - "id": "looker.projects.locations.instances.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/[^/]+/instances/[^/]+$", - "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}/instances/{instancesId}:testIamPermissions", - "httpMethod": "POST", - "id": "looker.projects.locations.instances.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/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "backups": { - "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}/instances/{instancesId}/backups/{backupsId}:getIamPolicy", - "httpMethod": "GET", - "id": "looker.projects.locations.instances.backups.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/[^/]+/instances/[^/]+/backups/[^/]+$", - "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}/instances/{instancesId}/backups/{backupsId}:setIamPolicy", - "httpMethod": "POST", - "id": "looker.projects.locations.instances.backups.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/[^/]+/instances/[^/]+/backups/[^/]+$", - "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}/instances/{instancesId}/backups/{backupsId}:testIamPermissions", - "httpMethod": "POST", - "id": "looker.projects.locations.instances.backups.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/[^/]+/instances/[^/]+/backups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } }, @@ -731,7 +551,7 @@ } } }, - "revision": "20250108", + "revision": "20250305", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -748,76 +568,6 @@ }, "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" - }, - "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" - }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -1024,29 +774,6 @@ }, "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" - }, "ImportInstanceRequest": { "description": "Requestion options for importing looker data to an Instance", "id": "ImportInstanceRequest", @@ -1194,6 +921,16 @@ "description": "Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request.", "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" + }, "state": { "description": "Output only. The state of the instance.", "enum": [ @@ -1468,37 +1205,6 @@ }, "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", - "properties": { - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "items": { - "$ref": "AuditConfig" - }, - "type": "array" - }, - "bindings": { - "description": "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`.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "etag": { - "description": "`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.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "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).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "PscConfig": { "description": "Information for Private Service Connect (PSC) setup for a Looker instance.", "id": "PscConfig", @@ -1567,22 +1273,6 @@ }, "type": "object" }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "Policy", - "description": "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." - }, - "updateMask": { - "description": "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\"`", - "format": "google-fieldmask", - "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", @@ -1610,34 +1300,6 @@ }, "type": "object" }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "TestIamPermissionsRequest", - "properties": { - "permissions": { - "description": "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).", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "TestIamPermissionsResponse", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "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", diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index 54dbbb9947d..fa7b2213326 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -133,49 +133,6 @@ export namespace looker_v1 { */ allowedEmailDomains?: string[] | null; } - /** - * 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$AuditConfig { - /** - * The configuration for logging of each type of permission. - */ - auditLogConfigs?: Schema$AuditLogConfig[]; - /** - * 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. - */ - service?: 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. - */ - export interface Schema$AuditLogConfig { - /** - * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. - */ - exemptedMembers?: string[] | null; - /** - * The log type that this config enables. - */ - logType?: string | 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; - } /** * The request message for Operations.CancelOperation. */ @@ -316,27 +273,6 @@ export namespace looker_v1 { */ version?: 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; - } /** * Requestion options for importing looker data to an Instance */ @@ -450,6 +386,14 @@ export namespace looker_v1 { * Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request. */ reservedRange?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. The state of the instance. */ @@ -628,27 +572,6 @@ export namespace looker_v1 { */ 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 { - /** - * 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; - } /** * Information for Private Service Connect (PSC) setup for a Looker instance. */ @@ -687,19 +610,6 @@ export namespace looker_v1 { */ targetServiceAttachmentUri?: 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; - } /** * 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). */ @@ -717,24 +627,6 @@ export namespace looker_v1 { */ message?: 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; - } /** * 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`. */ @@ -1003,12 +895,8 @@ export namespace looker_v1 { export class Resource$Projects$Locations$Instances { context: APIRequestContext; - backups: Resource$Projects$Locations$Instances$Backups; constructor(context: APIRequestContext) { this.context = context; - this.backups = new Resource$Projects$Locations$Instances$Backups( - this.context - ); } /** @@ -1354,95 +1242,6 @@ export namespace looker_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$Instances$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Instances$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://looker.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); - } - } - /** * Import instance. * @@ -1793,191 +1592,6 @@ export namespace looker_v1 { 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$Instances$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Instances$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://looker.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$Instances$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Instances$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://looker.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$Instances$Create @@ -2026,17 +1640,6 @@ export namespace looker_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Instances$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$Instances$Import extends StandardParameters { /** @@ -2092,347 +1695,6 @@ export namespace looker_v1 { */ requestBody?: Schema$RestartInstanceRequest; } - export interface Params$Resource$Projects$Locations$Instances$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$Instances$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$Instances$Backups { - 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$Instances$Backups$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Instances$Backups$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Backups$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Backups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Backups$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Backups$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Backups$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Backups$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://looker.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$Instances$Backups$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Instances$Backups$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Backups$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Backups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Backups$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Backups$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Backups$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Backups$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://looker.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$Instances$Backups$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Instances$Backups$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Backups$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Backups$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Backups$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Backups$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Backups$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Backups$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://looker.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$Instances$Backups$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$Instances$Backups$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$Instances$Backups$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; From 5457fe13d238b09220e484eb319df853f7b770d4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:46 +0000 Subject: [PATCH 082/144] fix(managedkafka): update the API --- discovery/managedkafka-v1.json | 1253 +++++++++++ src/apis/managedkafka/README.md | 28 + src/apis/managedkafka/index.ts | 46 + src/apis/managedkafka/package.json | 43 + src/apis/managedkafka/tsconfig.json | 10 + src/apis/managedkafka/v1.ts | 2530 +++++++++++++++++++++++ src/apis/managedkafka/webpack.config.js | 79 + 7 files changed, 3989 insertions(+) create mode 100644 discovery/managedkafka-v1.json create mode 100644 src/apis/managedkafka/README.md create mode 100644 src/apis/managedkafka/index.ts create mode 100644 src/apis/managedkafka/package.json create mode 100644 src/apis/managedkafka/tsconfig.json create mode 100644 src/apis/managedkafka/v1.ts create mode 100644 src/apis/managedkafka/webpack.config.js diff --git a/discovery/managedkafka-v1.json b/discovery/managedkafka-v1.json new file mode 100644 index 00000000000..1cbec11182b --- /dev/null +++ b/discovery/managedkafka-v1.json @@ -0,0 +1,1253 @@ +{ + "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://managedkafka.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Managed Kafka", + "description": "Manage Apache Kafka clusters and resources. ", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/managed-service-for-apache-kafka/docs", + "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": "managedkafka:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://managedkafka.mtls.googleapis.com/", + "name": "managedkafka", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "clusters": { + "methods": { + "create": { + "description": "Creates a new cluster in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.clusters.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "clusterId": { + "description": "Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-cluster-id`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent region in which to create the cluster. Structured like `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 to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/clusters", + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.clusters.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the cluster to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A 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": "Returns the properties of a single cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.clusters.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the cluster whose configuration to return.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Cluster" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the clusters in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.clusters.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression for the result.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Order by fields for the result.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClusters` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location whose clusters are to be listed. Structured like `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/clusters", + "response": { + "$ref": "ListClustersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the properties of a single cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "httpMethod": "PATCH", + "id": "managedkafka.projects.locations.clusters.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A 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 cluster 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. The mask is required and a value of * will update all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "consumerGroups": { + "methods": { + "delete": { + "description": "Deletes a single consumer group.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups/{consumerGroupsId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.clusters.consumerGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the consumer group to delete. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/consumerGroups/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the properties of a single consumer group.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups/{consumerGroupsId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.clusters.consumerGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the consumer group whose configuration to return. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/consumerGroups/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ConsumerGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the consumer groups in a given cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.clusters.consumerGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListConsumerGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConsumerGroups` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent cluster whose consumer groups are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/consumerGroups", + "response": { + "$ref": "ListConsumerGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the properties of a single consumer group.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups/{consumerGroupsId}", + "httpMethod": "PATCH", + "id": "managedkafka.projects.locations.clusters.consumerGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/consumerGroups/.*$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup 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. The mask is required and a value of * will update all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ConsumerGroup" + }, + "response": { + "$ref": "ConsumerGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "topics": { + "methods": { + "create": { + "description": "Creates a new topic in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.clusters.topics.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent cluster in which to create the topic. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "topicId": { + "description": "Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/topics", + "request": { + "$ref": "Topic" + }, + "response": { + "$ref": "Topic" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single topic.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics/{topicsId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.clusters.topics.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the topic to delete. `projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the properties of a single topic.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics/{topicsId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.clusters.topics.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Topic" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the topics in a given cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.clusters.topics.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent cluster whose topics are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/topics", + "response": { + "$ref": "ListTopicsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the properties of a single topic.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics/{topicsId}", + "httpMethod": "PATCH", + "id": "managedkafka.projects.locations.clusters.topics.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the topic. The `topic` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the Topic 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. The mask is required and a value of * will update all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Topic" + }, + "response": { + "$ref": "Topic" + }, + "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": "managedkafka.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": "managedkafka.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": "managedkafka.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": "managedkafka.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": "20250306", + "rootUrl": "https://managedkafka.googleapis.com/", + "schemas": { + "AccessConfig": { + "description": "The configuration of access to the Kafka cluster.", + "id": "AccessConfig", + "properties": { + "networkConfigs": { + "description": "Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka cluster. Minimum of 1 network is required. Maximum 10 networks can be specified.", + "items": { + "$ref": "NetworkConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CapacityConfig": { + "description": "A capacity configuration of a Kafka cluster.", + "id": "CapacityConfig", + "properties": { + "memoryBytes": { + "description": "Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB).", + "format": "int64", + "type": "string" + }, + "vcpuCount": { + "description": "Required. The number of vCPUs to provision for the cluster. Minimum: 3.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Cluster": { + "description": "An Apache Kafka cluster deployed in a location.", + "id": "Cluster", + "properties": { + "capacityConfig": { + "$ref": "CapacityConfig", + "description": "Required. Capacity configuration for the Kafka cluster." + }, + "createTime": { + "description": "Output only. The time when the cluster was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "gcpConfig": { + "$ref": "GcpConfig", + "description": "Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}", + "type": "string" + }, + "rebalanceConfig": { + "$ref": "RebalanceConfig", + "description": "Optional. Rebalance configuration for the Kafka cluster." + }, + "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. The current state of the cluster.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING" + ], + "enumDescriptions": [ + "A state was not specified.", + "The cluster is being created.", + "The cluster is active.", + "The cluster is being deleted." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the cluster was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ConsumerGroup": { + "description": "A Kafka consumer group in a given cluster.", + "id": "ConsumerGroup", + "properties": { + "name": { + "description": "Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}", + "type": "string" + }, + "topics": { + "additionalProperties": { + "$ref": "ConsumerTopicMetadata" + }, + "description": "Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}", + "type": "object" + } + }, + "type": "object" + }, + "ConsumerPartitionMetadata": { + "description": "Metadata for a consumer group corresponding to a specific partition.", + "id": "ConsumerPartitionMetadata", + "properties": { + "metadata": { + "description": "Optional. The associated metadata for this partition, or empty if it does not exist.", + "type": "string" + }, + "offset": { + "description": "Required. The current offset for this partition, or 0 if no offset has been committed.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ConsumerTopicMetadata": { + "description": "Metadata for a consumer group corresponding to a specific topic.", + "id": "ConsumerTopicMetadata", + "properties": { + "partitions": { + "additionalProperties": { + "$ref": "ConsumerPartitionMetadata" + }, + "description": "Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.", + "type": "object" + } + }, + "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" + }, + "GcpConfig": { + "description": "Configuration properties for a Kafka cluster deployed to Google Cloud Platform.", + "id": "GcpConfig", + "properties": { + "accessConfig": { + "$ref": "AccessConfig", + "description": "Required. Access configuration for the Kafka cluster." + }, + "kmsKey": { + "description": "Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.", + "type": "string" + } + }, + "type": "object" + }, + "ListClustersResponse": { + "description": "Response for ListClusters.", + "id": "ListClustersResponse", + "properties": { + "clusters": { + "description": "The list of Clusters in the requested parent.", + "items": { + "$ref": "Cluster" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListConsumerGroupsResponse": { + "description": "Response for ListConsumerGroups.", + "id": "ListConsumerGroupsResponse", + "properties": { + "consumerGroups": { + "description": "The list of consumer group in the requested parent. The order of the consumer groups is unspecified.", + "items": { + "$ref": "ConsumerGroup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.", + "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" + }, + "ListTopicsResponse": { + "description": "Response for ListTopics.", + "id": "ListTopicsResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.", + "type": "string" + }, + "topics": { + "description": "The list of topics in the requested parent. The order of the topics is unspecified.", + "items": { + "$ref": "Topic" + }, + "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" + }, + "NetworkConfig": { + "description": "The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka cluster.", + "id": "NetworkConfig", + "properties": { + "subnet": { + "description": "Required. Name of the VPC subnet in which to create Private Service Connect (PSC) endpoints for the Kafka brokers and bootstrap address. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id} The subnet must be located in the same region as the Kafka cluster. The project may differ. Multiple subnets from the same parent network must not be specified.", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RebalanceConfig": { + "description": "Defines rebalancing behavior of a Kafka cluster.", + "id": "RebalanceConfig", + "properties": { + "mode": { + "description": "Optional. The rebalance behavior for the cluster. When not specified, defaults to `NO_REBALANCE`.", + "enum": [ + "MODE_UNSPECIFIED", + "NO_REBALANCE", + "AUTO_REBALANCE_ON_SCALE_UP" + ], + "enumDescriptions": [ + "A mode was not specified. Do not use.", + "Do not rebalance automatically.", + "Automatically rebalance topic partitions among brokers when the cluster is scaled up." + ], + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "Topic": { + "description": "A Kafka topic in a given cluster.", + "id": "Topic", + "properties": { + "configs": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the topic. The `topic` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}", + "type": "string" + }, + "partitionCount": { + "description": "Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected.", + "format": "int32", + "type": "integer" + }, + "replicationFactor": { + "description": "Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Managed Service for Apache Kafka API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/src/apis/managedkafka/README.md b/src/apis/managedkafka/README.md new file mode 100644 index 00000000000..178674842d6 --- /dev/null +++ b/src/apis/managedkafka/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# managedkafka + +> Manage Apache Kafka clusters and resources. + +## Installation + +```sh +$ npm install @googleapis/managedkafka +``` + +## 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/managedkafka/classes/Managedkafka.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/managedkafka/index.ts b/src/apis/managedkafka/index.ts new file mode 100644 index 00000000000..ffa71f4778a --- /dev/null +++ b/src/apis/managedkafka/index.ts @@ -0,0 +1,46 @@ +// 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 {managedkafka_v1} from './v1'; + +export const VERSIONS = { + v1: managedkafka_v1.Managedkafka, +}; + +export function managedkafka(version: 'v1'): managedkafka_v1.Managedkafka; +export function managedkafka( + options: managedkafka_v1.Options +): managedkafka_v1.Managedkafka; +export function managedkafka( + this: GoogleConfigurable, + versionOrOptions: 'v1' | managedkafka_v1.Options +) { + return getAPI('managedkafka', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {managedkafka_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/managedkafka/package.json b/src/apis/managedkafka/package.json new file mode 100644 index 00000000000..f19b4700536 --- /dev/null +++ b/src/apis/managedkafka/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/managedkafka", + "version": "0.1.0", + "description": "managedkafka", + "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/managedkafka/tsconfig.json b/src/apis/managedkafka/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/managedkafka/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/managedkafka/v1.ts b/src/apis/managedkafka/v1.ts new file mode 100644 index 00000000000..67f2b9ff7cb --- /dev/null +++ b/src/apis/managedkafka/v1.ts @@ -0,0 +1,2530 @@ +// 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 managedkafka_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; + } + + /** + * Managed Service for Apache Kafka API + * + * Manage Apache Kafka clusters and resources. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const managedkafka = google.managedkafka('v1'); + * ``` + */ + export class Managedkafka { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * The configuration of access to the Kafka cluster. + */ + export interface Schema$AccessConfig { + /** + * Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka cluster. Minimum of 1 network is required. Maximum 10 networks can be specified. + */ + networkConfigs?: Schema$NetworkConfig[]; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * A capacity configuration of a Kafka cluster. + */ + export interface Schema$CapacityConfig { + /** + * Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB). + */ + memoryBytes?: string | null; + /** + * Required. The number of vCPUs to provision for the cluster. Minimum: 3. + */ + vcpuCount?: string | null; + } + /** + * An Apache Kafka cluster deployed in a location. + */ + export interface Schema$Cluster { + /** + * Required. Capacity configuration for the Kafka cluster. + */ + capacityConfig?: Schema$CapacityConfig; + /** + * Output only. The time when the cluster was created. + */ + createTime?: string | null; + /** + * Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform. + */ + gcpConfig?: Schema$GcpConfig; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the cluster. Structured like: projects/{project_number\}/locations/{location\}/clusters/{cluster_id\} + */ + name?: string | null; + /** + * Optional. Rebalance configuration for the Kafka cluster. + */ + rebalanceConfig?: Schema$RebalanceConfig; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Output only. The current state of the cluster. + */ + state?: string | null; + /** + * Output only. The time when the cluster was last updated. + */ + updateTime?: string | null; + } + /** + * A Kafka consumer group in a given cluster. + */ + export interface Schema$ConsumerGroup { + /** + * Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/consumerGroups/{consumer_group\} + */ + name?: string | null; + /** + * Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/topics/{topic\} + */ + topics?: {[key: string]: Schema$ConsumerTopicMetadata} | null; + } + /** + * Metadata for a consumer group corresponding to a specific partition. + */ + export interface Schema$ConsumerPartitionMetadata { + /** + * Optional. The associated metadata for this partition, or empty if it does not exist. + */ + metadata?: string | null; + /** + * Required. The current offset for this partition, or 0 if no offset has been committed. + */ + offset?: string | null; + } + /** + * Metadata for a consumer group corresponding to a specific topic. + */ + export interface Schema$ConsumerTopicMetadata { + /** + * Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for. + */ + partitions?: {[key: string]: Schema$ConsumerPartitionMetadata} | 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 {} + /** + * Configuration properties for a Kafka cluster deployed to Google Cloud Platform. + */ + export interface Schema$GcpConfig { + /** + * Required. Access configuration for the Kafka cluster. + */ + accessConfig?: Schema$AccessConfig; + /** + * Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}. + */ + kmsKey?: string | null; + } + /** + * Response for ListClusters. + */ + export interface Schema$ListClustersResponse { + /** + * The list of Clusters in the requested parent. + */ + clusters?: Schema$Cluster[]; + /** + * A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response for ListConsumerGroups. + */ + export interface Schema$ListConsumerGroupsResponse { + /** + * The list of consumer group in the requested parent. The order of the consumer groups is unspecified. + */ + consumerGroups?: Schema$ConsumerGroup[]; + /** + * A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. + */ + nextPageToken?: 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[]; + } + /** + * Response for ListTopics. + */ + export interface Schema$ListTopicsResponse { + /** + * A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. + */ + nextPageToken?: string | null; + /** + * The list of topics in the requested parent. The order of the topics is unspecified. + */ + topics?: Schema$Topic[]; + } + /** + * 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; + } + /** + * The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka cluster. + */ + export interface Schema$NetworkConfig { + /** + * Required. Name of the VPC subnet in which to create Private Service Connect (PSC) endpoints for the Kafka brokers and bootstrap address. Structured like: projects/{project\}/regions/{region\}/subnetworks/{subnet_id\} The subnet must be located in the same region as the Kafka cluster. The project may differ. Multiple subnets from the same parent network must not be specified. + */ + subnet?: 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. 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 been cancelled successfully 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; + } + /** + * Defines rebalancing behavior of a Kafka cluster. + */ + export interface Schema$RebalanceConfig { + /** + * Optional. The rebalance behavior for the cluster. When not specified, defaults to `NO_REBALANCE`. + */ + mode?: 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 { + /** + * 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 Kafka topic in a given cluster. + */ + export interface Schema$Topic { + /** + * Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`. + */ + configs?: {[key: string]: string} | null; + /** + * Identifier. The name of the topic. The `topic` segment is used when connecting directly to the cluster. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/topics/{topic\} + */ + name?: string | null; + /** + * Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected. + */ + partitionCount?: number | null; + /** + * Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability. + */ + replicationFactor?: number | 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; + clusters: Resource$Projects$Locations$Clusters; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.clusters = new Resource$Projects$Locations$Clusters(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://managedkafka.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://managedkafka.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$Clusters { + context: APIRequestContext; + consumerGroups: Resource$Projects$Locations$Clusters$Consumergroups; + topics: Resource$Projects$Locations$Clusters$Topics; + constructor(context: APIRequestContext) { + this.context = context; + this.consumerGroups = + new Resource$Projects$Locations$Clusters$Consumergroups(this.context); + this.topics = new Resource$Projects$Locations$Clusters$Topics( + this.context + ); + } + + /** + * Creates a new cluster 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$Clusters$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Clusters$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Clusters$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Clusters$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Clusters$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/clusters').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 cluster. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Clusters$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Clusters$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Clusters$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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); + } + } + + /** + * Returns the properties of a single cluster. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Clusters$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Clusters$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Clusters$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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 clusters 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$Clusters$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Clusters$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Clusters$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clusters$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clusters$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/clusters').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 properties of a single cluster. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Clusters$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Clusters$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Clusters$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clusters$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clusters$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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$Clusters$Create + extends StandardParameters { + /** + * Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-cluster-id`. + */ + clusterId?: string; + /** + * Required. The parent region in which to create the cluster. Structured like `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Cluster; + } + export interface Params$Resource$Projects$Locations$Clusters$Delete + extends StandardParameters { + /** + * Required. The name of the cluster to delete. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Get + extends StandardParameters { + /** + * Required. The name of the cluster whose configuration to return. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$List + extends StandardParameters { + /** + * Optional. Filter expression for the result. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClusters` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent location whose clusters are to be listed. Structured like `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Patch + extends StandardParameters { + /** + * Identifier. The name of the cluster. Structured like: projects/{project_number\}/locations/{location\}/clusters/{cluster_id\} + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A 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 cluster 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. The mask is required and a value of * will update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Cluster; + } + + export class Resource$Projects$Locations$Clusters$Consumergroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a single consumer 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. + */ + delete( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Consumergroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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); + } + } + + /** + * Returns the properties of a single consumer 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$Clusters$Consumergroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Clusters$Consumergroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Consumergroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Consumergroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Consumergroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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 consumer groups in a given cluster. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Clusters$Consumergroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Clusters$Consumergroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Consumergroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Consumergroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Consumergroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/consumerGroups').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 properties of a single consumer 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. + */ + patch( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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$Clusters$Consumergroups$Delete + extends StandardParameters { + /** + * Required. The name of the consumer group to delete. `projects/{project\}/locations/{location\}/clusters/{cluster\}/consumerGroups/{consumerGroup\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Consumergroups$Get + extends StandardParameters { + /** + * Required. The name of the consumer group whose configuration to return. `projects/{project\}/locations/{location\}/clusters/{cluster\}/consumerGroups/{consumerGroup\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Consumergroups$List + extends StandardParameters { + /** + * Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListConsumerGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConsumerGroups` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent cluster whose consumer groups are to be listed. Structured like `projects/{project\}/locations/{location\}/clusters/{cluster\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Consumergroups$Patch + extends StandardParameters { + /** + * Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/consumerGroups/{consumer_group\} + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup 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. The mask is required and a value of * will update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConsumerGroup; + } + + export class Resource$Projects$Locations$Clusters$Topics { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new topic 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$Clusters$Topics$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Clusters$Topics$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Clusters$Topics$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Clusters$Topics$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Clusters$Topics$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Topics$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Topics$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Topics$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/topics').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 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. + */ + delete( + params: Params$Resource$Projects$Locations$Clusters$Topics$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Clusters$Topics$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Clusters$Topics$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Topics$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Topics$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Topics$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Topics$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Topics$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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); + } + } + + /** + * Returns the properties of a single 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. + */ + get( + params: Params$Resource$Projects$Locations$Clusters$Topics$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Clusters$Topics$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Clusters$Topics$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Topics$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Topics$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Topics$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Topics$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Topics$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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 topics in a given cluster. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Clusters$Topics$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Clusters$Topics$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Clusters$Topics$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clusters$Topics$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clusters$Topics$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Topics$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Topics$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Topics$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/topics').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 properties of a single 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. + */ + patch( + params: Params$Resource$Projects$Locations$Clusters$Topics$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Clusters$Topics$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Clusters$Topics$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clusters$Topics$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clusters$Topics$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Topics$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Topics$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Topics$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.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$Clusters$Topics$Create + extends StandardParameters { + /** + * Required. The parent cluster in which to create the topic. Structured like `projects/{project\}/locations/{location\}/clusters/{cluster\}`. + */ + parent?: string; + /** + * Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`. + */ + topicId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Topic; + } + export interface Params$Resource$Projects$Locations$Clusters$Topics$Delete + extends StandardParameters { + /** + * Required. The name of the topic to delete. `projects/{project\}/locations/{location\}/clusters/{cluster\}/topics/{topic\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Topics$Get + extends StandardParameters { + /** + * Required. The name of the topic whose configuration to return. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/topics/{topic\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Topics$List + extends StandardParameters { + /** + * Optional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent cluster whose topics are to be listed. Structured like `projects/{project\}/locations/{location\}/clusters/{cluster\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Topics$Patch + extends StandardParameters { + /** + * Identifier. The name of the topic. The `topic` segment is used when connecting directly to the cluster. Structured like: projects/{project\}/locations/{location\}/clusters/{cluster\}/topics/{topic\} + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the Topic 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. The mask is required and a value of * will update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Topic; + } + + 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://managedkafka.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); + } + } + + /** + * 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://managedkafka.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 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://managedkafka.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$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://managedkafka.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$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$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; + } +} diff --git a/src/apis/managedkafka/webpack.config.js b/src/apis/managedkafka/webpack.config.js new file mode 100644 index 00000000000..7b15f163661 --- /dev/null +++ b/src/apis/managedkafka/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: 'Managedkafka', + filename: 'managedkafka.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: [], +}; From 4cb1662a7d6ddc692a7d63ae550364b8ee018870 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 083/144] feat(memcache)!: update the API BREAKING CHANGE: This release has breaking changes. #### memcache:v1beta2 The following keys were deleted: - schemas.AssetLocation.description - schemas.AssetLocation.id - schemas.AssetLocation.properties.ccfeRmsPath.description - schemas.AssetLocation.properties.ccfeRmsPath.type - schemas.AssetLocation.properties.expected.$ref - schemas.AssetLocation.properties.expected.description - schemas.AssetLocation.properties.extraParameters.description - schemas.AssetLocation.properties.extraParameters.items.$ref - schemas.AssetLocation.properties.extraParameters.type - schemas.AssetLocation.properties.locationData.description - schemas.AssetLocation.properties.locationData.items.$ref - schemas.AssetLocation.properties.locationData.type - schemas.AssetLocation.properties.parentAsset.description - schemas.AssetLocation.properties.parentAsset.items.$ref - schemas.AssetLocation.properties.parentAsset.type - schemas.AssetLocation.type - schemas.BlobstoreLocation.description - schemas.BlobstoreLocation.id - schemas.BlobstoreLocation.properties.policyId.items.type - schemas.BlobstoreLocation.properties.policyId.type - schemas.BlobstoreLocation.type - schemas.CloudAsset.id - schemas.CloudAsset.properties.assetName.type - schemas.CloudAsset.properties.assetType.type - schemas.CloudAsset.type - schemas.CloudAssetComposition.id - schemas.CloudAssetComposition.properties.childAsset.items.$ref - schemas.CloudAssetComposition.properties.childAsset.type - schemas.CloudAssetComposition.type - schemas.DirectLocationAssignment.id - schemas.DirectLocationAssignment.properties.location.items.$ref - schemas.DirectLocationAssignment.properties.location.type - schemas.DirectLocationAssignment.type - schemas.ExtraParameter.description - schemas.ExtraParameter.id - schemas.ExtraParameter.properties.regionalMigDistributionPolicy.$ref - schemas.ExtraParameter.properties.regionalMigDistributionPolicy.description - schemas.ExtraParameter.type - schemas.IsolationExpectations.id - schemas.IsolationExpectations.properties.requirementOverride.$ref - schemas.IsolationExpectations.properties.requirementOverride.description - schemas.IsolationExpectations.properties.ziOrgPolicy.enum - schemas.IsolationExpectations.properties.ziOrgPolicy.enumDescriptions - schemas.IsolationExpectations.properties.ziOrgPolicy.type - schemas.IsolationExpectations.properties.ziRegionPolicy.enum - schemas.IsolationExpectations.properties.ziRegionPolicy.enumDescriptions - schemas.IsolationExpectations.properties.ziRegionPolicy.type - schemas.IsolationExpectations.properties.ziRegionState.enum - schemas.IsolationExpectations.properties.ziRegionState.enumDescriptions - schemas.IsolationExpectations.properties.ziRegionState.type - schemas.IsolationExpectations.properties.zoneIsolation.deprecated - schemas.IsolationExpectations.properties.zoneIsolation.description - schemas.IsolationExpectations.properties.zoneIsolation.enum - schemas.IsolationExpectations.properties.zoneIsolation.enumDescriptions - schemas.IsolationExpectations.properties.zoneIsolation.type - schemas.IsolationExpectations.properties.zoneSeparation.deprecated - schemas.IsolationExpectations.properties.zoneSeparation.description - schemas.IsolationExpectations.properties.zoneSeparation.enum - schemas.IsolationExpectations.properties.zoneSeparation.enumDescriptions - schemas.IsolationExpectations.properties.zoneSeparation.type - schemas.IsolationExpectations.properties.zsOrgPolicy.enum - schemas.IsolationExpectations.properties.zsOrgPolicy.enumDescriptions - schemas.IsolationExpectations.properties.zsOrgPolicy.type - schemas.IsolationExpectations.properties.zsRegionState.enum - schemas.IsolationExpectations.properties.zsRegionState.enumDescriptions - schemas.IsolationExpectations.properties.zsRegionState.type - schemas.IsolationExpectations.type - schemas.LocationAssignment.id - schemas.LocationAssignment.properties.location.type - schemas.LocationAssignment.properties.locationType.enum - schemas.LocationAssignment.properties.locationType.enumDescriptions - schemas.LocationAssignment.properties.locationType.type - schemas.LocationAssignment.type - schemas.LocationData.id - schemas.LocationData.properties.blobstoreLocation.$ref - schemas.LocationData.properties.childAssetLocation.$ref - schemas.LocationData.properties.directLocation.$ref - schemas.LocationData.properties.gcpProjectProxy.$ref - schemas.LocationData.properties.placerLocation.$ref - schemas.LocationData.properties.spannerLocation.$ref - schemas.LocationData.type - schemas.PlacerLocation.description - schemas.PlacerLocation.id - schemas.PlacerLocation.properties.placerConfig.description - schemas.PlacerLocation.properties.placerConfig.type - schemas.PlacerLocation.type - schemas.RegionalMigDistributionPolicy.description - schemas.RegionalMigDistributionPolicy.id - schemas.RegionalMigDistributionPolicy.properties.targetShape.description - schemas.RegionalMigDistributionPolicy.properties.targetShape.format - schemas.RegionalMigDistributionPolicy.properties.targetShape.type - schemas.RegionalMigDistributionPolicy.properties.zones.description - schemas.RegionalMigDistributionPolicy.properties.zones.items.$ref - schemas.RegionalMigDistributionPolicy.properties.zones.type - schemas.RegionalMigDistributionPolicy.type - schemas.RequirementOverride.id - schemas.RequirementOverride.properties.ziOverride.enum - schemas.RequirementOverride.properties.ziOverride.enumDescriptions - schemas.RequirementOverride.properties.ziOverride.type - schemas.RequirementOverride.properties.zsOverride.enum - schemas.RequirementOverride.properties.zsOverride.enumDescriptions - schemas.RequirementOverride.properties.zsOverride.type - schemas.RequirementOverride.type - schemas.SpannerLocation.id - schemas.SpannerLocation.properties.backupName.description - schemas.SpannerLocation.properties.backupName.items.type - schemas.SpannerLocation.properties.backupName.type - schemas.SpannerLocation.properties.dbName.description - schemas.SpannerLocation.properties.dbName.items.type - schemas.SpannerLocation.properties.dbName.type - schemas.SpannerLocation.type - schemas.TenantProjectProxy.id - schemas.TenantProjectProxy.properties.projectNumbers.items.type - schemas.TenantProjectProxy.properties.projectNumbers.type - schemas.TenantProjectProxy.type - schemas.ZoneConfiguration.id - schemas.ZoneConfiguration.properties.zone.type - schemas.ZoneConfiguration.type The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description #### memcache:v1 The following keys were deleted: - schemas.AssetLocation.description - schemas.AssetLocation.id - schemas.AssetLocation.properties.ccfeRmsPath.description - schemas.AssetLocation.properties.ccfeRmsPath.type - schemas.AssetLocation.properties.expected.$ref - schemas.AssetLocation.properties.expected.description - schemas.AssetLocation.properties.extraParameters.description - schemas.AssetLocation.properties.extraParameters.items.$ref - schemas.AssetLocation.properties.extraParameters.type - schemas.AssetLocation.properties.locationData.description - schemas.AssetLocation.properties.locationData.items.$ref - schemas.AssetLocation.properties.locationData.type - schemas.AssetLocation.properties.parentAsset.description - schemas.AssetLocation.properties.parentAsset.items.$ref - schemas.AssetLocation.properties.parentAsset.type - schemas.AssetLocation.type - schemas.BlobstoreLocation.description - schemas.BlobstoreLocation.id - schemas.BlobstoreLocation.properties.policyId.items.type - schemas.BlobstoreLocation.properties.policyId.type - schemas.BlobstoreLocation.type - schemas.CloudAsset.id - schemas.CloudAsset.properties.assetName.type - schemas.CloudAsset.properties.assetType.type - schemas.CloudAsset.type - schemas.CloudAssetComposition.id - schemas.CloudAssetComposition.properties.childAsset.items.$ref - schemas.CloudAssetComposition.properties.childAsset.type - schemas.CloudAssetComposition.type - schemas.DirectLocationAssignment.id - schemas.DirectLocationAssignment.properties.location.items.$ref - schemas.DirectLocationAssignment.properties.location.type - schemas.DirectLocationAssignment.type - schemas.ExtraParameter.description - schemas.ExtraParameter.id - schemas.ExtraParameter.properties.regionalMigDistributionPolicy.$ref - schemas.ExtraParameter.properties.regionalMigDistributionPolicy.description - schemas.ExtraParameter.type - schemas.IsolationExpectations.id - schemas.IsolationExpectations.properties.requirementOverride.$ref - schemas.IsolationExpectations.properties.requirementOverride.description - schemas.IsolationExpectations.properties.ziOrgPolicy.enum - schemas.IsolationExpectations.properties.ziOrgPolicy.enumDescriptions - schemas.IsolationExpectations.properties.ziOrgPolicy.type - schemas.IsolationExpectations.properties.ziRegionPolicy.enum - schemas.IsolationExpectations.properties.ziRegionPolicy.enumDescriptions - schemas.IsolationExpectations.properties.ziRegionPolicy.type - schemas.IsolationExpectations.properties.ziRegionState.enum - schemas.IsolationExpectations.properties.ziRegionState.enumDescriptions - schemas.IsolationExpectations.properties.ziRegionState.type - schemas.IsolationExpectations.properties.zoneIsolation.deprecated - schemas.IsolationExpectations.properties.zoneIsolation.description - schemas.IsolationExpectations.properties.zoneIsolation.enum - schemas.IsolationExpectations.properties.zoneIsolation.enumDescriptions - schemas.IsolationExpectations.properties.zoneIsolation.type - schemas.IsolationExpectations.properties.zoneSeparation.deprecated - schemas.IsolationExpectations.properties.zoneSeparation.description - schemas.IsolationExpectations.properties.zoneSeparation.enum - schemas.IsolationExpectations.properties.zoneSeparation.enumDescriptions - schemas.IsolationExpectations.properties.zoneSeparation.type - schemas.IsolationExpectations.properties.zsOrgPolicy.enum - schemas.IsolationExpectations.properties.zsOrgPolicy.enumDescriptions - schemas.IsolationExpectations.properties.zsOrgPolicy.type - schemas.IsolationExpectations.properties.zsRegionState.enum - schemas.IsolationExpectations.properties.zsRegionState.enumDescriptions - schemas.IsolationExpectations.properties.zsRegionState.type - schemas.IsolationExpectations.type - schemas.LocationAssignment.id - schemas.LocationAssignment.properties.location.type - schemas.LocationAssignment.properties.locationType.enum - schemas.LocationAssignment.properties.locationType.enumDescriptions - schemas.LocationAssignment.properties.locationType.type - schemas.LocationAssignment.type - schemas.LocationData.id - schemas.LocationData.properties.blobstoreLocation.$ref - schemas.LocationData.properties.childAssetLocation.$ref - schemas.LocationData.properties.directLocation.$ref - schemas.LocationData.properties.gcpProjectProxy.$ref - schemas.LocationData.properties.placerLocation.$ref - schemas.LocationData.properties.spannerLocation.$ref - schemas.LocationData.type - schemas.PlacerLocation.description - schemas.PlacerLocation.id - schemas.PlacerLocation.properties.placerConfig.description - schemas.PlacerLocation.properties.placerConfig.type - schemas.PlacerLocation.type - schemas.RegionalMigDistributionPolicy.description - schemas.RegionalMigDistributionPolicy.id - schemas.RegionalMigDistributionPolicy.properties.targetShape.description - schemas.RegionalMigDistributionPolicy.properties.targetShape.format - schemas.RegionalMigDistributionPolicy.properties.targetShape.type - schemas.RegionalMigDistributionPolicy.properties.zones.description - schemas.RegionalMigDistributionPolicy.properties.zones.items.$ref - schemas.RegionalMigDistributionPolicy.properties.zones.type - schemas.RegionalMigDistributionPolicy.type - schemas.RequirementOverride.id - schemas.RequirementOverride.properties.ziOverride.enum - schemas.RequirementOverride.properties.ziOverride.enumDescriptions - schemas.RequirementOverride.properties.ziOverride.type - schemas.RequirementOverride.properties.zsOverride.enum - schemas.RequirementOverride.properties.zsOverride.enumDescriptions - schemas.RequirementOverride.properties.zsOverride.type - schemas.RequirementOverride.type - schemas.SpannerLocation.id - schemas.SpannerLocation.properties.backupName.description - schemas.SpannerLocation.properties.backupName.items.type - schemas.SpannerLocation.properties.backupName.type - schemas.SpannerLocation.properties.dbName.description - schemas.SpannerLocation.properties.dbName.items.type - schemas.SpannerLocation.properties.dbName.type - schemas.SpannerLocation.type - schemas.TenantProjectProxy.id - schemas.TenantProjectProxy.properties.projectNumbers.items.type - schemas.TenantProjectProxy.properties.projectNumbers.type - schemas.TenantProjectProxy.type - schemas.ZoneConfiguration.id - schemas.ZoneConfiguration.properties.zone.type - schemas.ZoneConfiguration.type The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description --- discovery/memcache-v1.json | 392 +------------------------------- discovery/memcache-v1beta2.json | 392 +------------------------------- src/apis/memcache/v1.ts | 125 +--------- src/apis/memcache/v1beta2.ts | 125 +--------- 4 files changed, 6 insertions(+), 1028 deletions(-) diff --git a/discovery/memcache-v1.json b/discovery/memcache-v1.json index d48d38c8293..19db8617bcd 100644 --- a/discovery/memcache-v1.json +++ b/discovery/memcache-v1.json @@ -459,7 +459,7 @@ "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`.", + "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": "memcache.projects.locations.operations.cancel", @@ -584,7 +584,7 @@ } } }, - "revision": "20241010", + "revision": "20250206", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -605,85 +605,12 @@ }, "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" - }, - "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" - }, "DailyCycle": { "description": "Time window specified for daily operations.", "id": "DailyCycle", @@ -741,35 +668,12 @@ }, "type": "object" }, - "DirectLocationAssignment": { - "id": "DirectLocationAssignment", - "properties": { - "location": { - "items": { - "$ref": "LocationAssignment" - }, - "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" }, - "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" - }, "GoogleCloudMemcacheV1LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleCloudMemcacheV1LocationMetadata", @@ -1328,131 +1232,6 @@ }, "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" - } - }, - "type": "object" - }, "ListInstancesResponse": { "description": "Response for ListInstances.", "id": "ListInstancesResponse", @@ -1548,64 +1327,6 @@ }, "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" - }, "LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "LocationMetadata", @@ -1895,74 +1616,6 @@ }, "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" - }, - "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" - }, - "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" - }, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", @@ -2031,26 +1684,6 @@ }, "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", @@ -2078,18 +1711,6 @@ }, "type": "object" }, - "TenantProjectProxy": { - "id": "TenantProjectProxy", - "properties": { - "projectNumbers": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "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", @@ -2225,15 +1846,6 @@ }, "type": "object" }, - "ZoneConfiguration": { - "id": "ZoneConfiguration", - "properties": { - "zone": { - "type": "string" - } - }, - "type": "object" - }, "ZoneMetadata": { "id": "ZoneMetadata", "properties": {}, diff --git a/discovery/memcache-v1beta2.json b/discovery/memcache-v1beta2.json index 4ad1be83eb3..f6edbe8c523 100644 --- a/discovery/memcache-v1beta2.json +++ b/discovery/memcache-v1beta2.json @@ -487,7 +487,7 @@ "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`.", + "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": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "memcache.projects.locations.operations.cancel", @@ -612,7 +612,7 @@ } } }, - "revision": "20241010", + "revision": "20250206", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -651,85 +651,12 @@ }, "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" - }, - "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" - }, "DailyCycle": { "description": "Time window specified for daily operations.", "id": "DailyCycle", @@ -787,35 +714,12 @@ }, "type": "object" }, - "DirectLocationAssignment": { - "id": "DirectLocationAssignment", - "properties": { - "location": { - "items": { - "$ref": "LocationAssignment" - }, - "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" }, - "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" - }, "GoogleCloudMemcacheV1beta2LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleCloudMemcacheV1beta2LocationMetadata", @@ -1379,131 +1283,6 @@ }, "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" - } - }, - "type": "object" - }, "ListInstancesResponse": { "description": "Response for ListInstances.", "id": "ListInstancesResponse", @@ -1599,64 +1378,6 @@ }, "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" - }, "LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "LocationMetadata", @@ -1951,74 +1672,6 @@ }, "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" - }, - "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" - }, - "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" - }, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", @@ -2087,26 +1740,6 @@ }, "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", @@ -2134,18 +1767,6 @@ }, "type": "object" }, - "TenantProjectProxy": { - "id": "TenantProjectProxy", - "properties": { - "projectNumbers": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "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", @@ -2281,15 +1902,6 @@ }, "type": "object" }, - "ZoneConfiguration": { - "id": "ZoneConfiguration", - "properties": { - "zone": { - "type": "string" - } - }, - "type": "object" - }, "ZoneMetadata": { "id": "ZoneMetadata", "properties": {}, diff --git a/src/apis/memcache/v1.ts b/src/apis/memcache/v1.ts index c5d60778491..b396c7a4a28 100644 --- a/src/apis/memcache/v1.ts +++ b/src/apis/memcache/v1.ts @@ -137,48 +137,10 @@ export namespace memcache_v1 { */ nodeIds?: 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 { - /** - * 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. - */ - 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[]; - } - /** - * 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[]; - } /** * Time window specified for daily operations. */ @@ -226,22 +188,10 @@ export namespace memcache_v1 { */ time?: Schema$TimeOfDay; } - export interface Schema$DirectLocationAssignment { - location?: Schema$LocationAssignment[]; - } /** * 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 {} - /** - * 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; - } /** * Metadata for the given google.cloud.location.Location. */ @@ -621,25 +571,6 @@ export namespace memcache_v1 { */ message?: 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 for ListInstances. */ @@ -708,18 +639,6 @@ export namespace memcache_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; - } /** * Metadata for the given google.cloud.location.Location. */ @@ -907,32 +826,6 @@ export namespace memcache_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; - } - /** - * 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[]; - } - export interface Schema$RequirementOverride { - ziOverride?: string | null; - zsOverride?: string | null; - } /** * Request for RescheduleMaintenance. */ @@ -963,16 +856,6 @@ export namespace memcache_v1 { */ startTime?: Schema$TimeOfDay; } - 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). */ @@ -990,9 +873,6 @@ export namespace memcache_v1 { */ message?: string | null; } - export interface Schema$TenantProjectProxy { - projectNumbers?: string[] | 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`. */ @@ -1070,9 +950,6 @@ export namespace memcache_v1 { */ startTime?: Schema$TimeOfDay; } - export interface Schema$ZoneConfiguration { - zone?: string | null; - } export interface Schema$ZoneMetadata {} export class Resource$Projects { @@ -2227,7 +2104,7 @@ export namespace memcache_v1 { } /** - * 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`. + * 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`. diff --git a/src/apis/memcache/v1beta2.ts b/src/apis/memcache/v1beta2.ts index 18b1428fd1f..87350ac032b 100644 --- a/src/apis/memcache/v1beta2.ts +++ b/src/apis/memcache/v1beta2.ts @@ -150,48 +150,10 @@ export namespace memcache_v1beta2 { */ nodeIds?: 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 { - /** - * 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. - */ - 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[]; - } - /** - * 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[]; - } /** * Time window specified for daily operations. */ @@ -239,22 +201,10 @@ export namespace memcache_v1beta2 { */ time?: Schema$TimeOfDay; } - export interface Schema$DirectLocationAssignment { - location?: Schema$LocationAssignment[]; - } /** * 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 {} - /** - * 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; - } /** * Metadata for the given google.cloud.location.Location. */ @@ -638,25 +588,6 @@ export namespace memcache_v1beta2 { */ message?: 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 for ListInstances. */ @@ -725,18 +656,6 @@ export namespace memcache_v1beta2 { */ 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; - } /** * Metadata for the given google.cloud.location.Location. */ @@ -928,32 +847,6 @@ export namespace memcache_v1beta2 { */ 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; - } - /** - * 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[]; - } - export interface Schema$RequirementOverride { - ziOverride?: string | null; - zsOverride?: string | null; - } /** * Request for RescheduleMaintenance. */ @@ -984,16 +877,6 @@ export namespace memcache_v1beta2 { */ startTime?: Schema$TimeOfDay; } - 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). */ @@ -1011,9 +894,6 @@ export namespace memcache_v1beta2 { */ message?: string | null; } - export interface Schema$TenantProjectProxy { - projectNumbers?: string[] | 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`. */ @@ -1091,9 +971,6 @@ export namespace memcache_v1beta2 { */ startTime?: Schema$TimeOfDay; } - export interface Schema$ZoneConfiguration { - zone?: string | null; - } export interface Schema$ZoneMetadata {} export class Resource$Projects { @@ -2348,7 +2225,7 @@ export namespace memcache_v1beta2 { } /** - * 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`. + * 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`. From 1e2ee7c3563f8b8d17f4f3a469ec2f5efa54712e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 084/144] feat(merchantapi)!: update the API BREAKING CHANGE: This release has breaking changes. #### merchantapi:accounts_v1beta The following keys were deleted: - schemas.SeasonalOverride.description - schemas.SeasonalOverride.properties.begin.$ref - schemas.SeasonalOverride.properties.begin.description - schemas.SeasonalOverride.properties.end.$ref - schemas.SeasonalOverride.properties.end.description - schemas.SeasonalOverride.properties.policy.$ref - schemas.SeasonalOverride.properties.policy.description The following keys were added: - resources.accounts.methods.getAutomaticImprovements.description - resources.accounts.methods.getAutomaticImprovements.flatPath - resources.accounts.methods.getAutomaticImprovements.httpMethod - resources.accounts.methods.getAutomaticImprovements.id - resources.accounts.methods.getAutomaticImprovements.parameterOrder - resources.accounts.methods.getAutomaticImprovements.parameters.name.description - resources.accounts.methods.getAutomaticImprovements.parameters.name.location - resources.accounts.methods.getAutomaticImprovements.parameters.name.pattern - resources.accounts.methods.getAutomaticImprovements.parameters.name.required - resources.accounts.methods.getAutomaticImprovements.parameters.name.type - resources.accounts.methods.getAutomaticImprovements.path - resources.accounts.methods.getAutomaticImprovements.response.$ref - resources.accounts.methods.getAutomaticImprovements.scopes - resources.accounts.methods.updateAutomaticImprovements.description - resources.accounts.methods.updateAutomaticImprovements.flatPath - resources.accounts.methods.updateAutomaticImprovements.httpMethod - resources.accounts.methods.updateAutomaticImprovements.id - resources.accounts.methods.updateAutomaticImprovements.parameterOrder - resources.accounts.methods.updateAutomaticImprovements.parameters.name.description - resources.accounts.methods.updateAutomaticImprovements.parameters.name.location - resources.accounts.methods.updateAutomaticImprovements.parameters.name.pattern - resources.accounts.methods.updateAutomaticImprovements.parameters.name.required - resources.accounts.methods.updateAutomaticImprovements.parameters.name.type - resources.accounts.methods.updateAutomaticImprovements.parameters.updateMask.description - resources.accounts.methods.updateAutomaticImprovements.parameters.updateMask.format - resources.accounts.methods.updateAutomaticImprovements.parameters.updateMask.location - resources.accounts.methods.updateAutomaticImprovements.parameters.updateMask.type - resources.accounts.methods.updateAutomaticImprovements.path - resources.accounts.methods.updateAutomaticImprovements.request.$ref - resources.accounts.methods.updateAutomaticImprovements.response.$ref - resources.accounts.methods.updateAutomaticImprovements.scopes - schemas.AddUser.description - schemas.AddUser.id - schemas.AddUser.properties.user.$ref - schemas.AddUser.properties.user.description - schemas.AddUser.properties.userId.description - schemas.AddUser.properties.userId.type - schemas.AddUser.type - schemas.AutomaticImageImprovements.description - schemas.AutomaticImageImprovements.id - schemas.AutomaticImageImprovements.properties.accountImageImprovementsSettings.$ref - schemas.AutomaticImageImprovements.properties.accountImageImprovementsSettings.description - schemas.AutomaticImageImprovements.properties.effectiveAllowAutomaticImageImprovements.description - schemas.AutomaticImageImprovements.properties.effectiveAllowAutomaticImageImprovements.readOnly - schemas.AutomaticImageImprovements.properties.effectiveAllowAutomaticImageImprovements.type - schemas.AutomaticImageImprovements.type - schemas.AutomaticImprovements.description - schemas.AutomaticImprovements.id - schemas.AutomaticImprovements.properties.imageImprovements.$ref - schemas.AutomaticImprovements.properties.imageImprovements.description - schemas.AutomaticImprovements.properties.itemUpdates.$ref - schemas.AutomaticImprovements.properties.itemUpdates.description - schemas.AutomaticImprovements.properties.name.description - schemas.AutomaticImprovements.properties.name.type - schemas.AutomaticImprovements.properties.shippingImprovements.$ref - schemas.AutomaticImprovements.properties.shippingImprovements.description - schemas.AutomaticImprovements.type - schemas.AutomaticItemUpdates.description - schemas.AutomaticItemUpdates.id - schemas.AutomaticItemUpdates.properties.accountItemUpdatesSettings.$ref - schemas.AutomaticItemUpdates.properties.accountItemUpdatesSettings.description - schemas.AutomaticItemUpdates.properties.effectiveAllowAvailabilityUpdates.description - schemas.AutomaticItemUpdates.properties.effectiveAllowAvailabilityUpdates.readOnly - schemas.AutomaticItemUpdates.properties.effectiveAllowAvailabilityUpdates.type - schemas.AutomaticItemUpdates.properties.effectiveAllowConditionUpdates.description - schemas.AutomaticItemUpdates.properties.effectiveAllowConditionUpdates.readOnly - schemas.AutomaticItemUpdates.properties.effectiveAllowConditionUpdates.type - schemas.AutomaticItemUpdates.properties.effectiveAllowPriceUpdates.description - schemas.AutomaticItemUpdates.properties.effectiveAllowPriceUpdates.readOnly - schemas.AutomaticItemUpdates.properties.effectiveAllowPriceUpdates.type - schemas.AutomaticItemUpdates.properties.effectiveAllowStrictAvailabilityUpdates.description - schemas.AutomaticItemUpdates.properties.effectiveAllowStrictAvailabilityUpdates.readOnly - schemas.AutomaticItemUpdates.properties.effectiveAllowStrictAvailabilityUpdates.type - schemas.AutomaticItemUpdates.type - schemas.AutomaticShippingImprovements.description - schemas.AutomaticShippingImprovements.id - schemas.AutomaticShippingImprovements.properties.allowShippingImprovements.description - schemas.AutomaticShippingImprovements.properties.allowShippingImprovements.type - schemas.AutomaticShippingImprovements.type - schemas.CreateAndConfigureAccountRequest.properties.user.description - schemas.CreateAndConfigureAccountRequest.properties.user.items.$ref - schemas.CreateAndConfigureAccountRequest.properties.user.type - schemas.CreateAndConfigureAccountRequest.properties.users.deprecated - schemas.ImageImprovementsAccountLevelSettings.description - schemas.ImageImprovementsAccountLevelSettings.id - schemas.ImageImprovementsAccountLevelSettings.properties.allowAutomaticImageImprovements.description - schemas.ImageImprovementsAccountLevelSettings.properties.allowAutomaticImageImprovements.type - schemas.ImageImprovementsAccountLevelSettings.type - schemas.ItemUpdatesAccountLevelSettings.description - schemas.ItemUpdatesAccountLevelSettings.id - schemas.ItemUpdatesAccountLevelSettings.properties.allowAvailabilityUpdates.description - schemas.ItemUpdatesAccountLevelSettings.properties.allowAvailabilityUpdates.type - schemas.ItemUpdatesAccountLevelSettings.properties.allowConditionUpdates.description - schemas.ItemUpdatesAccountLevelSettings.properties.allowConditionUpdates.type - schemas.ItemUpdatesAccountLevelSettings.properties.allowPriceUpdates.description - schemas.ItemUpdatesAccountLevelSettings.properties.allowPriceUpdates.type - schemas.ItemUpdatesAccountLevelSettings.properties.allowStrictAvailabilityUpdates.description - schemas.ItemUpdatesAccountLevelSettings.properties.allowStrictAvailabilityUpdates.type - schemas.ItemUpdatesAccountLevelSettings.type - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type - schemas.SeasonalOverride.properties.endDate.$ref - schemas.SeasonalOverride.properties.endDate.description - schemas.SeasonalOverride.properties.returnDays.description - schemas.SeasonalOverride.properties.returnDays.format - schemas.SeasonalOverride.properties.returnDays.type - schemas.SeasonalOverride.properties.returnUntilDate.$ref - schemas.SeasonalOverride.properties.returnUntilDate.description - schemas.SeasonalOverride.properties.startDate.$ref - schemas.SeasonalOverride.properties.startDate.description The following keys were changed: - resources.accounts.methods.list.description - resources.accounts.methods.list.parameters.filter.description - schemas.Account.properties.adultContent.description - schemas.CreateAndConfigureAccountRequest.properties.users.description - schemas.ImpactedDestination.properties.reportingContext.enum - schemas.ImpactedDestination.properties.reportingContext.enumDeprecated - schemas.ImpactedDestination.properties.reportingContext.enumDescriptions - schemas.OnlineReturnPolicy.properties.itemConditions.description - schemas.OnlineReturnPolicy.properties.returnMethods.description - schemas.OnlineReturnPolicy.properties.returnShippingFee.description - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description - schemas.Program.description - schemas.User.properties.accessRights.description #### merchantapi:conversions_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:datasources_v1beta The following keys were added: - schemas.Destination.description - schemas.Destination.id - schemas.Destination.properties.destination.description - schemas.Destination.properties.destination.enum - schemas.Destination.properties.destination.enumDescriptions - schemas.Destination.properties.destination.type - schemas.Destination.properties.state.description - schemas.Destination.properties.state.enum - schemas.Destination.properties.state.enumDescriptions - schemas.Destination.properties.state.type - schemas.Destination.type - schemas.PrimaryProductDataSource.properties.destinations.description - schemas.PrimaryProductDataSource.properties.destinations.items.$ref - schemas.PrimaryProductDataSource.properties.destinations.type - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.PrimaryProductDataSource.properties.channel.description - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:inventories_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:lfp_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:notifications_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:products_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - resources.accounts.resources.productInputs.methods.insert.parameters.dataSource.description - schemas.DestinationStatus.properties.reportingContext.enum - schemas.DestinationStatus.properties.reportingContext.enumDeprecated - schemas.DestinationStatus.properties.reportingContext.enumDescriptions - schemas.ItemLevelIssue.properties.reportingContext.enum - schemas.ItemLevelIssue.properties.reportingContext.enumDeprecated - schemas.ItemLevelIssue.properties.reportingContext.enumDescriptions - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:promotions_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.Attributes.properties.couponValueType.enumDescriptions - schemas.Attributes.properties.promotionDestinations.items.enumDescriptions - schemas.DestinationStatus.properties.reportingContext.enum - schemas.DestinationStatus.properties.reportingContext.enumDeprecated - schemas.DestinationStatus.properties.reportingContext.enumDescriptions - schemas.ItemLevelIssue.properties.reportingContext.enum - schemas.ItemLevelIssue.properties.reportingContext.enumDeprecated - schemas.ItemLevelIssue.properties.reportingContext.enumDescriptions - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:quota_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:reports_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.IssueSeverityPerReportingContext.properties.reportingContext.enum - schemas.IssueSeverityPerReportingContext.properties.reportingContext.enumDeprecated - schemas.IssueSeverityPerReportingContext.properties.reportingContext.enumDescriptions - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description #### merchantapi:reviews_v1beta The following keys were added: - schemas.ProductStatusChangeMessage.properties.eventTime.description - schemas.ProductStatusChangeMessage.properties.eventTime.format - schemas.ProductStatusChangeMessage.properties.eventTime.type The following keys were changed: - schemas.MerchantReview.properties.customAttributes.description - schemas.MerchantReviewAttributes.properties.reviewLanguage.description - schemas.MerchantReviewDestinationStatus.properties.reportingContext.enum - schemas.MerchantReviewDestinationStatus.properties.reportingContext.enumDeprecated - schemas.MerchantReviewDestinationStatus.properties.reportingContext.enumDescriptions - schemas.MerchantReviewItemLevelIssue.properties.reportingContext.enum - schemas.MerchantReviewItemLevelIssue.properties.reportingContext.enumDeprecated - schemas.MerchantReviewItemLevelIssue.properties.reportingContext.enumDescriptions - schemas.ProductChange.properties.newValue.description - schemas.ProductChange.properties.oldValue.description - schemas.ProductChange.properties.regionCode.description - schemas.ProductChange.properties.reportingContext.description - schemas.ProductChange.properties.reportingContext.enum - schemas.ProductChange.properties.reportingContext.enumDeprecated - schemas.ProductChange.properties.reportingContext.enumDescriptions - schemas.ProductReviewDestinationStatus.properties.reportingContext.enum - schemas.ProductReviewDestinationStatus.properties.reportingContext.enumDeprecated - schemas.ProductReviewDestinationStatus.properties.reportingContext.enumDescriptions - schemas.ProductReviewItemLevelIssue.properties.reportingContext.enum - schemas.ProductReviewItemLevelIssue.properties.reportingContext.enumDeprecated - schemas.ProductReviewItemLevelIssue.properties.reportingContext.enumDescriptions - schemas.ProductStatusChangeMessage.properties.expirationTime.description - schemas.ProductStatusChangeMessage.properties.resource.description --- discovery/merchantapi-accounts_v1beta.json | 266 ++++++++++-- discovery/merchantapi-conversions_v1beta.json | 24 +- discovery/merchantapi-datasources_v1beta.json | 88 +++- discovery/merchantapi-inventories_v1beta.json | 24 +- discovery/merchantapi-lfp_v1beta.json | 24 +- .../merchantapi-notifications_v1beta.json | 24 +- discovery/merchantapi-products_v1beta.json | 36 +- discovery/merchantapi-promotions_v1beta.json | 50 ++- discovery/merchantapi-quota_v1beta.json | 24 +- discovery/merchantapi-reports_v1beta.json | 29 +- discovery/merchantapi-reviews_v1beta.json | 48 ++- src/apis/merchantapi/accounts_v1beta.ts | 381 ++++++++++++++++-- src/apis/merchantapi/conversions_v1beta.ts | 16 +- src/apis/merchantapi/datasources_v1beta.ts | 35 +- src/apis/merchantapi/inventories_v1beta.ts | 16 +- src/apis/merchantapi/lfp_v1beta.ts | 16 +- src/apis/merchantapi/notifications_v1beta.ts | 16 +- src/apis/merchantapi/products_v1beta.ts | 18 +- src/apis/merchantapi/promotions_v1beta.ts | 16 +- src/apis/merchantapi/quota_v1beta.ts | 16 +- src/apis/merchantapi/reports_v1beta.ts | 16 +- src/apis/merchantapi/reviews_v1beta.ts | 20 +- 22 files changed, 987 insertions(+), 216 deletions(-) diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index a5cd6c9c79c..1a717b4afd7 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -180,15 +180,40 @@ "https://www.googleapis.com/auth/content" ] }, + "getAutomaticImprovements": { + "description": "Retrieves the automatic improvements of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/automaticImprovements", + "httpMethod": "GET", + "id": "merchantapi.accounts.getAutomaticImprovements", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the automatic improvements. Format: `accounts/{account}/automaticImprovements`", + "location": "path", + "pattern": "^accounts/[^/]+/automaticImprovements$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "AutomaticImprovements" + }, + "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. If no filter is provided, then it returns accounts the user is directly added to.", + "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. If no filter is provided, then it returns all the accounts the user has access to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.", "flatPath": "accounts/v1beta/accounts", "httpMethod": "GET", "id": "merchantapi.accounts.list", "parameterOrder": [], "parameters": { "filter": { - "description": "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).", + "description": "Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax).", "location": "query", "type": "string" }, @@ -281,6 +306,40 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] + }, + "updateAutomaticImprovements": { + "description": "Updates the automatic improvements of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/automaticImprovements", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.updateAutomaticImprovements", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the automatic improvements. Format: `accounts/{account}/automaticImprovements`.", + "location": "path", + "pattern": "^accounts/[^/]+/automaticImprovements$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `item_updates` - `item_updates.account_level_settings` - `image_improvements` - `image_improvements.account_level_settings` - `shipping_improvements` - `shipping_improvements.allow_shipping_improvements`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "AutomaticImprovements" + }, + "response": { + "$ref": "AutomaticImprovements" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] } }, "resources": { @@ -1417,7 +1476,7 @@ } } }, - "revision": "20250115", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Accepted": { @@ -1454,7 +1513,7 @@ "type": "string" }, "adultContent": { - "description": "Whether this account contains adult content.", + "description": "Optional. Whether this account contains adult content.", "type": "boolean" }, "languageCode": { @@ -1544,6 +1603,21 @@ }, "type": "object" }, + "AddUser": { + "description": "Instruction for adding a user to the account during creation.", + "id": "AddUser", + "properties": { + "user": { + "$ref": "User", + "description": "Optional. Details about the user to be added. At the moment, only access rights may be specified." + }, + "userId": { + "description": "Required. The email address of the user (for example, `john.doe@gmail.com`).", + "type": "string" + } + }, + "type": "object" + }, "Address": { "description": "Shipping address of the warehouse.", "id": "Address", @@ -1591,6 +1665,87 @@ }, "type": "object" }, + "AutomaticImageImprovements": { + "description": "This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973)", + "id": "AutomaticImageImprovements", + "properties": { + "accountImageImprovementsSettings": { + "$ref": "ImageImprovementsAccountLevelSettings", + "description": "Optional. Determines how the images should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator." + }, + "effectiveAllowAutomaticImageImprovements": { + "description": "Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "AutomaticImprovements": { + "description": "Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account.", + "id": "AutomaticImprovements", + "properties": { + "imageImprovements": { + "$ref": "AutomaticImageImprovements", + "description": "This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided in the update mask." + }, + "itemUpdates": { + "$ref": "AutomaticItemUpdates", + "description": "Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided in the update mask." + }, + "name": { + "description": "Identifier. The resource name of the automatic improvements. Format: `accounts/{account}/automaticImprovements`.", + "type": "string" + }, + "shippingImprovements": { + "$ref": "AutomaticShippingImprovements", + "description": "Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data This field is only updated (cleared) if provided in the update mask." + } + }, + "type": "object" + }, + "AutomaticItemUpdates": { + "description": "Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown.", + "id": "AutomaticItemUpdates", + "properties": { + "accountItemUpdatesSettings": { + "$ref": "ItemUpdatesAccountLevelSettings", + "description": "Optional. Determines which attributes of the items should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator." + }, + "effectiveAllowAvailabilityUpdates": { + "description": "Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.", + "readOnly": true, + "type": "boolean" + }, + "effectiveAllowConditionUpdates": { + "description": "Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.", + "readOnly": true, + "type": "boolean" + }, + "effectiveAllowPriceUpdates": { + "description": "Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.", + "readOnly": true, + "type": "boolean" + }, + "effectiveAllowStrictAvailabilityUpdates": { + "description": "Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "AutomaticShippingImprovements": { + "description": "Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data", + "id": "AutomaticShippingImprovements", + "properties": { + "allowShippingImprovements": { + "description": "Enables automatic shipping improvements.", + "type": "boolean" + } + }, + "type": "object" + }, "BusinessDayConfig": { "description": "Business days of the warehouse.", "id": "BusinessDayConfig", @@ -1770,8 +1925,16 @@ }, "type": "array" }, - "users": { + "user": { "description": "Optional. Users to be added to the account.", + "items": { + "$ref": "AddUser" + }, + "type": "array" + }, + "users": { + "deprecated": true, + "description": "Optional. Users to be added to the account. This field is deprecated and will not exist after the API evolves out of beta. Use the `user` field instead.", "items": { "$ref": "CreateUserRequest" }, @@ -2100,6 +2263,17 @@ }, "type": "object" }, + "ImageImprovementsAccountLevelSettings": { + "description": "Settings for the Automatic Image Improvements.", + "id": "ImageImprovementsAccountLevelSettings", + "properties": { + "allowAutomaticImageImprovements": { + "description": "Enables automatic image improvements.", + "type": "boolean" + } + }, + "type": "object" + }, "Impact": { "description": "The impact of the issue on a region.", "id": "Impact", @@ -2153,6 +2327,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -2178,6 +2353,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2193,18 +2369,42 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } }, "type": "object" }, + "ItemUpdatesAccountLevelSettings": { + "description": "Settings for the Automatic Item Updates.", + "id": "ItemUpdatesAccountLevelSettings", + "properties": { + "allowAvailabilityUpdates": { + "description": "If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_strict_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.", + "type": "boolean" + }, + "allowConditionUpdates": { + "description": "If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.", + "type": "boolean" + }, + "allowPriceUpdates": { + "description": "If price updates are enabled, Google always updates the active price with the crawled information.", + "type": "boolean" + }, + "allowStrictAvailabilityUpdates": { + "description": "If `allow_availability_updates` is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also set `allow_availability_updates`.", + "type": "boolean" + } + }, + "type": "object" + }, "ListAccountIssuesResponse": { "description": "Response message for the `ListAccountIssues` method.", "id": "ListAccountIssuesResponse", @@ -2425,7 +2625,7 @@ "type": "array" }, "itemConditions": { - "description": "The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.", + "description": "Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.", "items": { "enum": [ "ITEM_CONDITION_UNSPECIFIED", @@ -2463,7 +2663,7 @@ "description": "The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set." }, "returnMethods": { - "description": "The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.", + "description": "Optional. The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.", "items": { "enum": [ "RETURN_METHOD_UNSPECIFIED", @@ -2492,7 +2692,7 @@ }, "returnShippingFee": { "$ref": "ReturnShippingFee", - "description": "The return shipping fee. Should be set only when customer need to download and print the return label." + "description": "Optional. The return shipping fee. Should be set only when customer need to download and print the return label." }, "seasonalOverrides": { "description": "Optional. Overrides to the general policy for orders placed during a specific set of time intervals.", @@ -2663,19 +2863,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -2689,6 +2889,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -2714,6 +2915,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2729,12 +2931,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -2768,8 +2971,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -2778,7 +2986,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { @@ -2801,7 +3009,7 @@ "type": "object" }, "Program": { - "description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free.", + "description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { @@ -3018,14 +3226,9 @@ "type": "object" }, "SeasonalOverride": { - "description": "Next: 5", "id": "SeasonalOverride", "properties": { - "begin": { - "$ref": "Date", - "description": "Required. Defines the date range when this seasonal override applies. Both begin and end are inclusive and should be in date decimal format, example 20250115. The dates of the seasonal overrides should not overlap." - }, - "end": { + "endDate": { "$ref": "Date", "description": "Required. seasonal override end date (inclusive)." }, @@ -3033,9 +3236,18 @@ "description": "Required. Display name of this seasonal override in Merchant Center.", "type": "string" }, - "policy": { - "$ref": "Policy", - "description": "Required. The return policy for the given date range." + "returnDays": { + "description": "Number of days (from the delivery date) that the product can be returned.", + "format": "int32", + "type": "integer" + }, + "returnUntilDate": { + "$ref": "Date", + "description": "Fixed end date until which the product can be returned." + }, + "startDate": { + "$ref": "Date", + "description": "Required. Defines the date range when this seasonal override applies. Both start_date and end_date are inclusive. The dates of the seasonal overrides should not overlap." } }, "type": "object" @@ -3391,7 +3603,7 @@ "id": "User", "properties": { "accessRights": { - "description": "Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.", + "description": "Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.", "items": { "enum": [ "ACCESS_RIGHT_UNSPECIFIED", diff --git a/discovery/merchantapi-conversions_v1beta.json b/discovery/merchantapi-conversions_v1beta.json index fe8452846a4..572f9314b86 100644 --- a/discovery/merchantapi-conversions_v1beta.json +++ b/discovery/merchantapi-conversions_v1beta.json @@ -295,7 +295,7 @@ } } }, - "revision": "20250118", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -490,19 +490,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -516,6 +516,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -541,6 +542,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -556,12 +558,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -595,8 +598,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -605,7 +613,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-datasources_v1beta.json b/discovery/merchantapi-datasources_v1beta.json index 8720f8bfd5c..44e07fd4554 100644 --- a/discovery/merchantapi-datasources_v1beta.json +++ b/discovery/merchantapi-datasources_v1beta.json @@ -321,7 +321,7 @@ } } }, - "revision": "20250108", + "revision": "20250312", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -429,6 +429,61 @@ }, "type": "object" }, + "Destination": { + "description": "Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections.", + "id": "Destination", + "properties": { + "destination": { + "description": "[Marketing methods](https://support.google.com/merchants/answer/15130232) (also known as destination) selections.", + "enum": [ + "DESTINATION_ENUM_UNSPECIFIED", + "SHOPPING_ADS", + "DISPLAY_ADS", + "LOCAL_INVENTORY_ADS", + "FREE_LISTINGS", + "FREE_LOCAL_LISTINGS", + "YOUTUBE_SHOPPING", + "YOUTUBE_SHOPPING_CHECKOUT", + "YOUTUBE_AFFILIATE", + "FREE_VEHICLE_LISTINGS", + "VEHICLE_ADS", + "CLOUD_RETAIL", + "LOCAL_CLOUD_RETAIL" + ], + "enumDescriptions": [ + "Not specified.", + "[Shopping ads](https://support.google.com/google-ads/answer/2454022).", + "[Display ads](https://support.google.com/merchants/answer/6069387).", + "[Local inventory ads](https://support.google.com/merchants/answer/3057972).", + "[Free listings](https://support.google.com/merchants/answer/9199328).", + "[Free local product listings](https://support.google.com/merchants/answer/9825611).", + "[YouTube Shopping](https://support.google.com/merchants/answer/12362804).", + "Youtube shopping checkout.", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", + "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", + "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", + "[Cloud retail](https://cloud.google.com/solutions/retail).", + "[Local cloud retail](https://cloud.google.com/solutions/retail)." + ], + "type": "string" + }, + "state": { + "description": "The state of the destination.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "Not specified.", + "Indicates that the destination is enabled.", + "Indicates that the destination is disabled." + ], + "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", @@ -707,7 +762,7 @@ "id": "PrimaryProductDataSource", "properties": { "channel": { - "description": "Required. Immutable. Specifies the type of data source channel.", + "description": "Optional. Immutable. Specifies the type of data source channel.", "enum": [ "CHANNEL_UNSPECIFIED", "ONLINE_PRODUCTS", @@ -737,6 +792,13 @@ "$ref": "DefaultRule", "description": "Optional. Default rule management of the data source. If set, the linked data sources will be replaced." }, + "destinations": { + "description": "Optional. A list of destinations describing where products of the data source can be shown. When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account. Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source. If unset, during creation, the destinations will be inherited based on the account level program participation. If set, during creation or update, the data source will be set only for the specified destinations. Updating this field requires at least one destination.", + "items": { + "$ref": "Destination" + }, + "type": "array" + }, "feedLabel": { "description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.", "type": "string" @@ -749,19 +811,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -775,6 +837,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -800,6 +863,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -815,12 +879,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -860,8 +925,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -870,7 +940,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-inventories_v1beta.json b/discovery/merchantapi-inventories_v1beta.json index ec779881f58..d824b814b2b 100644 --- a/discovery/merchantapi-inventories_v1beta.json +++ b/discovery/merchantapi-inventories_v1beta.json @@ -300,7 +300,7 @@ } } }, - "revision": "20241119", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -467,19 +467,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -493,6 +493,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -518,6 +519,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -533,12 +535,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -572,8 +575,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -582,7 +590,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-lfp_v1beta.json b/discovery/merchantapi-lfp_v1beta.json index 96a45c05230..2596ffdbc9e 100644 --- a/discovery/merchantapi-lfp_v1beta.json +++ b/discovery/merchantapi-lfp_v1beta.json @@ -298,7 +298,7 @@ } } }, - "revision": "20241119", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -541,19 +541,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -567,6 +567,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -592,6 +593,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -607,12 +609,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -646,8 +649,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -656,7 +664,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-notifications_v1beta.json b/discovery/merchantapi-notifications_v1beta.json index 9e971193437..974cbc9c619 100644 --- a/discovery/merchantapi-notifications_v1beta.json +++ b/discovery/merchantapi-notifications_v1beta.json @@ -262,7 +262,7 @@ } } }, - "revision": "20241119", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -330,19 +330,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -356,6 +356,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -381,6 +382,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -396,12 +398,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -435,8 +438,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -445,7 +453,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-products_v1beta.json b/discovery/merchantapi-products_v1beta.json index 77a453cb0d4..538a3c40125 100644 --- a/discovery/merchantapi-products_v1beta.json +++ b/discovery/merchantapi-products_v1beta.json @@ -149,7 +149,7 @@ ], "parameters": { "dataSource": { - "description": "Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Format: `accounts/{account}/dataSources/{datasource}`.", + "description": "Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Only API data sources are supported. Format: `accounts/{account}/dataSources/{datasource}`.", "location": "query", "type": "string" }, @@ -242,7 +242,7 @@ } } }, - "revision": "20250106", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -829,6 +829,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -854,6 +855,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -869,12 +871,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -989,6 +992,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -1014,6 +1018,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1029,12 +1034,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" }, @@ -1227,19 +1233,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -1253,6 +1259,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -1278,6 +1285,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1293,12 +1301,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -1461,8 +1470,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -1471,7 +1485,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-promotions_v1beta.json b/discovery/merchantapi-promotions_v1beta.json index 4ab2e53e3cc..aff00c026d7 100644 --- a/discovery/merchantapi-promotions_v1beta.json +++ b/discovery/merchantapi-promotions_v1beta.json @@ -203,7 +203,7 @@ } } }, - "revision": "20241119", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -252,9 +252,9 @@ "Free gift with description only.", "Free gift with monetary value.", "Free gift with item ID.", - "Standard free shipping coupon value type.", - "Overnight free shipping coupon value type.", - "Two day free shipping coupon value type." + "Standard free shipping coupon value type. Only available for online promotions.", + "Overnight free shipping coupon value type. Only available for online promotions.", + "Two day free shipping coupon value type. Only available for online promotions." ], "type": "string" }, @@ -407,11 +407,11 @@ "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[YouTube Shopping](https://support.google.com/merchants/answer/12362804).", "Youtube shopping checkout.", - "Youtube affiliate.", - "Free vehicle listings.", - "Vehicle ads.", - "Cloud retail.", - "Local cloud retail." + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", + "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", + "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", + "[Cloud retail](https://cloud.google.com/solutions/retail).", + "[Local cloud retail](https://cloud.google.com/solutions/retail)." ], "type": "string" }, @@ -501,6 +501,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -526,6 +527,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -541,12 +543,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "readOnly": true, "type": "string" @@ -661,6 +664,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -686,6 +690,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -701,12 +706,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "readOnly": true, "type": "string" @@ -775,19 +781,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -801,6 +807,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -826,6 +833,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -841,12 +849,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -880,8 +889,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -890,7 +904,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-quota_v1beta.json b/discovery/merchantapi-quota_v1beta.json index 08ad7e8f6a4..11090acb3a1 100644 --- a/discovery/merchantapi-quota_v1beta.json +++ b/discovery/merchantapi-quota_v1beta.json @@ -150,7 +150,7 @@ } } }, - "revision": "20241119", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "ListQuotaGroupsResponse": { @@ -203,19 +203,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -229,6 +229,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -254,6 +255,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -269,12 +271,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -308,8 +311,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -318,7 +326,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-reports_v1beta.json b/discovery/merchantapi-reports_v1beta.json index a595210f10f..afe45510417 100644 --- a/discovery/merchantapi-reports_v1beta.json +++ b/discovery/merchantapi-reports_v1beta.json @@ -142,7 +142,7 @@ } } }, - "revision": "20241119", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -650,6 +650,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -675,6 +676,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -690,12 +692,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -1004,19 +1007,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -1030,6 +1033,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -1055,6 +1059,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1070,12 +1075,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -1243,8 +1249,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -1253,7 +1264,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/discovery/merchantapi-reviews_v1beta.json b/discovery/merchantapi-reviews_v1beta.json index 9e7dbdae555..65e17eb51db 100644 --- a/discovery/merchantapi-reviews_v1beta.json +++ b/discovery/merchantapi-reviews_v1beta.json @@ -356,7 +356,7 @@ } } }, - "revision": "20241119", + "revision": "20250311", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -432,7 +432,7 @@ "description": "Optional. A list of merchant review attributes." }, "customAttributes": { - "description": "Required. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.", + "description": "Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.", "items": { "$ref": "CustomAttribute" }, @@ -523,7 +523,7 @@ "type": "string" }, "reviewLanguage": { - "description": "Required. The language of the review defined by BCP-47 language code.", + "description": "Optional. The language of the review defined by BCP-47 language code.", "type": "string" }, "reviewTime": { @@ -565,6 +565,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -590,6 +591,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -605,12 +607,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "readOnly": true, "type": "string" @@ -662,6 +665,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -687,6 +691,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -702,12 +707,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "readOnly": true, "type": "string" @@ -775,19 +781,19 @@ "id": "ProductChange", "properties": { "newValue": { - "description": "The new value of the changed resource or attribute.", + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "oldValue": { - "description": "The old value of the changed resource or attribute.", + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { - "description": "Countries that have the change (if applicable)", + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "reportingContext": { - "description": "Reporting contexts that have the change (if applicable)", + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", @@ -801,6 +807,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -826,6 +833,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -841,12 +849,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "type": "string" } @@ -1075,6 +1084,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -1100,6 +1110,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1115,12 +1126,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "readOnly": true, "type": "string" @@ -1172,6 +1184,7 @@ "FREE_LISTINGS", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", @@ -1197,6 +1210,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1212,12 +1226,13 @@ "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", - "[YouTube Checkout](" + "YouTube Checkout ." ], "readOnly": true, "type": "string" @@ -1307,8 +1322,13 @@ }, "type": "array" }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, "expirationTime": { - "description": "The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", "format": "google-datetime", "type": "string" }, @@ -1317,7 +1337,7 @@ "type": "string" }, "resource": { - "description": "The product name. Format: `{product.name=accounts/{account}/products/{product}}`", + "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "resourceId": { diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index 10a0fa2ac20..d93b6b409f3 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -156,7 +156,7 @@ export namespace merchantapi_accounts_v1beta { */ accountName?: string | null; /** - * Whether this account contains adult content. + * Optional. Whether this account contains adult content. */ adultContent?: boolean | null; /** @@ -247,6 +247,19 @@ export namespace merchantapi_accounts_v1beta { */ streetAddress?: string | null; } + /** + * Instruction for adding a user to the account during creation. + */ + export interface Schema$AddUser { + /** + * Optional. Details about the user to be added. At the moment, only access rights may be specified. + */ + user?: Schema$User; + /** + * Required. The email address of the user (for example, `john.doe@gmail.com`). + */ + userId?: string | null; + } /** * Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. */ @@ -264,6 +277,74 @@ export namespace merchantapi_accounts_v1beta { */ name?: string | null; } + /** + * This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) + */ + export interface Schema$AutomaticImageImprovements { + /** + * Optional. Determines how the images should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator. + */ + accountImageImprovementsSettings?: Schema$ImageImprovementsAccountLevelSettings; + /** + * Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only. + */ + effectiveAllowAutomaticImageImprovements?: boolean | null; + } + /** + * Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account. + */ + export interface Schema$AutomaticImprovements { + /** + * This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided in the update mask. + */ + imageImprovements?: Schema$AutomaticImageImprovements; + /** + * Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided in the update mask. + */ + itemUpdates?: Schema$AutomaticItemUpdates; + /** + * Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`. + */ + name?: string | null; + /** + * Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data This field is only updated (cleared) if provided in the update mask. + */ + shippingImprovements?: Schema$AutomaticShippingImprovements; + } + /** + * Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. + */ + export interface Schema$AutomaticItemUpdates { + /** + * Optional. Determines which attributes of the items should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator. + */ + accountItemUpdatesSettings?: Schema$ItemUpdatesAccountLevelSettings; + /** + * Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only. + */ + effectiveAllowAvailabilityUpdates?: boolean | null; + /** + * Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only. + */ + effectiveAllowConditionUpdates?: boolean | null; + /** + * Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only. + */ + effectiveAllowPriceUpdates?: boolean | null; + /** + * Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only. + */ + effectiveAllowStrictAvailabilityUpdates?: boolean | null; + } + /** + * Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data + */ + export interface Schema$AutomaticShippingImprovements { + /** + * Enables automatic shipping improvements. + */ + allowShippingImprovements?: boolean | null; + } /** * Business days of the warehouse. */ @@ -388,6 +469,10 @@ export namespace merchantapi_accounts_v1beta { /** * Optional. Users to be added to the account. */ + user?: Schema$AddUser[]; + /** + * Optional. Users to be added to the account. This field is deprecated and will not exist after the API evolves out of beta. Use the `user` field instead. + */ users?: Schema$CreateUserRequest[]; } /** @@ -614,6 +699,15 @@ export namespace merchantapi_accounts_v1beta { */ identityDeclaration?: string | null; } + /** + * Settings for the Automatic Image Improvements. + */ + export interface Schema$ImageImprovementsAccountLevelSettings { + /** + * Enables automatic image improvements. + */ + allowAutomaticImageImprovements?: boolean | null; + } /** * The impact of the issue on a region. */ @@ -640,6 +734,27 @@ export namespace merchantapi_accounts_v1beta { */ reportingContext?: string | null; } + /** + * Settings for the Automatic Item Updates. + */ + export interface Schema$ItemUpdatesAccountLevelSettings { + /** + * If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_strict_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page. + */ + allowAvailabilityUpdates?: boolean | null; + /** + * If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product. + */ + allowConditionUpdates?: boolean | null; + /** + * If price updates are enabled, Google always updates the active price with the crawled information. + */ + allowPriceUpdates?: boolean | null; + /** + * If `allow_availability_updates` is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also set `allow_availability_updates`. + */ + allowStrictAvailabilityUpdates?: boolean | null; + } /** * Response message for the `ListAccountIssues` method. */ @@ -801,7 +916,7 @@ export namespace merchantapi_accounts_v1beta { */ countries?: string[] | null; /** - * The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'. + * Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'. */ itemConditions?: string[] | null; /** @@ -825,7 +940,7 @@ export namespace merchantapi_accounts_v1beta { */ restockingFee?: Schema$RestockingFee; /** - * The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns. + * Optional. The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns. */ returnMethods?: string[] | null; /** @@ -837,7 +952,7 @@ export namespace merchantapi_accounts_v1beta { */ returnPolicyUri?: string | null; /** - * The return shipping fee. Should be set only when customer need to download and print the return label. + * Optional. The return shipping fee. Should be set only when customer need to download and print the return label. */ returnShippingFee?: Schema$ReturnShippingFee; /** @@ -968,19 +1083,19 @@ export namespace merchantapi_accounts_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -1001,7 +1116,11 @@ export namespace merchantapi_accounts_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -1009,7 +1128,7 @@ export namespace merchantapi_accounts_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** @@ -1022,7 +1141,7 @@ export namespace merchantapi_accounts_v1beta { resourceType?: string | null; } /** - * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. + * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` */ export interface Schema$Program { /** @@ -1169,26 +1288,27 @@ export namespace merchantapi_accounts_v1beta { */ cells?: Schema$Value[]; } - /** - * Next: 5 - */ export interface Schema$SeasonalOverride { - /** - * Required. Defines the date range when this seasonal override applies. Both begin and end are inclusive and should be in date decimal format, example 20250115. The dates of the seasonal overrides should not overlap. - */ - begin?: Schema$Date; /** * Required. seasonal override end date (inclusive). */ - end?: Schema$Date; + endDate?: Schema$Date; /** * Required. Display name of this seasonal override in Merchant Center. */ label?: string | null; /** - * Required. The return policy for the given date range. + * Number of days (from the delivery date) that the product can be returned. */ - policy?: Schema$Policy; + returnDays?: number | null; + /** + * Fixed end date until which the product can be returned. + */ + returnUntilDate?: Schema$Date; + /** + * Required. Defines the date range when this seasonal override applies. Both start_date and end_date are inclusive. The dates of the seasonal overrides should not overlap. + */ + startDate?: Schema$Date; } /** * Shipping service. @@ -1439,7 +1559,7 @@ export namespace merchantapi_accounts_v1beta { */ export interface Schema$User { /** - * Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + * Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. */ accessRights?: string[] | null; /** @@ -1848,7 +1968,102 @@ export namespace merchantapi_accounts_v1beta { } /** - * 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. If no filter is provided, then it returns accounts the user is directly added to. + * Retrieves the automatic improvements 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. + */ + getAutomaticImprovements( + params: Params$Resource$Accounts$Getautomaticimprovements, + options: StreamMethodOptions + ): GaxiosPromise; + getAutomaticImprovements( + params?: Params$Resource$Accounts$Getautomaticimprovements, + options?: MethodOptions + ): GaxiosPromise; + getAutomaticImprovements( + params: Params$Resource$Accounts$Getautomaticimprovements, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAutomaticImprovements( + params: Params$Resource$Accounts$Getautomaticimprovements, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAutomaticImprovements( + params: Params$Resource$Accounts$Getautomaticimprovements, + callback: BodyResponseCallback + ): void; + getAutomaticImprovements( + callback: BodyResponseCallback + ): void; + getAutomaticImprovements( + paramsOrCallback?: + | Params$Resource$Accounts$Getautomaticimprovements + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Getautomaticimprovements; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Getautomaticimprovements; + 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 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. If no filter is provided, then it returns all the accounts the user has access to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2119,6 +2334,101 @@ export namespace merchantapi_accounts_v1beta { return createAPIRequest(parameters); } } + + /** + * Updates the automatic improvements 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. + */ + updateAutomaticImprovements( + params: Params$Resource$Accounts$Updateautomaticimprovements, + options: StreamMethodOptions + ): GaxiosPromise; + updateAutomaticImprovements( + params?: Params$Resource$Accounts$Updateautomaticimprovements, + options?: MethodOptions + ): GaxiosPromise; + updateAutomaticImprovements( + params: Params$Resource$Accounts$Updateautomaticimprovements, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAutomaticImprovements( + params: Params$Resource$Accounts$Updateautomaticimprovements, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAutomaticImprovements( + params: Params$Resource$Accounts$Updateautomaticimprovements, + callback: BodyResponseCallback + ): void; + updateAutomaticImprovements( + callback: BodyResponseCallback + ): void; + updateAutomaticImprovements( + paramsOrCallback?: + | Params$Resource$Accounts$Updateautomaticimprovements + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Updateautomaticimprovements; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Updateautomaticimprovements; + 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$Createandconfigure @@ -2144,9 +2454,16 @@ export namespace merchantapi_accounts_v1beta { */ name?: string; } + export interface Params$Resource$Accounts$Getautomaticimprovements + extends StandardParameters { + /** + * Required. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements` + */ + 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). + * Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax). */ filter?: string; /** @@ -2188,6 +2505,22 @@ export namespace merchantapi_accounts_v1beta { */ requestBody?: Schema$Account; } + export interface Params$Resource$Accounts$Updateautomaticimprovements + extends StandardParameters { + /** + * Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`. + */ + name?: string; + /** + * Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `item_updates` - `item_updates.account_level_settings` - `image_improvements` - `image_improvements.account_level_settings` - `shipping_improvements` - `shipping_improvements.allow_shipping_improvements` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutomaticImprovements; + } export class Resource$Accounts$Autofeedsettings { context: APIRequestContext; diff --git a/src/apis/merchantapi/conversions_v1beta.ts b/src/apis/merchantapi/conversions_v1beta.ts index 8cf6fa14201..9fb5eae7bc8 100644 --- a/src/apis/merchantapi/conversions_v1beta.ts +++ b/src/apis/merchantapi/conversions_v1beta.ts @@ -240,19 +240,19 @@ export namespace merchantapi_conversions_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -273,7 +273,11 @@ export namespace merchantapi_conversions_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -281,7 +285,7 @@ export namespace merchantapi_conversions_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** diff --git a/src/apis/merchantapi/datasources_v1beta.ts b/src/apis/merchantapi/datasources_v1beta.ts index ef3ad743776..ec19c21f6fd 100644 --- a/src/apis/merchantapi/datasources_v1beta.ts +++ b/src/apis/merchantapi/datasources_v1beta.ts @@ -203,6 +203,19 @@ export namespace merchantapi_datasources_v1beta { */ takeFromDataSources?: Schema$DataSourceReference[]; } + /** + * Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections. + */ + export interface Schema$Destination { + /** + * [Marketing methods](https://support.google.com/merchants/answer/15130232) (also known as destination) selections. + */ + destination?: string | null; + /** + * The state of the destination. + */ + state?: 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); \} */ @@ -370,7 +383,7 @@ export namespace merchantapi_datasources_v1beta { */ export interface Schema$PrimaryProductDataSource { /** - * Required. Immutable. Specifies the type of data source channel. + * Optional. Immutable. Specifies the type of data source channel. */ channel?: string | null; /** @@ -385,6 +398,10 @@ export namespace merchantapi_datasources_v1beta { * Optional. Default rule management of the data source. If set, the linked data sources will be replaced. */ defaultRule?: Schema$DefaultRule; + /** + * Optional. A list of destinations describing where products of the data source can be shown. When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account. Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source. If unset, during creation, the destinations will be inherited based on the account level program participation. If set, during creation or update, the data source will be set only for the specified destinations. Updating this field requires at least one destination. + */ + destinations?: Schema$Destination[]; /** * Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. */ @@ -395,19 +412,19 @@ export namespace merchantapi_datasources_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -432,7 +449,11 @@ export namespace merchantapi_datasources_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -440,7 +461,7 @@ export namespace merchantapi_datasources_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** diff --git a/src/apis/merchantapi/inventories_v1beta.ts b/src/apis/merchantapi/inventories_v1beta.ts index 78a4c247b9e..980bae82dfc 100644 --- a/src/apis/merchantapi/inventories_v1beta.ts +++ b/src/apis/merchantapi/inventories_v1beta.ts @@ -255,19 +255,19 @@ export namespace merchantapi_inventories_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -288,7 +288,11 @@ export namespace merchantapi_inventories_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -296,7 +300,7 @@ export namespace merchantapi_inventories_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** diff --git a/src/apis/merchantapi/lfp_v1beta.ts b/src/apis/merchantapi/lfp_v1beta.ts index f7a5be9aba7..f6853563e0c 100644 --- a/src/apis/merchantapi/lfp_v1beta.ts +++ b/src/apis/merchantapi/lfp_v1beta.ts @@ -322,19 +322,19 @@ export namespace merchantapi_lfp_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -355,7 +355,11 @@ export namespace merchantapi_lfp_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -363,7 +367,7 @@ export namespace merchantapi_lfp_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** diff --git a/src/apis/merchantapi/notifications_v1beta.ts b/src/apis/merchantapi/notifications_v1beta.ts index 2c7bc0c6f74..53d3f45e7bd 100644 --- a/src/apis/merchantapi/notifications_v1beta.ts +++ b/src/apis/merchantapi/notifications_v1beta.ts @@ -171,19 +171,19 @@ export namespace merchantapi_notifications_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -204,7 +204,11 @@ export namespace merchantapi_notifications_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -212,7 +216,7 @@ export namespace merchantapi_notifications_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** diff --git a/src/apis/merchantapi/products_v1beta.ts b/src/apis/merchantapi/products_v1beta.ts index 6dc7f14c240..02814f225af 100644 --- a/src/apis/merchantapi/products_v1beta.ts +++ b/src/apis/merchantapi/products_v1beta.ts @@ -815,19 +815,19 @@ export namespace merchantapi_products_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -944,7 +944,11 @@ export namespace merchantapi_products_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -952,7 +956,7 @@ export namespace merchantapi_products_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** @@ -1375,7 +1379,7 @@ export namespace merchantapi_products_v1beta { export interface Params$Resource$Accounts$Productinputs$Insert extends StandardParameters { /** - * Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Format: `accounts/{account\}/dataSources/{datasource\}`. + * Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`. */ dataSource?: string; /** diff --git a/src/apis/merchantapi/promotions_v1beta.ts b/src/apis/merchantapi/promotions_v1beta.ts index 6c75f56386c..bc753111f4f 100644 --- a/src/apis/merchantapi/promotions_v1beta.ts +++ b/src/apis/merchantapi/promotions_v1beta.ts @@ -377,19 +377,19 @@ export namespace merchantapi_promotions_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -410,7 +410,11 @@ export namespace merchantapi_promotions_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -418,7 +422,7 @@ export namespace merchantapi_promotions_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** diff --git a/src/apis/merchantapi/quota_v1beta.ts b/src/apis/merchantapi/quota_v1beta.ts index 38403a7cefa..6793152552b 100644 --- a/src/apis/merchantapi/quota_v1beta.ts +++ b/src/apis/merchantapi/quota_v1beta.ts @@ -163,19 +163,19 @@ export namespace merchantapi_quota_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -196,7 +196,11 @@ export namespace merchantapi_quota_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -204,7 +208,7 @@ export namespace merchantapi_quota_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** diff --git a/src/apis/merchantapi/reports_v1beta.ts b/src/apis/merchantapi/reports_v1beta.ts index bd76daefd0f..5a2e9277aa3 100644 --- a/src/apis/merchantapi/reports_v1beta.ts +++ b/src/apis/merchantapi/reports_v1beta.ts @@ -651,19 +651,19 @@ export namespace merchantapi_reports_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -801,7 +801,11 @@ export namespace merchantapi_reports_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -809,7 +813,7 @@ export namespace merchantapi_reports_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** diff --git a/src/apis/merchantapi/reviews_v1beta.ts b/src/apis/merchantapi/reviews_v1beta.ts index 40ff3636827..2d62186f19b 100644 --- a/src/apis/merchantapi/reviews_v1beta.ts +++ b/src/apis/merchantapi/reviews_v1beta.ts @@ -180,7 +180,7 @@ export namespace merchantapi_reviews_v1beta { */ attributes?: Schema$MerchantReviewAttributes; /** - * Required. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" \}`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. + * Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" \}`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. */ customAttributes?: Schema$CustomAttribute[]; /** @@ -257,7 +257,7 @@ export namespace merchantapi_reviews_v1beta { */ reviewerUsername?: string | null; /** - * Required. The language of the review defined by BCP-47 language code. + * Optional. The language of the review defined by BCP-47 language code. */ reviewLanguage?: string | null; /** @@ -341,19 +341,19 @@ export namespace merchantapi_reviews_v1beta { */ export interface Schema$ProductChange { /** - * The new value of the changed resource or attribute. + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ newValue?: string | null; /** - * The old value of the changed resource or attribute. + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) */ oldValue?: string | null; /** - * Countries that have the change (if applicable) + * Countries that have the change (if applicable). Represented in the ISO 3166 format. */ regionCode?: string | null; /** - * Reporting contexts that have the change (if applicable) + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */ reportingContext?: string | null; } @@ -591,7 +591,11 @@ export namespace merchantapi_reviews_v1beta { */ changes?: Schema$ProductChange[]; /** - * The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. */ expirationTime?: string | null; /** @@ -599,7 +603,7 @@ export namespace merchantapi_reviews_v1beta { */ managingAccount?: string | null; /** - * The product name. Format: `{product.name=accounts/{account\}/products/{product\}\}` + * The product name. Format: `accounts/{account\}/products/{product\}` */ resource?: string | null; /** From 0c4460910a851d9c78cd02a3e2c9a2b40f9203f0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 085/144] feat(metastore): update the API #### metastore:v1alpha The following keys were added: - schemas.MultiRegionMetadata.properties.continent.description - schemas.MultiRegionMetadata.properties.continent.type - schemas.MultiRegionMetadata.properties.witnessRegion.description - schemas.MultiRegionMetadata.properties.witnessRegion.type #### metastore:v2alpha The following keys were added: - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.witnessRegion.type - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.witnessRegion.type - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.witnessRegion.type The following keys were changed: - schemas.GoogleCloudMetastoreV2alphaDatabaseDump.description #### metastore:v1beta The following keys were added: - schemas.MultiRegionMetadata.properties.continent.description - schemas.MultiRegionMetadata.properties.continent.type - schemas.MultiRegionMetadata.properties.witnessRegion.description - schemas.MultiRegionMetadata.properties.witnessRegion.type #### metastore:v2beta The following keys were added: - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.witnessRegion.type - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.witnessRegion.type - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.witnessRegion.type The following keys were changed: - schemas.GoogleCloudMetastoreV2betaDatabaseDump.description #### metastore:v1 The following keys were added: - schemas.MultiRegionMetadata.properties.continent.description - schemas.MultiRegionMetadata.properties.continent.type - schemas.MultiRegionMetadata.properties.witnessRegion.description - schemas.MultiRegionMetadata.properties.witnessRegion.type #### metastore:v2 The following keys were added: - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1MultiRegionMetadata.properties.witnessRegion.type - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1alphaMultiRegionMetadata.properties.witnessRegion.type - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.continent.description - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.continent.type - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.witnessRegion.description - schemas.GoogleCloudMetastoreV1betaMultiRegionMetadata.properties.witnessRegion.type The following keys were changed: - schemas.GoogleCloudMetastoreV2DatabaseDump.description --- discovery/metastore-v1.json | 10 +++++++++- discovery/metastore-v1alpha.json | 10 +++++++++- discovery/metastore-v1beta.json | 10 +++++++++- discovery/metastore-v2.json | 28 ++++++++++++++++++++++++++-- discovery/metastore-v2alpha.json | 28 ++++++++++++++++++++++++++-- discovery/metastore-v2beta.json | 28 ++++++++++++++++++++++++++-- src/apis/metastore/v1.ts | 8 ++++++++ src/apis/metastore/v1alpha.ts | 8 ++++++++ src/apis/metastore/v1beta.ts | 8 ++++++++ src/apis/metastore/v2.ts | 26 +++++++++++++++++++++++++- src/apis/metastore/v2alpha.ts | 26 +++++++++++++++++++++++++- src/apis/metastore/v2beta.ts | 26 +++++++++++++++++++++++++- 12 files changed, 204 insertions(+), 12 deletions(-) diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index c1854cefcb1..b219fc08531 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -1684,7 +1684,7 @@ } } }, - "revision": "20250121", + "revision": "20250227", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2948,6 +2948,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index 8aa2d6f0110..10b0d61bb59 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -1796,7 +1796,7 @@ } } }, - "revision": "20250121", + "revision": "20250227", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -3153,6 +3153,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index 33c0ae2717e..b68fcf8777e 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -1796,7 +1796,7 @@ } } }, - "revision": "20250121", + "revision": "20250227", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -3153,6 +3153,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" diff --git a/discovery/metastore-v2.json b/discovery/metastore-v2.json index dd95c53399a..6cff955c06c 100644 --- a/discovery/metastore-v2.json +++ b/discovery/metastore-v2.json @@ -637,7 +637,7 @@ } } }, - "revision": "20241203", + "revision": "20250227", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "GoogleCloudMetastoreV1AlterMetadataResourceLocationResponse": { @@ -741,6 +741,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -923,6 +931,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -1105,6 +1121,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -1301,7 +1325,7 @@ "type": "object" }, "GoogleCloudMetastoreV2DatabaseDump": { - "description": "A specification of the location of and metadata about a database dump from a relational database management system.", + "description": "A specification of the location and metadata type for a database dump from a relational database management system.", "id": "GoogleCloudMetastoreV2DatabaseDump", "properties": { "gcsUri": { diff --git a/discovery/metastore-v2alpha.json b/discovery/metastore-v2alpha.json index 05153aa7600..b1d95448137 100644 --- a/discovery/metastore-v2alpha.json +++ b/discovery/metastore-v2alpha.json @@ -854,7 +854,7 @@ } } }, - "revision": "20241203", + "revision": "20250227", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "GoogleCloudMetastoreV1AlterMetadataResourceLocationResponse": { @@ -958,6 +958,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -1140,6 +1148,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -1322,6 +1338,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -1641,7 +1665,7 @@ "type": "object" }, "GoogleCloudMetastoreV2alphaDatabaseDump": { - "description": "A specification of the location of and metadata about a database dump from a relational database management system.", + "description": "A specification of the location and metadata type for a database dump from a relational database management system.", "id": "GoogleCloudMetastoreV2alphaDatabaseDump", "properties": { "gcsUri": { diff --git a/discovery/metastore-v2beta.json b/discovery/metastore-v2beta.json index 3dc967a65c4..c9560670c32 100644 --- a/discovery/metastore-v2beta.json +++ b/discovery/metastore-v2beta.json @@ -854,7 +854,7 @@ } } }, - "revision": "20241203", + "revision": "20250227", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "GoogleCloudMetastoreV1AlterMetadataResourceLocationResponse": { @@ -958,6 +958,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -1140,6 +1148,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -1322,6 +1338,14 @@ "type": "string" }, "type": "array" + }, + "continent": { + "description": "The continent for this multi-region.", + "type": "string" + }, + "witnessRegion": { + "description": "The Spanner witness region for this multi-region.", + "type": "string" } }, "type": "object" @@ -1641,7 +1665,7 @@ "type": "object" }, "GoogleCloudMetastoreV2betaDatabaseDump": { - "description": "A specification of the location of and metadata about a database dump from a relational database management system.", + "description": "A specification of the location and metadata type for a database dump from a relational database management system.", "id": "GoogleCloudMetastoreV2betaDatabaseDump", "properties": { "gcsUri": { diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index 7df1975b4ed..f180f9d292e 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -942,6 +942,14 @@ export namespace metastore_v1 { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Network configuration for the Dataproc Metastore service. diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index b1ceea2b170..9592dfaaac9 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -1005,6 +1005,14 @@ export namespace metastore_v1alpha { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Network configuration for the Dataproc Metastore service. diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index 0e846c93adb..5351779a6c7 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -1005,6 +1005,14 @@ export namespace metastore_v1beta { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Network configuration for the Dataproc Metastore service. diff --git a/src/apis/metastore/v2.ts b/src/apis/metastore/v2.ts index 86585bf1ded..4f2a3741b92 100644 --- a/src/apis/metastore/v2.ts +++ b/src/apis/metastore/v2.ts @@ -214,6 +214,14 @@ export namespace metastore_v2 { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -351,6 +359,14 @@ export namespace metastore_v2 { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -462,6 +478,14 @@ export namespace metastore_v2 { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -586,7 +610,7 @@ export namespace metastore_v2 { state?: string | null; } /** - * A specification of the location of and metadata about a database dump from a relational database management system. + * A specification of the location and metadata type for a database dump from a relational database management system. */ export interface Schema$GoogleCloudMetastoreV2DatabaseDump { /** diff --git a/src/apis/metastore/v2alpha.ts b/src/apis/metastore/v2alpha.ts index 4051da2615f..b3f80ba98c8 100644 --- a/src/apis/metastore/v2alpha.ts +++ b/src/apis/metastore/v2alpha.ts @@ -214,6 +214,14 @@ export namespace metastore_v2alpha { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -351,6 +359,14 @@ export namespace metastore_v2alpha { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -462,6 +478,14 @@ export namespace metastore_v2alpha { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -694,7 +718,7 @@ export namespace metastore_v2alpha { */ export interface Schema$GoogleCloudMetastoreV2alphaCompleteMigrationRequest {} /** - * A specification of the location of and metadata about a database dump from a relational database management system. + * A specification of the location and metadata type for a database dump from a relational database management system. */ export interface Schema$GoogleCloudMetastoreV2alphaDatabaseDump { /** diff --git a/src/apis/metastore/v2beta.ts b/src/apis/metastore/v2beta.ts index cd9e5cb6dd8..313ccb83808 100644 --- a/src/apis/metastore/v2beta.ts +++ b/src/apis/metastore/v2beta.ts @@ -214,6 +214,14 @@ export namespace metastore_v2beta { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -351,6 +359,14 @@ export namespace metastore_v2beta { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -462,6 +478,14 @@ export namespace metastore_v2beta { * The regions constituting the multi-region. */ constituentRegions?: string[] | null; + /** + * The continent for this multi-region. + */ + continent?: string | null; + /** + * The Spanner witness region for this multi-region. + */ + witnessRegion?: string | null; } /** * Represents the metadata of a long-running operation. @@ -694,7 +718,7 @@ export namespace metastore_v2beta { */ export interface Schema$GoogleCloudMetastoreV2betaCompleteMigrationRequest {} /** - * A specification of the location of and metadata about a database dump from a relational database management system. + * A specification of the location and metadata type for a database dump from a relational database management system. */ export interface Schema$GoogleCloudMetastoreV2betaDatabaseDump { /** From 3b99d33f93a6042f3f5bf8b55167ca6d7c4ccb5c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 086/144] feat(migrationcenter): update the API #### migrationcenter:v1alpha1 The following keys were added: - schemas.AwsRds.description - schemas.AwsRds.id - schemas.AwsRds.type - schemas.DatabaseDeploymentDetails.properties.awsRds.$ref - schemas.DatabaseDeploymentDetails.properties.awsRds.description - schemas.DiskPartitionDetails.description - schemas.DiskPartitionDetails.id - schemas.DiskPartitionDetails.properties.freeSpaceBytes.description - schemas.DiskPartitionDetails.properties.freeSpaceBytes.format - schemas.DiskPartitionDetails.properties.freeSpaceBytes.readOnly - schemas.DiskPartitionDetails.properties.freeSpaceBytes.type - schemas.DiskPartitionDetails.properties.partitions.$ref - schemas.DiskPartitionDetails.properties.partitions.description - schemas.DiskPartitionDetails.properties.totalCapacityBytes.description - schemas.DiskPartitionDetails.properties.totalCapacityBytes.format - schemas.DiskPartitionDetails.properties.totalCapacityBytes.readOnly - schemas.DiskPartitionDetails.properties.totalCapacityBytes.type - schemas.DiskPartitionDetails.type - schemas.MachineDetails.properties.diskPartitions.$ref - schemas.MachineDetails.properties.diskPartitions.description - schemas.VirtualMachineDetails.properties.diskPartitions.$ref - schemas.VirtualMachineDetails.properties.diskPartitions.description The following keys were changed: - schemas.DiskPartition.properties.mountPoint.description - schemas.DiskUsageSample.properties.averageIops.description - schemas.DiskUsageSample.properties.averageReadIops.description - schemas.DiskUsageSample.properties.averageWriteIops.description - schemas.NetworkAddress.properties.assignment.enumDescriptions #### migrationcenter:v1 The following keys were added: - schemas.AwsRds.description - schemas.AwsRds.id - schemas.AwsRds.type - schemas.DatabaseDeploymentDetails.properties.awsRds.$ref - schemas.DatabaseDeploymentDetails.properties.awsRds.description - schemas.DiskPartitionDetails.description - schemas.DiskPartitionDetails.id - schemas.DiskPartitionDetails.properties.freeSpaceBytes.description - schemas.DiskPartitionDetails.properties.freeSpaceBytes.format - schemas.DiskPartitionDetails.properties.freeSpaceBytes.readOnly - schemas.DiskPartitionDetails.properties.freeSpaceBytes.type - schemas.DiskPartitionDetails.properties.partitions.$ref - schemas.DiskPartitionDetails.properties.partitions.description - schemas.DiskPartitionDetails.properties.totalCapacityBytes.description - schemas.DiskPartitionDetails.properties.totalCapacityBytes.format - schemas.DiskPartitionDetails.properties.totalCapacityBytes.readOnly - schemas.DiskPartitionDetails.properties.totalCapacityBytes.type - schemas.DiskPartitionDetails.type - schemas.MachineDetails.properties.diskPartitions.$ref - schemas.MachineDetails.properties.diskPartitions.description The following keys were changed: - resources.projects.resources.locations.resources.assets.methods.get.parameters.view.enum - resources.projects.resources.locations.resources.assets.methods.get.parameters.view.enumDescriptions - resources.projects.resources.locations.resources.assets.methods.list.parameters.view.enum - resources.projects.resources.locations.resources.assets.methods.list.parameters.view.enumDescriptions - schemas.DiskPartition.properties.mountPoint.description - schemas.DiskUsageSample.properties.averageIops.description - schemas.DiskUsageSample.properties.averageReadIops.description - schemas.DiskUsageSample.properties.averageWriteIops.description - schemas.NetworkAddress.properties.assignment.enumDescriptions --- discovery/migrationcenter-v1.json | 69 +++++++++++++++++++++---- discovery/migrationcenter-v1alpha1.json | 53 ++++++++++++++++--- src/apis/migrationcenter/v1.ts | 37 +++++++++++-- src/apis/migrationcenter/v1alpha1.ts | 41 +++++++++++++-- 4 files changed, 176 insertions(+), 24 deletions(-) diff --git a/discovery/migrationcenter-v1.json b/discovery/migrationcenter-v1.json index d7c8a44af51..edab12e0369 100644 --- a/discovery/migrationcenter-v1.json +++ b/discovery/migrationcenter-v1.json @@ -378,12 +378,18 @@ "enum": [ "ASSET_VIEW_UNSPECIFIED", "ASSET_VIEW_BASIC", - "ASSET_VIEW_FULL" + "ASSET_VIEW_FULL", + "ASSET_VIEW_STANDARD", + "ASSET_VIEW_UI", + "ASSET_VIEW_LABELS" ], "enumDescriptions": [ "The asset view is not specified. The API displays the basic view by default.", "The asset view includes only basic metadata of the asset.", - "The asset view includes all the metadata of an asset and performance data." + "The asset view includes all the metadata of an asset and performance data.", + "The asset view includes the standard metadata of an asset.", + "The asset view includes fields needed by UI.", + "The asset view includes asset name and labels." ], "location": "query", "type": "string" @@ -439,12 +445,18 @@ "enum": [ "ASSET_VIEW_UNSPECIFIED", "ASSET_VIEW_BASIC", - "ASSET_VIEW_FULL" + "ASSET_VIEW_FULL", + "ASSET_VIEW_STANDARD", + "ASSET_VIEW_UI", + "ASSET_VIEW_LABELS" ], "enumDescriptions": [ "The asset view is not specified. The API displays the basic view by default.", "The asset view includes only basic metadata of the asset.", - "The asset view includes all the metadata of an asset and performance data." + "The asset view includes all the metadata of an asset and performance data.", + "The asset view includes the standard metadata of an asset.", + "The asset view includes fields needed by UI.", + "The asset view includes asset name and labels." ], "location": "query", "type": "string" @@ -2384,7 +2396,7 @@ } } }, - "revision": "20250115", + "revision": "20250227", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2802,6 +2814,12 @@ }, "type": "object" }, + "AwsRds": { + "description": "Specific details for an AWS RDS database deployment.", + "id": "AwsRds", + "properties": {}, + "type": "object" + }, "AzureVmPlatformDetails": { "description": "Azure VM specific details.", "id": "AzureVmPlatformDetails", @@ -3173,6 +3191,10 @@ "description": "Output only. Aggregated stats for the database deployment.", "readOnly": true }, + "awsRds": { + "$ref": "AwsRds", + "description": "Optional. Details of an AWS RDS instance." + }, "edition": { "description": "Optional. The database deployment edition.", "type": "string" @@ -3658,7 +3680,7 @@ "type": "string" }, "mountPoint": { - "description": "Mount pount (Linux/Windows) or drive letter (Windows).", + "description": "Mount point (Linux/Windows) or drive letter (Windows).", "type": "string" }, "subPartitions": { @@ -3676,6 +3698,29 @@ }, "type": "object" }, + "DiskPartitionDetails": { + "description": "Disk partition details.", + "id": "DiskPartitionDetails", + "properties": { + "freeSpaceBytes": { + "description": "Output only. Total free space of all partitions.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "partitions": { + "$ref": "DiskPartitionList", + "description": "Optional. List of partitions." + }, + "totalCapacityBytes": { + "description": "Output only. Total capacity of all partitions.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "DiskPartitionList": { "description": "Disk partition list.", "id": "DiskPartitionList", @@ -3695,17 +3740,17 @@ "id": "DiskUsageSample", "properties": { "averageIops": { - "description": "Optional. Average IOPS sampled over a short window. Must be non-negative. Must be equal to the sum of read and write if one of them is positive. if both read and write are zero they are ignored.", + "description": "Optional. Average IOPS sampled over a short window. Must be non-negative. If read or write are set, the sum of read and write will override the value of the average_iops.", "format": "float", "type": "number" }, "averageReadIops": { - "description": "Optional. Average read IOPS sampled over a short window. Must be non-negative.", + "description": "Optional. Average read IOPS sampled over a short window. Must be non-negative. If both read and write are zero they are ignored.", "format": "float", "type": "number" }, "averageWriteIops": { - "description": "Optional. Average write IOPS sampled over a short window. Must be non-negative.", + "description": "Optional. Average write IOPS sampled over a short window. Must be non-negative. If both read and write are zero they are ignored.", "format": "float", "type": "number" } @@ -4908,6 +4953,10 @@ "format": "google-datetime", "type": "string" }, + "diskPartitions": { + "$ref": "DiskPartitionDetails", + "description": "Optional. Disk partitions details. Note: Partitions are not necessarily mounted on local disks and therefore might not have a one-to-one correspondence with local disks." + }, "disks": { "$ref": "MachineDiskDetails", "description": "Disk details." @@ -5281,7 +5330,7 @@ ], "enumDescriptions": [ "Unknown (default value).", - "Staticly assigned IP.", + "Statically assigned IP.", "Dynamically assigned IP (DHCP)." ], "type": "string" diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index b3087b353f3..b3fe81718e9 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -2548,7 +2548,7 @@ } } }, - "revision": "20250123", + "revision": "20250220", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3159,6 +3159,12 @@ }, "type": "object" }, + "AwsRds": { + "description": "Specific details for an AWS RDS database deployment.", + "id": "AwsRds", + "properties": {}, + "type": "object" + }, "AzureVmPlatformDetails": { "description": "Azure VM specific details.", "id": "AzureVmPlatformDetails", @@ -3904,6 +3910,10 @@ "description": "Output only. Aggregated stats for the database deployment.", "readOnly": true }, + "awsRds": { + "$ref": "AwsRds", + "description": "Optional. Details of an AWS RDS instance." + }, "edition": { "description": "The database deployment edition.", "type": "string" @@ -4643,7 +4653,7 @@ "type": "string" }, "mountPoint": { - "description": "Mount pount (Linux/Windows) or drive letter (Windows).", + "description": "Mount point (Linux/Windows) or drive letter (Windows).", "type": "string" }, "subPartitions": { @@ -4661,6 +4671,29 @@ }, "type": "object" }, + "DiskPartitionDetails": { + "description": "Disk partition details.", + "id": "DiskPartitionDetails", + "properties": { + "freeSpaceBytes": { + "description": "Output only. Total free space of all partitions.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "partitions": { + "$ref": "DiskPartitionList", + "description": "Optional. List of partitions." + }, + "totalCapacityBytes": { + "description": "Output only. Total capacity of all partitions.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "DiskPartitionList": { "description": "Disk partition list.", "id": "DiskPartitionList", @@ -4680,17 +4713,17 @@ "id": "DiskUsageSample", "properties": { "averageIops": { - "description": "Average IOPS sampled over a short window. Must be non-negative. Must be equal to the sum of read and write if one of them is positive. if both read and write are zero they are ignored.", + "description": "Average IOPS sampled over a short window. Must be non-negative. If read or write are set, the sum of read and write will override the value of the average_iops.", "format": "float", "type": "number" }, "averageReadIops": { - "description": "Average read IOPS sampled over a short window. Must be non-negative.", + "description": "Average read IOPS sampled over a short window. Must be non-negative. If both read and write are zero they are ignored.", "format": "float", "type": "number" }, "averageWriteIops": { - "description": "Average write IOPS sampled over a short window. Must be non-negative.", + "description": "Average write IOPS sampled over a short window. Must be non-negative. If both read and write are zero they are ignored.", "format": "float", "type": "number" } @@ -6068,6 +6101,10 @@ "format": "google-datetime", "type": "string" }, + "diskPartitions": { + "$ref": "DiskPartitionDetails", + "description": "Optional. Disk partitions details. Note: Partitions are not necessarily mounted on local disks and therefore might not have a one-to-one correspondence with local disks." + }, "disks": { "$ref": "MachineDiskDetails", "description": "Disk details." @@ -6477,7 +6514,7 @@ ], "enumDescriptions": [ "Unknown (default value).", - "Staticly assigned IP.", + "Statically assigned IP.", "Dynamically assigned IP (DHCP)." ], "type": "string" @@ -8590,6 +8627,10 @@ "format": "google-datetime", "type": "string" }, + "diskPartitions": { + "$ref": "DiskPartitionDetails", + "description": "Optional. Disk partitions details. Note: Partitions are not necessarily mounted on local disks and therefore might not have a one-to-one correspondence with local disks." + }, "guestOs": { "$ref": "GuestOsDetails", "description": "Guest OS information." diff --git a/src/apis/migrationcenter/v1.ts b/src/apis/migrationcenter/v1.ts index 15cddb69802..4c32f41b098 100644 --- a/src/apis/migrationcenter/v1.ts +++ b/src/apis/migrationcenter/v1.ts @@ -396,6 +396,10 @@ export namespace migrationcenter_v1 { */ machineTypeLabel?: string | null; } + /** + * Specific details for an AWS RDS database deployment. + */ + export interface Schema$AwsRds {} /** * Azure VM specific details. */ @@ -660,6 +664,10 @@ export namespace migrationcenter_v1 { * Output only. Aggregated stats for the database deployment. */ aggregatedStats?: Schema$DatabaseDeploymentDetailsAggregatedStats; + /** + * Optional. Details of an AWS RDS instance. + */ + awsRds?: Schema$AwsRds; /** * Optional. The database deployment edition. */ @@ -998,7 +1006,7 @@ export namespace migrationcenter_v1 { */ freeBytes?: string | null; /** - * Mount pount (Linux/Windows) or drive letter (Windows). + * Mount point (Linux/Windows) or drive letter (Windows). */ mountPoint?: string | null; /** @@ -1014,6 +1022,23 @@ export namespace migrationcenter_v1 { */ uuid?: string | null; } + /** + * Disk partition details. + */ + export interface Schema$DiskPartitionDetails { + /** + * Output only. Total free space of all partitions. + */ + freeSpaceBytes?: string | null; + /** + * Optional. List of partitions. + */ + partitions?: Schema$DiskPartitionList; + /** + * Output only. Total capacity of all partitions. + */ + totalCapacityBytes?: string | null; + } /** * Disk partition list. */ @@ -1028,15 +1053,15 @@ export namespace migrationcenter_v1 { */ export interface Schema$DiskUsageSample { /** - * Optional. Average IOPS sampled over a short window. Must be non-negative. Must be equal to the sum of read and write if one of them is positive. if both read and write are zero they are ignored. + * Optional. Average IOPS sampled over a short window. Must be non-negative. If read or write are set, the sum of read and write will override the value of the average_iops. */ averageIops?: number | null; /** - * Optional. Average read IOPS sampled over a short window. Must be non-negative. + * Optional. Average read IOPS sampled over a short window. Must be non-negative. If both read and write are zero they are ignored. */ averageReadIops?: number | null; /** - * Optional. Average write IOPS sampled over a short window. Must be non-negative. + * Optional. Average write IOPS sampled over a short window. Must be non-negative. If both read and write are zero they are ignored. */ averageWriteIops?: number | null; } @@ -1854,6 +1879,10 @@ export namespace migrationcenter_v1 { * Machine creation time. */ createTime?: string | null; + /** + * Optional. Disk partitions details. Note: Partitions are not necessarily mounted on local disks and therefore might not have a one-to-one correspondence with local disks. + */ + diskPartitions?: Schema$DiskPartitionDetails; /** * Disk details. */ diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 1bbf01667b1..805bafcf6bb 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -546,6 +546,10 @@ export namespace migrationcenter_v1alpha1 { */ machineTypeLabel?: string | null; } + /** + * Specific details for an AWS RDS database deployment. + */ + export interface Schema$AwsRds {} /** * Azure VM specific details. */ @@ -988,6 +992,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. Aggregated stats for the database deployment. */ aggregatedStats?: Schema$DatabaseDeploymentDetailsAggregatedStats; + /** + * Optional. Details of an AWS RDS instance. + */ + awsRds?: Schema$AwsRds; /** * The database deployment edition. */ @@ -1474,7 +1482,7 @@ export namespace migrationcenter_v1alpha1 { */ freeBytes?: string | null; /** - * Mount pount (Linux/Windows) or drive letter (Windows). + * Mount point (Linux/Windows) or drive letter (Windows). */ mountPoint?: string | null; /** @@ -1490,6 +1498,23 @@ export namespace migrationcenter_v1alpha1 { */ uuid?: string | null; } + /** + * Disk partition details. + */ + export interface Schema$DiskPartitionDetails { + /** + * Output only. Total free space of all partitions. + */ + freeSpaceBytes?: string | null; + /** + * Optional. List of partitions. + */ + partitions?: Schema$DiskPartitionList; + /** + * Output only. Total capacity of all partitions. + */ + totalCapacityBytes?: string | null; + } /** * Disk partition list. */ @@ -1504,15 +1529,15 @@ export namespace migrationcenter_v1alpha1 { */ export interface Schema$DiskUsageSample { /** - * Average IOPS sampled over a short window. Must be non-negative. Must be equal to the sum of read and write if one of them is positive. if both read and write are zero they are ignored. + * Average IOPS sampled over a short window. Must be non-negative. If read or write are set, the sum of read and write will override the value of the average_iops. */ averageIops?: number | null; /** - * Average read IOPS sampled over a short window. Must be non-negative. + * Average read IOPS sampled over a short window. Must be non-negative. If both read and write are zero they are ignored. */ averageReadIops?: number | null; /** - * Average write IOPS sampled over a short window. Must be non-negative. + * Average write IOPS sampled over a short window. Must be non-negative. If both read and write are zero they are ignored. */ averageWriteIops?: number | null; } @@ -2407,6 +2432,10 @@ export namespace migrationcenter_v1alpha1 { * Machine creation time. */ createTime?: string | null; + /** + * Optional. Disk partitions details. Note: Partitions are not necessarily mounted on local disks and therefore might not have a one-to-one correspondence with local disks. + */ + diskPartitions?: Schema$DiskPartitionDetails; /** * Disk details. */ @@ -4174,6 +4203,10 @@ export namespace migrationcenter_v1alpha1 { * VM creation timestamp. */ createTime?: string | null; + /** + * Optional. Disk partitions details. Note: Partitions are not necessarily mounted on local disks and therefore might not have a one-to-one correspondence with local disks. + */ + diskPartitions?: Schema$DiskPartitionDetails; /** * Guest OS information. */ From 5448212a42323a16755388809120ed04b8686fc0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 087/144] feat(monitoring): update the API #### monitoring:v1 The following keys were added: - schemas.Scorecard.properties.breakdowns.description - schemas.Scorecard.properties.breakdowns.items.$ref - schemas.Scorecard.properties.breakdowns.type - schemas.SingleViewGroup.properties.displayType.description - schemas.SingleViewGroup.properties.displayType.enum - schemas.SingleViewGroup.properties.displayType.enumDescriptions - schemas.SingleViewGroup.properties.displayType.type - schemas.TemplateVariableCondition.description - schemas.TemplateVariableCondition.id - schemas.TemplateVariableCondition.properties.comparator.description - schemas.TemplateVariableCondition.properties.comparator.enum - schemas.TemplateVariableCondition.properties.comparator.enumDescriptions - schemas.TemplateVariableCondition.properties.comparator.type - schemas.TemplateVariableCondition.properties.templateVariable.description - schemas.TemplateVariableCondition.properties.templateVariable.type - schemas.TemplateVariableCondition.properties.templateVariableValue.description - schemas.TemplateVariableCondition.properties.templateVariableValue.type - schemas.TemplateVariableCondition.type - schemas.VisibilityCondition.description - schemas.VisibilityCondition.id - schemas.VisibilityCondition.properties.templateVariableCondition.$ref - schemas.VisibilityCondition.properties.templateVariableCondition.description - schemas.VisibilityCondition.type - schemas.Widget.properties.visibilityCondition.$ref - schemas.Widget.properties.visibilityCondition.description #### monitoring:v3 The following keys were added: - schemas.Criteria.properties.filter.description - schemas.Criteria.properties.filter.type - schemas.UptimeCheckConfig.properties.logCheckFailures.description - schemas.UptimeCheckConfig.properties.logCheckFailures.type The following keys were changed: - resources.projects.resources.snoozes.methods.list.parameters.filter.description - schemas.Criteria.properties.policies.description --- discovery/monitoring-v1.json | 68 ++++++++++++++++++++++++++++++++++-- discovery/monitoring-v3.json | 14 ++++++-- src/apis/monitoring/v3.ts | 12 +++++-- 3 files changed, 87 insertions(+), 7 deletions(-) diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index 005df8b4ccb..7e66dfbb1f8 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -753,7 +753,7 @@ } } }, - "revision": "20241212", + "revision": "20250227", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2236,6 +2236,13 @@ "$ref": "Empty", "description": "Will cause the Scorecard to show only the value, with no indicator to its value relative to its thresholds." }, + "breakdowns": { + "description": "Optional. The collection of breakdowns to be applied to the dataset. A breakdown is a way to slice the data. For example, you can break down the data by region.", + "items": { + "$ref": "Breakdown" + }, + "type": "array" + }, "dimensions": { "description": "Optional. A dimension is a structured label, class, or category for a set of measurements in your data.", "items": { @@ -2290,7 +2297,22 @@ "SingleViewGroup": { "description": "A widget that groups the other widgets by using a dropdown menu. All widgets that are within the area spanned by the grouping widget are considered member widgets.", "id": "SingleViewGroup", - "properties": {}, + "properties": { + "displayType": { + "description": "Optional. Determines how the widget selector will be displayed.", + "enum": [ + "DISPLAY_TYPE_UNSPECIFIED", + "DROPDOWN", + "TAB" + ], + "enumDescriptions": [ + "Display type is not specified, defaults to DROPDOWN.", + "Renders the widget selector as a dropdown.", + "Renders the widget selector as a tab list." + ], + "type": "string" + } + }, "type": "object" }, "SourceContext": { @@ -2445,6 +2467,33 @@ }, "type": "object" }, + "TemplateVariableCondition": { + "description": "A condition whose evaluation is based on the value of a template variable.", + "id": "TemplateVariableCondition", + "properties": { + "comparator": { + "description": "Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable.", + "enum": [ + "COMPARATOR_UNSPECIFIED", + "REGEX_FULL_MATCH" + ], + "enumDescriptions": [ + "No comparator specified. Behavior defaults to REGEX_FULL_MATCH.", + "Condition with this comparator evaluates to true when the value of the template variables matches the specified regex." + ], + "type": "string" + }, + "templateVariable": { + "description": "The template variable whose value is evaluated.", + "type": "string" + }, + "templateVariableValue": { + "description": "The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex.", + "type": "string" + } + }, + "type": "object" + }, "Text": { "description": "A widget that displays textual content.", "id": "Text", @@ -2864,6 +2913,17 @@ }, "type": "object" }, + "VisibilityCondition": { + "description": "Condition that determines whether the widget should be displayed.", + "id": "VisibilityCondition", + "properties": { + "templateVariableCondition": { + "$ref": "TemplateVariableCondition", + "description": "A condition whose evaluation is based on the value of a template variable." + } + }, + "type": "object" + }, "Widget": { "description": "Widget contains a single dashboard component and configuration of how to present the component in the dashboard.", "id": "Widget", @@ -2924,6 +2984,10 @@ "description": "Optional. The title of the widget.", "type": "string" }, + "visibilityCondition": { + "$ref": "VisibilityCondition", + "description": "Optional. If set, this widget is rendered only when the condition is evaluated to true." + }, "xyChart": { "$ref": "XyChart", "description": "A chart of time series data." diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index a8a1e4bc0c2..196b45f0a4f 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -1720,7 +1720,7 @@ ], "parameters": { "filter": { - "description": "Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time > \"2022-03-11T00:00:00-08:00\" AND interval.end_time < \"2022-03-12T00:00:00-08:00\" ``` ", + "description": "Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time > \"2022-03-11T00:00:00-08:00\" AND interval.end_time < \"2022-03-12T00:00:00-08:00\" ", "location": "query", "type": "string" }, @@ -2720,7 +2720,7 @@ } } }, - "revision": "20250111", + "revision": "20250227", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -3414,8 +3414,12 @@ "description": "Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied.", "id": "Criteria", "properties": { + "filter": { + "description": "Optional. The filter string to match on Alert fields when silencing the alerts. It follows the standard https://google.aip.dev/160 syntax. A filter string used to apply the snooze to specific incidents that have matching filter values. Filters can be defined for snoozes that apply to one alerting policy. Filters must be a string formatted as one or more resource labels with specific label values. If multiple resource labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have an instance ID of 1234567890 and a zone of us-central1-a: resource.labels.instance_id=\"1234567890\" AND resource.labels.zone=\"us-central1-a\" ", + "type": "string" + }, "policies": { - "description": "The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.", + "description": "The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time.", "items": { "type": "string" }, @@ -6114,6 +6118,10 @@ "description": "If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.", "type": "boolean" }, + "logCheckFailures": { + "description": "To specify whether to log the results of failed probes to Cloud Logging.", + "type": "boolean" + }, "monitoredResource": { "$ref": "MonitoredResource", "description": "The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision" diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 3a86ed0f5b4..703e65f2330 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -576,7 +576,11 @@ export namespace monitoring_v3 { */ export interface Schema$Criteria { /** - * The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. + * Optional. The filter string to match on Alert fields when silencing the alerts. It follows the standard https://google.aip.dev/160 syntax. A filter string used to apply the snooze to specific incidents that have matching filter values. Filters can be defined for snoozes that apply to one alerting policy. Filters must be a string formatted as one or more resource labels with specific label values. If multiple resource labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have an instance ID of 1234567890 and a zone of us-central1-a: resource.labels.instance_id="1234567890" AND resource.labels.zone="us-central1-a" + */ + filter?: string | null; + /** + * The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. */ policies?: string[] | null; } @@ -2386,6 +2390,10 @@ export namespace monitoring_v3 { * If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false. */ isInternal?: boolean | null; + /** + * To specify whether to log the results of failed probes to Cloud Logging. + */ + logCheckFailures?: boolean | null; /** * The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision */ @@ -6232,7 +6240,7 @@ export namespace monitoring_v3 { export interface Params$Resource$Projects$Snoozes$List extends StandardParameters { /** - * Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time \> "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" ``` + * Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time \> "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" */ filter?: string; /** From 0e6c1bff86a22441fbbfdaf550dd7c3805d5ed27 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 088/144] feat(mybusinessbusinessinformation): update the API #### mybusinessbusinessinformation:v1 The following keys were added: - schemas.Metadata.properties.canOperateLocalPost.deprecated The following keys were changed: - schemas.Metadata.properties.canOperateLocalPost.description --- discovery/mybusinessbusinessinformation-v1.json | 5 +++-- src/apis/mybusinessbusinessinformation/v1.ts | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/discovery/mybusinessbusinessinformation-v1.json b/discovery/mybusinessbusinessinformation-v1.json index e84e53ca552..2621438ac0b 100644 --- a/discovery/mybusinessbusinessinformation-v1.json +++ b/discovery/mybusinessbusinessinformation-v1.json @@ -612,7 +612,7 @@ } } }, - "revision": "20241120", + "revision": "20250217", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1198,7 +1198,8 @@ "type": "boolean" }, "canOperateLocalPost": { - "description": "Output only. Indicates if the listing can manage local posts.", + "deprecated": true, + "description": "Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version.", "readOnly": true, "type": "boolean" }, diff --git a/src/apis/mybusinessbusinessinformation/v1.ts b/src/apis/mybusinessbusinessinformation/v1.ts index 2fe6b0b0a92..7f8909ae8fd 100644 --- a/src/apis/mybusinessbusinessinformation/v1.ts +++ b/src/apis/mybusinessbusinessinformation/v1.ts @@ -573,7 +573,7 @@ export namespace mybusinessbusinessinformation_v1 { */ canOperateHealthData?: boolean | null; /** - * Output only. Indicates if the listing can manage local posts. + * Output only. Indicates if the listing can manage local posts. Deprecated: This field is no longer populated and will be removed in a future version. */ canOperateLocalPost?: boolean | null; /** From 33013c48e0d7afa430a40eca1dfa4fc4bdbd2343 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 089/144] feat(netapp): update the API #### netapp:v1beta1 The following keys were added: - schemas.LocationMetadata.properties.supportedFlexPerformance.description - schemas.LocationMetadata.properties.supportedFlexPerformance.items.enum - schemas.LocationMetadata.properties.supportedFlexPerformance.items.enumDescriptions - schemas.LocationMetadata.properties.supportedFlexPerformance.items.type - schemas.LocationMetadata.properties.supportedFlexPerformance.readOnly - schemas.LocationMetadata.properties.supportedFlexPerformance.type #### netapp:v1 The following keys were added: - schemas.LocationMetadata.properties.supportedFlexPerformance.description - schemas.LocationMetadata.properties.supportedFlexPerformance.items.enum - schemas.LocationMetadata.properties.supportedFlexPerformance.items.enumDescriptions - schemas.LocationMetadata.properties.supportedFlexPerformance.items.type - schemas.LocationMetadata.properties.supportedFlexPerformance.readOnly - schemas.LocationMetadata.properties.supportedFlexPerformance.type --- discovery/netapp-v1.json | 20 +++++++++++++++++++- discovery/netapp-v1beta1.json | 20 +++++++++++++++++++- src/apis/netapp/v1.ts | 4 ++++ src/apis/netapp/v1beta1.ts | 4 ++++ 4 files changed, 46 insertions(+), 2 deletions(-) diff --git a/discovery/netapp-v1.json b/discovery/netapp-v1.json index a3df49512aa..eaddeb1307f 100644 --- a/discovery/netapp-v1.json +++ b/discovery/netapp-v1.json @@ -2264,7 +2264,7 @@ } } }, - "revision": "20250123", + "revision": "20250129", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3254,6 +3254,24 @@ "description": "Metadata for a given google.cloud.location.Location.", "id": "LocationMetadata", "properties": { + "supportedFlexPerformance": { + "description": "Output only. Supported flex performance in a location.", + "items": { + "enum": [ + "FLEX_PERFORMANCE_UNSPECIFIED", + "FLEX_PERFORMANCE_DEFAULT", + "FLEX_PERFORMANCE_CUSTOM" + ], + "enumDescriptions": [ + "Unspecified flex performance.", + "Flex Storage Pool with default performance.", + "Flex Storage Pool with custom performance." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "supportedServiceLevels": { "description": "Output only. Supported service levels in a location.", "items": { diff --git a/discovery/netapp-v1beta1.json b/discovery/netapp-v1beta1.json index b449582a3e5..502498836d3 100644 --- a/discovery/netapp-v1beta1.json +++ b/discovery/netapp-v1beta1.json @@ -2264,7 +2264,7 @@ } } }, - "revision": "20250123", + "revision": "20250129", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3254,6 +3254,24 @@ "description": "Metadata for a given google.cloud.location.Location.", "id": "LocationMetadata", "properties": { + "supportedFlexPerformance": { + "description": "Output only. Supported flex performance in a location.", + "items": { + "enum": [ + "FLEX_PERFORMANCE_UNSPECIFIED", + "FLEX_PERFORMANCE_DEFAULT", + "FLEX_PERFORMANCE_CUSTOM" + ], + "enumDescriptions": [ + "Unspecified flex performance.", + "Flex Storage Pool with default performance.", + "Flex Storage Pool with custom performance." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "supportedServiceLevels": { "description": "Output only. Supported service levels in a location.", "items": { diff --git a/src/apis/netapp/v1.ts b/src/apis/netapp/v1.ts index e6175942ae5..ecc4fffffbe 100644 --- a/src/apis/netapp/v1.ts +++ b/src/apis/netapp/v1.ts @@ -794,6 +794,10 @@ export namespace netapp_v1 { * Metadata for a given google.cloud.location.Location. */ export interface Schema$LocationMetadata { + /** + * Output only. Supported flex performance in a location. + */ + supportedFlexPerformance?: string[] | null; /** * Output only. Supported service levels in a location. */ diff --git a/src/apis/netapp/v1beta1.ts b/src/apis/netapp/v1beta1.ts index 39461283907..5581996c388 100644 --- a/src/apis/netapp/v1beta1.ts +++ b/src/apis/netapp/v1beta1.ts @@ -794,6 +794,10 @@ export namespace netapp_v1beta1 { * Metadata for a given google.cloud.location.Location. */ export interface Schema$LocationMetadata { + /** + * Output only. Supported flex performance in a location. + */ + supportedFlexPerformance?: string[] | null; /** * Output only. Supported service levels in a location. */ From ed49cac0a8fc44f2e7ab9914a1d81655ff49844b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 090/144] feat(networkconnectivity): update the API #### networkconnectivity:v1alpha1 The following keys were changed: - schemas.Hub.properties.state.enum - schemas.Hub.properties.state.enumDescriptions - schemas.Migration.properties.target.description - schemas.Spoke.properties.state.enum - schemas.Spoke.properties.state.enumDescriptions #### networkconnectivity:v1 The following keys were added: - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.flatPath - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.httpMethod - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.id - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.parameterOrder - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.parameters.name.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.parameters.name.location - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.parameters.name.pattern - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.parameters.name.required - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.parameters.name.type - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.path - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.request.$ref - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.response.$ref - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpokeUpdate.scopes - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.flatPath - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.httpMethod - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.id - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.parameterOrder - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.parameters.name.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.parameters.name.location - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.parameters.name.pattern - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.parameters.name.required - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.parameters.name.type - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.path - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.request.$ref - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.response.$ref - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpokeUpdate.scopes - schemas.AcceptSpokeUpdateRequest.description - schemas.AcceptSpokeUpdateRequest.id - schemas.AcceptSpokeUpdateRequest.properties.requestId.description - schemas.AcceptSpokeUpdateRequest.properties.requestId.type - schemas.AcceptSpokeUpdateRequest.properties.spokeEtag.description - schemas.AcceptSpokeUpdateRequest.properties.spokeEtag.type - schemas.AcceptSpokeUpdateRequest.properties.spokeUri.description - schemas.AcceptSpokeUpdateRequest.properties.spokeUri.type - schemas.AcceptSpokeUpdateRequest.type - schemas.LinkedProducerVpcNetwork.properties.proposedIncludeExportRanges.description - schemas.LinkedProducerVpcNetwork.properties.proposedIncludeExportRanges.items.type - schemas.LinkedProducerVpcNetwork.properties.proposedIncludeExportRanges.type - schemas.LinkedVpcNetwork.properties.proposedIncludeExportRanges.description - schemas.LinkedVpcNetwork.properties.proposedIncludeExportRanges.items.type - schemas.LinkedVpcNetwork.properties.proposedIncludeExportRanges.type - schemas.RejectSpokeUpdateRequest.description - schemas.RejectSpokeUpdateRequest.id - schemas.RejectSpokeUpdateRequest.properties.details.description - schemas.RejectSpokeUpdateRequest.properties.details.type - schemas.RejectSpokeUpdateRequest.properties.requestId.description - schemas.RejectSpokeUpdateRequest.properties.requestId.type - schemas.RejectSpokeUpdateRequest.properties.spokeEtag.description - schemas.RejectSpokeUpdateRequest.properties.spokeEtag.type - schemas.RejectSpokeUpdateRequest.properties.spokeUri.description - schemas.RejectSpokeUpdateRequest.properties.spokeUri.type - schemas.RejectSpokeUpdateRequest.type - schemas.Spoke.properties.etag.description - schemas.Spoke.properties.etag.type - schemas.Spoke.properties.fieldPathsPendingUpdate.description - schemas.Spoke.properties.fieldPathsPendingUpdate.items.type - schemas.Spoke.properties.fieldPathsPendingUpdate.type The following keys were changed: - resources.projects.resources.locations.resources.global.resources.policyBasedRoutes.methods.create.parameters.policyBasedRouteId.description - resources.projects.resources.locations.resources.regionalEndpoints.methods.create.parameters.regionalEndpointId.description - schemas.Group.properties.state.enum - schemas.Group.properties.state.enumDescriptions - schemas.Hub.properties.exportPsc.description - schemas.Hub.properties.state.enum - schemas.Hub.properties.state.enumDescriptions - schemas.Migration.properties.target.description - schemas.RegionalEndpoint.properties.name.description - schemas.Route.properties.state.enum - schemas.Route.properties.state.enumDescriptions - schemas.RouteTable.properties.state.enum - schemas.RouteTable.properties.state.enumDescriptions - schemas.Spoke.properties.state.enum - schemas.Spoke.properties.state.enumDescriptions - schemas.SpokeStateCount.properties.state.enum - schemas.SpokeStateCount.properties.state.enumDescriptions --- discovery/networkconnectivity-v1.json | 171 ++++++++++-- discovery/networkconnectivity-v1alpha1.json | 16 +- src/apis/networkconnectivity/v1.ts | 282 +++++++++++++++++++- src/apis/networkconnectivity/v1alpha1.ts | 2 +- 4 files changed, 441 insertions(+), 30 deletions(-) diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index 37040d79a85..2cc03b8a566 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -209,6 +209,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "acceptSpokeUpdate": { + "description": "Accepts a proposal to update a Network Connectivity Center spoke in a hub.", + "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:acceptSpokeUpdate", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.global.hubs.acceptSpokeUpdate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the hub to accept spoke update.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:acceptSpokeUpdate", + "request": { + "$ref": "AcceptSpokeUpdateRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a new Network Connectivity Center hub in the specified project.", "flatPath": "v1/projects/{projectsId}/locations/global/hubs", @@ -564,6 +592,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "rejectSpokeUpdate": { + "description": "Rejects a proposal to update a Network Connectivity Center spoke in a hub.", + "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:rejectSpokeUpdate", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.global.hubs.rejectSpokeUpdate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the hub to reject spoke update.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:rejectSpokeUpdate", + "request": { + "$ref": "RejectSpokeUpdateRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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/global/hubs/{hubsId}:setIamPolicy", @@ -996,7 +1052,7 @@ "type": "string" }, "policyBasedRouteId": { - "description": "Required. Unique id for the policy-based route to create.", + "description": "Required. Unique id for the policy-based route to create. Provided by the client when the resource is created. The name must comply with https://google.aip.dev/122#resource-id-segments. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([a-z0-9-]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", "location": "query", "type": "string" }, @@ -1533,7 +1589,7 @@ "type": "string" }, "regionalEndpointId": { - "description": "Required. Unique id of the Regional Endpoint to be created.", + "description": "Required. Unique id of the Regional Endpoint to be created. @pattern: ^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$", "location": "query", "type": "string" }, @@ -2863,7 +2919,7 @@ } } }, - "revision": "20250110", + "revision": "20250305", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -2892,6 +2948,25 @@ }, "type": "object" }, + "AcceptSpokeUpdateRequest": { + "description": "The request for HubService.AcceptSpokeUpdate.", + "id": "AcceptSpokeUpdateRequest", + "properties": { + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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" + }, + "spokeEtag": { + "description": "Required. The etag of the spoke to accept update.", + "type": "string" + }, + "spokeUri": { + "description": "Required. The URI of the spoke to accept update.", + "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", @@ -3380,7 +3455,8 @@ "REJECTING", "UPDATING", "INACTIVE", - "OBSOLETE" + "OBSOLETE", + "FAILED" ], "enumDescriptions": [ "No state information available", @@ -3391,7 +3467,8 @@ "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", - "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only." + "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true, "type": "string" @@ -3425,7 +3502,7 @@ "type": "string" }, "exportPsc": { - "description": "Optional. Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.", + "description": "Optional. Whether Private Service Connect connection propagation is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.", "type": "boolean" }, "labels": { @@ -3496,7 +3573,8 @@ "REJECTING", "UPDATING", "INACTIVE", - "OBSOLETE" + "OBSOLETE", + "FAILED" ], "enumDescriptions": [ "No state information available", @@ -3507,7 +3585,8 @@ "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", - "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only." + "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true, "type": "string" @@ -3730,6 +3809,13 @@ "readOnly": true, "type": "string" }, + "proposedIncludeExportRanges": { + "description": "Optional. The proposed include export IP ranges waiting for hub administration's approval.", + "items": { + "type": "string" + }, + "type": "array" + }, "serviceConsumerVpcSpoke": { "description": "Output only. The Service Consumer Network spoke.", "readOnly": true, @@ -3794,6 +3880,13 @@ "readOnly": true, "type": "array" }, + "proposedIncludeExportRanges": { + "description": "Optional. The proposed include export IP ranges waiting for hub administration's approval.", + "items": { + "type": "string" + }, + "type": "array" + }, "uri": { "description": "Required. The URI of the VPC network resource.", "type": "string" @@ -4241,7 +4334,7 @@ "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}", + "description": "Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. For example: /projects/{project}/regions/{region}/subnetworks/{subnet}", "type": "string" } }, @@ -4756,7 +4849,7 @@ "type": "object" }, "name": { - "description": "Output only. The name of a RegionalEndpoint. Format: `projects/{project}/locations/{location}/regionalEndpoints/{regional_endpoint}`.", + "description": "Output only. The name of a RegionalEndpoint. Pattern: `projects/{project}/locations/{location}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$`.", "readOnly": true, "type": "string" }, @@ -4816,6 +4909,29 @@ }, "type": "object" }, + "RejectSpokeUpdateRequest": { + "description": "The request for HubService.RejectSpokeUpdate.", + "id": "RejectSpokeUpdateRequest", + "properties": { + "details": { + "description": "Optional. Additional information provided by the hub administrator.", + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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" + }, + "spokeEtag": { + "description": "Required. The etag of the spoke to reject update.", + "type": "string" + }, + "spokeUri": { + "description": "Required. The URI of the spoke to reject update.", + "type": "string" + } + }, + "type": "object" + }, "Route": { "description": "A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.", "id": "Route", @@ -4887,7 +5003,8 @@ "REJECTING", "UPDATING", "INACTIVE", - "OBSOLETE" + "OBSOLETE", + "FAILED" ], "enumDescriptions": [ "No state information available", @@ -4898,7 +5015,8 @@ "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", - "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only." + "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true, "type": "string" @@ -4969,7 +5087,8 @@ "REJECTING", "UPDATING", "INACTIVE", - "OBSOLETE" + "OBSOLETE", + "FAILED" ], "enumDescriptions": [ "No state information available", @@ -4980,7 +5099,8 @@ "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", - "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only." + "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true, "type": "string" @@ -5313,6 +5433,17 @@ "description": "Optional. An optional description of the spoke.", "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.", + "type": "string" + }, + "fieldPathsPendingUpdate": { + "description": "Optional. The list of fields waiting for hub administration's approval.", + "items": { + "type": "string" + }, + "type": "array" + }, "group": { "description": "Optional. The name of the group that this spoke is associated with.", "type": "string" @@ -5392,7 +5523,8 @@ "REJECTING", "UPDATING", "INACTIVE", - "OBSOLETE" + "OBSOLETE", + "FAILED" ], "enumDescriptions": [ "No state information available", @@ -5403,7 +5535,8 @@ "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", - "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only." + "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true, "type": "string" @@ -5443,7 +5576,8 @@ "REJECTING", "UPDATING", "INACTIVE", - "OBSOLETE" + "OBSOLETE", + "FAILED" ], "enumDescriptions": [ "No state information available", @@ -5454,7 +5588,8 @@ "The resource's reject operation is in progress.", "The resource's update operation is in progress.", "The resource is inactive.", - "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only." + "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true, "type": "string" diff --git a/discovery/networkconnectivity-v1alpha1.json b/discovery/networkconnectivity-v1alpha1.json index b441e0d5ae9..d6bd95a44af 100644 --- a/discovery/networkconnectivity-v1alpha1.json +++ b/discovery/networkconnectivity-v1alpha1.json @@ -1116,7 +1116,7 @@ } } }, - "revision": "20250110", + "revision": "20250219", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { @@ -1344,14 +1344,16 @@ "CREATING", "ACTIVE", "DELETING", - "UPDATING" + "UPDATING", + "FAILED" ], "enumDescriptions": [ "No state information available", "The resource's create operation is in progress", "The resource is active", "The resource's Delete operation is in progress", - "The resource's Update operation is in progress" + "The resource's Update operation is in progress", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true, "type": "string" @@ -1622,7 +1624,7 @@ "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}", + "description": "Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. For example: /projects/{project}/regions/{region}/subnetworks/{subnet}", "type": "string" } }, @@ -1794,14 +1796,16 @@ "CREATING", "ACTIVE", "DELETING", - "UPDATING" + "UPDATING", + "FAILED" ], "enumDescriptions": [ "No state information available", "The resource's create operation is in progress", "The resource is active", "The resource's Delete operation is in progress", - "The resource's Update operation is in progress" + "The resource's Update operation is in progress", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." ], "readOnly": true, "type": "string" diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index ec53abc20c8..b243dcaf427 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -146,6 +146,23 @@ export namespace networkconnectivity_v1 { */ spoke?: Schema$Spoke; } + /** + * The request for HubService.AcceptSpokeUpdate. + */ + export interface Schema$AcceptSpokeUpdateRequest { + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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. The etag of the spoke to accept update. + */ + spokeEtag?: string | null; + /** + * Required. The URI of the spoke to accept update. + */ + spokeUri?: string | null; + } /** * 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. */ @@ -480,7 +497,7 @@ export namespace networkconnectivity_v1 { */ description?: string | null; /** - * Optional. Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false. + * Optional. Whether Private Service Connect connection propagation is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false. */ exportPsc?: boolean | null; /** @@ -653,6 +670,10 @@ export namespace networkconnectivity_v1 { * Output only. The URI of the Producer VPC. */ producerNetwork?: string | null; + /** + * Optional. The proposed include export IP ranges waiting for hub administration's approval. + */ + proposedIncludeExportRanges?: string[] | null; /** * Output only. The Service Consumer Network spoke. */ @@ -695,6 +716,10 @@ export namespace networkconnectivity_v1 { * 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. Because they are directly connected throuh VPC peering, NCC export filters do not apply between the service consumer VPC spoke and any of its producer VPC spokes. This VPC spoke cannot be deleted as long as any of these producer VPC spokes are connected to the NCC Hub. */ producerVpcSpokes?: string[] | null; + /** + * Optional. The proposed include export IP ranges waiting for hub administration's approval. + */ + proposedIncludeExportRanges?: string[] | null; /** * Required. The URI of the VPC network resource. */ @@ -998,7 +1023,7 @@ export namespace networkconnectivity_v1 { */ 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\} + * Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. For example: /projects/{project\}/regions/{region\}/subnetworks/{subnet\} */ target?: string | null; } @@ -1344,7 +1369,7 @@ export namespace networkconnectivity_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. The name of a RegionalEndpoint. Format: `projects/{project\}/locations/{location\}/regionalEndpoints/{regional_endpoint\}`. + * Output only. The name of a RegionalEndpoint. Pattern: `projects/{project\}/locations/{location\}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44\})[a-z0-9]$`. */ name?: string | null; /** @@ -1394,6 +1419,27 @@ export namespace networkconnectivity_v1 { */ spoke?: Schema$Spoke; } + /** + * The request for HubService.RejectSpokeUpdate. + */ + export interface Schema$RejectSpokeUpdateRequest { + /** + * Optional. Additional information provided by the hub administrator. + */ + details?: string | null; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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. The etag of the spoke to reject update. + */ + spokeEtag?: string | null; + /** + * Required. The URI of the spoke to reject update. + */ + spokeUri?: string | null; + } /** * A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes. */ @@ -1724,6 +1770,14 @@ export namespace networkconnectivity_v1 { * Optional. An optional description of the spoke. */ description?: 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. + */ + etag?: string | null; + /** + * Optional. The list of fields waiting for hub administration's approval. + */ + fieldPathsPendingUpdate?: string[] | null; /** * Optional. The name of the group that this spoke is associated with. */ @@ -2272,6 +2326,103 @@ export namespace networkconnectivity_v1 { } } + /** + * Accepts a proposal to update a Network Connectivity Center spoke in a 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. + */ + acceptSpokeUpdate( + params: Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate, + options: StreamMethodOptions + ): GaxiosPromise; + acceptSpokeUpdate( + params?: Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate, + options?: MethodOptions + ): GaxiosPromise; + acceptSpokeUpdate( + params: Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + acceptSpokeUpdate( + params: Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + acceptSpokeUpdate( + params: Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate, + callback: BodyResponseCallback + ): void; + acceptSpokeUpdate( + callback: BodyResponseCallback + ): void; + acceptSpokeUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:acceptSpokeUpdate').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 Network Connectivity Center hub in the specified project. * @@ -3104,6 +3255,103 @@ export namespace networkconnectivity_v1 { } } + /** + * Rejects a proposal to update a Network Connectivity Center spoke in a 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. + */ + rejectSpokeUpdate( + params: Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate, + options: StreamMethodOptions + ): GaxiosPromise; + rejectSpokeUpdate( + params?: Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate, + options?: MethodOptions + ): GaxiosPromise; + rejectSpokeUpdate( + params: Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rejectSpokeUpdate( + params: Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rejectSpokeUpdate( + params: Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate, + callback: BodyResponseCallback + ): void; + rejectSpokeUpdate( + callback: BodyResponseCallback + ): void; + rejectSpokeUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:rejectSpokeUpdate').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. * @@ -3304,6 +3552,18 @@ export namespace networkconnectivity_v1 { */ requestBody?: Schema$AcceptHubSpokeRequest; } + export interface Params$Resource$Projects$Locations$Global$Hubs$Acceptspokeupdate + extends StandardParameters { + /** + * Required. The name of the hub to accept spoke update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AcceptSpokeUpdateRequest; + } export interface Params$Resource$Projects$Locations$Global$Hubs$Create extends StandardParameters { /** @@ -3466,6 +3726,18 @@ export namespace networkconnectivity_v1 { */ requestBody?: Schema$RejectHubSpokeRequest; } + export interface Params$Resource$Projects$Locations$Global$Hubs$Rejectspokeupdate + extends StandardParameters { + /** + * Required. The name of the hub to reject spoke update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RejectSpokeUpdateRequest; + } export interface Params$Resource$Projects$Locations$Global$Hubs$Setiampolicy extends StandardParameters { /** @@ -5246,7 +5518,7 @@ export namespace networkconnectivity_v1 { */ parent?: string; /** - * Required. Unique id for the policy-based route to create. + * Required. Unique id for the policy-based route to create. Provided by the client when the resource is created. The name must comply with https://google.aip.dev/122#resource-id-segments. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([a-z0-9-]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ policyBasedRouteId?: string; /** @@ -6695,7 +6967,7 @@ export namespace networkconnectivity_v1 { */ parent?: string; /** - * Required. Unique id of the Regional Endpoint to be created. + * Required. Unique id of the Regional Endpoint to be created. @pattern: ^[-a-z0-9](?:[-a-z0-9]{0,44\})[a-z0-9]$ */ regionalEndpointId?: string; /** diff --git a/src/apis/networkconnectivity/v1alpha1.ts b/src/apis/networkconnectivity/v1alpha1.ts index 027ecc21100..3359322fd55 100644 --- a/src/apis/networkconnectivity/v1alpha1.ts +++ b/src/apis/networkconnectivity/v1alpha1.ts @@ -451,7 +451,7 @@ export namespace networkconnectivity_v1alpha1 { */ 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\} + * Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. For example: /projects/{project\}/regions/{region\}/subnetworks/{subnet\} */ target?: string | null; } From 883bbb02f685c9674733b6a885130383e3646bab Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 091/144] feat(networkmanagement): update the API #### networkmanagement:v1beta1 The following keys were added: - resources.organizations.resources.locations.methods.get.description - resources.organizations.resources.locations.methods.get.flatPath - resources.organizations.resources.locations.methods.get.httpMethod - resources.organizations.resources.locations.methods.get.id - resources.organizations.resources.locations.methods.get.parameterOrder - resources.organizations.resources.locations.methods.get.parameters.name.description - resources.organizations.resources.locations.methods.get.parameters.name.location - resources.organizations.resources.locations.methods.get.parameters.name.pattern - resources.organizations.resources.locations.methods.get.parameters.name.required - resources.organizations.resources.locations.methods.get.parameters.name.type - resources.organizations.resources.locations.methods.get.path - resources.organizations.resources.locations.methods.get.response.$ref - resources.organizations.resources.locations.methods.get.scopes - resources.organizations.resources.locations.methods.list.description - resources.organizations.resources.locations.methods.list.flatPath - resources.organizations.resources.locations.methods.list.httpMethod - resources.organizations.resources.locations.methods.list.id - resources.organizations.resources.locations.methods.list.parameterOrder - resources.organizations.resources.locations.methods.list.parameters.filter.description - resources.organizations.resources.locations.methods.list.parameters.filter.location - resources.organizations.resources.locations.methods.list.parameters.filter.type - resources.organizations.resources.locations.methods.list.parameters.name.description - resources.organizations.resources.locations.methods.list.parameters.name.location - resources.organizations.resources.locations.methods.list.parameters.name.pattern - resources.organizations.resources.locations.methods.list.parameters.name.required - resources.organizations.resources.locations.methods.list.parameters.name.type - resources.organizations.resources.locations.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.methods.list.parameters.pageSize.format - resources.organizations.resources.locations.methods.list.parameters.pageSize.location - resources.organizations.resources.locations.methods.list.parameters.pageSize.type - resources.organizations.resources.locations.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.methods.list.parameters.pageToken.location - resources.organizations.resources.locations.methods.list.parameters.pageToken.type - resources.organizations.resources.locations.methods.list.path - resources.organizations.resources.locations.methods.list.response.$ref - resources.organizations.resources.locations.methods.list.scopes - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.flatPath - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.httpMethod - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.id - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.parameterOrder - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.parameters.name.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.parameters.name.location - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.parameters.name.pattern - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.parameters.name.required - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.parameters.name.type - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.path - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.request.$ref - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.response.$ref - resources.organizations.resources.locations.resources.global.resources.operations.methods.cancel.scopes - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.flatPath - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.httpMethod - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.id - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.parameterOrder - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.parameters.name.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.parameters.name.location - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.parameters.name.pattern - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.parameters.name.required - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.parameters.name.type - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.path - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.response.$ref - resources.organizations.resources.locations.resources.global.resources.operations.methods.delete.scopes - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.flatPath - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.httpMethod - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.id - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.parameterOrder - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.parameters.name.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.parameters.name.location - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.parameters.name.pattern - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.parameters.name.required - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.parameters.name.type - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.path - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.response.$ref - resources.organizations.resources.locations.resources.global.resources.operations.methods.get.scopes - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.flatPath - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.httpMethod - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.id - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameterOrder - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.filter.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.filter.location - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.filter.type - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.name.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.name.location - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.name.pattern - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.name.required - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.name.type - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.pageSize.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.pageSize.format - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.pageSize.location - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.pageSize.type - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.pageToken.description - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.pageToken.location - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.parameters.pageToken.type - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.path - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.response.$ref - resources.organizations.resources.locations.resources.global.resources.operations.methods.list.scopes - schemas.DirectVpcEgressConnectionInfo.description - schemas.DirectVpcEgressConnectionInfo.id - schemas.DirectVpcEgressConnectionInfo.properties.networkUri.description - schemas.DirectVpcEgressConnectionInfo.properties.networkUri.type - schemas.DirectVpcEgressConnectionInfo.properties.region.description - schemas.DirectVpcEgressConnectionInfo.properties.region.type - schemas.DirectVpcEgressConnectionInfo.properties.selectedIpAddress.description - schemas.DirectVpcEgressConnectionInfo.properties.selectedIpAddress.type - schemas.DirectVpcEgressConnectionInfo.properties.selectedIpRange.description - schemas.DirectVpcEgressConnectionInfo.properties.selectedIpRange.type - schemas.DirectVpcEgressConnectionInfo.properties.subnetworkUri.description - schemas.DirectVpcEgressConnectionInfo.properties.subnetworkUri.type - schemas.DirectVpcEgressConnectionInfo.type - schemas.ServerlessExternalConnectionInfo.description - schemas.ServerlessExternalConnectionInfo.id - schemas.ServerlessExternalConnectionInfo.properties.selectedIpAddress.description - schemas.ServerlessExternalConnectionInfo.properties.selectedIpAddress.type - schemas.ServerlessExternalConnectionInfo.type - schemas.Step.properties.directVpcEgressConnection.$ref - schemas.Step.properties.directVpcEgressConnection.description - schemas.Step.properties.serverlessExternalConnection.$ref - schemas.Step.properties.serverlessExternalConnection.description The following keys were changed: - resources.projects.resources.locations.resources.vpcFlowLogsConfigs.methods.create.description - resources.projects.resources.locations.resources.vpcFlowLogsConfigs.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.vpcFlowLogsConfigs.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.vpcFlowLogsConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.vpcFlowLogsConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.vpcFlowLogsConfigs.methods.patch.description - resources.projects.resources.locations.resources.vpcFlowLogsConfigs.methods.patch.parameters.name.description - schemas.AbortInfo.properties.cause.enum - schemas.AbortInfo.properties.cause.enumDeprecated - schemas.AbortInfo.properties.cause.enumDescriptions - schemas.DropInfo.properties.cause.enum - schemas.DropInfo.properties.cause.enumDescriptions - schemas.RedisClusterInfo.properties.networkUri.description - schemas.Step.properties.state.enum - schemas.Step.properties.state.enumDeprecated - schemas.Step.properties.state.enumDescriptions - schemas.VpcFlowLogsConfig.properties.name.description #### networkmanagement:v1 The following keys were added: - schemas.DirectVpcEgressConnectionInfo.description - schemas.DirectVpcEgressConnectionInfo.id - schemas.DirectVpcEgressConnectionInfo.properties.networkUri.description - schemas.DirectVpcEgressConnectionInfo.properties.networkUri.type - schemas.DirectVpcEgressConnectionInfo.properties.region.description - schemas.DirectVpcEgressConnectionInfo.properties.region.type - schemas.DirectVpcEgressConnectionInfo.properties.selectedIpAddress.description - schemas.DirectVpcEgressConnectionInfo.properties.selectedIpAddress.type - schemas.DirectVpcEgressConnectionInfo.properties.selectedIpRange.description - schemas.DirectVpcEgressConnectionInfo.properties.selectedIpRange.type - schemas.DirectVpcEgressConnectionInfo.properties.subnetworkUri.description - schemas.DirectVpcEgressConnectionInfo.properties.subnetworkUri.type - schemas.DirectVpcEgressConnectionInfo.type - schemas.ServerlessExternalConnectionInfo.description - schemas.ServerlessExternalConnectionInfo.id - schemas.ServerlessExternalConnectionInfo.properties.selectedIpAddress.description - schemas.ServerlessExternalConnectionInfo.properties.selectedIpAddress.type - schemas.ServerlessExternalConnectionInfo.type - schemas.Step.properties.directVpcEgressConnection.$ref - schemas.Step.properties.directVpcEgressConnection.description - schemas.Step.properties.serverlessExternalConnection.$ref - schemas.Step.properties.serverlessExternalConnection.description The following keys were changed: - schemas.AbortInfo.properties.cause.enum - schemas.AbortInfo.properties.cause.enumDeprecated - schemas.AbortInfo.properties.cause.enumDescriptions - schemas.DropInfo.properties.cause.enum - schemas.DropInfo.properties.cause.enumDescriptions - schemas.RedisClusterInfo.properties.networkUri.description - schemas.Step.properties.state.enum - schemas.Step.properties.state.enumDeprecated - schemas.Step.properties.state.enumDescriptions --- discovery/networkmanagement-v1.json | 65 ++- discovery/networkmanagement-v1beta1.json | 284 ++++++++- src/apis/networkmanagement/v1.ts | 44 +- src/apis/networkmanagement/v1beta1.ts | 710 ++++++++++++++++++++++- 4 files changed, 1077 insertions(+), 26 deletions(-) diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index bde78541a3d..361302c10e6 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -758,7 +758,7 @@ } } }, - "revision": "20250101", + "revision": "20250305", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -803,7 +803,8 @@ "SOURCE_FORWARDING_RULE_UNSUPPORTED", "NON_ROUTABLE_IP_ADDRESS", "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", - "UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG" + "UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG", + "NO_SERVERLESS_IP_RANGES" ], "enumDeprecated": [ false, @@ -841,6 +842,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -879,7 +881,8 @@ "Aborted because tests with a forwarding rule as a source are not supported.", "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", "Aborted due to an unknown issue in the Google-managed project.", - "Aborted due to an unsupported configuration of the Google-managed project." + "Aborted due to an unsupported configuration of the Google-managed project.", + "Aborted because the source endpoint is a Cloud Run revision with direct VPC access enabled, but there are no reserved serverless IP ranges." ], "type": "string" }, @@ -1259,6 +1262,33 @@ }, "type": "object" }, + "DirectVpcEgressConnectionInfo": { + "description": "For display only. Metadata associated with a serverless direct VPC egress connection.", + "id": "DirectVpcEgressConnectionInfo", + "properties": { + "networkUri": { + "description": "URI of direct access network.", + "type": "string" + }, + "region": { + "description": "Region in which the Direct VPC egress is deployed.", + "type": "string" + }, + "selectedIpAddress": { + "description": "Selected starting IP address, from the selected IP range.", + "type": "string" + }, + "selectedIpRange": { + "description": "Selected IP range.", + "type": "string" + }, + "subnetworkUri": { + "description": "URI of direct access subnetwork.", + "type": "string" + } + }, + "type": "object" + }, "DropInfo": { "description": "Details of the final state \"drop\" and associated resource.", "id": "DropInfo", @@ -1291,6 +1321,7 @@ "FORWARDING_RULE_MISMATCH", "FORWARDING_RULE_NO_INSTANCES", "FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK", + "INGRESS_FIREWALL_TAGS_UNSUPPORTED_BY_DIRECT_VPC_EGRESS", "INSTANCE_NOT_RUNNING", "GKE_CLUSTER_NOT_RUNNING", "CLOUD_SQL_INSTANCE_NOT_RUNNING", @@ -1377,6 +1408,7 @@ "Forwarding rule's protocol and ports do not match the packet header.", "Forwarding rule does not have backends configured.", "Firewalls block the health check probes to the backends and cause the backends to be unavailable for traffic from the load balancer. For more details, see [Health check firewall rules](https://cloud.google.com/load-balancing/docs/health-checks#firewall_rules).", + "Matching ingress firewall rules by network tags for packets sent via serverless VPC direct egress is unsupported. Behavior is undefined. https://cloud.google.com/run/docs/configuring/vpc-direct-vpc#limitations", "Packet is sent from or to a Compute Engine instance that is not in a running state.", "Packet sent from or to a GKE cluster that is not in running state.", "Packet sent from or to a Cloud SQL instance that is not in running state.", @@ -2672,7 +2704,7 @@ "type": "string" }, "networkUri": { - "description": "URI of a Redis Cluster network in format \"projects/{project_id}/global/networks/{network_id}\".", + "description": "URI of the network containing the Redis Cluster endpoints in format \"projects/{project_id}/global/networks/{network_id}\".", "type": "string" }, "secondaryEndpointIpAddress": { @@ -2904,6 +2936,17 @@ }, "type": "object" }, + "ServerlessExternalConnectionInfo": { + "description": "For display only. Metadata associated with a serverless public connection.", + "id": "ServerlessExternalConnectionInfo", + "properties": { + "selectedIpAddress": { + "description": "Selected starting IP address, from the Google dynamic address pool.", + "type": "string" + } + }, + "type": "object" + }, "ServerlessNegInfo": { "description": "For display only. Metadata associated with the serverless network endpoint group backend.", "id": "ServerlessNegInfo", @@ -2994,6 +3037,10 @@ "description": "A description of the step. Usually this is a summary of the state.", "type": "string" }, + "directVpcEgressConnection": { + "$ref": "DirectVpcEgressConnectionInfo", + "description": "Display information of a serverless direct VPC egress connection." + }, "drop": { "$ref": "DropInfo", "description": "Display information of the final state \"drop\" and reason." @@ -3063,6 +3110,10 @@ "$ref": "RouteInfo", "description": "Display information of a Compute Engine route." }, + "serverlessExternalConnection": { + "$ref": "ServerlessExternalConnectionInfo", + "description": "Display information of a serverless public (external) connection." + }, "serverlessNeg": { "$ref": "ServerlessNegInfo", "description": "Display information of a Serverless network endpoint group backend. Used only for return traces." @@ -3097,6 +3148,8 @@ "ARRIVE_AT_VPN_GATEWAY", "ARRIVE_AT_VPN_TUNNEL", "ARRIVE_AT_VPC_CONNECTOR", + "DIRECT_VPC_EGRESS_CONNECTION", + "SERVERLESS_EXTERNAL_CONNECTION", "NAT", "PROXY_CONNECTION", "DELIVER", @@ -3139,6 +3192,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -3169,6 +3224,8 @@ "Forwarding state: arriving at a Cloud VPN gateway.", "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at a VPC connector.", + "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", + "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", "Transition state: packet header translated.", "Transition state: original connection is terminated and a new proxied connection is initiated.", "Final state: packet could be delivered.", diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index 394df0843e6..4f875d282b1 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -105,6 +105,209 @@ }, "protocol": "rest", "resources": { + "organizations": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "networkmanagement.organizations.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations", + "httpMethod": "GET", + "id": "networkmanagement.organizations.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": "^organizations/[^/]+$", + "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": "v1beta1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "global": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/organizations/{organizationsId}/locations/global/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "networkmanagement.organizations.locations.global.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/global/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+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": "v1beta1/organizations/{organizationsId}/locations/global/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "networkmanagement.organizations.locations.global.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/global/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+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": "v1beta1/organizations/{organizationsId}/locations/global/operations/{operationsId}", + "httpMethod": "GET", + "id": "networkmanagement.organizations.locations.global.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/global/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+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": "v1beta1/organizations/{organizationsId}/locations/global/operations", + "httpMethod": "GET", + "id": "networkmanagement.organizations.locations.global.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": "^organizations/[^/]+/locations/global$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, "projects": { "resources": { "locations": { @@ -589,7 +792,7 @@ "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 considered 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 ", + "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 considered 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", @@ -598,7 +801,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource of the VPC Flow Logs configuration to create: `projects/{project_id}/locations/global`", + "description": "Required. The parent resource of the VPC Flow Logs configuration to create: `projects/{project_id}/locations/global` `organizations/{organization_id}/locations/global`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -631,7 +834,7 @@ ], "parameters": { "name": { - "description": "Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}`", + "description": "Required. `VpcFlowLogsConfig` resource name using one of the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}` `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", "required": true, @@ -656,7 +859,7 @@ ], "parameters": { "name": { - "description": "Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}`", + "description": "Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}` `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", "required": true, @@ -702,7 +905,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id}/locations/global`", + "description": "Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id}/locations/global` `organizations/{organization_id}/locations/global`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -718,7 +921,7 @@ ] }, "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. Updating a configuration with state=DISABLED will fail. 2. The following fields are not considered 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 ", + "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. Updating a configuration with state=DISABLED will fail 2. The following fields are not considered 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", @@ -727,7 +930,7 @@ ], "parameters": { "name": { - "description": "Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", + "description": "Identifier. Unique name of the configuration using one of the forms: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", "required": true, @@ -758,7 +961,7 @@ } } }, - "revision": "20250108", + "revision": "20250305", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -803,7 +1006,8 @@ "SOURCE_FORWARDING_RULE_UNSUPPORTED", "NON_ROUTABLE_IP_ADDRESS", "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", - "UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG" + "UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG", + "NO_SERVERLESS_IP_RANGES" ], "enumDeprecated": [ false, @@ -841,6 +1045,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -879,7 +1084,8 @@ "Aborted because tests with a forwarding rule as a source are not supported.", "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", "Aborted due to an unknown issue in the Google-managed project.", - "Aborted due to an unsupported configuration of the Google-managed project." + "Aborted due to an unsupported configuration of the Google-managed project.", + "Aborted because the source endpoint is a Cloud Run revision with direct VPC access enabled, but there are no reserved serverless IP ranges." ], "type": "string" }, @@ -1259,6 +1465,33 @@ }, "type": "object" }, + "DirectVpcEgressConnectionInfo": { + "description": "For display only. Metadata associated with a serverless direct VPC egress connection.", + "id": "DirectVpcEgressConnectionInfo", + "properties": { + "networkUri": { + "description": "URI of direct access network.", + "type": "string" + }, + "region": { + "description": "Region in which the Direct VPC egress is deployed.", + "type": "string" + }, + "selectedIpAddress": { + "description": "Selected starting IP address, from the selected IP range.", + "type": "string" + }, + "selectedIpRange": { + "description": "Selected IP range.", + "type": "string" + }, + "subnetworkUri": { + "description": "URI of direct access subnetwork.", + "type": "string" + } + }, + "type": "object" + }, "DropInfo": { "description": "Details of the final state \"drop\" and associated resource.", "id": "DropInfo", @@ -1291,6 +1524,7 @@ "FORWARDING_RULE_MISMATCH", "FORWARDING_RULE_NO_INSTANCES", "FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK", + "INGRESS_FIREWALL_TAGS_UNSUPPORTED_BY_DIRECT_VPC_EGRESS", "INSTANCE_NOT_RUNNING", "GKE_CLUSTER_NOT_RUNNING", "CLOUD_SQL_INSTANCE_NOT_RUNNING", @@ -1377,6 +1611,7 @@ "Forwarding rule's protocol and ports do not match the packet header.", "Forwarding rule does not have backends configured.", "Firewalls block the health check probes to the backends and cause the backends to be unavailable for traffic from the load balancer. For more details, see [Health check firewall rules](https://cloud.google.com/load-balancing/docs/health-checks#firewall_rules).", + "Matching ingress firewall rules by network tags for packets sent via serverless VPC direct egress is unsupported. Behavior is undefined. https://cloud.google.com/run/docs/configuring/vpc-direct-vpc#limitations", "Packet is sent from or to a Compute Engine instance that is not in a running state.", "Packet sent from or to a GKE cluster that is not in running state.", "Packet sent from or to a Cloud SQL instance that is not in running state.", @@ -2676,7 +2911,7 @@ "type": "string" }, "networkUri": { - "description": "URI of a Redis Cluster network in format \"projects/{project_id}/global/networks/{network_id}\".", + "description": "URI of the network containing the Redis Cluster endpoints in format \"projects/{project_id}/global/networks/{network_id}\".", "type": "string" }, "secondaryEndpointIpAddress": { @@ -2908,6 +3143,17 @@ }, "type": "object" }, + "ServerlessExternalConnectionInfo": { + "description": "For display only. Metadata associated with a serverless public connection.", + "id": "ServerlessExternalConnectionInfo", + "properties": { + "selectedIpAddress": { + "description": "Selected starting IP address, from the Google dynamic address pool.", + "type": "string" + } + }, + "type": "object" + }, "ServerlessNegInfo": { "description": "For display only. Metadata associated with the serverless network endpoint group backend.", "id": "ServerlessNegInfo", @@ -2998,6 +3244,10 @@ "description": "A description of the step. Usually this is a summary of the state.", "type": "string" }, + "directVpcEgressConnection": { + "$ref": "DirectVpcEgressConnectionInfo", + "description": "Display information of a serverless direct VPC egress connection." + }, "drop": { "$ref": "DropInfo", "description": "Display information of the final state \"drop\" and reason." @@ -3067,6 +3317,10 @@ "$ref": "RouteInfo", "description": "Display information of a Compute Engine route." }, + "serverlessExternalConnection": { + "$ref": "ServerlessExternalConnectionInfo", + "description": "Display information of a serverless public (external) connection." + }, "serverlessNeg": { "$ref": "ServerlessNegInfo", "description": "Display information of a Serverless network endpoint group backend. Used only for return traces." @@ -3101,6 +3355,8 @@ "ARRIVE_AT_VPN_GATEWAY", "ARRIVE_AT_VPN_TUNNEL", "ARRIVE_AT_VPC_CONNECTOR", + "DIRECT_VPC_EGRESS_CONNECTION", + "SERVERLESS_EXTERNAL_CONNECTION", "NAT", "PROXY_CONNECTION", "DELIVER", @@ -3143,6 +3399,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -3173,6 +3431,8 @@ "Forwarding state: arriving at a Cloud VPN gateway.", "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at a VPC connector.", + "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", + "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", "Transition state: packet header translated.", "Transition state: original connection is terminated and a new proxied connection is initiated.", "Final state: packet could be delivered.", @@ -3363,7 +3623,7 @@ "type": "array" }, "name": { - "description": "Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", + "description": "Identifier. Unique name of the configuration using one of the forms: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", "type": "string" }, "state": { diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index 1bc14fe5d98..c3c9290ea9b 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -401,6 +401,31 @@ export namespace networkmanagement_v1 { */ target?: string | null; } + /** + * For display only. Metadata associated with a serverless direct VPC egress connection. + */ + export interface Schema$DirectVpcEgressConnectionInfo { + /** + * URI of direct access network. + */ + networkUri?: string | null; + /** + * Region in which the Direct VPC egress is deployed. + */ + region?: string | null; + /** + * Selected starting IP address, from the selected IP range. + */ + selectedIpAddress?: string | null; + /** + * Selected IP range. + */ + selectedIpRange?: string | null; + /** + * URI of direct access subnetwork. + */ + subnetworkUri?: string | null; + } /** * Details of the final state "drop" and associated resource. */ @@ -1259,7 +1284,7 @@ export namespace networkmanagement_v1 { */ location?: string | null; /** - * URI of a Redis Cluster network in format "projects/{project_id\}/global/networks/{network_id\}". + * URI of the network containing the Redis Cluster endpoints in format "projects/{project_id\}/global/networks/{network_id\}". */ networkUri?: string | null; /** @@ -1405,6 +1430,15 @@ export namespace networkmanagement_v1 { */ uri?: string | null; } + /** + * For display only. Metadata associated with a serverless public connection. + */ + export interface Schema$ServerlessExternalConnectionInfo { + /** + * Selected starting IP address, from the Google dynamic address pool. + */ + selectedIpAddress?: string | null; + } /** * For display only. Metadata associated with the serverless network endpoint group backend. */ @@ -1480,6 +1514,10 @@ export namespace networkmanagement_v1 { * A description of the step. Usually this is a summary of the state. */ description?: string | null; + /** + * Display information of a serverless direct VPC egress connection. + */ + directVpcEgressConnection?: Schema$DirectVpcEgressConnectionInfo; /** * Display information of the final state "drop" and reason. */ @@ -1548,6 +1586,10 @@ export namespace networkmanagement_v1 { * Display information of a Compute Engine route. */ route?: Schema$RouteInfo; + /** + * Display information of a serverless public (external) connection. + */ + serverlessExternalConnection?: Schema$ServerlessExternalConnectionInfo; /** * Display information of a Serverless network endpoint group backend. Used only for return traces. */ diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index 0198305274a..60815db33f5 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -112,6 +112,7 @@ export namespace networkmanagement_v1beta1 { */ export class Networkmanagement { context: APIRequestContext; + organizations: Resource$Organizations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace networkmanagement_v1beta1 { google, }; + this.organizations = new Resource$Organizations(this.context); this.projects = new Resource$Projects(this.context); } } @@ -401,6 +403,31 @@ export namespace networkmanagement_v1beta1 { */ target?: string | null; } + /** + * For display only. Metadata associated with a serverless direct VPC egress connection. + */ + export interface Schema$DirectVpcEgressConnectionInfo { + /** + * URI of direct access network. + */ + networkUri?: string | null; + /** + * Region in which the Direct VPC egress is deployed. + */ + region?: string | null; + /** + * Selected starting IP address, from the selected IP range. + */ + selectedIpAddress?: string | null; + /** + * Selected IP range. + */ + selectedIpRange?: string | null; + /** + * URI of direct access subnetwork. + */ + subnetworkUri?: string | null; + } /** * Details of the final state "drop" and associated resource. */ @@ -1263,7 +1290,7 @@ export namespace networkmanagement_v1beta1 { */ location?: string | null; /** - * URI of a Redis Cluster network in format "projects/{project_id\}/global/networks/{network_id\}". + * URI of the network containing the Redis Cluster endpoints in format "projects/{project_id\}/global/networks/{network_id\}". */ networkUri?: string | null; /** @@ -1409,6 +1436,15 @@ export namespace networkmanagement_v1beta1 { */ uri?: string | null; } + /** + * For display only. Metadata associated with a serverless public connection. + */ + export interface Schema$ServerlessExternalConnectionInfo { + /** + * Selected starting IP address, from the Google dynamic address pool. + */ + selectedIpAddress?: string | null; + } /** * For display only. Metadata associated with the serverless network endpoint group backend. */ @@ -1484,6 +1520,10 @@ export namespace networkmanagement_v1beta1 { * A description of the step. Usually this is a summary of the state. */ description?: string | null; + /** + * Display information of a serverless direct VPC egress connection. + */ + directVpcEgressConnection?: Schema$DirectVpcEgressConnectionInfo; /** * Display information of the final state "drop" and reason. */ @@ -1552,6 +1592,10 @@ export namespace networkmanagement_v1beta1 { * Display information of a Compute Engine route. */ route?: Schema$RouteInfo; + /** + * Display information of a serverless public (external) connection. + */ + serverlessExternalConnection?: Schema$ServerlessExternalConnectionInfo; /** * Display information of a Serverless network endpoint group backend. Used only for return traces. */ @@ -1679,7 +1723,7 @@ export namespace networkmanagement_v1beta1 { */ metadataFields?: string[] | null; /** - * Identifier. Unique name of the configuration using the form: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + * Identifier. Unique name of the configuration using one of the forms: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` */ name?: string | null; /** @@ -1770,6 +1814,654 @@ export namespace networkmanagement_v1beta1 { uri?: string | null; } + export class Resource$Organizations { + context: APIRequestContext; + locations: Resource$Organizations$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Organizations$Locations(this.context); + } + } + + export class Resource$Organizations$Locations { + context: APIRequestContext; + global: Resource$Organizations$Locations$Global; + constructor(context: APIRequestContext) { + this.context = context; + this.global = new Resource$Organizations$Locations$Global(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$Organizations$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Organizations$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$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 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$Organizations$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$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/{+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$Organizations$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Organizations$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$Organizations$Locations$Global { + context: APIRequestContext; + operations: Resource$Organizations$Locations$Global$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Organizations$Locations$Global$Operations( + this.context + ); + } + } + + export class Resource$Organizations$Locations$Global$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$Organizations$Locations$Global$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Organizations$Locations$Global$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Organizations$Locations$Global$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Locations$Global$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Locations$Global$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Operations$Cancel; + 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}: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$Organizations$Locations$Global$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Organizations$Locations$Global$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Global$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Global$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Global$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Operations$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 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$Organizations$Locations$Global$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Organizations$Locations$Global$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Global$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Global$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Global$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Operations$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 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$Organizations$Locations$Global$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Global$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Global$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Global$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Global$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Global$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Global$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Global$Operations$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/{+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$Organizations$Locations$Global$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$Organizations$Locations$Global$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Global$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Global$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 { context: APIRequestContext; locations: Resource$Projects$Locations; @@ -3371,7 +4063,7 @@ export namespace networkmanagement_v1beta1 { } /** - * 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 considered 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 + * 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 considered 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`. @@ -3737,7 +4429,7 @@ export namespace networkmanagement_v1beta1 { } /** - * 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. Updating a configuration with state=DISABLED will fail. 2. The following fields are not considered 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 + * 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. Updating a configuration with state=DISABLED will fail 2. The following fields are not considered 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`. @@ -3827,7 +4519,7 @@ export namespace networkmanagement_v1beta1 { 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` + * Required. The parent resource of the VPC Flow Logs configuration to create: `projects/{project_id\}/locations/global` `organizations/{organization_id\}/locations/global` */ parent?: string; /** @@ -3843,14 +4535,14 @@ export namespace networkmanagement_v1beta1 { 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\}` + * Required. `VpcFlowLogsConfig` resource name using one of the form: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config\}` `organizations/{organization_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\}` + * Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config\}` `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config\}` */ name?: string; } @@ -3873,14 +4565,14 @@ export namespace networkmanagement_v1beta1 { */ pageToken?: string; /** - * Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id\}/locations/global` + * Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id\}/locations/global` `organizations/{organization_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\}` + * Identifier. Unique name of the configuration using one of the forms: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` `organizations/{organization_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` */ name?: string; /** From b2fda4229868fc46fd96f4fbec903b60cdd84403 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 092/144] feat(networksecurity): update the API #### networksecurity:v1beta1 The following keys were added: - resources.organizations.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.description - resources.organizations.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.location - resources.organizations.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.flatPath - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.httpMethod - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.id - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameterOrder - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameters.backendAuthenticationConfigId.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameters.backendAuthenticationConfigId.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameters.backendAuthenticationConfigId.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.path - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.request.$ref - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.response.$ref - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.create.scopes - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.flatPath - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.httpMethod - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.id - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameterOrder - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.path - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.response.$ref - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.delete.scopes - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.flatPath - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.httpMethod - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.id - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.parameterOrder - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.path - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.response.$ref - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.get.scopes - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.flatPath - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.httpMethod - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.id - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameterOrder - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.path - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.response.$ref - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.list.scopes - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.flatPath - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.httpMethod - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.id - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameterOrder - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.path - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.request.$ref - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.response.$ref - resources.projects.resources.locations.resources.backendAuthenticationConfigs.methods.patch.scopes - resources.projects.resources.locations.resources.serverTlsPolicies.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.serverTlsPolicies.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.serverTlsPolicies.methods.list.parameters.returnPartialSuccess.type - schemas.AntivirusOverride.description - schemas.AntivirusOverride.id - schemas.AntivirusOverride.properties.action.description - schemas.AntivirusOverride.properties.action.enum - schemas.AntivirusOverride.properties.action.enumDescriptions - schemas.AntivirusOverride.properties.action.type - schemas.AntivirusOverride.properties.protocol.description - schemas.AntivirusOverride.properties.protocol.enum - schemas.AntivirusOverride.properties.protocol.enumDescriptions - schemas.AntivirusOverride.properties.protocol.type - schemas.AntivirusOverride.type - schemas.BackendAuthenticationConfig.description - schemas.BackendAuthenticationConfig.id - schemas.BackendAuthenticationConfig.properties.clientCertificate.description - schemas.BackendAuthenticationConfig.properties.clientCertificate.type - schemas.BackendAuthenticationConfig.properties.createTime.description - schemas.BackendAuthenticationConfig.properties.createTime.format - schemas.BackendAuthenticationConfig.properties.createTime.readOnly - schemas.BackendAuthenticationConfig.properties.createTime.type - schemas.BackendAuthenticationConfig.properties.description.description - schemas.BackendAuthenticationConfig.properties.description.type - schemas.BackendAuthenticationConfig.properties.etag.description - schemas.BackendAuthenticationConfig.properties.etag.readOnly - schemas.BackendAuthenticationConfig.properties.etag.type - schemas.BackendAuthenticationConfig.properties.labels.additionalProperties.type - schemas.BackendAuthenticationConfig.properties.labels.description - schemas.BackendAuthenticationConfig.properties.labels.type - schemas.BackendAuthenticationConfig.properties.name.description - schemas.BackendAuthenticationConfig.properties.name.type - schemas.BackendAuthenticationConfig.properties.trustConfig.description - schemas.BackendAuthenticationConfig.properties.trustConfig.type - schemas.BackendAuthenticationConfig.properties.updateTime.description - schemas.BackendAuthenticationConfig.properties.updateTime.format - schemas.BackendAuthenticationConfig.properties.updateTime.readOnly - schemas.BackendAuthenticationConfig.properties.updateTime.type - schemas.BackendAuthenticationConfig.properties.wellKnownRoots.description - schemas.BackendAuthenticationConfig.properties.wellKnownRoots.enum - schemas.BackendAuthenticationConfig.properties.wellKnownRoots.enumDescriptions - schemas.BackendAuthenticationConfig.properties.wellKnownRoots.type - schemas.BackendAuthenticationConfig.type - schemas.FirewallEndpoint.properties.satisfiesPzi.description - schemas.FirewallEndpoint.properties.satisfiesPzi.readOnly - schemas.FirewallEndpoint.properties.satisfiesPzi.type - schemas.FirewallEndpoint.properties.satisfiesPzs.description - schemas.FirewallEndpoint.properties.satisfiesPzs.readOnly - schemas.FirewallEndpoint.properties.satisfiesPzs.type - schemas.InterceptDeploymentGroup.properties.locations.description - schemas.InterceptDeploymentGroup.properties.locations.items.$ref - schemas.InterceptDeploymentGroup.properties.locations.readOnly - schemas.InterceptDeploymentGroup.properties.locations.type - schemas.InterceptDeploymentGroup.properties.nestedDeployments.deprecated - schemas.InterceptDeploymentGroup.properties.nestedDeployments.description - schemas.InterceptDeploymentGroup.properties.nestedDeployments.items.$ref - schemas.InterceptDeploymentGroup.properties.nestedDeployments.readOnly - schemas.InterceptDeploymentGroup.properties.nestedDeployments.type - schemas.InterceptDeploymentGroupDeployment.description - schemas.InterceptDeploymentGroupDeployment.id - schemas.InterceptDeploymentGroupDeployment.properties.name.description - schemas.InterceptDeploymentGroupDeployment.properties.name.readOnly - schemas.InterceptDeploymentGroupDeployment.properties.name.type - schemas.InterceptDeploymentGroupDeployment.properties.state.description - schemas.InterceptDeploymentGroupDeployment.properties.state.enum - schemas.InterceptDeploymentGroupDeployment.properties.state.enumDescriptions - schemas.InterceptDeploymentGroupDeployment.properties.state.readOnly - schemas.InterceptDeploymentGroupDeployment.properties.state.type - schemas.InterceptDeploymentGroupDeployment.type - schemas.InterceptEndpointGroup.properties.connectedDeploymentGroup.$ref - schemas.InterceptEndpointGroup.properties.connectedDeploymentGroup.description - schemas.InterceptEndpointGroup.properties.connectedDeploymentGroup.readOnly - schemas.InterceptEndpointGroupAssociation.properties.locations.description - schemas.InterceptEndpointGroupAssociation.properties.locations.items.$ref - schemas.InterceptEndpointGroupAssociation.properties.locations.readOnly - schemas.InterceptEndpointGroupAssociation.properties.locations.type - schemas.InterceptEndpointGroupAssociation.properties.locationsDetails.deprecated - schemas.InterceptEndpointGroupConnectedDeploymentGroup.description - schemas.InterceptEndpointGroupConnectedDeploymentGroup.id - schemas.InterceptEndpointGroupConnectedDeploymentGroup.properties.locations.description - schemas.InterceptEndpointGroupConnectedDeploymentGroup.properties.locations.items.$ref - schemas.InterceptEndpointGroupConnectedDeploymentGroup.properties.locations.readOnly - schemas.InterceptEndpointGroupConnectedDeploymentGroup.properties.locations.type - schemas.InterceptEndpointGroupConnectedDeploymentGroup.properties.name.description - schemas.InterceptEndpointGroupConnectedDeploymentGroup.properties.name.readOnly - schemas.InterceptEndpointGroupConnectedDeploymentGroup.properties.name.type - schemas.InterceptEndpointGroupConnectedDeploymentGroup.type - schemas.InterceptLocation.description - schemas.InterceptLocation.id - schemas.InterceptLocation.properties.location.description - schemas.InterceptLocation.properties.location.readOnly - schemas.InterceptLocation.properties.location.type - schemas.InterceptLocation.properties.state.description - schemas.InterceptLocation.properties.state.enum - schemas.InterceptLocation.properties.state.enumDescriptions - schemas.InterceptLocation.properties.state.readOnly - schemas.InterceptLocation.properties.state.type - schemas.InterceptLocation.type - schemas.ListAddressGroupsResponse.properties.unreachable.description - schemas.ListAddressGroupsResponse.properties.unreachable.items.type - schemas.ListAddressGroupsResponse.properties.unreachable.type - schemas.ListBackendAuthenticationConfigsResponse.description - schemas.ListBackendAuthenticationConfigsResponse.id - schemas.ListBackendAuthenticationConfigsResponse.properties.backendAuthenticationConfigs.description - schemas.ListBackendAuthenticationConfigsResponse.properties.backendAuthenticationConfigs.items.$ref - schemas.ListBackendAuthenticationConfigsResponse.properties.backendAuthenticationConfigs.type - schemas.ListBackendAuthenticationConfigsResponse.properties.nextPageToken.description - schemas.ListBackendAuthenticationConfigsResponse.properties.nextPageToken.type - schemas.ListBackendAuthenticationConfigsResponse.properties.unreachable.description - schemas.ListBackendAuthenticationConfigsResponse.properties.unreachable.items.type - schemas.ListBackendAuthenticationConfigsResponse.properties.unreachable.type - schemas.ListBackendAuthenticationConfigsResponse.type - schemas.ListServerTlsPoliciesResponse.properties.unreachable.description - schemas.ListServerTlsPoliciesResponse.properties.unreachable.items.type - schemas.ListServerTlsPoliciesResponse.properties.unreachable.type - schemas.MirroringDeployment.properties.description.description - schemas.MirroringDeployment.properties.description.type - schemas.MirroringDeploymentGroup.properties.description.description - schemas.MirroringDeploymentGroup.properties.description.type - schemas.MirroringDeploymentGroup.properties.locations.description - schemas.MirroringDeploymentGroup.properties.locations.items.$ref - schemas.MirroringDeploymentGroup.properties.locations.readOnly - schemas.MirroringDeploymentGroup.properties.locations.type - schemas.MirroringDeploymentGroup.properties.nestedDeployments.deprecated - schemas.MirroringDeploymentGroup.properties.nestedDeployments.description - schemas.MirroringDeploymentGroup.properties.nestedDeployments.items.$ref - schemas.MirroringDeploymentGroup.properties.nestedDeployments.readOnly - schemas.MirroringDeploymentGroup.properties.nestedDeployments.type - schemas.MirroringDeploymentGroupDeployment.description - schemas.MirroringDeploymentGroupDeployment.id - schemas.MirroringDeploymentGroupDeployment.properties.name.description - schemas.MirroringDeploymentGroupDeployment.properties.name.readOnly - schemas.MirroringDeploymentGroupDeployment.properties.name.type - schemas.MirroringDeploymentGroupDeployment.properties.state.description - schemas.MirroringDeploymentGroupDeployment.properties.state.enum - schemas.MirroringDeploymentGroupDeployment.properties.state.enumDescriptions - schemas.MirroringDeploymentGroupDeployment.properties.state.readOnly - schemas.MirroringDeploymentGroupDeployment.properties.state.type - schemas.MirroringDeploymentGroupDeployment.type - schemas.MirroringEndpointGroup.properties.connectedDeploymentGroups.description - schemas.MirroringEndpointGroup.properties.connectedDeploymentGroups.items.$ref - schemas.MirroringEndpointGroup.properties.connectedDeploymentGroups.readOnly - schemas.MirroringEndpointGroup.properties.connectedDeploymentGroups.type - schemas.MirroringEndpointGroup.properties.description.description - schemas.MirroringEndpointGroup.properties.description.type - schemas.MirroringEndpointGroupAssociation.properties.locations.description - schemas.MirroringEndpointGroupAssociation.properties.locations.items.$ref - schemas.MirroringEndpointGroupAssociation.properties.locations.readOnly - schemas.MirroringEndpointGroupAssociation.properties.locations.type - schemas.MirroringEndpointGroupAssociation.properties.locationsDetails.deprecated - schemas.MirroringEndpointGroupConnectedDeploymentGroup.description - schemas.MirroringEndpointGroupConnectedDeploymentGroup.id - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.locations.description - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.locations.items.$ref - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.locations.readOnly - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.locations.type - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.name.description - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.name.readOnly - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.name.type - schemas.MirroringEndpointGroupConnectedDeploymentGroup.type - schemas.MirroringLocation.description - schemas.MirroringLocation.id - schemas.MirroringLocation.properties.location.description - schemas.MirroringLocation.properties.location.readOnly - schemas.MirroringLocation.properties.location.type - schemas.MirroringLocation.properties.state.description - schemas.MirroringLocation.properties.state.enum - schemas.MirroringLocation.properties.state.enumDescriptions - schemas.MirroringLocation.properties.state.readOnly - schemas.MirroringLocation.properties.state.type - schemas.MirroringLocation.type - schemas.SecurityProfileGroup.properties.dataPathId.description - schemas.SecurityProfileGroup.properties.dataPathId.format - schemas.SecurityProfileGroup.properties.dataPathId.readOnly - schemas.SecurityProfileGroup.properties.dataPathId.type - schemas.ThreatPreventionProfile.properties.antivirusOverrides.description - schemas.ThreatPreventionProfile.properties.antivirusOverrides.items.$ref - schemas.ThreatPreventionProfile.properties.antivirusOverrides.type The following keys were changed: - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.create.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.create.parameters.interceptDeploymentGroupId.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.delete.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.get.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.get.parameters.name.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.list.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.patch.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.interceptDeploymentGroups.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.interceptDeployments.methods.create.description - resources.projects.resources.locations.resources.interceptDeployments.methods.create.parameters.interceptDeploymentId.description - resources.projects.resources.locations.resources.interceptDeployments.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.interceptDeployments.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.interceptDeployments.methods.delete.description - resources.projects.resources.locations.resources.interceptDeployments.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.interceptDeployments.methods.get.description - resources.projects.resources.locations.resources.interceptDeployments.methods.get.parameters.name.description - resources.projects.resources.locations.resources.interceptDeployments.methods.list.description - resources.projects.resources.locations.resources.interceptDeployments.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.interceptDeployments.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.interceptDeployments.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.interceptDeployments.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.interceptDeployments.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.interceptDeployments.methods.patch.description - resources.projects.resources.locations.resources.interceptDeployments.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.interceptDeployments.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.interceptDeployments.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.create.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.create.parameters.interceptEndpointGroupAssociationId.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.delete.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.get.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.list.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.patch.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.interceptEndpointGroupAssociations.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.create.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.create.parameters.interceptEndpointGroupId.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.delete.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.get.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.get.parameters.name.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.list.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.patch.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.interceptEndpointGroups.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.mirroringDeploymentGroupId.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.mirroringDeploymentId.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.mirroringEndpointGroupAssociationId.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.mirroringEndpointGroupId.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.updateMask.description - schemas.AuthzPolicyAuthzRuleFromRequestSource.properties.principals.description - schemas.CustomInterceptProfile.description - schemas.CustomInterceptProfile.properties.interceptEndpointGroup.description - schemas.CustomMirroringProfile.description - schemas.CustomMirroringProfile.properties.mirroringEndpointGroup.description - schemas.InterceptDeployment.description - schemas.InterceptDeployment.properties.createTime.description - schemas.InterceptDeployment.properties.forwardingRule.description - schemas.InterceptDeployment.properties.interceptDeploymentGroup.description - schemas.InterceptDeployment.properties.labels.description - schemas.InterceptDeployment.properties.name.description - schemas.InterceptDeployment.properties.reconciling.description - schemas.InterceptDeployment.properties.state.description - schemas.InterceptDeployment.properties.state.enumDescriptions - schemas.InterceptDeployment.properties.updateTime.description - schemas.InterceptDeploymentGroup.description - schemas.InterceptDeploymentGroup.properties.connectedEndpointGroups.description - schemas.InterceptDeploymentGroup.properties.createTime.description - schemas.InterceptDeploymentGroup.properties.labels.description - schemas.InterceptDeploymentGroup.properties.name.description - schemas.InterceptDeploymentGroup.properties.network.description - schemas.InterceptDeploymentGroup.properties.reconciling.description - schemas.InterceptDeploymentGroup.properties.state.description - schemas.InterceptDeploymentGroup.properties.state.enumDescriptions - schemas.InterceptDeploymentGroup.properties.updateTime.description - schemas.InterceptDeploymentGroupConnectedEndpointGroup.properties.name.description - schemas.InterceptEndpointGroup.description - schemas.InterceptEndpointGroup.properties.associations.description - schemas.InterceptEndpointGroup.properties.createTime.description - schemas.InterceptEndpointGroup.properties.interceptDeploymentGroup.description - schemas.InterceptEndpointGroup.properties.labels.description - schemas.InterceptEndpointGroup.properties.name.description - schemas.InterceptEndpointGroup.properties.reconciling.description - schemas.InterceptEndpointGroup.properties.state.description - schemas.InterceptEndpointGroup.properties.state.enumDescriptions - schemas.InterceptEndpointGroup.properties.updateTime.description - schemas.InterceptEndpointGroupAssociation.description - schemas.InterceptEndpointGroupAssociation.properties.createTime.description - schemas.InterceptEndpointGroupAssociation.properties.interceptEndpointGroup.description - schemas.InterceptEndpointGroupAssociation.properties.labels.description - schemas.InterceptEndpointGroupAssociation.properties.locationsDetails.description - schemas.InterceptEndpointGroupAssociation.properties.name.description - schemas.InterceptEndpointGroupAssociation.properties.network.description - schemas.InterceptEndpointGroupAssociation.properties.reconciling.description - schemas.InterceptEndpointGroupAssociation.properties.state.enumDescriptions - schemas.InterceptEndpointGroupAssociation.properties.updateTime.description - schemas.InterceptEndpointGroupAssociationDetails.description - schemas.InterceptEndpointGroupAssociationDetails.properties.name.description - schemas.InterceptEndpointGroupAssociationDetails.properties.network.description - schemas.InterceptEndpointGroupAssociationDetails.properties.state.description - schemas.InterceptEndpointGroupAssociationDetails.properties.state.enumDescriptions - schemas.InterceptEndpointGroupAssociationLocationDetails.description - schemas.InterceptEndpointGroupAssociationLocationDetails.properties.location.description - schemas.InterceptEndpointGroupAssociationLocationDetails.properties.state.description - schemas.InterceptEndpointGroupAssociationLocationDetails.properties.state.enumDescriptions - schemas.ListInterceptDeploymentGroupsResponse.description - schemas.ListInterceptDeploymentGroupsResponse.properties.interceptDeploymentGroups.description - schemas.ListInterceptDeploymentGroupsResponse.properties.nextPageToken.description - schemas.ListInterceptDeploymentsResponse.description - schemas.ListInterceptDeploymentsResponse.properties.interceptDeployments.description - schemas.ListInterceptDeploymentsResponse.properties.nextPageToken.description - schemas.ListInterceptEndpointGroupAssociationsResponse.description - schemas.ListInterceptEndpointGroupAssociationsResponse.properties.interceptEndpointGroupAssociations.description - schemas.ListInterceptEndpointGroupAssociationsResponse.properties.nextPageToken.description - schemas.ListInterceptEndpointGroupsResponse.description - schemas.ListInterceptEndpointGroupsResponse.properties.interceptEndpointGroups.description - schemas.ListInterceptEndpointGroupsResponse.properties.nextPageToken.description - schemas.ListMirroringDeploymentGroupsResponse.description - schemas.ListMirroringDeploymentGroupsResponse.properties.mirroringDeploymentGroups.description - schemas.ListMirroringDeploymentGroupsResponse.properties.nextPageToken.description - schemas.ListMirroringDeploymentsResponse.description - schemas.ListMirroringDeploymentsResponse.properties.mirroringDeployments.description - schemas.ListMirroringDeploymentsResponse.properties.nextPageToken.description - schemas.ListMirroringEndpointGroupAssociationsResponse.description - schemas.ListMirroringEndpointGroupAssociationsResponse.properties.mirroringEndpointGroupAssociations.description - schemas.ListMirroringEndpointGroupAssociationsResponse.properties.nextPageToken.description - schemas.ListMirroringEndpointGroupsResponse.description - schemas.ListMirroringEndpointGroupsResponse.properties.mirroringEndpointGroups.description - schemas.ListMirroringEndpointGroupsResponse.properties.nextPageToken.description - schemas.MirroringDeployment.description - schemas.MirroringDeployment.properties.createTime.description - schemas.MirroringDeployment.properties.forwardingRule.description - schemas.MirroringDeployment.properties.labels.description - schemas.MirroringDeployment.properties.mirroringDeploymentGroup.description - schemas.MirroringDeployment.properties.name.description - schemas.MirroringDeployment.properties.reconciling.description - schemas.MirroringDeployment.properties.state.description - schemas.MirroringDeployment.properties.state.enumDescriptions - schemas.MirroringDeployment.properties.updateTime.description - schemas.MirroringDeploymentGroup.description - schemas.MirroringDeploymentGroup.properties.connectedEndpointGroups.description - schemas.MirroringDeploymentGroup.properties.createTime.description - schemas.MirroringDeploymentGroup.properties.labels.description - schemas.MirroringDeploymentGroup.properties.name.description - schemas.MirroringDeploymentGroup.properties.network.description - schemas.MirroringDeploymentGroup.properties.reconciling.description - schemas.MirroringDeploymentGroup.properties.state.description - schemas.MirroringDeploymentGroup.properties.state.enumDescriptions - schemas.MirroringDeploymentGroup.properties.updateTime.description - schemas.MirroringDeploymentGroupConnectedEndpointGroup.properties.name.description - schemas.MirroringEndpointGroup.description - schemas.MirroringEndpointGroup.properties.associations.description - schemas.MirroringEndpointGroup.properties.createTime.description - schemas.MirroringEndpointGroup.properties.labels.description - schemas.MirroringEndpointGroup.properties.mirroringDeploymentGroup.description - schemas.MirroringEndpointGroup.properties.name.description - schemas.MirroringEndpointGroup.properties.reconciling.description - schemas.MirroringEndpointGroup.properties.state.description - schemas.MirroringEndpointGroup.properties.state.enumDescriptions - schemas.MirroringEndpointGroup.properties.updateTime.description - schemas.MirroringEndpointGroupAssociation.description - schemas.MirroringEndpointGroupAssociation.properties.createTime.description - schemas.MirroringEndpointGroupAssociation.properties.labels.description - schemas.MirroringEndpointGroupAssociation.properties.locationsDetails.description - schemas.MirroringEndpointGroupAssociation.properties.mirroringEndpointGroup.description - schemas.MirroringEndpointGroupAssociation.properties.name.description - schemas.MirroringEndpointGroupAssociation.properties.network.description - schemas.MirroringEndpointGroupAssociation.properties.reconciling.description - schemas.MirroringEndpointGroupAssociation.properties.state.enumDescriptions - schemas.MirroringEndpointGroupAssociation.properties.updateTime.description - schemas.MirroringEndpointGroupAssociationDetails.description - schemas.MirroringEndpointGroupAssociationDetails.properties.name.description - schemas.MirroringEndpointGroupAssociationDetails.properties.network.description - schemas.MirroringEndpointGroupAssociationDetails.properties.state.description - schemas.MirroringEndpointGroupAssociationDetails.properties.state.enumDescriptions - schemas.MirroringEndpointGroupAssociationLocationDetails.description - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.location.description - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.state.description - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.state.enumDescriptions #### networksecurity:v1 The following keys were added: - resources.organizations.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.description - resources.organizations.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.location - resources.organizations.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.addressGroups.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.flatPath - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.httpMethod - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.id - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameterOrder - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.mirroringDeploymentGroupId.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.mirroringDeploymentGroupId.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.mirroringDeploymentGroupId.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.path - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.request.$ref - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.response.$ref - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.create.scopes - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.flatPath - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.httpMethod - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.id - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameterOrder - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.path - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.response.$ref - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.delete.scopes - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.flatPath - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.httpMethod - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.id - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.parameterOrder - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.parameters.name.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.parameters.name.required - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.parameters.name.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.path - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.response.$ref - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.get.scopes - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.flatPath - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.httpMethod - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.id - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameterOrder - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.path - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.response.$ref - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.list.scopes - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.flatPath - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.httpMethod - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.id - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameterOrder - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.path - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.request.$ref - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.response.$ref - resources.projects.resources.locations.resources.mirroringDeploymentGroups.methods.patch.scopes - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.flatPath - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.httpMethod - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.id - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameterOrder - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.mirroringDeploymentId.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.mirroringDeploymentId.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.mirroringDeploymentId.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.path - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.request.$ref - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.response.$ref - resources.projects.resources.locations.resources.mirroringDeployments.methods.create.scopes - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.flatPath - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.httpMethod - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.id - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameterOrder - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.path - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.response.$ref - resources.projects.resources.locations.resources.mirroringDeployments.methods.delete.scopes - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.flatPath - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.httpMethod - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.id - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.parameterOrder - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.parameters.name.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.parameters.name.required - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.parameters.name.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.path - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.response.$ref - resources.projects.resources.locations.resources.mirroringDeployments.methods.get.scopes - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.flatPath - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.httpMethod - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.id - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameterOrder - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.path - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.response.$ref - resources.projects.resources.locations.resources.mirroringDeployments.methods.list.scopes - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.flatPath - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.httpMethod - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.id - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameterOrder - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.path - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.request.$ref - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.response.$ref - resources.projects.resources.locations.resources.mirroringDeployments.methods.patch.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.id - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.mirroringEndpointGroupAssociationId.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.mirroringEndpointGroupAssociationId.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.mirroringEndpointGroupAssociationId.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.path - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.request.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.create.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.id - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.path - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.delete.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.id - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.path - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.get.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.id - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.path - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.list.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.id - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.path - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.request.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroupAssociations.methods.patch.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.id - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.mirroringEndpointGroupId.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.mirroringEndpointGroupId.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.mirroringEndpointGroupId.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.path - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.request.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.create.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.id - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.path - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.delete.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.id - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.parameters.name.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.parameters.name.required - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.parameters.name.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.path - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.get.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.id - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.path - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.list.scopes - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.flatPath - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.httpMethod - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.id - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameterOrder - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.path - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.request.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.response.$ref - resources.projects.resources.locations.resources.mirroringEndpointGroups.methods.patch.scopes - resources.projects.resources.locations.resources.serverTlsPolicies.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.serverTlsPolicies.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.serverTlsPolicies.methods.list.parameters.returnPartialSuccess.type - schemas.AntivirusOverride.description - schemas.AntivirusOverride.id - schemas.AntivirusOverride.properties.action.description - schemas.AntivirusOverride.properties.action.enum - schemas.AntivirusOverride.properties.action.enumDescriptions - schemas.AntivirusOverride.properties.action.type - schemas.AntivirusOverride.properties.protocol.description - schemas.AntivirusOverride.properties.protocol.enum - schemas.AntivirusOverride.properties.protocol.enumDescriptions - schemas.AntivirusOverride.properties.protocol.type - schemas.AntivirusOverride.type - schemas.FirewallEndpoint.properties.satisfiesPzi.description - schemas.FirewallEndpoint.properties.satisfiesPzi.readOnly - schemas.FirewallEndpoint.properties.satisfiesPzi.type - schemas.FirewallEndpoint.properties.satisfiesPzs.description - schemas.FirewallEndpoint.properties.satisfiesPzs.readOnly - schemas.FirewallEndpoint.properties.satisfiesPzs.type - schemas.ListAddressGroupsResponse.properties.unreachable.description - schemas.ListAddressGroupsResponse.properties.unreachable.items.type - schemas.ListAddressGroupsResponse.properties.unreachable.type - schemas.ListMirroringDeploymentGroupsResponse.description - schemas.ListMirroringDeploymentGroupsResponse.id - schemas.ListMirroringDeploymentGroupsResponse.properties.mirroringDeploymentGroups.description - schemas.ListMirroringDeploymentGroupsResponse.properties.mirroringDeploymentGroups.items.$ref - schemas.ListMirroringDeploymentGroupsResponse.properties.mirroringDeploymentGroups.type - schemas.ListMirroringDeploymentGroupsResponse.properties.nextPageToken.description - schemas.ListMirroringDeploymentGroupsResponse.properties.nextPageToken.type - schemas.ListMirroringDeploymentGroupsResponse.type - schemas.ListMirroringDeploymentsResponse.description - schemas.ListMirroringDeploymentsResponse.id - schemas.ListMirroringDeploymentsResponse.properties.mirroringDeployments.description - schemas.ListMirroringDeploymentsResponse.properties.mirroringDeployments.items.$ref - schemas.ListMirroringDeploymentsResponse.properties.mirroringDeployments.type - schemas.ListMirroringDeploymentsResponse.properties.nextPageToken.description - schemas.ListMirroringDeploymentsResponse.properties.nextPageToken.type - schemas.ListMirroringDeploymentsResponse.properties.unreachable.description - schemas.ListMirroringDeploymentsResponse.properties.unreachable.items.type - schemas.ListMirroringDeploymentsResponse.properties.unreachable.type - schemas.ListMirroringDeploymentsResponse.type - schemas.ListMirroringEndpointGroupAssociationsResponse.description - schemas.ListMirroringEndpointGroupAssociationsResponse.id - schemas.ListMirroringEndpointGroupAssociationsResponse.properties.mirroringEndpointGroupAssociations.description - schemas.ListMirroringEndpointGroupAssociationsResponse.properties.mirroringEndpointGroupAssociations.items.$ref - schemas.ListMirroringEndpointGroupAssociationsResponse.properties.mirroringEndpointGroupAssociations.type - schemas.ListMirroringEndpointGroupAssociationsResponse.properties.nextPageToken.description - schemas.ListMirroringEndpointGroupAssociationsResponse.properties.nextPageToken.type - schemas.ListMirroringEndpointGroupAssociationsResponse.type - schemas.ListMirroringEndpointGroupsResponse.description - schemas.ListMirroringEndpointGroupsResponse.id - schemas.ListMirroringEndpointGroupsResponse.properties.mirroringEndpointGroups.description - schemas.ListMirroringEndpointGroupsResponse.properties.mirroringEndpointGroups.items.$ref - schemas.ListMirroringEndpointGroupsResponse.properties.mirroringEndpointGroups.type - schemas.ListMirroringEndpointGroupsResponse.properties.nextPageToken.description - schemas.ListMirroringEndpointGroupsResponse.properties.nextPageToken.type - schemas.ListMirroringEndpointGroupsResponse.type - schemas.ListServerTlsPoliciesResponse.properties.unreachable.description - schemas.ListServerTlsPoliciesResponse.properties.unreachable.items.type - schemas.ListServerTlsPoliciesResponse.properties.unreachable.type - schemas.MirroringDeployment.description - schemas.MirroringDeployment.id - schemas.MirroringDeployment.properties.createTime.description - schemas.MirroringDeployment.properties.createTime.format - schemas.MirroringDeployment.properties.createTime.readOnly - schemas.MirroringDeployment.properties.createTime.type - schemas.MirroringDeployment.properties.description.description - schemas.MirroringDeployment.properties.description.type - schemas.MirroringDeployment.properties.forwardingRule.description - schemas.MirroringDeployment.properties.forwardingRule.type - schemas.MirroringDeployment.properties.labels.additionalProperties.type - schemas.MirroringDeployment.properties.labels.description - schemas.MirroringDeployment.properties.labels.type - schemas.MirroringDeployment.properties.mirroringDeploymentGroup.description - schemas.MirroringDeployment.properties.mirroringDeploymentGroup.type - schemas.MirroringDeployment.properties.name.description - schemas.MirroringDeployment.properties.name.type - schemas.MirroringDeployment.properties.reconciling.description - schemas.MirroringDeployment.properties.reconciling.readOnly - schemas.MirroringDeployment.properties.reconciling.type - schemas.MirroringDeployment.properties.state.description - schemas.MirroringDeployment.properties.state.enum - schemas.MirroringDeployment.properties.state.enumDescriptions - schemas.MirroringDeployment.properties.state.readOnly - schemas.MirroringDeployment.properties.state.type - schemas.MirroringDeployment.properties.updateTime.description - schemas.MirroringDeployment.properties.updateTime.format - schemas.MirroringDeployment.properties.updateTime.readOnly - schemas.MirroringDeployment.properties.updateTime.type - schemas.MirroringDeployment.type - schemas.MirroringDeploymentGroup.description - schemas.MirroringDeploymentGroup.id - schemas.MirroringDeploymentGroup.properties.connectedEndpointGroups.description - schemas.MirroringDeploymentGroup.properties.connectedEndpointGroups.items.$ref - schemas.MirroringDeploymentGroup.properties.connectedEndpointGroups.readOnly - schemas.MirroringDeploymentGroup.properties.connectedEndpointGroups.type - schemas.MirroringDeploymentGroup.properties.createTime.description - schemas.MirroringDeploymentGroup.properties.createTime.format - schemas.MirroringDeploymentGroup.properties.createTime.readOnly - schemas.MirroringDeploymentGroup.properties.createTime.type - schemas.MirroringDeploymentGroup.properties.description.description - schemas.MirroringDeploymentGroup.properties.description.type - schemas.MirroringDeploymentGroup.properties.labels.additionalProperties.type - schemas.MirroringDeploymentGroup.properties.labels.description - schemas.MirroringDeploymentGroup.properties.labels.type - schemas.MirroringDeploymentGroup.properties.locations.description - schemas.MirroringDeploymentGroup.properties.locations.items.$ref - schemas.MirroringDeploymentGroup.properties.locations.readOnly - schemas.MirroringDeploymentGroup.properties.locations.type - schemas.MirroringDeploymentGroup.properties.name.description - schemas.MirroringDeploymentGroup.properties.name.type - schemas.MirroringDeploymentGroup.properties.nestedDeployments.deprecated - schemas.MirroringDeploymentGroup.properties.nestedDeployments.description - schemas.MirroringDeploymentGroup.properties.nestedDeployments.items.$ref - schemas.MirroringDeploymentGroup.properties.nestedDeployments.readOnly - schemas.MirroringDeploymentGroup.properties.nestedDeployments.type - schemas.MirroringDeploymentGroup.properties.network.description - schemas.MirroringDeploymentGroup.properties.network.type - schemas.MirroringDeploymentGroup.properties.reconciling.description - schemas.MirroringDeploymentGroup.properties.reconciling.readOnly - schemas.MirroringDeploymentGroup.properties.reconciling.type - schemas.MirroringDeploymentGroup.properties.state.description - schemas.MirroringDeploymentGroup.properties.state.enum - schemas.MirroringDeploymentGroup.properties.state.enumDescriptions - schemas.MirroringDeploymentGroup.properties.state.readOnly - schemas.MirroringDeploymentGroup.properties.state.type - schemas.MirroringDeploymentGroup.properties.updateTime.description - schemas.MirroringDeploymentGroup.properties.updateTime.format - schemas.MirroringDeploymentGroup.properties.updateTime.readOnly - schemas.MirroringDeploymentGroup.properties.updateTime.type - schemas.MirroringDeploymentGroup.type - schemas.MirroringDeploymentGroupConnectedEndpointGroup.description - schemas.MirroringDeploymentGroupConnectedEndpointGroup.id - schemas.MirroringDeploymentGroupConnectedEndpointGroup.properties.name.description - schemas.MirroringDeploymentGroupConnectedEndpointGroup.properties.name.readOnly - schemas.MirroringDeploymentGroupConnectedEndpointGroup.properties.name.type - schemas.MirroringDeploymentGroupConnectedEndpointGroup.type - schemas.MirroringDeploymentGroupDeployment.description - schemas.MirroringDeploymentGroupDeployment.id - schemas.MirroringDeploymentGroupDeployment.properties.name.description - schemas.MirroringDeploymentGroupDeployment.properties.name.readOnly - schemas.MirroringDeploymentGroupDeployment.properties.name.type - schemas.MirroringDeploymentGroupDeployment.properties.state.description - schemas.MirroringDeploymentGroupDeployment.properties.state.enum - schemas.MirroringDeploymentGroupDeployment.properties.state.enumDescriptions - schemas.MirroringDeploymentGroupDeployment.properties.state.readOnly - schemas.MirroringDeploymentGroupDeployment.properties.state.type - schemas.MirroringDeploymentGroupDeployment.type - schemas.MirroringEndpointGroup.description - schemas.MirroringEndpointGroup.id - schemas.MirroringEndpointGroup.properties.associations.description - schemas.MirroringEndpointGroup.properties.associations.items.$ref - schemas.MirroringEndpointGroup.properties.associations.readOnly - schemas.MirroringEndpointGroup.properties.associations.type - schemas.MirroringEndpointGroup.properties.connectedDeploymentGroups.description - schemas.MirroringEndpointGroup.properties.connectedDeploymentGroups.items.$ref - schemas.MirroringEndpointGroup.properties.connectedDeploymentGroups.readOnly - schemas.MirroringEndpointGroup.properties.connectedDeploymentGroups.type - schemas.MirroringEndpointGroup.properties.createTime.description - schemas.MirroringEndpointGroup.properties.createTime.format - schemas.MirroringEndpointGroup.properties.createTime.readOnly - schemas.MirroringEndpointGroup.properties.createTime.type - schemas.MirroringEndpointGroup.properties.description.description - schemas.MirroringEndpointGroup.properties.description.type - schemas.MirroringEndpointGroup.properties.labels.additionalProperties.type - schemas.MirroringEndpointGroup.properties.labels.description - schemas.MirroringEndpointGroup.properties.labels.type - schemas.MirroringEndpointGroup.properties.mirroringDeploymentGroup.description - schemas.MirroringEndpointGroup.properties.mirroringDeploymentGroup.type - schemas.MirroringEndpointGroup.properties.name.description - schemas.MirroringEndpointGroup.properties.name.type - schemas.MirroringEndpointGroup.properties.reconciling.description - schemas.MirroringEndpointGroup.properties.reconciling.readOnly - schemas.MirroringEndpointGroup.properties.reconciling.type - schemas.MirroringEndpointGroup.properties.state.description - schemas.MirroringEndpointGroup.properties.state.enum - schemas.MirroringEndpointGroup.properties.state.enumDescriptions - schemas.MirroringEndpointGroup.properties.state.readOnly - schemas.MirroringEndpointGroup.properties.state.type - schemas.MirroringEndpointGroup.properties.updateTime.description - schemas.MirroringEndpointGroup.properties.updateTime.format - schemas.MirroringEndpointGroup.properties.updateTime.readOnly - schemas.MirroringEndpointGroup.properties.updateTime.type - schemas.MirroringEndpointGroup.type - schemas.MirroringEndpointGroupAssociation.description - schemas.MirroringEndpointGroupAssociation.id - schemas.MirroringEndpointGroupAssociation.properties.createTime.description - schemas.MirroringEndpointGroupAssociation.properties.createTime.format - schemas.MirroringEndpointGroupAssociation.properties.createTime.readOnly - schemas.MirroringEndpointGroupAssociation.properties.createTime.type - schemas.MirroringEndpointGroupAssociation.properties.labels.additionalProperties.type - schemas.MirroringEndpointGroupAssociation.properties.labels.description - schemas.MirroringEndpointGroupAssociation.properties.labels.type - schemas.MirroringEndpointGroupAssociation.properties.locations.description - schemas.MirroringEndpointGroupAssociation.properties.locations.items.$ref - schemas.MirroringEndpointGroupAssociation.properties.locations.readOnly - schemas.MirroringEndpointGroupAssociation.properties.locations.type - schemas.MirroringEndpointGroupAssociation.properties.locationsDetails.deprecated - schemas.MirroringEndpointGroupAssociation.properties.locationsDetails.description - schemas.MirroringEndpointGroupAssociation.properties.locationsDetails.items.$ref - schemas.MirroringEndpointGroupAssociation.properties.locationsDetails.readOnly - schemas.MirroringEndpointGroupAssociation.properties.locationsDetails.type - schemas.MirroringEndpointGroupAssociation.properties.mirroringEndpointGroup.description - schemas.MirroringEndpointGroupAssociation.properties.mirroringEndpointGroup.type - schemas.MirroringEndpointGroupAssociation.properties.name.description - schemas.MirroringEndpointGroupAssociation.properties.name.type - schemas.MirroringEndpointGroupAssociation.properties.network.description - schemas.MirroringEndpointGroupAssociation.properties.network.type - schemas.MirroringEndpointGroupAssociation.properties.reconciling.description - schemas.MirroringEndpointGroupAssociation.properties.reconciling.readOnly - schemas.MirroringEndpointGroupAssociation.properties.reconciling.type - schemas.MirroringEndpointGroupAssociation.properties.state.description - schemas.MirroringEndpointGroupAssociation.properties.state.enum - schemas.MirroringEndpointGroupAssociation.properties.state.enumDescriptions - schemas.MirroringEndpointGroupAssociation.properties.state.readOnly - schemas.MirroringEndpointGroupAssociation.properties.state.type - schemas.MirroringEndpointGroupAssociation.properties.updateTime.description - schemas.MirroringEndpointGroupAssociation.properties.updateTime.format - schemas.MirroringEndpointGroupAssociation.properties.updateTime.readOnly - schemas.MirroringEndpointGroupAssociation.properties.updateTime.type - schemas.MirroringEndpointGroupAssociation.type - schemas.MirroringEndpointGroupAssociationDetails.description - schemas.MirroringEndpointGroupAssociationDetails.id - schemas.MirroringEndpointGroupAssociationDetails.properties.name.description - schemas.MirroringEndpointGroupAssociationDetails.properties.name.readOnly - schemas.MirroringEndpointGroupAssociationDetails.properties.name.type - schemas.MirroringEndpointGroupAssociationDetails.properties.network.description - schemas.MirroringEndpointGroupAssociationDetails.properties.network.readOnly - schemas.MirroringEndpointGroupAssociationDetails.properties.network.type - schemas.MirroringEndpointGroupAssociationDetails.properties.state.description - schemas.MirroringEndpointGroupAssociationDetails.properties.state.enum - schemas.MirroringEndpointGroupAssociationDetails.properties.state.enumDescriptions - schemas.MirroringEndpointGroupAssociationDetails.properties.state.readOnly - schemas.MirroringEndpointGroupAssociationDetails.properties.state.type - schemas.MirroringEndpointGroupAssociationDetails.type - schemas.MirroringEndpointGroupAssociationLocationDetails.description - schemas.MirroringEndpointGroupAssociationLocationDetails.id - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.location.description - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.location.readOnly - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.location.type - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.state.description - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.state.enum - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.state.enumDescriptions - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.state.readOnly - schemas.MirroringEndpointGroupAssociationLocationDetails.properties.state.type - schemas.MirroringEndpointGroupAssociationLocationDetails.type - schemas.MirroringEndpointGroupConnectedDeploymentGroup.description - schemas.MirroringEndpointGroupConnectedDeploymentGroup.id - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.locations.description - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.locations.items.$ref - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.locations.readOnly - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.locations.type - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.name.description - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.name.readOnly - schemas.MirroringEndpointGroupConnectedDeploymentGroup.properties.name.type - schemas.MirroringEndpointGroupConnectedDeploymentGroup.type - schemas.MirroringLocation.description - schemas.MirroringLocation.id - schemas.MirroringLocation.properties.location.description - schemas.MirroringLocation.properties.location.readOnly - schemas.MirroringLocation.properties.location.type - schemas.MirroringLocation.properties.state.description - schemas.MirroringLocation.properties.state.enum - schemas.MirroringLocation.properties.state.enumDescriptions - schemas.MirroringLocation.properties.state.readOnly - schemas.MirroringLocation.properties.state.type - schemas.MirroringLocation.type - schemas.SecurityProfileGroup.properties.dataPathId.description - schemas.SecurityProfileGroup.properties.dataPathId.format - schemas.SecurityProfileGroup.properties.dataPathId.readOnly - schemas.SecurityProfileGroup.properties.dataPathId.type - schemas.ThreatPreventionProfile.properties.antivirusOverrides.description - schemas.ThreatPreventionProfile.properties.antivirusOverrides.items.$ref - schemas.ThreatPreventionProfile.properties.antivirusOverrides.type The following keys were changed: - schemas.AuthzPolicyAuthzRuleFromRequestSource.properties.principals.description - schemas.CustomInterceptProfile.description - schemas.CustomInterceptProfile.properties.interceptEndpointGroup.description - schemas.CustomMirroringProfile.description - schemas.CustomMirroringProfile.properties.mirroringEndpointGroup.description --- discovery/networksecurity-v1.json | 2221 ++++++++++++++++---- discovery/networksecurity-v1beta1.json | 1288 ++++++++---- src/apis/networksecurity/v1.ts | 2585 +++++++++++++++++++++++- src/apis/networksecurity/v1beta1.ts | 1410 ++++++++++--- 4 files changed, 6395 insertions(+), 1109 deletions(-) diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index c801494e274..23a5a869c32 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -286,6 +286,11 @@ "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/addressGroups", @@ -1314,6 +1319,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/addressGroups", @@ -2740,122 +2750,181 @@ } } }, - "operations": { + "mirroringDeploymentGroups": { "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": "Creates a deployment group in a given project and location. See https://google.aip.dev/133.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", "httpMethod": "POST", - "id": "networksecurity.projects.locations.operations.cancel", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", + "mirroringDeploymentGroupId": { + "description": "Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}:cancel", + "path": "v1/{+parent}/mirroringDeploymentGroups", "request": { - "$ref": "CancelOperationRequest" + "$ref": "MirroringDeploymentGroup" }, "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 deployment group. See https://google.aip.dev/135.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", "httpMethod": "DELETE", - "id": "networksecurity.projects.locations.operations.delete", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The deployment group to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "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 a specific deployment group. See https://google.aip.dev/131.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", "httpMethod": "GET", - "id": "networksecurity.projects.locations.operations.get", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/mirroringDeploymentGroups/{mirroring_deployment_group}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "Operation" + "$ref": "MirroringDeploymentGroup" }, "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 deployment groups in a given project and location. See https://google.aip.dev/132.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", "httpMethod": "GET", - "id": "networksecurity.projects.locations.operations.list", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + "orderBy": { + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", + "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. A page token, received from a previous `ListMirroringDeploymentGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringDeploymentGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of deployment groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/mirroringDeploymentGroups", + "response": { + "$ref": "ListMirroringDeploymentGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a deployment group. See https://google.aip.dev/134.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. `description`; *not* `mirroring_deployment_group.description`). See https://google.aip.dev/161 for more details.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1/{+name}/operations", + "path": "v1/{+name}", + "request": { + "$ref": "MirroringDeploymentGroup" + }, "response": { - "$ref": "ListOperationsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2863,33 +2932,38 @@ } } }, - "serverTlsPolicies": { + "mirroringDeployments": { "methods": { "create": { - "description": "Creates a new ServerTlsPolicy in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies", + "description": "Creates a deployment in a given project and location. See https://google.aip.dev/133.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", "httpMethod": "POST", - "id": "networksecurity.projects.locations.serverTlsPolicies.create", + "id": "networksecurity.projects.locations.mirroringDeployments.create", "parameterOrder": [ "parent" ], "parameters": { + "mirroringDeploymentId": { + "description": "Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name.", + "location": "query", + "type": "string" + }, "parent": { - "description": "Required. The parent resource of the ServerTlsPolicy. Must be in the format `projects/*/locations/{location}`.", + "description": "Required. The parent resource where this deployment will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, - "serverTlsPolicyId": { - "description": "Required. Short name of the ServerTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"server_mtls_policy\".", + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/serverTlsPolicies", + "path": "v1/{+parent}/mirroringDeployments", "request": { - "$ref": "ServerTlsPolicy" + "$ref": "MirroringDeployment" }, "response": { "$ref": "Operation" @@ -2899,20 +2973,25 @@ ] }, "delete": { - "description": "Deletes a single ServerTlsPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", + "description": "Deletes a deployment. See https://google.aip.dev/135.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "DELETE", - "id": "networksecurity.projects.locations.serverTlsPolicies.delete", + "id": "networksecurity.projects.locations.mirroringDeployments.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the ServerTlsPolicy to delete. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", + "description": "Required. Name of the resource", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -2924,115 +3003,99 @@ ] }, "get": { - "description": "Gets details of a single ServerTlsPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", + "description": "Gets a specific deployment. See https://google.aip.dev/131.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "GET", - "id": "networksecurity.projects.locations.serverTlsPolicies.get", + "id": "networksecurity.projects.locations.mirroringDeployments.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the ServerTlsPolicy to get. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", + "description": "Required. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "ServerTlsPolicy" + "$ref": "MirroringDeployment" }, "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}/serverTlsPolicies/{serverTlsPoliciesId}:getIamPolicy", + "list": { + "description": "Lists deployments in a given project and location. See https://google.aip.dev/132.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", "httpMethod": "GET", - "id": "networksecurity.projects.locations.serverTlsPolicies.getIamPolicy", + "id": "networksecurity.projects.locations.mirroringDeployments.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).", - "format": "int32", + "filter": { + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", - "type": "integer" + "type": "string" }, - "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/[^/]+/serverTlsPolicies/[^/]+$", - "required": true, + "orderBy": { + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", + "location": "query", "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists ServerTlsPolicies in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies", - "httpMethod": "GET", - "id": "networksecurity.projects.locations.serverTlsPolicies.list", - "parameterOrder": [ - "parent" - ], - "parameters": { + }, "pageSize": { - "description": "Maximum number of ServerTlsPolicies to return per call.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListServerTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListServerTlsPolicies` call, and that the system should return the next page of data.", + "description": "Optional. A page token, received from a previous `ListMirroringDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringDeployments` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The project and location from which the ServerTlsPolicies should be listed, specified in the format `projects/*/locations/{location}`.", + "description": "Required. The parent, which owns this collection of deployments. Example: `projects/123456789/locations/us-central1-a`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/serverTlsPolicies", + "path": "v1/{+parent}/mirroringDeployments", "response": { - "$ref": "ListServerTlsPoliciesResponse" + "$ref": "ListMirroringDeploymentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single ServerTlsPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", + "description": "Updates a deployment. See https://google.aip.dev/134.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.serverTlsPolicies.patch", + "id": "networksecurity.projects.locations.mirroringDeployments.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`", + "description": "Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", "required": true, "type": "string" }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" + }, "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the ServerTlsPolicy 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the deployment (e.g. `description`; *not* `mirroring_deployment.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3040,7 +3103,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "ServerTlsPolicy" + "$ref": "MirroringDeployment" }, "response": { "$ref": "Operation" @@ -3048,92 +3111,223 @@ "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}/serverTlsPolicies/{serverTlsPoliciesId}:setIamPolicy", + } + } + }, + "mirroringEndpointGroupAssociations": { + "methods": { + "create": { + "description": "Creates an association in a given project and location. See https://google.aip.dev/133.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", "httpMethod": "POST", - "id": "networksecurity.projects.locations.serverTlsPolicies.setIamPolicy", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.create", "parameterOrder": [ - "resource" + "parent" ], "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.", + "mirroringEndpointGroupAssociationId": { + "description": "Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this association will be created. Format: projects/{project}/locations/{location}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" } }, - "path": "v1/{+resource}:setIamPolicy", + "path": "v1/{+parent}/mirroringEndpointGroupAssociations", "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" + "$ref": "MirroringEndpointGroupAssociation" }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "Operation" }, "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}/serverTlsPolicies/{serverTlsPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networksecurity.projects.locations.serverTlsPolicies.testIamPermissions", + "delete": { + "description": "Deletes an association. See https://google.aip.dev/135.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.delete", "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. The association to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" } }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - }, - "tlsInspectionPolicies": { - "methods": { - "create": { - "description": "Creates a new TlsInspectionPolicy in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies", - "httpMethod": "POST", - "id": "networksecurity.projects.locations.tlsInspectionPolicies.create", + }, + "get": { + "description": "Gets a specific association. See https://google.aip.dev/131.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.get", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The parent resource of the TlsInspectionPolicy. Must be in the format `projects/{project}/locations/{location}`.", + "name": { + "description": "Required. The name of the association to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroupAssociations/{mirroring_endpoint_group_association}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "MirroringEndpointGroupAssociation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists associations in a given project and location. See https://google.aip.dev/132.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", + "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. See https://google.aip.dev/158 for more details.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of associations. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1/{+parent}/mirroringEndpointGroupAssociations", + "response": { + "$ref": "ListMirroringEndpointGroupAssociationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an association. See https://google.aip.dev/134.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", + "required": true, + "type": "string" }, - "tlsInspectionPolicyId": { - "description": "Required. Short name of the TlsInspectionPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"tls_inspection_policy1\".", + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update. Fields are specified relative to the association (e.g. `description`; *not* `mirroring_endpoint_group_association.description`). See https://google.aip.dev/161 for more details.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/tlsInspectionPolicies", + "path": "v1/{+name}", "request": { - "$ref": "TlsInspectionPolicy" + "$ref": "MirroringEndpointGroupAssociation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "mirroringEndpointGroups": { + "methods": { + "create": { + "description": "Creates an endpoint group in a given project and location. See https://google.aip.dev/133.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "mirroringEndpointGroupId": { + "description": "Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/mirroringEndpointGroups", + "request": { + "$ref": "MirroringEndpointGroup" }, "response": { "$ref": "Operation" @@ -3143,25 +3337,25 @@ ] }, "delete": { - "description": "Deletes a single TlsInspectionPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}", + "description": "Deletes an endpoint group. See https://google.aip.dev/135.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", "httpMethod": "DELETE", - "id": "networksecurity.projects.locations.tlsInspectionPolicies.delete", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.delete", "parameterOrder": [ "name" ], "parameters": { - "force": { - "description": "If set to true, any rules for this TlsInspectionPolicy will also be deleted. (Otherwise, the request will only work if the TlsInspectionPolicy has no rules.)", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Required. A name of the TlsInspectionPolicy to delete. Must be in the format `projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}`.", + "description": "Required. The endpoint group to delete.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tlsInspectionPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -3173,84 +3367,99 @@ ] }, "get": { - "description": "Gets details of a single TlsInspectionPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}", + "description": "Gets a specific endpoint group. See https://google.aip.dev/131.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", "httpMethod": "GET", - "id": "networksecurity.projects.locations.tlsInspectionPolicies.get", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the TlsInspectionPolicy to get. Must be in the format `projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}`.", + "description": "Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroring_endpoint_group}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tlsInspectionPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "TlsInspectionPolicy" + "$ref": "MirroringEndpointGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists TlsInspectionPolicies in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies", + "description": "Lists endpoint groups in a given project and location. See https://google.aip.dev/132.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", "httpMethod": "GET", - "id": "networksecurity.projects.locations.tlsInspectionPolicies.list", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.list", "parameterOrder": [ "parent" ], "parameters": { + "filter": { + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "Maximum number of TlsInspectionPolicies to return per call.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last 'ListTlsInspectionPoliciesResponse' Indicates that this is a continuation of a prior 'ListTlsInspectionPolicies' call, and that the system should return the next page of data.", + "description": "Optional. A page token, received from a previous `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The project and location from which the TlsInspectionPolicies should be listed, specified in the format `projects/{project}/locations/{location}`.", + "description": "Required. The parent, which owns this collection of endpoint groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/tlsInspectionPolicies", + "path": "v1/{+parent}/mirroringEndpointGroups", "response": { - "$ref": "ListTlsInspectionPoliciesResponse" + "$ref": "ListMirroringEndpointGroupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single TlsInspectionPolicy.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}", + "description": "Updates an endpoint group. See https://google.aip.dev/134.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.tlsInspectionPolicies.patch", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy} tls_inspection_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", + "description": "Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tlsInspectionPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", "required": true, "type": "string" }, + "requestId": { + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", + "location": "query", + "type": "string" + }, "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the TlsInspectionPolicy 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the endpoint group (e.g. `description`; *not* `mirroring_endpoint_group.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3258,7 +3467,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "TlsInspectionPolicy" + "$ref": "MirroringEndpointGroup" }, "response": { "$ref": "Operation" @@ -3269,140 +3478,674 @@ } } }, - "urlLists": { + "operations": { "methods": { - "create": { - "description": "Creates a new UrlList in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists", + "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": "networksecurity.projects.locations.urlLists.create", + "id": "networksecurity.projects.locations.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The parent resource of the UrlList. Must be in the format `projects/*/locations/{location}`.", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "urlListId": { - "description": "Required. Short name of the UrlList resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"url_list\".", - "location": "query", - "type": "string" } }, - "path": "v1/{+parent}/urlLists", + "path": "v1/{+name}:cancel", "request": { - "$ref": "UrlList" + "$ref": "CancelOperationRequest" }, "response": { - "$ref": "Operation" + "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a single UrlList.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}", + "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": "networksecurity.projects.locations.urlLists.delete", + "id": "networksecurity.projects.locations.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the UrlList to delete. Must be in the format `projects/*/locations/{location}/urlLists/*`.", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/urlLists/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "Operation" + "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets details of a single UrlList.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}", + "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": "networksecurity.projects.locations.urlLists.get", + "id": "networksecurity.projects.locations.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the UrlList to get. Must be in the format `projects/*/locations/{location}/urlLists/*`.", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/urlLists/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "UrlList" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists UrlLists in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists", + "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": "networksecurity.projects.locations.urlLists.list", + "id": "networksecurity.projects.locations.operations.list", "parameterOrder": [ - "parent" + "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": "Maximum number of UrlLists to return per call.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListUrlListsResponse` Indicates that this is a continuation of a prior `ListUrlLists` call, and that the system should return the next page of data.", + "description": "The standard list page token.", "location": "query", "type": "string" - }, - "parent": { - "description": "Required. The project and location from which the UrlLists should be listed, specified in the format `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" } }, - "path": "v1/{+parent}/urlLists", + "path": "v1/{+name}/operations", "response": { - "$ref": "ListUrlListsResponse" + "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "patch": { - "description": "Updates the parameters of a single UrlList.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}", - "httpMethod": "PATCH", - "id": "networksecurity.projects.locations.urlLists.patch", + } + } + }, + "serverTlsPolicies": { + "methods": { + "create": { + "description": "Creates a new ServerTlsPolicy in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.serverTlsPolicies.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. Name of the resource provided by the user. Name is of the form projects/{project}/locations/{location}/urlLists/{url_list} url_list should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", + "parent": { + "description": "Required. The parent resource of the ServerTlsPolicy. Must be in the format `projects/*/locations/{location}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/urlLists/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "serverTlsPolicyId": { + "description": "Required. Short name of the ServerTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"server_mtls_policy\".", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/serverTlsPolicies", + "request": { + "$ref": "ServerTlsPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ServerTlsPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.serverTlsPolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the ServerTlsPolicy to delete. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ServerTlsPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.serverTlsPolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the ServerTlsPolicy to get. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ServerTlsPolicy" + }, + "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}/serverTlsPolicies/{serverTlsPoliciesId}:getIamPolicy", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.serverTlsPolicies.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/[^/]+/serverTlsPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ServerTlsPolicies in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.serverTlsPolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of ServerTlsPolicies to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListServerTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListServerTlsPolicies` 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 ServerTlsPolicies should be listed, specified in the format `projects/*/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. Setting this field to `true` will opt the request into returning the resources that are reachable, and into including the names of those that were unreachable in the [ListServerTlsPoliciesResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/serverTlsPolicies", + "response": { + "$ref": "ListServerTlsPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single ServerTlsPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.serverTlsPolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the ServerTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ServerTlsPolicy" + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}:setIamPolicy", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.serverTlsPolicies.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/[^/]+/serverTlsPolicies/[^/]+$", + "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}/serverTlsPolicies/{serverTlsPoliciesId}:testIamPermissions", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.serverTlsPolicies.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/[^/]+/serverTlsPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "tlsInspectionPolicies": { + "methods": { + "create": { + "description": "Creates a new TlsInspectionPolicy in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.tlsInspectionPolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the TlsInspectionPolicy. Must be in the format `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "tlsInspectionPolicyId": { + "description": "Required. Short name of the TlsInspectionPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"tls_inspection_policy1\".", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/tlsInspectionPolicies", + "request": { + "$ref": "TlsInspectionPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single TlsInspectionPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.tlsInspectionPolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any rules for this TlsInspectionPolicy will also be deleted. (Otherwise, the request will only work if the TlsInspectionPolicy has no rules.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. A name of the TlsInspectionPolicy to delete. Must be in the format `projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tlsInspectionPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single TlsInspectionPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.tlsInspectionPolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the TlsInspectionPolicy to get. Must be in the format `projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tlsInspectionPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "TlsInspectionPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists TlsInspectionPolicies in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.tlsInspectionPolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of TlsInspectionPolicies to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last 'ListTlsInspectionPoliciesResponse' Indicates that this is a continuation of a prior 'ListTlsInspectionPolicies' 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 TlsInspectionPolicies should be listed, specified in the format `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tlsInspectionPolicies", + "response": { + "$ref": "ListTlsInspectionPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single TlsInspectionPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.tlsInspectionPolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy} tls_inspection_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tlsInspectionPolicies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the TlsInspectionPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "TlsInspectionPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "urlLists": { + "methods": { + "create": { + "description": "Creates a new UrlList in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.urlLists.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the UrlList. Must be in the format `projects/*/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "urlListId": { + "description": "Required. Short name of the UrlList resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"url_list\".", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/urlLists", + "request": { + "$ref": "UrlList" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single UrlList.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.urlLists.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the UrlList to delete. Must be in the format `projects/*/locations/{location}/urlLists/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/urlLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single UrlList.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.urlLists.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the UrlList to get. Must be in the format `projects/*/locations/{location}/urlLists/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/urlLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "UrlList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists UrlLists in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.urlLists.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of UrlLists to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListUrlListsResponse` Indicates that this is a continuation of a prior `ListUrlLists` 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 UrlLists should be listed, specified in the format `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/urlLists", + "response": { + "$ref": "ListUrlListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single UrlList.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.urlLists.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource provided by the user. Name is of the form projects/{project}/locations/{location}/urlLists/{url_list} url_list should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/urlLists/[^/]+$", "required": true, "type": "string" }, @@ -3431,7 +4174,7 @@ } } }, - "revision": "20241202", + "revision": "20250310", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3534,6 +4277,55 @@ }, "type": "object" }, + "AntivirusOverride": { + "description": "Defines what action to take for antivirus threats per protocol.", + "id": "AntivirusOverride", + "properties": { + "action": { + "description": "Required. Threat action override. For some threat types, only a subset of actions applies.", + "enum": [ + "THREAT_ACTION_UNSPECIFIED", + "DEFAULT_ACTION", + "ALLOW", + "ALERT", + "DENY" + ], + "enumDescriptions": [ + "Threat action not specified.", + "The default action (as specified by the vendor) is taken.", + "The packet matching this rule will be allowed to transmit.", + "The packet matching this rule will be allowed to transmit, but a threat_log entry will be sent to the consumer project.", + "The packet matching this rule will be dropped, and a threat_log entry will be sent to the consumer project." + ], + "type": "string" + }, + "protocol": { + "description": "Required. Protocol to match.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "SMTP", + "SMB", + "POP3", + "IMAP", + "HTTP2", + "HTTP", + "FTP" + ], + "enumDescriptions": [ + "Protocol not specified.", + "SMTP prtocol", + "SMB protocol", + "POP3 protocol", + "IMAP protocol", + "HTTP2 protocol", + "HTTP protocol", + "FTP protocol" + ], + "type": "string" + } + }, + "type": "object" + }, "AuthorizationPolicy": { "description": "AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource.", "id": "AuthorizationPolicy", @@ -3699,7 +4491,7 @@ "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 5 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. For Application Load Balancers, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or SPIFFE ID, or the subject field in the client's certificate. For Cloud Service Mesh, 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 5 principals.", "items": { "$ref": "AuthzPolicyAuthzRuleStringMatch" }, @@ -4001,22 +4793,22 @@ "type": "object" }, "CustomInterceptProfile": { - "description": "CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule.", + "description": "CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action.", "id": "CustomInterceptProfile", "properties": { "interceptEndpointGroup": { - "description": "Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored.", + "description": "Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group.", "type": "string" } }, "type": "object" }, "CustomMirroringProfile": { - "description": "CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup", + "description": "CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action.", "id": "CustomMirroringProfile", "properties": { "mirroringEndpointGroup": { - "description": "Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.", + "description": "Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group.", "type": "string" } }, @@ -4135,6 +4927,16 @@ "readOnly": true, "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. [Output Only] Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. [Output Only] Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. Current state of the endpoint.", "enum": [ @@ -4583,6 +5385,13 @@ "nextPageToken": { "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4623,48 +5432,299 @@ "unreachable": { "description": "Locations that could not be reached.", "items": { - "type": "string" + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListClientTlsPoliciesResponse": { + "description": "Response returned by the ListClientTlsPolicies method.", + "id": "ListClientTlsPoliciesResponse", + "properties": { + "clientTlsPolicies": { + "description": "List of ClientTlsPolicy resources.", + "items": { + "$ref": "ClientTlsPolicy" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "type": "string" + } + }, + "type": "object" + }, + "ListFirewallEndpointAssociationsResponse": { + "description": "Message for response to listing Associations", + "id": "ListFirewallEndpointAssociationsResponse", + "properties": { + "firewallEndpointAssociations": { + "description": "The list of Association", + "items": { + "$ref": "FirewallEndpointAssociation" + }, + "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" + }, + "ListFirewallEndpointsResponse": { + "description": "Message for response to listing Endpoints", + "id": "ListFirewallEndpointsResponse", + "properties": { + "firewallEndpoints": { + "description": "The list of Endpoint", + "items": { + "$ref": "FirewallEndpoint" + }, + "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" + }, + "ListGatewaySecurityPoliciesResponse": { + "description": "Response returned by the ListGatewaySecurityPolicies method.", + "id": "ListGatewaySecurityPoliciesResponse", + "properties": { + "gatewaySecurityPolicies": { + "description": "List of GatewaySecurityPolicies resources.", + "items": { + "$ref": "GatewaySecurityPolicy" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListGatewaySecurityPolicyRulesResponse": { + "description": "Response returned by the ListGatewaySecurityPolicyRules method.", + "id": "ListGatewaySecurityPolicyRulesResponse", + "properties": { + "gatewaySecurityPolicyRules": { + "description": "List of GatewaySecurityPolicyRule resources.", + "items": { + "$ref": "GatewaySecurityPolicyRule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListMirroringDeploymentGroupsResponse": { + "description": "Response message for ListMirroringDeploymentGroups.", + "id": "ListMirroringDeploymentGroupsResponse", + "properties": { + "mirroringDeploymentGroups": { + "description": "The deployment groups from the specified parent.", + "items": { + "$ref": "MirroringDeploymentGroup" + }, + "type": "array" + }, + "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. See https://google.aip.dev/158 for more details.", + "type": "string" + } + }, + "type": "object" + }, + "ListMirroringDeploymentsResponse": { + "description": "Response message for ListMirroringDeployments.", + "id": "ListMirroringDeploymentsResponse", + "properties": { + "mirroringDeployments": { + "description": "The deployments from the specified parent.", + "items": { + "$ref": "MirroringDeployment" + }, + "type": "array" + }, + "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. See https://google.aip.dev/158 for more details.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListMirroringEndpointGroupAssociationsResponse": { + "description": "Response message for ListMirroringEndpointGroupAssociations.", + "id": "ListMirroringEndpointGroupAssociationsResponse", + "properties": { + "mirroringEndpointGroupAssociations": { + "description": "The associations from the specified parent.", + "items": { + "$ref": "MirroringEndpointGroupAssociation" + }, + "type": "array" + }, + "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. See https://google.aip.dev/158 for more details.", + "type": "string" + } + }, + "type": "object" + }, + "ListMirroringEndpointGroupsResponse": { + "description": "Response message for ListMirroringEndpointGroups.", + "id": "ListMirroringEndpointGroupsResponse", + "properties": { + "mirroringEndpointGroups": { + "description": "The endpoint groups from the specified parent.", + "items": { + "$ref": "MirroringEndpointGroup" + }, + "type": "array" + }, + "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. See https://google.aip.dev/158 for more details.", + "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" + }, + "ListSecurityProfileGroupsResponse": { + "description": "Response returned by the ListSecurityProfileGroups method.", + "id": "ListSecurityProfileGroupsResponse", + "properties": { + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "type": "string" + }, + "securityProfileGroups": { + "description": "List of SecurityProfileGroups resources.", + "items": { + "$ref": "SecurityProfileGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSecurityProfilesResponse": { + "description": "Response returned by the ListSecurityProfiles method.", + "id": "ListSecurityProfilesResponse", + "properties": { + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "type": "string" + }, + "securityProfiles": { + "description": "List of SecurityProfile resources.", + "items": { + "$ref": "SecurityProfile" }, "type": "array" } }, "type": "object" }, - "ListClientTlsPoliciesResponse": { - "description": "Response returned by the ListClientTlsPolicies method.", - "id": "ListClientTlsPoliciesResponse", + "ListServerTlsPoliciesResponse": { + "description": "Response returned by the ListServerTlsPolicies method.", + "id": "ListServerTlsPoliciesResponse", "properties": { - "clientTlsPolicies": { - "description": "List of ClientTlsPolicy resources.", - "items": { - "$ref": "ClientTlsPolicy" - }, - "type": "array" - }, "nextPageToken": { "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" - } - }, - "type": "object" - }, - "ListFirewallEndpointAssociationsResponse": { - "description": "Message for response to listing Associations", - "id": "ListFirewallEndpointAssociationsResponse", - "properties": { - "firewallEndpointAssociations": { - "description": "The list of Association", + }, + "serverTlsPolicies": { + "description": "List of ServerTlsPolicy resources.", "items": { - "$ref": "FirewallEndpointAssociation" + "$ref": "ServerTlsPolicy" }, "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.", + "description": "Unreachable resources. Populated when the request opts into `return_partial_success` and reading across collections e.g. when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -4673,21 +5733,21 @@ }, "type": "object" }, - "ListFirewallEndpointsResponse": { - "description": "Message for response to listing Endpoints", - "id": "ListFirewallEndpointsResponse", + "ListTlsInspectionPoliciesResponse": { + "description": "Response returned by the ListTlsInspectionPolicies method.", + "id": "ListTlsInspectionPoliciesResponse", "properties": { - "firewallEndpoints": { - "description": "The list of Endpoint", + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "type": "string" + }, + "tlsInspectionPolicies": { + "description": "List of TlsInspectionPolicies resources.", "items": { - "$ref": "FirewallEndpoint" + "$ref": "TlsInspectionPolicy" }, "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": { @@ -4698,19 +5758,12 @@ }, "type": "object" }, - "ListGatewaySecurityPoliciesResponse": { - "description": "Response returned by the ListGatewaySecurityPolicies method.", - "id": "ListGatewaySecurityPoliciesResponse", + "ListUrlListsResponse": { + "description": "Response returned by the ListUrlLists method.", + "id": "ListUrlListsResponse", "properties": { - "gatewaySecurityPolicies": { - "description": "List of GatewaySecurityPolicies resources.", - "items": { - "$ref": "GatewaySecurityPolicy" - }, - "type": "array" - }, "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" }, "unreachable": { @@ -4719,236 +5772,555 @@ "type": "string" }, "type": "array" + }, + "urlLists": { + "description": "List of UrlList resources.", + "items": { + "$ref": "UrlList" + }, + "type": "array" } }, "type": "object" }, - "ListGatewaySecurityPolicyRulesResponse": { - "description": "Response returned by the ListGatewaySecurityPolicyRules method.", - "id": "ListGatewaySecurityPolicyRulesResponse", + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", "properties": { - "gatewaySecurityPolicyRules": { - "description": "List of GatewaySecurityPolicyRule resources.", - "items": { - "$ref": "GatewaySecurityPolicyRule" + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" }, - "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, - "unreachable": { - "description": "Locations that could not be reached.", - "items": { - "type": "string" + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" }, - "type": "array" + "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" }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "id": "ListLocationsResponse", + "MTLSPolicy": { + "description": "Specification of the MTLSPolicy.", + "id": "MTLSPolicy", "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", + "clientValidationCa": { + "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": "Location" + "$ref": "ValidationCA" }, "type": "array" }, - "nextPageToken": { - "description": "The standard List next-page token.", + "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 Application Load Balancers. For Traffic Director it must be empty.", + "enum": [ + "CLIENT_VALIDATION_MODE_UNSPECIFIED", + "ALLOW_INVALID_OR_MISSING_CLIENT_CERT", + "REJECT_INVALID" + ], + "enumDescriptions": [ + "Not allowed.", + "Allow connection even if certificate chain validation of the client certificate failed or no client certificate was presented. The proof of possession of the private key is always checked if client certificate was presented. This mode requires the backend to implement processing of data extracted from a client certificate to authenticate the peer, or to reject connections if the client certificate fingerprint is missing.", + "Require a client certificate and allow connection to the backend only if validation of the client certificate passed. If set, requires a reference to non-empty TrustConfig specified in `client_validation_trust_config`." + ], + "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 Application Load Balancers.", "type": "string" } }, "type": "object" }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", + "MirroringDeployment": { + "description": "A deployment represents a zonal mirroring backend ready to accept GENEVE-encapsulated replica traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global mirroring service.", + "id": "MirroringDeployment", "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", + "createTime": { + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "Operation" + "description": { + "description": "Optional. User-provided description of the deployment. Used as additional context for the deployment.", + "type": "string" + }, + "forwardingRule": { + "description": "Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", + "type": "object" + }, + "mirroringDeploymentGroup": { + "description": "Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details.", + "type": "string" + }, + "reconciling": { + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The current state of the deployment. See https://google.aip.dev/216.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "State not set (this is not a valid state).", + "The deployment is ready and in sync with the parent group.", + "The deployment is being created.", + "The deployment is being deleted.", + "The deployment is out of sync with the parent group. In most cases, this is a result of a transient issue within the system (e.g. a delayed data-path config) and the system is expected to recover automatically. See the parent deployment group's state for more details.", + "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to recover. The only permitted operation is to retry deleting the deployment." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "ListSecurityProfileGroupsResponse": { - "description": "Response returned by the ListSecurityProfileGroups method.", - "id": "ListSecurityProfileGroupsResponse", + "MirroringDeploymentGroup": { + "description": "A deployment group aggregates many zonal mirroring backends (deployments) into a single global mirroring service. Consumers can connect this service using an endpoint group.", + "id": "MirroringDeploymentGroup", "properties": { - "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "connectedEndpointGroups": { + "description": "Output only. The list of endpoint groups that are connected to this resource.", + "items": { + "$ref": "MirroringDeploymentGroupConnectedEndpointGroup" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. User-provided description of the deployment group. Used as additional context for the deployment group.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", + "type": "object" + }, + "locations": { + "description": "Output only. The list of locations where the deployment group is present.", + "items": { + "$ref": "MirroringLocation" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.", + "type": "string" + }, + "nestedDeployments": { + "deprecated": true, + "description": "Output only. The list of Mirroring Deployments that belong to this group.", + "items": { + "$ref": "MirroringDeploymentGroupDeployment" + }, + "readOnly": true, + "type": "array" + }, + "network": { + "description": "Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project}/global/networks/{network}`. See https://google.aip.dev/124.", + "type": "string" + }, + "reconciling": { + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The current state of the deployment group. See https://google.aip.dev/216.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING" + ], + "enumDescriptions": [ + "State not set (this is not a valid state).", + "The deployment group is ready.", + "The deployment group is being created.", + "The deployment group is being deleted." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", + "format": "google-datetime", + "readOnly": true, "type": "string" - }, - "securityProfileGroups": { - "description": "List of SecurityProfileGroups resources.", - "items": { - "$ref": "SecurityProfileGroup" - }, - "type": "array" } }, "type": "object" }, - "ListSecurityProfilesResponse": { - "description": "Response returned by the ListSecurityProfiles method.", - "id": "ListSecurityProfilesResponse", + "MirroringDeploymentGroupConnectedEndpointGroup": { + "description": "An endpoint group connected to this deployment group.", + "id": "MirroringDeploymentGroupConnectedEndpointGroup", "properties": { - "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "name": { + "description": "Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124.", + "readOnly": true, "type": "string" - }, - "securityProfiles": { - "description": "List of SecurityProfile resources.", - "items": { - "$ref": "SecurityProfile" - }, - "type": "array" } }, "type": "object" }, - "ListServerTlsPoliciesResponse": { - "description": "Response returned by the ListServerTlsPolicies method.", - "id": "ListServerTlsPoliciesResponse", + "MirroringDeploymentGroupDeployment": { + "description": "A deployment belonging to this deployment group.", + "id": "MirroringDeploymentGroupDeployment", "properties": { - "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "name": { + "description": "Output only. The name of the Mirroring Deployment, in the format: `projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}`.", + "readOnly": true, "type": "string" }, - "serverTlsPolicies": { - "description": "List of ServerTlsPolicy resources.", - "items": { - "$ref": "ServerTlsPolicy" - }, - "type": "array" + "state": { + "description": "Output only. Most recent known state of the deployment.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "State not set (this is not a valid state).", + "The deployment is ready and in sync with the parent group.", + "The deployment is being created.", + "The deployment is being deleted.", + "The deployment is out of sync with the parent group. In most cases, this is a result of a transient issue within the system (e.g. a delayed data-path config) and the system is expected to recover automatically. See the parent deployment group's state for more details.", + "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to recover. The only permitted operation is to retry deleting the deployment." + ], + "readOnly": true, + "type": "string" } }, "type": "object" }, - "ListTlsInspectionPoliciesResponse": { - "description": "Response returned by the ListTlsInspectionPolicies method.", - "id": "ListTlsInspectionPoliciesResponse", + "MirroringEndpointGroup": { + "description": "An endpoint group is a consumer frontend for a deployment group (backend). In order to configure mirroring for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A mirroring rule that references the security profile (group).", + "id": "MirroringEndpointGroup", "properties": { - "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", - "type": "string" - }, - "tlsInspectionPolicies": { - "description": "List of TlsInspectionPolicies resources.", + "associations": { + "description": "Output only. List of associations to this endpoint group.", "items": { - "$ref": "TlsInspectionPolicy" + "$ref": "MirroringEndpointGroupAssociationDetails" }, + "readOnly": true, "type": "array" }, - "unreachable": { - "description": "Locations that could not be reached.", + "connectedDeploymentGroups": { + "description": "Output only. List of details about the connected deployment groups to this endpoint group.", "items": { - "type": "string" + "$ref": "MirroringEndpointGroupConnectedDeploymentGroup" }, + "readOnly": true, "type": "array" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", + "type": "object" + }, + "mirroringDeploymentGroup": { + "description": "Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.", + "type": "string" + }, + "reconciling": { + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The current state of the endpoint group. See https://google.aip.dev/216.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CLOSED", + "CREATING", + "DELETING", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "State not set (this is not a valid state).", + "The endpoint group is ready and in sync with the target deployment group.", + "The deployment group backing this endpoint group has been force-deleted. This endpoint group cannot be used and mirroring is effectively disabled.", + "The endpoint group is being created.", + "The endpoint group is being deleted.", + "The endpoint group is out of sync with the backing deployment group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. See the associations field for details per network and location.", + "An attempt to delete the endpoint group has failed. This is a terminal state and the endpoint group is not expected to recover. The only permitted operation is to retry deleting the endpoint group." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "ListUrlListsResponse": { - "description": "Response returned by the ListUrlLists method.", - "id": "ListUrlListsResponse", + "MirroringEndpointGroupAssociation": { + "description": "An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable mirroring by itself. To enable mirroring, the user must also create a network firewall policy containing mirroring rules and associate it with the network.", + "id": "MirroringEndpointGroupAssociation", "properties": { - "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "createTime": { + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "unreachable": { - "description": "Locations that could not be reached.", - "items": { + "labels": { + "additionalProperties": { "type": "string" }, + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", + "type": "object" + }, + "locations": { + "description": "Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group.", + "items": { + "$ref": "MirroringLocation" + }, + "readOnly": true, "type": "array" }, - "urlLists": { - "description": "List of UrlList resources.", + "locationsDetails": { + "deprecated": true, + "description": "Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself.", "items": { - "$ref": "UrlList" + "$ref": "MirroringEndpointGroupAssociationLocationDetails" }, + "readOnly": true, "type": "array" + }, + "mirroringEndpointGroup": { + "description": "Immutable. The endpoint group that this association is connected to, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124.", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details.", + "type": "string" + }, + "network": { + "description": "Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124.", + "type": "string" + }, + "reconciling": { + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. Current state of the endpoint group association.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "CLOSED", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "Not set.", + "The association is ready and in sync with the linked endpoint group.", + "The association is being created.", + "The association is being deleted.", + "The association is disabled due to a breaking change in another resource.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. Check the `locations_details` field for more details.", + "An attempt to delete the association has failed. This is a terminal state and the association is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the association." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "Location": { - "description": "A resource that represents a Google Cloud location.", - "id": "Location", + "MirroringEndpointGroupAssociationDetails": { + "description": "The endpoint group's view of a connected association.", + "id": "MirroringEndpointGroupAssociationDetails", "properties": { - "displayName": { - "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "name": { + "description": "Output only. The connected association's resource name, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124.", + "readOnly": true, "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\"`.", + "network": { + "description": "Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124.", + "readOnly": true, "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" + "state": { + "description": "Output only. Most recent known state of the association.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "CLOSED", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "Not set.", + "The association is ready and in sync with the linked endpoint group.", + "The association is being created.", + "The association is being deleted.", + "The association is disabled due to a breaking change in another resource.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. Check the `locations_details` field for more details.", + "An attempt to delete the association has failed. This is a terminal state and the association is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the association." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringEndpointGroupAssociationLocationDetails": { + "description": "Contains details about the state of an association in a specific cloud location.", + "id": "MirroringEndpointGroupAssociationLocationDetails", + "properties": { + "location": { + "description": "Output only. The cloud location, e.g. \"us-central1-a\" or \"asia-south1\".", + "readOnly": true, + "type": "string" }, - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "state": { + "description": "Output only. The current state of the association in this location.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "OUT_OF_SYNC" + ], + "enumDescriptions": [ + "Not set.", + "The association is ready and in sync with the linked endpoint group.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically." + ], + "readOnly": true, "type": "string" } }, "type": "object" }, - "MTLSPolicy": { - "description": "Specification of the MTLSPolicy.", - "id": "MTLSPolicy", + "MirroringEndpointGroupConnectedDeploymentGroup": { + "description": "The endpoint group's view of a connected deployment group.", + "id": "MirroringEndpointGroupConnectedDeploymentGroup", "properties": { - "clientValidationCa": { - "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.", + "locations": { + "description": "Output only. The list of locations where the deployment group is present.", "items": { - "$ref": "ValidationCA" + "$ref": "MirroringLocation" }, + "readOnly": true, "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 Application Load Balancers. For Traffic Director it must be empty.", + "name": { + "description": "Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringLocation": { + "description": "Details about mirroring in a specific cloud location.", + "id": "MirroringLocation", + "properties": { + "location": { + "description": "Output only. The cloud location, e.g. \"us-central1-a\" or \"asia-south1\".", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the association in this location.", "enum": [ - "CLIENT_VALIDATION_MODE_UNSPECIFIED", - "ALLOW_INVALID_OR_MISSING_CLIENT_CERT", - "REJECT_INVALID" + "STATE_UNSPECIFIED", + "ACTIVE", + "OUT_OF_SYNC" ], "enumDescriptions": [ - "Not allowed.", - "Allow connection even if certificate chain validation of the client certificate failed or no client certificate was presented. The proof of possession of the private key is always checked if client certificate was presented. This mode requires the backend to implement processing of data extracted from a client certificate to authenticate the peer, or to reject connections if the client certificate fingerprint is missing.", - "Require a client certificate and allow connection to the backend only if validation of the client certificate passed. If set, requires a reference to non-empty TrustConfig specified in `client_validation_trust_config`." + "State not set (this is not a valid state).", + "The resource is ready and in sync in the location.", + "The resource is out of sync in the location. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically." ], - "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 Application Load Balancers.", + "readOnly": true, "type": "string" } }, @@ -5157,6 +6529,12 @@ "description": "Optional. Reference to a SecurityProfile with the CustomMirroring configuration.", "type": "string" }, + "dataPathId": { + "description": "Output only. Identifier used by the data-path. Unique within {container, location}.", + "format": "uint64", + "readOnly": true, + "type": "string" + }, "description": { "description": "Optional. An optional description of the profile group. Max length 2048 characters.", "type": "string" @@ -5383,6 +6761,13 @@ "description": "ThreatPreventionProfile defines an action for specific threat signatures or severity levels.", "id": "ThreatPreventionProfile", "properties": { + "antivirusOverrides": { + "description": "Optional. Configuration for overriding antivirus actions per protocol.", + "items": { + "$ref": "AntivirusOverride" + }, + "type": "array" + }, "severityOverrides": { "description": "Optional. Configuration for overriding threats actions by severity match.", "items": { diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 27e9c0a3b8e..90d8e6a9b67 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -286,6 +286,11 @@ "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+parent}/addressGroups", @@ -1314,6 +1319,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+parent}/addressGroups", @@ -1998,6 +2008,168 @@ } } }, + "backendAuthenticationConfigs": { + "methods": { + "create": { + "description": "Creates a new BackendAuthenticationConfig in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.backendAuthenticationConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "backendAuthenticationConfigId": { + "description": "Required. Short name of the BackendAuthenticationConfig resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"backend-auth-config\".", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the BackendAuthenticationConfig. Must be in the format `projects/*/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/backendAuthenticationConfigs", + "request": { + "$ref": "BackendAuthenticationConfig" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs/{backendAuthenticationConfigsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.backendAuthenticationConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. A name of the BackendAuthenticationConfig to delete. Must be in the format `projects/*/locations/{location}/backendAuthenticationConfigs/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backendAuthenticationConfigs/[^/]+$", + "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 BackendAuthenticationConfig to BackendAuthenticationConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs/{backendAuthenticationConfigsId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.backendAuthenticationConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the BackendAuthenticationConfig to get. Must be in the format `projects/*/locations/{location}/backendAuthenticationConfigs/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backendAuthenticationConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "BackendAuthenticationConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BackendAuthenticationConfigs in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.backendAuthenticationConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of BackendAuthenticationConfigs to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListBackendAuthenticationConfigsResponse` Indicates that this is a continuation of a prior `ListBackendAuthenticationConfigs` 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 BackendAuthenticationConfigs should be listed, specified in the format `projects/*/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/backendAuthenticationConfigs", + "response": { + "$ref": "ListBackendAuthenticationConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs/{backendAuthenticationConfigsId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.backendAuthenticationConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backendAuthenticationConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the BackendAuthenticationConfig 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": "BackendAuthenticationConfig" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "clientTlsPolicies": { "methods": { "create": { @@ -2743,7 +2915,7 @@ "interceptDeploymentGroups": { "methods": { "create": { - "description": "Creates a new InterceptDeploymentGroup in a given project and location.", + "description": "Creates a deployment group in a given project and location. See https://google.aip.dev/133.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups", "httpMethod": "POST", "id": "networksecurity.projects.locations.interceptDeploymentGroups.create", @@ -2752,19 +2924,19 @@ ], "parameters": { "interceptDeploymentGroupId": { - "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and intercept_deployment_group_id from the method_signature of Create RPC", + "description": "Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -2781,7 +2953,7 @@ ] }, "delete": { - "description": "Deletes a single InterceptDeploymentGroup.", + "description": "Deletes a deployment group. See https://google.aip.dev/135.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups/{interceptDeploymentGroupsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.interceptDeploymentGroups.delete", @@ -2790,14 +2962,14 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The deployment group to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeploymentGroups/[^/]+$", "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).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -2811,7 +2983,7 @@ ] }, "get": { - "description": "Gets details of a single InterceptDeploymentGroup.", + "description": "Gets a specific deployment group. See https://google.aip.dev/131.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups/{interceptDeploymentGroupsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.interceptDeploymentGroups.get", @@ -2820,7 +2992,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/interceptDeploymentGroups/{intercept_deployment_group}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeploymentGroups/[^/]+$", "required": true, @@ -2836,7 +3008,7 @@ ] }, "list": { - "description": "Lists InterceptDeploymentGroups in a given project and location.", + "description": "Lists deployment groups in a given project and location. See https://google.aip.dev/132.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups", "httpMethod": "GET", "id": "networksecurity.projects.locations.interceptDeploymentGroups.list", @@ -2845,28 +3017,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", "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.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListInterceptDeploymentGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptDeploymentGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListInterceptDeploymentGroupsRequest", + "description": "Required. The parent, which owns this collection of deployment groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2882,7 +3054,7 @@ ] }, "patch": { - "description": "Updates a single InterceptDeploymentGroup.", + "description": "Updates a deployment group. See https://google.aip.dev/134.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups/{interceptDeploymentGroupsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.interceptDeploymentGroups.patch", @@ -2891,19 +3063,19 @@ ], "parameters": { "name": { - "description": "Immutable. Identifier. Then name of the InterceptDeploymentGroup.", + "description": "Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeploymentGroups/[^/]+$", "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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the InterceptDeploymentGroup 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. `description`; *not* `intercept_deployment_group.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2925,7 +3097,7 @@ "interceptDeployments": { "methods": { "create": { - "description": "Creates a new InterceptDeployment in a given project and location.", + "description": "Creates a deployment in a given project and location. See https://google.aip.dev/133.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeployments", "httpMethod": "POST", "id": "networksecurity.projects.locations.interceptDeployments.create", @@ -2934,19 +3106,19 @@ ], "parameters": { "interceptDeploymentId": { - "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and intercept_deployment_id from the method_signature of Create RPC", + "description": "Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. The parent resource where this deployment will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -2963,7 +3135,7 @@ ] }, "delete": { - "description": "Deletes a single InterceptDeployment.", + "description": "Deletes a deployment. See https://google.aip.dev/135.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeployments/{interceptDeploymentsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.interceptDeployments.delete", @@ -2979,7 +3151,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -2993,7 +3165,7 @@ ] }, "get": { - "description": "Gets details of a single InterceptDeployment.", + "description": "Gets a specific deployment. See https://google.aip.dev/131.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeployments/{interceptDeploymentsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.interceptDeployments.get", @@ -3002,7 +3174,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeployments/[^/]+$", "required": true, @@ -3018,7 +3190,7 @@ ] }, "list": { - "description": "Lists InterceptDeployments in a given project and location.", + "description": "Lists deployments in a given project and location. See https://google.aip.dev/132.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeployments", "httpMethod": "GET", "id": "networksecurity.projects.locations.interceptDeployments.list", @@ -3027,28 +3199,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", "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.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListInterceptDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptDeployments` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListInterceptDeploymentsRequest", + "description": "Required. The parent, which owns this collection of deployments. Example: `projects/123456789/locations/us-central1-a`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3064,7 +3236,7 @@ ] }, "patch": { - "description": "Updates a single InterceptDeployment.", + "description": "Updates a deployment. See https://google.aip.dev/134.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptDeployments/{interceptDeploymentsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.interceptDeployments.patch", @@ -3073,19 +3245,19 @@ ], "parameters": { "name": { - "description": "Immutable. Identifier. The name of the InterceptDeployment.", + "description": "Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/interceptDeployments/my-dep`. See https://google.aip.dev/122 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptDeployments/[^/]+$", "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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the InterceptDeployment 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the deployment (e.g. `description`; *not* `intercept_deployment.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3107,7 +3279,7 @@ "interceptEndpointGroupAssociations": { "methods": { "create": { - "description": "Creates a new InterceptEndpointGroupAssociation in a given project and location.", + "description": "Creates an association in a given project and location. See https://google.aip.dev/133.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations", "httpMethod": "POST", "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.create", @@ -3116,19 +3288,19 @@ ], "parameters": { "interceptEndpointGroupAssociationId": { - "description": "Optional. Id of the requesting object If auto-generating Id server-side, remove this field and intercept_endpoint_group_association_id from the method_signature of Create RPC", + "description": "Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. The parent resource where this association will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3145,7 +3317,7 @@ ] }, "delete": { - "description": "Deletes a single InterceptEndpointGroupAssociation.", + "description": "Deletes an association. See https://google.aip.dev/135.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociationsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.delete", @@ -3154,14 +3326,14 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The association to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroupAssociations/[^/]+$", "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).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3175,7 +3347,7 @@ ] }, "get": { - "description": "Gets details of a single InterceptEndpointGroupAssociation.", + "description": "Gets a specific association. See https://google.aip.dev/131.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociationsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.get", @@ -3184,7 +3356,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The name of the association to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroupAssociations/{intercept_endpoint_group_association}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroupAssociations/[^/]+$", "required": true, @@ -3200,7 +3372,7 @@ ] }, "list": { - "description": "Lists InterceptEndpointGroupAssociations in a given project and location.", + "description": "Lists associations in a given project and location. See https://google.aip.dev/132.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations", "httpMethod": "GET", "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.list", @@ -3209,28 +3381,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", "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.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListInterceptEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListInterceptEndpointGroupAssociationsRequest", + "description": "Required. The parent, which owns this collection of associations. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3246,7 +3418,7 @@ ] }, "patch": { - "description": "Updates a single InterceptEndpointGroupAssociation.", + "description": "Updates an association. See https://google.aip.dev/134.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociationsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.interceptEndpointGroupAssociations.patch", @@ -3255,19 +3427,19 @@ ], "parameters": { "name": { - "description": "Immutable. Identifier. The name of the InterceptEndpointGroupAssociation.", + "description": "Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroupAssociations/[^/]+$", "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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the InterceptEndpointGroupAssociation 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the association (e.g. `description`; *not* `intercept_endpoint_group_association.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3289,7 +3461,7 @@ "interceptEndpointGroups": { "methods": { "create": { - "description": "Creates a new InterceptEndpointGroup in a given project and location.", + "description": "Creates an endpoint group in a given project and location. See https://google.aip.dev/133.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups", "httpMethod": "POST", "id": "networksecurity.projects.locations.interceptEndpointGroups.create", @@ -3298,19 +3470,19 @@ ], "parameters": { "interceptEndpointGroupId": { - "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and intercept_endpoint_group_id from the method_signature of Create RPC", + "description": "Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3327,7 +3499,7 @@ ] }, "delete": { - "description": "Deletes a single InterceptEndpointGroup.", + "description": "Deletes an endpoint group. See https://google.aip.dev/135.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups/{interceptEndpointGroupsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.interceptEndpointGroups.delete", @@ -3336,14 +3508,14 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The endpoint group to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroups/[^/]+$", "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).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3357,7 +3529,7 @@ ] }, "get": { - "description": "Gets details of a single InterceptEndpointGroup.", + "description": "Gets a specific endpoint group. See https://google.aip.dev/131.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups/{interceptEndpointGroupsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.interceptEndpointGroups.get", @@ -3366,7 +3538,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroups/{intercept_endpoint_group}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroups/[^/]+$", "required": true, @@ -3382,7 +3554,7 @@ ] }, "list": { - "description": "Lists InterceptEndpointGroups in a given project and location.", + "description": "Lists endpoint groups in a given project and location. See https://google.aip.dev/132.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups", "httpMethod": "GET", "id": "networksecurity.projects.locations.interceptEndpointGroups.list", @@ -3391,28 +3563,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", "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.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListInterceptEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListInterceptEndpointGroupsRequest", + "description": "Required. The parent, which owns this collection of endpoint groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3428,7 +3600,7 @@ ] }, "patch": { - "description": "Updates a single InterceptEndpointGroup.", + "description": "Updates an endpoint group. See https://google.aip.dev/134.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups/{interceptEndpointGroupsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.interceptEndpointGroups.patch", @@ -3437,19 +3609,19 @@ ], "parameters": { "name": { - "description": "Immutable. Identifier. The name of the InterceptEndpointGroup.", + "description": "Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interceptEndpointGroups/[^/]+$", "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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the InterceptEndpointGroup 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the endpoint group (e.g. `description`; *not* `intercept_endpoint_group.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3471,7 +3643,7 @@ "mirroringDeploymentGroups": { "methods": { "create": { - "description": "Creates a new MirroringDeploymentGroup in a given project and location.", + "description": "Creates a deployment group in a given project and location. See https://google.aip.dev/133.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", "httpMethod": "POST", "id": "networksecurity.projects.locations.mirroringDeploymentGroups.create", @@ -3480,19 +3652,19 @@ ], "parameters": { "mirroringDeploymentGroupId": { - "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_group_id from the method_signature of Create RPC", + "description": "Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3509,7 +3681,7 @@ ] }, "delete": { - "description": "Deletes a single MirroringDeploymentGroup.", + "description": "Deletes a deployment group. See https://google.aip.dev/135.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.mirroringDeploymentGroups.delete", @@ -3518,14 +3690,14 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The deployment group to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", "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).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3539,7 +3711,7 @@ ] }, "get": { - "description": "Gets details of a single MirroringDeploymentGroup.", + "description": "Gets a specific deployment group. See https://google.aip.dev/131.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.mirroringDeploymentGroups.get", @@ -3548,7 +3720,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/mirroringDeploymentGroups/{mirroring_deployment_group}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", "required": true, @@ -3564,7 +3736,7 @@ ] }, "list": { - "description": "Lists MirroringDeploymentGroups in a given project and location.", + "description": "Lists deployment groups in a given project and location. See https://google.aip.dev/132.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", "httpMethod": "GET", "id": "networksecurity.projects.locations.mirroringDeploymentGroups.list", @@ -3573,28 +3745,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", "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.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListMirroringDeploymentGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringDeploymentGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListMirroringDeploymentGroupsRequest", + "description": "Required. The parent, which owns this collection of deployment groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3610,7 +3782,7 @@ ] }, "patch": { - "description": "Updates a single MirroringDeploymentGroup.", + "description": "Updates a deployment group. See https://google.aip.dev/134.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.mirroringDeploymentGroups.patch", @@ -3619,19 +3791,19 @@ ], "parameters": { "name": { - "description": "Immutable. Identifier. Then name of the MirroringDeploymentGroup.", + "description": "Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", "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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringDeploymentGroup 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. `description`; *not* `mirroring_deployment_group.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3653,7 +3825,7 @@ "mirroringDeployments": { "methods": { "create": { - "description": "Creates a new MirroringDeployment in a given project and location.", + "description": "Creates a deployment in a given project and location. See https://google.aip.dev/133.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", "httpMethod": "POST", "id": "networksecurity.projects.locations.mirroringDeployments.create", @@ -3662,19 +3834,19 @@ ], "parameters": { "mirroringDeploymentId": { - "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC", + "description": "Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. The parent resource where this deployment will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3691,7 +3863,7 @@ ] }, "delete": { - "description": "Deletes a single MirroringDeployment.", + "description": "Deletes a deployment. See https://google.aip.dev/135.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.mirroringDeployments.delete", @@ -3707,7 +3879,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3721,7 +3893,7 @@ ] }, "get": { - "description": "Gets details of a single MirroringDeployment.", + "description": "Gets a specific deployment. See https://google.aip.dev/131.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.mirroringDeployments.get", @@ -3730,7 +3902,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", "required": true, @@ -3746,7 +3918,7 @@ ] }, "list": { - "description": "Lists MirroringDeployments in a given project and location.", + "description": "Lists deployments in a given project and location. See https://google.aip.dev/132.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", "httpMethod": "GET", "id": "networksecurity.projects.locations.mirroringDeployments.list", @@ -3755,28 +3927,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", "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.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListMirroringDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringDeployments` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListMirroringDeploymentsRequest", + "description": "Required. The parent, which owns this collection of deployments. Example: `projects/123456789/locations/us-central1-a`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3792,7 +3964,7 @@ ] }, "patch": { - "description": "Updates a single MirroringDeployment.", + "description": "Updates a deployment. See https://google.aip.dev/134.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.mirroringDeployments.patch", @@ -3801,19 +3973,19 @@ ], "parameters": { "name": { - "description": "Immutable. Identifier. The name of the MirroringDeployment.", + "description": "Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", "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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringDeployment 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the deployment (e.g. `description`; *not* `mirroring_deployment.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3835,7 +4007,7 @@ "mirroringEndpointGroupAssociations": { "methods": { "create": { - "description": "Creates a new MirroringEndpointGroupAssociation in a given project and location.", + "description": "Creates an association in a given project and location. See https://google.aip.dev/133.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", "httpMethod": "POST", "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.create", @@ -3844,19 +4016,19 @@ ], "parameters": { "mirroringEndpointGroupAssociationId": { - "description": "Optional. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_association_id from the method_signature of Create RPC", + "description": "Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. The parent resource where this association will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3873,7 +4045,7 @@ ] }, "delete": { - "description": "Deletes a single MirroringEndpointGroupAssociation.", + "description": "Deletes an association. See https://google.aip.dev/135.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.delete", @@ -3882,14 +4054,14 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The association to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", "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).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -3903,7 +4075,7 @@ ] }, "get": { - "description": "Gets details of a single MirroringEndpointGroupAssociation.", + "description": "Gets a specific association. See https://google.aip.dev/131.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.get", @@ -3912,7 +4084,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The name of the association to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroupAssociations/{mirroring_endpoint_group_association}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", "required": true, @@ -3928,7 +4100,7 @@ ] }, "list": { - "description": "Lists MirroringEndpointGroupAssociations in a given project and location.", + "description": "Lists associations in a given project and location. See https://google.aip.dev/132.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", "httpMethod": "GET", "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.list", @@ -3937,28 +4109,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", "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.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListMirroringEndpointGroupAssociationsRequest", + "description": "Required. The parent, which owns this collection of associations. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3974,7 +4146,7 @@ ] }, "patch": { - "description": "Updates a single MirroringEndpointGroupAssociation.", + "description": "Updates an association. See https://google.aip.dev/134.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.patch", @@ -3983,19 +4155,19 @@ ], "parameters": { "name": { - "description": "Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.", + "description": "Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", "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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringEndpointGroupAssociation 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the association (e.g. `description`; *not* `mirroring_endpoint_group_association.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4017,7 +4189,7 @@ "mirroringEndpointGroups": { "methods": { "create": { - "description": "Creates a new MirroringEndpointGroup in a given project and location.", + "description": "Creates an endpoint group in a given project and location. See https://google.aip.dev/133.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", "httpMethod": "POST", "id": "networksecurity.projects.locations.mirroringEndpointGroups.create", @@ -4026,19 +4198,19 @@ ], "parameters": { "mirroringEndpointGroupId": { - "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_id from the method_signature of Create RPC", + "description": "Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Value for parent.", + "description": "Required. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -4055,7 +4227,7 @@ ] }, "delete": { - "description": "Deletes a single MirroringEndpointGroup.", + "description": "Deletes an endpoint group. See https://google.aip.dev/135.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.mirroringEndpointGroups.delete", @@ -4064,14 +4236,14 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The endpoint group to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", "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).", + "description": "Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" } @@ -4085,7 +4257,7 @@ ] }, "get": { - "description": "Gets details of a single MirroringEndpointGroup.", + "description": "Gets a specific endpoint group. See https://google.aip.dev/131.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.mirroringEndpointGroups.get", @@ -4094,7 +4266,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroring_endpoint_group}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", "required": true, @@ -4110,7 +4282,7 @@ ] }, "list": { - "description": "Lists MirroringEndpointGroups in a given project and location.", + "description": "Lists endpoint groups in a given project and location. See https://google.aip.dev/132.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", "httpMethod": "GET", "id": "networksecurity.projects.locations.mirroringEndpointGroups.list", @@ -4119,28 +4291,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filtering results", + "description": "Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results", + "description": "Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.", "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.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Parent value for ListMirroringEndpointGroupsRequest", + "description": "Required. The parent, which owns this collection of endpoint groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4156,7 +4328,7 @@ ] }, "patch": { - "description": "Updates a single MirroringEndpointGroup.", + "description": "Updates an endpoint group. See https://google.aip.dev/134.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", "httpMethod": "PATCH", "id": "networksecurity.projects.locations.mirroringEndpointGroups.patch", @@ -4165,19 +4337,19 @@ ], "parameters": { "name": { - "description": "Immutable. Identifier. Next ID: 11 The name of the MirroringEndpointGroup.", + "description": "Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", "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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details.", "location": "query", "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringEndpointGroup 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.", + "description": "Optional. The list of fields to update. Fields are specified relative to the endpoint group (e.g. `description`; *not* `mirroring_endpoint_group.description`). See https://google.aip.dev/161 for more details.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4461,6 +4633,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. Setting this field to `true` will opt the request into returning the resources that are reachable, and into including the names of those that were unreachable in the [ListServerTlsPoliciesResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+parent}/serverTlsPolicies", @@ -4887,7 +5064,7 @@ } } }, - "revision": "20250118", + "revision": "20250310", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -4990,6 +5167,55 @@ }, "type": "object" }, + "AntivirusOverride": { + "description": "Defines what action to take for antivirus threats per protocol.", + "id": "AntivirusOverride", + "properties": { + "action": { + "description": "Required. Threat action override. For some threat types, only a subset of actions applies.", + "enum": [ + "THREAT_ACTION_UNSPECIFIED", + "DEFAULT_ACTION", + "ALLOW", + "ALERT", + "DENY" + ], + "enumDescriptions": [ + "Threat action not specified.", + "The default action (as specified by the vendor) is taken.", + "The packet matching this rule will be allowed to transmit.", + "The packet matching this rule will be allowed to transmit, but a threat_log entry will be sent to the consumer project.", + "The packet matching this rule will be dropped, and a threat_log entry will be sent to the consumer project." + ], + "type": "string" + }, + "protocol": { + "description": "Required. Protocol to match.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "SMTP", + "SMB", + "POP3", + "IMAP", + "HTTP2", + "HTTP", + "FTP" + ], + "enumDescriptions": [ + "Protocol not specified.", + "SMTP prtocol", + "SMB protocol", + "POP3 protocol", + "IMAP protocol", + "HTTP2 protocol", + "HTTP protocol", + "FTP protocol" + ], + "type": "string" + } + }, + "type": "object" + }, "AuthorizationPolicy": { "description": "AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource.", "id": "AuthorizationPolicy", @@ -5155,7 +5381,7 @@ "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 5 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. For Application Load Balancers, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or SPIFFE ID, or the subject field in the client's certificate. For Cloud Service Mesh, 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 5 principals.", "items": { "$ref": "AuthzPolicyAuthzRuleStringMatch" }, @@ -5375,30 +5601,13 @@ }, "type": "object" }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, - "type": "object" - }, - "CertificateProviderInstance": { - "description": "Specification of a TLS certificate provider instance. Workloads may have one or more CertificateProvider instances (plugins) and one of them is enabled and configured by specifying this message. Workloads use the values from this message to locate and load the CertificateProvider instance configuration.", - "id": "CertificateProviderInstance", - "properties": { - "pluginInstance": { - "description": "Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to \"google_cloud_private_spiffe\" to use Certificate Authority Service certificate provider instance.", - "type": "string" - } - }, - "type": "object" - }, - "ClientTlsPolicy": { - "description": "ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.", - "id": "ClientTlsPolicy", + "BackendAuthenticationConfig": { + "description": "BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS.", + "id": "BackendAuthenticationConfig", "properties": { "clientCertificate": { - "$ref": "GoogleCloudNetworksecurityV1beta1CertificateProvider", - "description": "Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS." + "description": "Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form \"projects/{project}/locations/{location}/certificates/{certificate}\". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.", + "type": "string" }, "createTime": { "description": "Output only. The timestamp when the resource was created.", @@ -5410,18 +5619,96 @@ "description": "Optional. Free-text description of the resource.", "type": "string" }, + "etag": { + "description": "Output only. Etag of the resource.", + "readOnly": true, + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Set of label tags associated with the resource.", + "description": "Set of label tags associated with the resource.", "type": "object" }, "name": { - "description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`", + "description": "Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`", "type": "string" }, - "serverValidationCa": { + "trustConfig": { + "description": "Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form \"projects/{project}/locations/{location}/trustConfigs/{trust_config}\". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "wellKnownRoots": { + "description": "Well known roots to use for server certificate validation.", + "enum": [ + "WELL_KNOWN_ROOTS_UNSPECIFIED", + "NONE", + "PUBLIC_ROOTS" + ], + "enumDescriptions": [ + "Equivalent to NONE.", + "The BackendService will only validate server certificates against roots specified in TrustConfig.", + "The BackendService uses a set of well-known public roots, in addition to any roots specified in the trustConfig field, when validating the server certificates presented by the backend. Validation with these roots is only considered when the TlsSettings.sni field in the BackendService is set. The well-known roots are a set of root CAs managed by Google. CAs in this set can be added or removed without notice." + ], + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CertificateProviderInstance": { + "description": "Specification of a TLS certificate provider instance. Workloads may have one or more CertificateProvider instances (plugins) and one of them is enabled and configured by specifying this message. Workloads use the values from this message to locate and load the CertificateProvider instance configuration.", + "id": "CertificateProviderInstance", + "properties": { + "pluginInstance": { + "description": "Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to \"google_cloud_private_spiffe\" to use Certificate Authority Service certificate provider instance.", + "type": "string" + } + }, + "type": "object" + }, + "ClientTlsPolicy": { + "description": "ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.", + "id": "ClientTlsPolicy", + "properties": { + "clientCertificate": { + "$ref": "GoogleCloudNetworksecurityV1beta1CertificateProvider", + "description": "Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS." + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Free-text description of the resource.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of label tags associated with the resource.", + "type": "object" + }, + "name": { + "description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`", + "type": "string" + }, + "serverValidationCa": { "description": "Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.", "items": { "$ref": "ValidationCA" @@ -5457,22 +5744,22 @@ "type": "object" }, "CustomInterceptProfile": { - "description": "CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule.", + "description": "CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action.", "id": "CustomInterceptProfile", "properties": { "interceptEndpointGroup": { - "description": "Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored.", + "description": "Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group.", "type": "string" } }, "type": "object" }, "CustomMirroringProfile": { - "description": "CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup", + "description": "CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action.", "id": "CustomMirroringProfile", "properties": { "mirroringEndpointGroup": { - "description": "Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.", + "description": "Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group.", "type": "string" } }, @@ -5591,6 +5878,16 @@ "readOnly": true, "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. [Output Only] Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. [Output Only] Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. Current state of the endpoint.", "enum": [ @@ -5988,11 +6285,11 @@ "type": "object" }, "InterceptDeployment": { - "description": "Message describing InterceptDeployment object NEXT ID: 10", + "description": "A deployment represents a zonal intercept backend ready to accept GENEVE-encapsulated traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global intercept service.", "id": "InterceptDeployment", "properties": { "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6002,31 +6299,31 @@ "type": "string" }, "forwardingRule": { - "description": "Required. Immutable. The regional load balancer which the intercepted traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", + "description": "Required. Immutable. The regional forwarding rule that fronts the interceptors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124.", "type": "string" }, "interceptDeploymentGroup": { - "description": "Required. Immutable. The Intercept Deployment Group that this resource is part of. Format is: `projects/{project}/locations/global/interceptDeploymentGroups/{interceptDeploymentGroup}`", + "description": "Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", "type": "object" }, "name": { - "description": "Immutable. Identifier. The name of the InterceptDeployment.", + "description": "Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/interceptDeployments/my-dep`. See https://google.aip.dev/122 for more details.", "type": "string" }, "reconciling": { - "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.", "readOnly": true, "type": "boolean" }, "state": { - "description": "Output only. Current state of the deployment.", + "description": "Output only. The current state of the deployment. See https://google.aip.dev/216.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -6036,18 +6333,18 @@ "DELETE_FAILED" ], "enumDescriptions": [ - "Not set.", - "Ready.", - "Being created.", - "Being deleted.", - "The underlying data plane is out of sync with the deployment. The deployment is not expected to be usable. This state can result in undefined behavior.", - "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the deployment." + "State not set (this is not a valid state).", + "The deployment is ready and in sync with the parent group.", + "The deployment is being created.", + "The deployment is being deleted.", + "The deployment is out of sync with the parent group. In most cases, this is a result of a transient issue within the system (e.g. a delayed data-path config) and the system is expected to recover automatically. See the parent deployment group's state for more details.", + "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to recover. The only permitted operation is to retry deleting the deployment." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6056,11 +6353,11 @@ "type": "object" }, "InterceptDeploymentGroup": { - "description": "Message describing InterceptDeploymentGroup object NEXT ID: 10", + "description": "A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.", "id": "InterceptDeploymentGroup", "properties": { "connectedEndpointGroups": { - "description": "Output only. The list of Intercept Endpoint Groups that are connected to this resource.", + "description": "Output only. The list of endpoint groups that are connected to this resource.", "items": { "$ref": "InterceptDeploymentGroupConnectedEndpointGroup" }, @@ -6068,7 +6365,7 @@ "type": "array" }, "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6081,24 +6378,41 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", "type": "object" }, + "locations": { + "description": "Output only. The list of locations where the deployment group is present.", + "items": { + "$ref": "InterceptLocation" + }, + "readOnly": true, + "type": "array" + }, "name": { - "description": "Immutable. Identifier. Then name of the InterceptDeploymentGroup.", + "description": "Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.", "type": "string" }, + "nestedDeployments": { + "deprecated": true, + "description": "Output only. The list of Intercept Deployments that belong to this group.", + "items": { + "$ref": "InterceptDeploymentGroupDeployment" + }, + "readOnly": true, + "type": "array" + }, "network": { - "description": "Required. Immutable. The network that is being used for the deployment. Format is: projects/{project}/global/networks/{network}.", + "description": "Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project}/global/networks/{network}`. See https://google.aip.dev/124.", "type": "string" }, "reconciling": { - "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.", "readOnly": true, "type": "boolean" }, "state": { - "description": "Output only. Current state of the deployment group.", + "description": "Output only. The current state of the deployment group. See https://google.aip.dev/216.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -6106,16 +6420,16 @@ "DELETING" ], "enumDescriptions": [ - "Not set.", - "Ready.", - "Being created.", - "Being deleted." + "State not set (this is not a valid state).", + "The deployment group is ready.", + "The deployment group is being created.", + "The deployment group is being deleted." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6128,7 +6442,40 @@ "id": "InterceptDeploymentGroupConnectedEndpointGroup", "properties": { "name": { - "description": "Output only. A connected intercept endpoint group.", + "description": "Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/124.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InterceptDeploymentGroupDeployment": { + "description": "A deployment belonging to this deployment group.", + "id": "InterceptDeploymentGroupDeployment", + "properties": { + "name": { + "description": "Output only. The name of the Intercept Deployment, in the format: `projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}`.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. Most recent known state of the deployment.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "State not set (this is not a valid state).", + "The deployment is ready and in sync with the parent group.", + "The deployment is being created.", + "The deployment is being deleted.", + "The deployment is out of sync with the parent group. In most cases, this is a result of a transient issue within the system (e.g. a delayed data-path config) and the system is expected to recover automatically. See the parent deployment group's state for more details.", + "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to recover. The only permitted operation is to retry deleting the deployment." + ], "readOnly": true, "type": "string" } @@ -6136,19 +6483,24 @@ "type": "object" }, "InterceptEndpointGroup": { - "description": "Message describing InterceptEndpointGroup object.", + "description": "An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group).", "id": "InterceptEndpointGroup", "properties": { "associations": { - "description": "Output only. List of Intercept Endpoint Group Associations that are associated to this endpoint group.", + "description": "Output only. List of associations to this endpoint group.", "items": { "$ref": "InterceptEndpointGroupAssociationDetails" }, "readOnly": true, "type": "array" }, + "connectedDeploymentGroup": { + "$ref": "InterceptEndpointGroupConnectedDeploymentGroup", + "description": "Output only. Details about the connected deployment group to this endpoint group.", + "readOnly": true + }, "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6158,27 +6510,27 @@ "type": "string" }, "interceptDeploymentGroup": { - "description": "Required. Immutable. The Intercept Deployment Group that this resource is connected to. Format is: `projects/{project}/locations/global/interceptDeploymentGroups/{interceptDeploymentGroup}`", + "description": "Required. Immutable. The deployment group that this endpoint group is connected to, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", "type": "object" }, "name": { - "description": "Immutable. Identifier. The name of the InterceptEndpointGroup.", + "description": "Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.", "type": "string" }, "reconciling": { - "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.", "readOnly": true, "type": "boolean" }, "state": { - "description": "Output only. Current state of the endpoint group.", + "description": "Output only. The current state of the endpoint group. See https://google.aip.dev/216.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -6189,19 +6541,19 @@ "DELETE_FAILED" ], "enumDescriptions": [ - "Not set.", - "Ready.", - "The deployment group has been deleted and intercept is disabled.", - "Being created.", - "Being deleted.", - "The underlying data plane is out of sync with the endpoint group. Some associations might not be usable.", - "An attempt to delete the endpoint group has failed. This is a terminal state and the endpoint group is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the endpoint group." + "State not set (this is not a valid state).", + "The endpoint group is ready and in sync with the target deployment group.", + "The deployment group backing this endpoint group has been force-deleted. This endpoint group cannot be used and interception is effectively disabled.", + "The endpoint group is being created.", + "The endpoint group is being deleted.", + "The endpoint group is out of sync with the backing deployment group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. See the associations field for details per network and location.", + "An attempt to delete the endpoint group has failed. This is a terminal state and the endpoint group is not expected to recover. The only permitted operation is to retry deleting the endpoint group." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6210,28 +6562,37 @@ "type": "object" }, "InterceptEndpointGroupAssociation": { - "description": "Message describing InterceptEndpointGroupAssociation object", + "description": "An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable intercept by itself. To enable intercept, the user must also create a network firewall policy containing intercept rules and associate it with the network.", "id": "InterceptEndpointGroupAssociation", "properties": { "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" }, "interceptEndpointGroup": { - "description": "Required. Immutable. The Intercept Endpoint Group that this resource is connected to. Format is: `projects/{project}/locations/global/interceptEndpointGroups/{interceptEndpointGroup}`", + "description": "Required. Immutable. The endpoint group that this association is connected to, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/124.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", "type": "object" }, + "locations": { + "description": "Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group.", + "items": { + "$ref": "InterceptLocation" + }, + "readOnly": true, + "type": "array" + }, "locationsDetails": { - "description": "Output only. The list of locations that this association is in and its details.", + "deprecated": true, + "description": "Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself.", "items": { "$ref": "InterceptEndpointGroupAssociationLocationDetails" }, @@ -6239,15 +6600,15 @@ "type": "array" }, "name": { - "description": "Immutable. Identifier. The name of the InterceptEndpointGroupAssociation.", + "description": "Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details.", "type": "string" }, "network": { - "description": "Required. Immutable. The VPC network associated. Format: projects/{project}/global/networks/{network}.", + "description": "Required. Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124.", "type": "string" }, "reconciling": { - "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.", "readOnly": true, "type": "boolean" }, @@ -6264,18 +6625,18 @@ ], "enumDescriptions": [ "Not set.", - "Ready.", - "Being created.", - "Being deleted.", - "Intercept is disabled due to an operation on another resource.", - "The underlying data plane is out of sync with the association. The association is not expected to be usable. This state can result in undefined behavior. See the `locations_details` field for more details.", + "The association is ready and in sync with the linked endpoint group.", + "The association is being created.", + "The association is being deleted.", + "The association is disabled due to a breaking change in another resource.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. Check the `locations_details` field for more details.", "An attempt to delete the association has failed. This is a terminal state and the association is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the association." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6284,21 +6645,21 @@ "type": "object" }, "InterceptEndpointGroupAssociationDetails": { - "description": "This is a subset of the InterceptEndpointGroupAssociation message, containing fields to be used by the consumer.", + "description": "The endpoint group's view of a connected association.", "id": "InterceptEndpointGroupAssociationDetails", "properties": { "name": { - "description": "Output only. The resource name of the InterceptEndpointGroupAssociation. Format: projects/{project}/locations/{location}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociation}", + "description": "Output only. The connected association's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124.", "readOnly": true, "type": "string" }, "network": { - "description": "Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.", + "description": "Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124.", "readOnly": true, "type": "string" }, "state": { - "description": "Output only. Current state of the association.", + "description": "Output only. Most recent known state of the association.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -6310,11 +6671,11 @@ ], "enumDescriptions": [ "Not set.", - "Ready.", - "Being created.", - "Being deleted.", - "Intercept is disabled due to an operation on another resource.", - "The underlying data plane is out of sync with the association. The association is not expected to be usable. This state can result in undefined behavior. See the `locations_details` field for more details.", + "The association is ready and in sync with the linked endpoint group.", + "The association is being created.", + "The association is being deleted.", + "The association is disabled due to a breaking change in another resource.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. Check the `locations_details` field for more details.", "An attempt to delete the association has failed. This is a terminal state and the association is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the association." ], "readOnly": true, @@ -6324,16 +6685,16 @@ "type": "object" }, "InterceptEndpointGroupAssociationLocationDetails": { - "description": "Details about the association status in a specific cloud location.", + "description": "Contains details about the state of an association in a specific cloud location.", "id": "InterceptEndpointGroupAssociationLocationDetails", "properties": { "location": { - "description": "Output only. The cloud location.", + "description": "Output only. The cloud location, e.g. \"us-central1-a\" or \"asia-south1\".", "readOnly": true, "type": "string" }, "state": { - "description": "Output only. The association state in this location.", + "description": "Output only. The current state of the association in this location.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -6341,8 +6702,55 @@ ], "enumDescriptions": [ "Not set.", - "Ready.", - "The data plane is out of sync with the association in this location." + "The association is ready and in sync with the linked endpoint group.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InterceptEndpointGroupConnectedDeploymentGroup": { + "description": "The endpoint group's view of a connected deployment group.", + "id": "InterceptEndpointGroupConnectedDeploymentGroup", + "properties": { + "locations": { + "description": "Output only. The list of locations where the deployment group is present.", + "items": { + "$ref": "InterceptLocation" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InterceptLocation": { + "description": "Details about intercept in a specific cloud location.", + "id": "InterceptLocation", + "properties": { + "location": { + "description": "Output only. The cloud location, e.g. \"us-central1-a\" or \"asia-south1\".", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the association in this location.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "OUT_OF_SYNC" + ], + "enumDescriptions": [ + "State not set (this is not a valid state).", + "The resource is ready and in sync in the location.", + "The resource is out of sync in the location. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically." ], "readOnly": true, "type": "string" @@ -6402,6 +6810,13 @@ "nextPageToken": { "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -6449,6 +6864,31 @@ }, "type": "object" }, + "ListBackendAuthenticationConfigsResponse": { + "description": "Response returned by the ListBackendAuthenticationConfigs method.", + "id": "ListBackendAuthenticationConfigsResponse", + "properties": { + "backendAuthenticationConfigs": { + "description": "List of BackendAuthenticationConfig resources.", + "items": { + "$ref": "BackendAuthenticationConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListClientTlsPoliciesResponse": { "description": "Response returned by the ListClientTlsPolicies method.", "id": "ListClientTlsPoliciesResponse", @@ -6568,36 +7008,36 @@ "type": "object" }, "ListInterceptDeploymentGroupsResponse": { - "description": "Message for response to listing InterceptDeploymentGroups", + "description": "Response message for ListInterceptDeploymentGroups.", "id": "ListInterceptDeploymentGroupsResponse", "properties": { "interceptDeploymentGroups": { - "description": "The list of InterceptDeploymentGroup", + "description": "The deployment groups from the specified parent.", "items": { "$ref": "InterceptDeploymentGroup" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "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. See https://google.aip.dev/158 for more details.", "type": "string" } }, "type": "object" }, "ListInterceptDeploymentsResponse": { - "description": "Message for response to listing InterceptDeployments", + "description": "Response message for ListInterceptDeployments.", "id": "ListInterceptDeploymentsResponse", "properties": { "interceptDeployments": { - "description": "The list of InterceptDeployment", + "description": "The deployments from the specified parent.", "items": { "$ref": "InterceptDeployment" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "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. See https://google.aip.dev/158 for more details.", "type": "string" }, "unreachable": { @@ -6611,36 +7051,36 @@ "type": "object" }, "ListInterceptEndpointGroupAssociationsResponse": { - "description": "Message for response to listing InterceptEndpointGroupAssociations", + "description": "Response message for ListInterceptEndpointGroupAssociations.", "id": "ListInterceptEndpointGroupAssociationsResponse", "properties": { "interceptEndpointGroupAssociations": { - "description": "The list of InterceptEndpointGroupAssociation", + "description": "The associations from the specified parent.", "items": { "$ref": "InterceptEndpointGroupAssociation" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "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. See https://google.aip.dev/158 for more details.", "type": "string" } }, "type": "object" }, "ListInterceptEndpointGroupsResponse": { - "description": "Message for response to listing InterceptEndpointGroups", + "description": "Response message for ListInterceptEndpointGroups.", "id": "ListInterceptEndpointGroupsResponse", "properties": { "interceptEndpointGroups": { - "description": "The list of InterceptEndpointGroup", + "description": "The endpoint groups from the specified parent.", "items": { "$ref": "InterceptEndpointGroup" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "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. See https://google.aip.dev/158 for more details.", "type": "string" } }, @@ -6665,36 +7105,36 @@ "type": "object" }, "ListMirroringDeploymentGroupsResponse": { - "description": "Message for response to listing MirroringDeploymentGroups", + "description": "Response message for ListMirroringDeploymentGroups.", "id": "ListMirroringDeploymentGroupsResponse", "properties": { "mirroringDeploymentGroups": { - "description": "The list of MirroringDeploymentGroup", + "description": "The deployment groups from the specified parent.", "items": { "$ref": "MirroringDeploymentGroup" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "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. See https://google.aip.dev/158 for more details.", "type": "string" } }, "type": "object" }, "ListMirroringDeploymentsResponse": { - "description": "Message for response to listing MirroringDeployments", + "description": "Response message for ListMirroringDeployments.", "id": "ListMirroringDeploymentsResponse", "properties": { "mirroringDeployments": { - "description": "The list of MirroringDeployment", + "description": "The deployments from the specified parent.", "items": { "$ref": "MirroringDeployment" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "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. See https://google.aip.dev/158 for more details.", "type": "string" }, "unreachable": { @@ -6708,36 +7148,36 @@ "type": "object" }, "ListMirroringEndpointGroupAssociationsResponse": { - "description": "Message for response to listing MirroringEndpointGroupAssociations", + "description": "Response message for ListMirroringEndpointGroupAssociations.", "id": "ListMirroringEndpointGroupAssociationsResponse", "properties": { "mirroringEndpointGroupAssociations": { - "description": "The list of MirroringEndpointGroupAssociation", + "description": "The associations from the specified parent.", "items": { "$ref": "MirroringEndpointGroupAssociation" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "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. See https://google.aip.dev/158 for more details.", "type": "string" } }, "type": "object" }, "ListMirroringEndpointGroupsResponse": { - "description": "Message for response to listing MirroringEndpointGroups", + "description": "Response message for ListMirroringEndpointGroups.", "id": "ListMirroringEndpointGroupsResponse", "properties": { "mirroringEndpointGroups": { - "description": "The list of MirroringEndpointGroup", + "description": "The endpoint groups from the specified parent.", "items": { "$ref": "MirroringEndpointGroup" }, "type": "array" }, "nextPageToken": { - "description": "A token identifying a page of results the server should return.", + "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. See https://google.aip.dev/158 for more details.", "type": "string" } }, @@ -6811,6 +7251,13 @@ "$ref": "ServerTlsPolicy" }, "type": "array" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request opts into `return_partial_success` and reading across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -6932,41 +7379,45 @@ "type": "object" }, "MirroringDeployment": { - "description": "Message describing MirroringDeployment object NEXT ID: 10", + "description": "A deployment represents a zonal mirroring backend ready to accept GENEVE-encapsulated replica traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global mirroring service.", "id": "MirroringDeployment", "properties": { "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" }, + "description": { + "description": "Optional. User-provided description of the deployment. Used as additional context for the deployment.", + "type": "string" + }, "forwardingRule": { - "description": "Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", + "description": "Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", "type": "object" }, "mirroringDeploymentGroup": { - "description": "Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`", + "description": "Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.", "type": "string" }, "name": { - "description": "Immutable. Identifier. The name of the MirroringDeployment.", + "description": "Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details.", "type": "string" }, "reconciling": { - "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.", "readOnly": true, "type": "boolean" }, "state": { - "description": "Output only. Current state of the deployment.", + "description": "Output only. The current state of the deployment. See https://google.aip.dev/216.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -6976,18 +7427,18 @@ "DELETE_FAILED" ], "enumDescriptions": [ - "Not set.", - "Ready.", - "Being created.", - "Being deleted.", - "The underlying data plane is out of sync with the deployment. The deployment is not expected to be usable. This state can result in undefined behavior.", - "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the deployment." + "State not set (this is not a valid state).", + "The deployment is ready and in sync with the parent group.", + "The deployment is being created.", + "The deployment is being deleted.", + "The deployment is out of sync with the parent group. In most cases, this is a result of a transient issue within the system (e.g. a delayed data-path config) and the system is expected to recover automatically. See the parent deployment group's state for more details.", + "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to recover. The only permitted operation is to retry deleting the deployment." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6996,11 +7447,11 @@ "type": "object" }, "MirroringDeploymentGroup": { - "description": "Message describing MirroringDeploymentGroup object NEXT ID: 10", + "description": "A deployment group aggregates many zonal mirroring backends (deployments) into a single global mirroring service. Consumers can connect this service using an endpoint group.", "id": "MirroringDeploymentGroup", "properties": { "connectedEndpointGroups": { - "description": "Output only. The list of Mirroring Endpoint Groups that are connected to this resource.", + "description": "Output only. The list of endpoint groups that are connected to this resource.", "items": { "$ref": "MirroringDeploymentGroupConnectedEndpointGroup" }, @@ -7008,33 +7459,54 @@ "type": "array" }, "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" }, + "description": { + "description": "Optional. User-provided description of the deployment group. Used as additional context for the deployment group.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", "type": "object" }, + "locations": { + "description": "Output only. The list of locations where the deployment group is present.", + "items": { + "$ref": "MirroringLocation" + }, + "readOnly": true, + "type": "array" + }, "name": { - "description": "Immutable. Identifier. Then name of the MirroringDeploymentGroup.", + "description": "Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details.", "type": "string" }, + "nestedDeployments": { + "deprecated": true, + "description": "Output only. The list of Mirroring Deployments that belong to this group.", + "items": { + "$ref": "MirroringDeploymentGroupDeployment" + }, + "readOnly": true, + "type": "array" + }, "network": { - "description": "Required. Immutable. The network that is being used for the deployment. Format is: projects/{project}/global/networks/{network}.", + "description": "Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project}/global/networks/{network}`. See https://google.aip.dev/124.", "type": "string" }, "reconciling": { - "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128.", "readOnly": true, "type": "boolean" }, "state": { - "description": "Output only. Current state of the deployment group.", + "description": "Output only. The current state of the deployment group. See https://google.aip.dev/216.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -7042,16 +7514,16 @@ "DELETING" ], "enumDescriptions": [ - "Not set.", - "Ready.", - "Being created.", - "Being deleted." + "State not set (this is not a valid state).", + "The deployment group is ready.", + "The deployment group is being created.", + "The deployment group is being deleted." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7064,7 +7536,40 @@ "id": "MirroringDeploymentGroupConnectedEndpointGroup", "properties": { "name": { - "description": "Output only. A connected mirroring endpoint group.", + "description": "Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringDeploymentGroupDeployment": { + "description": "A deployment belonging to this deployment group.", + "id": "MirroringDeploymentGroupDeployment", + "properties": { + "name": { + "description": "Output only. The name of the Mirroring Deployment, in the format: `projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}`.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. Most recent known state of the deployment.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "State not set (this is not a valid state).", + "The deployment is ready and in sync with the parent group.", + "The deployment is being created.", + "The deployment is being deleted.", + "The deployment is out of sync with the parent group. In most cases, this is a result of a transient issue within the system (e.g. a delayed data-path config) and the system is expected to recover automatically. See the parent deployment group's state for more details.", + "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to recover. The only permitted operation is to retry deleting the deployment." + ], "readOnly": true, "type": "string" } @@ -7072,45 +7577,57 @@ "type": "object" }, "MirroringEndpointGroup": { - "description": "Message describing MirroringEndpointGroup object.", + "description": "An endpoint group is a consumer frontend for a deployment group (backend). In order to configure mirroring for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A mirroring rule that references the security profile (group).", "id": "MirroringEndpointGroup", "properties": { "associations": { - "description": "Output only. List of Mirroring Endpoint Group Associations that are associated to this endpoint group.", + "description": "Output only. List of associations to this endpoint group.", "items": { "$ref": "MirroringEndpointGroupAssociationDetails" }, "readOnly": true, "type": "array" }, + "connectedDeploymentGroups": { + "description": "Output only. List of details about the connected deployment groups to this endpoint group.", + "items": { + "$ref": "MirroringEndpointGroupConnectedDeploymentGroup" + }, + "readOnly": true, + "type": "array" + }, "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" }, + "description": { + "description": "Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", "type": "object" }, "mirroringDeploymentGroup": { - "description": "Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`", + "description": "Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.", "type": "string" }, "name": { - "description": "Immutable. Identifier. Next ID: 11 The name of the MirroringEndpointGroup.", + "description": "Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.", "type": "string" }, "reconciling": { - "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.", "readOnly": true, "type": "boolean" }, "state": { - "description": "Output only. Current state of the endpoint group.", + "description": "Output only. The current state of the endpoint group. See https://google.aip.dev/216.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -7121,19 +7638,19 @@ "DELETE_FAILED" ], "enumDescriptions": [ - "Not set.", - "Ready.", - "The deployment group has been deleted and mirroring is disabled.", - "Being created.", - "Being deleted.", - "The underlying data plane is out of sync with the endpoint group. Some associations might not be usable.", - "An attempt to delete the endpoint group has failed. This is a terminal state and the endpoint group is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the endpoint group." + "State not set (this is not a valid state).", + "The endpoint group is ready and in sync with the target deployment group.", + "The deployment group backing this endpoint group has been force-deleted. This endpoint group cannot be used and mirroring is effectively disabled.", + "The endpoint group is being created.", + "The endpoint group is being deleted.", + "The endpoint group is out of sync with the backing deployment group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. See the associations field for details per network and location.", + "An attempt to delete the endpoint group has failed. This is a terminal state and the endpoint group is not expected to recover. The only permitted operation is to retry deleting the endpoint group." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7142,11 +7659,11 @@ "type": "object" }, "MirroringEndpointGroupAssociation": { - "description": "Message describing MirroringEndpointGroupAssociation object", + "description": "An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable mirroring by itself. To enable mirroring, the user must also create a network firewall policy containing mirroring rules and associate it with the network.", "id": "MirroringEndpointGroupAssociation", "properties": { "createTime": { - "description": "Output only. [Output only] Create time stamp", + "description": "Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7155,11 +7672,20 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Labels as key value pairs", + "description": "Optional. Labels are key/value pairs that help to organize and filter resources.", "type": "object" }, + "locations": { + "description": "Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group.", + "items": { + "$ref": "MirroringLocation" + }, + "readOnly": true, + "type": "array" + }, "locationsDetails": { - "description": "Output only. The list of locations that this association is in and its details.", + "deprecated": true, + "description": "Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself.", "items": { "$ref": "MirroringEndpointGroupAssociationLocationDetails" }, @@ -7167,19 +7693,19 @@ "type": "array" }, "mirroringEndpointGroup": { - "description": "Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup}`", + "description": "Immutable. The endpoint group that this association is connected to, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124.", "type": "string" }, "name": { - "description": "Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.", + "description": "Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details.", "type": "string" }, "network": { - "description": "Required. Immutable. The VPC network associated. Format: projects/{project}/global/networks/{network}.", + "description": "Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124.", "type": "string" }, "reconciling": { - "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "description": "Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.", "readOnly": true, "type": "boolean" }, @@ -7196,18 +7722,18 @@ ], "enumDescriptions": [ "Not set.", - "Ready.", - "Being created.", - "Being deleted.", - "Mirroring is disabled due to an operation on another resource.", - "The underlying data plane is out of sync with the association. The association is not expected to be usable. This state can result in undefined behavior. See the `locations_details` field for more details.", + "The association is ready and in sync with the linked endpoint group.", + "The association is being created.", + "The association is being deleted.", + "The association is disabled due to a breaking change in another resource.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. Check the `locations_details` field for more details.", "An attempt to delete the association has failed. This is a terminal state and the association is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the association." ], "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. [Output only] Update time stamp", + "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7216,21 +7742,21 @@ "type": "object" }, "MirroringEndpointGroupAssociationDetails": { - "description": "This is a subset of the MirroringEndpointGroupAssociation message, containing fields to be used by the consumer.", + "description": "The endpoint group's view of a connected association.", "id": "MirroringEndpointGroupAssociationDetails", "properties": { "name": { - "description": "Output only. The resource name of the MirroringEndpointGroupAssociation. Format: projects/{project}/locations/{location}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociation}", + "description": "Output only. The connected association's resource name, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124.", "readOnly": true, "type": "string" }, "network": { - "description": "Output only. The VPC network associated. Format: projects/{project}/global/networks/{name}.", + "description": "Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124.", "readOnly": true, "type": "string" }, "state": { - "description": "Output only. Current state of the association.", + "description": "Output only. Most recent known state of the association.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -7242,11 +7768,11 @@ ], "enumDescriptions": [ "Not set.", - "Ready.", - "Being created.", - "Being deleted.", - "Mirroring is disabled due to an operation on another resource.", - "The underlying data plane is out of sync with the association. The association is not expected to be usable. This state can result in undefined behavior. See the `locations_details` field for more details.", + "The association is ready and in sync with the linked endpoint group.", + "The association is being created.", + "The association is being deleted.", + "The association is disabled due to a breaking change in another resource.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically. Check the `locations_details` field for more details.", "An attempt to delete the association has failed. This is a terminal state and the association is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the association." ], "readOnly": true, @@ -7256,16 +7782,16 @@ "type": "object" }, "MirroringEndpointGroupAssociationLocationDetails": { - "description": "Details about the association status in a specific cloud location.", + "description": "Contains details about the state of an association in a specific cloud location.", "id": "MirroringEndpointGroupAssociationLocationDetails", "properties": { "location": { - "description": "Output only. The cloud location.", + "description": "Output only. The cloud location, e.g. \"us-central1-a\" or \"asia-south1\".", "readOnly": true, "type": "string" }, "state": { - "description": "Output only. The association state in this location.", + "description": "Output only. The current state of the association in this location.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -7273,8 +7799,55 @@ ], "enumDescriptions": [ "Not set.", - "Ready.", - "The data plane is out of sync with the association in this location." + "The association is ready and in sync with the linked endpoint group.", + "The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringEndpointGroupConnectedDeploymentGroup": { + "description": "The endpoint group's view of a connected deployment group.", + "id": "MirroringEndpointGroupConnectedDeploymentGroup", + "properties": { + "locations": { + "description": "Output only. The list of locations where the deployment group is present.", + "items": { + "$ref": "MirroringLocation" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringLocation": { + "description": "Details about mirroring in a specific cloud location.", + "id": "MirroringLocation", + "properties": { + "location": { + "description": "Output only. The cloud location, e.g. \"us-central1-a\" or \"asia-south1\".", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the association in this location.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "OUT_OF_SYNC" + ], + "enumDescriptions": [ + "State not set (this is not a valid state).", + "The resource is ready and in sync in the location.", + "The resource is out of sync in the location. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically." ], "readOnly": true, "type": "string" @@ -7485,6 +8058,12 @@ "description": "Optional. Reference to a SecurityProfile with the CustomMirroring configuration.", "type": "string" }, + "dataPathId": { + "description": "Output only. Identifier used by the data-path. Unique within {container, location}.", + "format": "uint64", + "readOnly": true, + "type": "string" + }, "description": { "description": "Optional. An optional description of the profile group. Max length 2048 characters.", "type": "string" @@ -7711,6 +8290,13 @@ "description": "ThreatPreventionProfile defines an action for specific threat signatures or severity levels.", "id": "ThreatPreventionProfile", "properties": { + "antivirusOverrides": { + "description": "Optional. Configuration for overriding antivirus actions per protocol.", + "items": { + "$ref": "AntivirusOverride" + }, + "type": "array" + }, "severityOverrides": { "description": "Optional. Configuration for overriding threats actions by severity match.", "items": { diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index e0e51c08b0e..ce55e1917fb 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -184,6 +184,19 @@ export namespace networksecurity_v1 { */ updateTime?: string | null; } + /** + * Defines what action to take for antivirus threats per protocol. + */ + export interface Schema$AntivirusOverride { + /** + * Required. Threat action override. For some threat types, only a subset of actions applies. + */ + action?: string | null; + /** + * Required. Protocol to match. + */ + protocol?: string | null; + } /** * AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource. */ @@ -293,7 +306,7 @@ export namespace networksecurity_v1 { */ 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 5 principals. + * 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. For Application Load Balancers, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or SPIFFE ID, or the subject field in the client's certificate. For Cloud Service Mesh, 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 5 principals. */ principals?: Schema$AuthzPolicyAuthzRuleStringMatch[]; /** @@ -507,20 +520,20 @@ export namespace networksecurity_v1 { sourceAddressGroup?: string | null; } /** - * CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule. + * CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. */ export interface Schema$CustomInterceptProfile { /** - * Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored. + * Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group. */ interceptEndpointGroup?: string | null; } /** - * CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup + * CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. */ export interface Schema$CustomMirroringProfile { /** - * Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored. + * Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group. */ mirroringEndpointGroup?: string | null; } @@ -606,6 +619,14 @@ export namespace networksecurity_v1 { * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. */ reconciling?: boolean | null; + /** + * Output only. [Output Only] Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. [Output Only] Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Current state of the endpoint. */ @@ -915,6 +936,10 @@ export namespace networksecurity_v1 { * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. */ nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; } /** * Response returned by the ListAuthorizationPolicies method. @@ -1040,6 +1065,62 @@ export namespace networksecurity_v1 { */ nextPageToken?: string | null; } + /** + * Response message for ListMirroringDeploymentGroups. + */ + export interface Schema$ListMirroringDeploymentGroupsResponse { + /** + * The deployment groups from the specified parent. + */ + mirroringDeploymentGroups?: Schema$MirroringDeploymentGroup[]; + /** + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListMirroringDeployments. + */ + export interface Schema$ListMirroringDeploymentsResponse { + /** + * The deployments from the specified parent. + */ + mirroringDeployments?: Schema$MirroringDeployment[]; + /** + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response message for ListMirroringEndpointGroupAssociations. + */ + export interface Schema$ListMirroringEndpointGroupAssociationsResponse { + /** + * The associations from the specified parent. + */ + mirroringEndpointGroupAssociations?: Schema$MirroringEndpointGroupAssociation[]; + /** + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListMirroringEndpointGroups. + */ + export interface Schema$ListMirroringEndpointGroupsResponse { + /** + * The endpoint groups from the specified parent. + */ + mirroringEndpointGroups?: Schema$MirroringEndpointGroup[]; + /** + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. + */ + nextPageToken?: string | null; + } /** * The response message for Operations.ListOperations. */ @@ -1091,6 +1172,10 @@ export namespace networksecurity_v1 { * List of ServerTlsPolicy resources. */ serverTlsPolicies?: Schema$ServerTlsPolicy[]; + /** + * Unreachable resources. Populated when the request opts into `return_partial_success` and reading across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response returned by the ListTlsInspectionPolicies method. @@ -1151,6 +1236,264 @@ export namespace networksecurity_v1 { */ name?: string | null; } + /** + * A deployment represents a zonal mirroring backend ready to accept GENEVE-encapsulated replica traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global mirroring service. + */ + export interface Schema$MirroringDeployment { + /** + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. + */ + createTime?: string | null; + /** + * Optional. User-provided description of the deployment. Used as additional context for the deployment. + */ + description?: string | null; + /** + * Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124. + */ + forwardingRule?: string | null; + /** + * Optional. Labels are key/value pairs that help to organize and filter resources. + */ + labels?: {[key: string]: string} | null; + /** + * Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124. + */ + mirroringDeploymentGroup?: string | null; + /** + * Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details. + */ + name?: string | null; + /** + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. The current state of the deployment. See https://google.aip.dev/216. + */ + state?: string | null; + /** + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. + */ + updateTime?: string | null; + } + /** + * A deployment group aggregates many zonal mirroring backends (deployments) into a single global mirroring service. Consumers can connect this service using an endpoint group. + */ + export interface Schema$MirroringDeploymentGroup { + /** + * Output only. The list of endpoint groups that are connected to this resource. + */ + connectedEndpointGroups?: Schema$MirroringDeploymentGroupConnectedEndpointGroup[]; + /** + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. + */ + createTime?: string | null; + /** + * Optional. User-provided description of the deployment group. Used as additional context for the deployment group. + */ + description?: string | null; + /** + * Optional. Labels are key/value pairs that help to organize and filter resources. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The list of locations where the deployment group is present. + */ + locations?: Schema$MirroringLocation[]; + /** + * Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details. + */ + name?: string | null; + /** + * Output only. The list of Mirroring Deployments that belong to this group. + */ + nestedDeployments?: Schema$MirroringDeploymentGroupDeployment[]; + /** + * Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project\}/global/networks/{network\}`. See https://google.aip.dev/124. + */ + network?: string | null; + /** + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. The current state of the deployment group. See https://google.aip.dev/216. + */ + state?: string | null; + /** + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. + */ + updateTime?: string | null; + } + /** + * An endpoint group connected to this deployment group. + */ + export interface Schema$MirroringDeploymentGroupConnectedEndpointGroup { + /** + * Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124. + */ + name?: string | null; + } + /** + * A deployment belonging to this deployment group. + */ + export interface Schema$MirroringDeploymentGroupDeployment { + /** + * Output only. The name of the Mirroring Deployment, in the format: `projects/{project\}/locations/{location\}/mirroringDeployments/{mirroring_deployment\}`. + */ + name?: string | null; + /** + * Output only. Most recent known state of the deployment. + */ + state?: string | null; + } + /** + * An endpoint group is a consumer frontend for a deployment group (backend). In order to configure mirroring for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A mirroring rule that references the security profile (group). + */ + export interface Schema$MirroringEndpointGroup { + /** + * Output only. List of associations to this endpoint group. + */ + associations?: Schema$MirroringEndpointGroupAssociationDetails[]; + /** + * Output only. List of details about the connected deployment groups to this endpoint group. + */ + connectedDeploymentGroups?: Schema$MirroringEndpointGroupConnectedDeploymentGroup[]; + /** + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. + */ + createTime?: string | null; + /** + * Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group. + */ + description?: string | null; + /** + * Optional. Labels are key/value pairs that help to organize and filter resources. + */ + labels?: {[key: string]: string} | null; + /** + * Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124. + */ + mirroringDeploymentGroup?: string | null; + /** + * Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. + */ + name?: string | null; + /** + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. The current state of the endpoint group. See https://google.aip.dev/216. + */ + state?: string | null; + /** + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. + */ + updateTime?: string | null; + } + /** + * An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable mirroring by itself. To enable mirroring, the user must also create a network firewall policy containing mirroring rules and associate it with the network. + */ + export interface Schema$MirroringEndpointGroupAssociation { + /** + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. + */ + createTime?: string | null; + /** + * Optional. Labels are key/value pairs that help to organize and filter resources. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group. + */ + locations?: Schema$MirroringLocation[]; + /** + * Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself. + */ + locationsDetails?: Schema$MirroringEndpointGroupAssociationLocationDetails[]; + /** + * Immutable. The endpoint group that this association is connected to, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124. + */ + mirroringEndpointGroup?: string | null; + /** + * Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. + */ + name?: string | null; + /** + * Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124. + */ + network?: string | null; + /** + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. Current state of the endpoint group association. + */ + state?: string | null; + /** + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. + */ + updateTime?: string | null; + } + /** + * The endpoint group's view of a connected association. + */ + export interface Schema$MirroringEndpointGroupAssociationDetails { + /** + * Output only. The connected association's resource name, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124. + */ + name?: string | null; + /** + * Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124. + */ + network?: string | null; + /** + * Output only. Most recent known state of the association. + */ + state?: string | null; + } + /** + * Contains details about the state of an association in a specific cloud location. + */ + export interface Schema$MirroringEndpointGroupAssociationLocationDetails { + /** + * Output only. The cloud location, e.g. "us-central1-a" or "asia-south1". + */ + location?: string | null; + /** + * Output only. The current state of the association in this location. + */ + state?: string | null; + } + /** + * The endpoint group's view of a connected deployment group. + */ + export interface Schema$MirroringEndpointGroupConnectedDeploymentGroup { + /** + * Output only. The list of locations where the deployment group is present. + */ + locations?: Schema$MirroringLocation[]; + /** + * Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124. + */ + name?: string | null; + } + /** + * Details about mirroring in a specific cloud location. + */ + export interface Schema$MirroringLocation { + /** + * Output only. The cloud location, e.g. "us-central1-a" or "asia-south1". + */ + location?: string | null; + /** + * Output only. The current state of the association in this location. + */ + state?: string | null; + } /** * Specification of the MTLSPolicy. */ @@ -1313,6 +1656,10 @@ export namespace networksecurity_v1 { * Optional. Reference to a SecurityProfile with the CustomMirroring configuration. */ customMirroringProfile?: string | null; + /** + * Output only. Identifier used by the data-path. Unique within {container, location\}. + */ + dataPathId?: string | null; /** * Optional. An optional description of the profile group. Max length 2048 characters. */ @@ -1439,6 +1786,10 @@ export namespace networksecurity_v1 { * ThreatPreventionProfile defines an action for specific threat signatures or severity levels. */ export interface Schema$ThreatPreventionProfile { + /** + * Optional. Configuration for overriding antivirus actions per protocol. + */ + antivirusOverrides?: Schema$AntivirusOverride[]; /** * Optional. Configuration for overriding threats actions by severity match. */ @@ -2467,6 +2818,10 @@ export namespace networksecurity_v1 { * Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/x/locations/{location\}`. */ parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Organizations$Locations$Addressgroups$Listreferences extends StandardParameters { @@ -4530,6 +4885,10 @@ export namespace networksecurity_v1 { clientTlsPolicies: Resource$Projects$Locations$Clienttlspolicies; firewallEndpointAssociations: Resource$Projects$Locations$Firewallendpointassociations; gatewaySecurityPolicies: Resource$Projects$Locations$Gatewaysecuritypolicies; + mirroringDeploymentGroups: Resource$Projects$Locations$Mirroringdeploymentgroups; + mirroringDeployments: Resource$Projects$Locations$Mirroringdeployments; + mirroringEndpointGroupAssociations: Resource$Projects$Locations$Mirroringendpointgroupassociations; + mirroringEndpointGroups: Resource$Projects$Locations$Mirroringendpointgroups; operations: Resource$Projects$Locations$Operations; serverTlsPolicies: Resource$Projects$Locations$Servertlspolicies; tlsInspectionPolicies: Resource$Projects$Locations$Tlsinspectionpolicies; @@ -4552,6 +4911,16 @@ export namespace networksecurity_v1 { ); this.gatewaySecurityPolicies = new Resource$Projects$Locations$Gatewaysecuritypolicies(this.context); + this.mirroringDeploymentGroups = + new Resource$Projects$Locations$Mirroringdeploymentgroups(this.context); + this.mirroringDeployments = + new Resource$Projects$Locations$Mirroringdeployments(this.context); + this.mirroringEndpointGroupAssociations = + new Resource$Projects$Locations$Mirroringendpointgroupassociations( + this.context + ); + this.mirroringEndpointGroups = + new Resource$Projects$Locations$Mirroringendpointgroups(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -5965,6 +6334,10 @@ export namespace networksecurity_v1 { * Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/x/locations/{location\}`. */ parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Addressgroups$Listreferences extends StandardParameters { @@ -10179,35 +10552,2211 @@ export namespace networksecurity_v1 { requestBody?: Schema$GatewaySecurityPolicyRule; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Mirroringdeploymentgroups { 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 deployment group in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeploymentgroups$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/mirroringDeploymentGroups').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 deployment group. See https://google.aip.dev/135. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeploymentgroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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 specific deployment group. See https://google.aip.dev/131. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeploymentgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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 deployment groups in a given project and location. See https://google.aip.dev/132. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeploymentgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/mirroringDeploymentGroups').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 deployment group. See https://google.aip.dev/134. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeploymentgroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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$Mirroringdeploymentgroups$Create + extends StandardParameters { + /** + * Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name. + */ + mirroringDeploymentGroupId?: string; + /** + * Required. The parent resource where this deployment group will be created. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringDeploymentGroup; + } + export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete + extends StandardParameters { + /** + * Required. The deployment group to delete. + */ + name?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get + extends StandardParameters { + /** + * Required. The name of the deployment group to retrieve. Format: projects/{project\}/locations/{location\}/mirroringDeploymentGroups/{mirroring_deployment_group\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List + extends StandardParameters { + /** + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. + */ + filter?: string; + /** + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListMirroringDeploymentGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringDeploymentGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of deployment groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details. + */ + name?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + /** + * Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. `description`; *not* `mirroring_deployment_group.description`). See https://google.aip.dev/161 for more details. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringDeploymentGroup; + } + + export class Resource$Projects$Locations$Mirroringdeployments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a deployment in a given project and location. See https://google.aip.dev/133. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeployments$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/mirroringDeployments').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 deployment. See https://google.aip.dev/135. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeployments$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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 specific deployment. See https://google.aip.dev/131. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeployments$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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 deployments in a given project and location. See https://google.aip.dev/132. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeployments$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Mirroringdeployments$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringdeployments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringdeployments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/mirroringDeployments').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 deployment. See https://google.aip.dev/134. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringdeployments$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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$Mirroringdeployments$Create + extends StandardParameters { + /** + * Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name. + */ + mirroringDeploymentId?: string; + /** + * Required. The parent resource where this deployment will be created. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringDeployment; + } + export interface Params$Resource$Projects$Locations$Mirroringdeployments$Delete + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeployments$Get + extends StandardParameters { + /** + * Required. The name of the deployment to retrieve. Format: projects/{project\}/locations/{location\}/mirroringDeployments/{mirroring_deployment\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeployments$List + extends StandardParameters { + /** + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. + */ + filter?: string; + /** + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListMirroringDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringDeployments` must match the call that provided the page token. See https://google.aip.dev/158 for more details. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of deployments. Example: `projects/123456789/locations/us-central1-a`. See https://google.aip.dev/132 for more details. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeployments$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details. + */ + name?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + /** + * Optional. The list of fields to update. Fields are specified relative to the deployment (e.g. `description`; *not* `mirroring_deployment.description`). See https://google.aip.dev/161 for more details. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringDeployment; + } + + export class Resource$Projects$Locations$Mirroringendpointgroupassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an association in a given project and location. See https://google.aip.dev/133. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroupassociations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/mirroringEndpointGroupAssociations' + ).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 an association. See https://google.aip.dev/135. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroupassociations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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 specific association. See https://google.aip.dev/131. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroupassociations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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 associations in a given project and location. See https://google.aip.dev/132. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroupassociations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/mirroringEndpointGroupAssociations' + ).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 association. See https://google.aip.dev/134. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroupassociations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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$Mirroringendpointgroupassociations$Create + extends StandardParameters { + /** + * Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID. + */ + mirroringEndpointGroupAssociationId?: string; + /** + * Required. The parent resource where this association will be created. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringEndpointGroupAssociation; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete + extends StandardParameters { + /** + * Required. The association to delete. + */ + name?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get + extends StandardParameters { + /** + * Required. The name of the association to retrieve. Format: projects/{project\}/locations/{location\}/mirroringEndpointGroupAssociations/{mirroring_endpoint_group_association\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List + extends StandardParameters { + /** + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. + */ + filter?: string; + /** + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of associations. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. + */ + name?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + /** + * Optional. The list of fields to update. Fields are specified relative to the association (e.g. `description`; *not* `mirroring_endpoint_group_association.description`). See https://google.aip.dev/161 for more details. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringEndpointGroupAssociation; + } + + export class Resource$Projects$Locations$Mirroringendpointgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an endpoint group in a given project and location. See https://google.aip.dev/133. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/mirroringEndpointGroups').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 an endpoint group. See https://google.aip.dev/135. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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 specific endpoint group. See https://google.aip.dev/131. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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 endpoint groups in a given project and location. See https://google.aip.dev/132. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/mirroringEndpointGroups').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 endpoint group. See https://google.aip.dev/134. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Mirroringendpointgroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.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$Mirroringendpointgroups$Create + extends StandardParameters { + /** + * Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name. + */ + mirroringEndpointGroupId?: string; + /** + * Required. The parent resource where this endpoint group will be created. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringEndpointGroup; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete + extends StandardParameters { + /** + * Required. The endpoint group to delete. + */ + name?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$Get + extends StandardParameters { + /** + * Required. The name of the endpoint group to retrieve. Format: projects/{project\}/locations/{location\}/mirroringEndpointGroups/{mirroring_endpoint_group\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$List + extends StandardParameters { + /** + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. + */ + filter?: string; + /** + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of endpoint groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. + */ + name?: string; + /** + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. + */ + requestId?: string; + /** + * Optional. The list of fields to update. Fields are specified relative to the endpoint group (e.g. `description`; *not* `mirroring_endpoint_group.description`). See https://google.aip.dev/161 for more details. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringEndpointGroup; + } + + 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; @@ -11384,6 +13933,10 @@ export namespace networksecurity_v1 { * Required. The project and location from which the ServerTlsPolicies should be listed, specified in the format `projects/x/locations/{location\}`. */ parent?: string; + /** + * Optional. Setting this field to `true` will opt the request into returning the resources that are reachable, and into including the names of those that were unreachable in the [ListServerTlsPoliciesResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Servertlspolicies$Patch extends StandardParameters { diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index aa1fabd1699..fce8d634bd0 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -184,6 +184,19 @@ export namespace networksecurity_v1beta1 { */ updateTime?: string | null; } + /** + * Defines what action to take for antivirus threats per protocol. + */ + export interface Schema$AntivirusOverride { + /** + * Required. Threat action override. For some threat types, only a subset of actions applies. + */ + action?: string | null; + /** + * Required. Protocol to match. + */ + protocol?: string | null; + } /** * AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource. */ @@ -293,7 +306,7 @@ export namespace networksecurity_v1beta1 { */ 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 5 principals. + * 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. For Application Load Balancers, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or SPIFFE ID, or the subject field in the client's certificate. For Cloud Service Mesh, 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 5 principals. */ principals?: Schema$AuthzPolicyAuthzRuleStringMatch[]; /** @@ -443,6 +456,47 @@ export namespace networksecurity_v1beta1 { */ resources?: string[] | null; } + /** + * BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS. + */ + export interface Schema$BackendAuthenticationConfig { + /** + * Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project\}/locations/{location\}/certificates/{certificate\}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope. + */ + clientCertificate?: string | null; + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. Free-text description of the resource. + */ + description?: string | null; + /** + * Output only. Etag of the resource. + */ + etag?: string | null; + /** + * Set of label tags associated with the resource. + */ + labels?: {[key: string]: string} | null; + /** + * Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/x/locations/{location\}/backendAuthenticationConfigs/{backend_authentication_config\}` + */ + name?: string | null; + /** + * Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project\}/locations/{location\}/trustConfigs/{trust_config\}". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS. + */ + trustConfig?: string | null; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + /** + * Well known roots to use for server certificate validation. + */ + wellKnownRoots?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -507,20 +561,20 @@ export namespace networksecurity_v1beta1 { sourceAddressGroup?: string | null; } /** - * CustomInterceptProfile defines the Packet Intercept Endpoint Group used to intercept traffic to a third-party firewall in a Firewall rule. + * CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. */ export interface Schema$CustomInterceptProfile { /** - * Required. The InterceptEndpointGroup to which traffic associated with the SP should be mirrored. + * Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group. */ interceptEndpointGroup?: string | null; } /** - * CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup + * CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. */ export interface Schema$CustomMirroringProfile { /** - * Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored. + * Required. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group. */ mirroringEndpointGroup?: string | null; } @@ -606,6 +660,14 @@ export namespace networksecurity_v1beta1 { * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. */ reconciling?: boolean | null; + /** + * Output only. [Output Only] Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. [Output Only] Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Current state of the endpoint. */ @@ -874,11 +936,11 @@ export namespace networksecurity_v1beta1 { regexMatch?: string | null; } /** - * Message describing InterceptDeployment object NEXT ID: 10 + * A deployment represents a zonal intercept backend ready to accept GENEVE-encapsulated traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global intercept service. */ export interface Schema$InterceptDeployment { /** - * Output only. [Output only] Create time stamp + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. */ createTime?: string | null; /** @@ -886,44 +948,44 @@ export namespace networksecurity_v1beta1 { */ description?: string | null; /** - * Required. Immutable. The regional load balancer which the intercepted traffic should be forwarded to. Format is: projects/{project\}/regions/{region\}/forwardingRules/{forwardingRule\} + * Required. Immutable. The regional forwarding rule that fronts the interceptors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124. */ forwardingRule?: string | null; /** - * Required. Immutable. The Intercept Deployment Group that this resource is part of. Format is: `projects/{project\}/locations/global/interceptDeploymentGroups/{interceptDeploymentGroup\}` + * Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124. */ interceptDeploymentGroup?: string | null; /** - * Optional. Labels as key value pairs + * Optional. Labels are key/value pairs that help to organize and filter resources. */ labels?: {[key: string]: string} | null; /** - * Immutable. Identifier. The name of the InterceptDeployment. + * Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/interceptDeployments/my-dep`. See https://google.aip.dev/122 for more details. */ name?: string | null; /** - * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128. */ reconciling?: boolean | null; /** - * Output only. Current state of the deployment. + * Output only. The current state of the deployment. See https://google.aip.dev/216. */ state?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ updateTime?: string | null; } /** - * Message describing InterceptDeploymentGroup object NEXT ID: 10 + * A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group. */ export interface Schema$InterceptDeploymentGroup { /** - * Output only. The list of Intercept Endpoint Groups that are connected to this resource. + * Output only. The list of endpoint groups that are connected to this resource. */ connectedEndpointGroups?: Schema$InterceptDeploymentGroupConnectedEndpointGroup[]; /** - * Output only. [Output only] Create time stamp + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. */ createTime?: string | null; /** @@ -931,27 +993,35 @@ export namespace networksecurity_v1beta1 { */ description?: string | null; /** - * Optional. Labels as key value pairs + * Optional. Labels are key/value pairs that help to organize and filter resources. */ labels?: {[key: string]: string} | null; /** - * Immutable. Identifier. Then name of the InterceptDeploymentGroup. + * Output only. The list of locations where the deployment group is present. + */ + locations?: Schema$InterceptLocation[]; + /** + * Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details. */ name?: string | null; /** - * Required. Immutable. The network that is being used for the deployment. Format is: projects/{project\}/global/networks/{network\}. + * Output only. The list of Intercept Deployments that belong to this group. + */ + nestedDeployments?: Schema$InterceptDeploymentGroupDeployment[]; + /** + * Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project\}/global/networks/{network\}`. See https://google.aip.dev/124. */ network?: string | null; /** - * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128. */ reconciling?: boolean | null; /** - * Output only. Current state of the deployment group. + * Output only. The current state of the deployment group. See https://google.aip.dev/216. */ state?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ updateTime?: string | null; } @@ -960,20 +1030,37 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$InterceptDeploymentGroupConnectedEndpointGroup { /** - * Output only. A connected intercept endpoint group. + * Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/124. + */ + name?: string | null; + } + /** + * A deployment belonging to this deployment group. + */ + export interface Schema$InterceptDeploymentGroupDeployment { + /** + * Output only. The name of the Intercept Deployment, in the format: `projects/{project\}/locations/{location\}/interceptDeployments/{intercept_deployment\}`. */ name?: string | null; + /** + * Output only. Most recent known state of the deployment. + */ + state?: string | null; } /** - * Message describing InterceptEndpointGroup object. + * An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group). */ export interface Schema$InterceptEndpointGroup { /** - * Output only. List of Intercept Endpoint Group Associations that are associated to this endpoint group. + * Output only. List of associations to this endpoint group. */ associations?: Schema$InterceptEndpointGroupAssociationDetails[]; /** - * Output only. [Output only] Create time stamp + * Output only. Details about the connected deployment group to this endpoint group. + */ + connectedDeploymentGroup?: Schema$InterceptEndpointGroupConnectedDeploymentGroup; + /** + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. */ createTime?: string | null; /** @@ -981,60 +1068,64 @@ export namespace networksecurity_v1beta1 { */ description?: string | null; /** - * Required. Immutable. The Intercept Deployment Group that this resource is connected to. Format is: `projects/{project\}/locations/global/interceptDeploymentGroups/{interceptDeploymentGroup\}` + * Required. Immutable. The deployment group that this endpoint group is connected to, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124. */ interceptDeploymentGroup?: string | null; /** - * Optional. Labels as key value pairs + * Optional. Labels are key/value pairs that help to organize and filter resources. */ labels?: {[key: string]: string} | null; /** - * Immutable. Identifier. The name of the InterceptEndpointGroup. + * Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. */ name?: string | null; /** - * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128. */ reconciling?: boolean | null; /** - * Output only. Current state of the endpoint group. + * Output only. The current state of the endpoint group. See https://google.aip.dev/216. */ state?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ updateTime?: string | null; } /** - * Message describing InterceptEndpointGroupAssociation object + * An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable intercept by itself. To enable intercept, the user must also create a network firewall policy containing intercept rules and associate it with the network. */ export interface Schema$InterceptEndpointGroupAssociation { /** - * Output only. [Output only] Create time stamp + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. */ createTime?: string | null; /** - * Required. Immutable. The Intercept Endpoint Group that this resource is connected to. Format is: `projects/{project\}/locations/global/interceptEndpointGroups/{interceptEndpointGroup\}` + * Required. Immutable. The endpoint group that this association is connected to, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/124. */ interceptEndpointGroup?: string | null; /** - * Optional. Labels as key value pairs + * Optional. Labels are key/value pairs that help to organize and filter resources. */ labels?: {[key: string]: string} | null; /** - * Output only. The list of locations that this association is in and its details. + * Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group. + */ + locations?: Schema$InterceptLocation[]; + /** + * Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself. */ locationsDetails?: Schema$InterceptEndpointGroupAssociationLocationDetails[]; /** - * Immutable. Identifier. The name of the InterceptEndpointGroupAssociation. + * Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. */ name?: string | null; /** - * Required. Immutable. The VPC network associated. Format: projects/{project\}/global/networks/{network\}. + * Required. Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124. */ network?: string | null; /** - * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128. */ reconciling?: boolean | null; /** @@ -1042,37 +1133,63 @@ export namespace networksecurity_v1beta1 { */ state?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ updateTime?: string | null; } /** - * This is a subset of the InterceptEndpointGroupAssociation message, containing fields to be used by the consumer. + * The endpoint group's view of a connected association. */ export interface Schema$InterceptEndpointGroupAssociationDetails { /** - * Output only. The resource name of the InterceptEndpointGroupAssociation. Format: projects/{project\}/locations/{location\}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociation\} + * Output only. The connected association's resource name, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124. */ name?: string | null; /** - * Output only. The VPC network associated. Format: projects/{project\}/global/networks/{name\}. + * Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124. */ network?: string | null; /** - * Output only. Current state of the association. + * Output only. Most recent known state of the association. */ state?: string | null; } /** - * Details about the association status in a specific cloud location. + * Contains details about the state of an association in a specific cloud location. */ export interface Schema$InterceptEndpointGroupAssociationLocationDetails { /** - * Output only. The cloud location. + * Output only. The cloud location, e.g. "us-central1-a" or "asia-south1". + */ + location?: string | null; + /** + * Output only. The current state of the association in this location. + */ + state?: string | null; + } + /** + * The endpoint group's view of a connected deployment group. + */ + export interface Schema$InterceptEndpointGroupConnectedDeploymentGroup { + /** + * Output only. The list of locations where the deployment group is present. + */ + locations?: Schema$InterceptLocation[]; + /** + * Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/124. + */ + name?: string | null; + } + /** + * Details about intercept in a specific cloud location. + */ + export interface Schema$InterceptLocation { + /** + * Output only. The cloud location, e.g. "us-central1-a" or "asia-south1". */ location?: string | null; /** - * Output only. The association state in this location. + * Output only. The current state of the association in this location. */ state?: string | null; } @@ -1118,6 +1235,10 @@ export namespace networksecurity_v1beta1 { * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. */ nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; } /** * Response returned by the ListAuthorizationPolicies method. @@ -1149,6 +1270,23 @@ export namespace networksecurity_v1beta1 { */ unreachable?: string[] | null; } + /** + * Response returned by the ListBackendAuthenticationConfigs method. + */ + export interface Schema$ListBackendAuthenticationConfigsResponse { + /** + * List of BackendAuthenticationConfig resources. + */ + backendAuthenticationConfigs?: Schema$BackendAuthenticationConfig[]; + /** + * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response returned by the ListClientTlsPolicies method. */ @@ -1231,28 +1369,28 @@ export namespace networksecurity_v1beta1 { unreachable?: string[] | null; } /** - * Message for response to listing InterceptDeploymentGroups + * Response message for ListInterceptDeploymentGroups. */ export interface Schema$ListInterceptDeploymentGroupsResponse { /** - * The list of InterceptDeploymentGroup + * The deployment groups from the specified parent. */ interceptDeploymentGroups?: Schema$InterceptDeploymentGroup[]; /** - * A token identifying a page of results the server should return. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. */ nextPageToken?: string | null; } /** - * Message for response to listing InterceptDeployments + * Response message for ListInterceptDeployments. */ export interface Schema$ListInterceptDeploymentsResponse { /** - * The list of InterceptDeployment + * The deployments from the specified parent. */ interceptDeployments?: Schema$InterceptDeployment[]; /** - * A token identifying a page of results the server should return. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. */ nextPageToken?: string | null; /** @@ -1261,28 +1399,28 @@ export namespace networksecurity_v1beta1 { unreachable?: string[] | null; } /** - * Message for response to listing InterceptEndpointGroupAssociations + * Response message for ListInterceptEndpointGroupAssociations. */ export interface Schema$ListInterceptEndpointGroupAssociationsResponse { /** - * The list of InterceptEndpointGroupAssociation + * The associations from the specified parent. */ interceptEndpointGroupAssociations?: Schema$InterceptEndpointGroupAssociation[]; /** - * A token identifying a page of results the server should return. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. */ nextPageToken?: string | null; } /** - * Message for response to listing InterceptEndpointGroups + * Response message for ListInterceptEndpointGroups. */ export interface Schema$ListInterceptEndpointGroupsResponse { /** - * The list of InterceptEndpointGroup + * The endpoint groups from the specified parent. */ interceptEndpointGroups?: Schema$InterceptEndpointGroup[]; /** - * A token identifying a page of results the server should return. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. */ nextPageToken?: string | null; } @@ -1300,28 +1438,28 @@ export namespace networksecurity_v1beta1 { nextPageToken?: string | null; } /** - * Message for response to listing MirroringDeploymentGroups + * Response message for ListMirroringDeploymentGroups. */ export interface Schema$ListMirroringDeploymentGroupsResponse { /** - * The list of MirroringDeploymentGroup + * The deployment groups from the specified parent. */ mirroringDeploymentGroups?: Schema$MirroringDeploymentGroup[]; /** - * A token identifying a page of results the server should return. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. */ nextPageToken?: string | null; } /** - * Message for response to listing MirroringDeployments + * Response message for ListMirroringDeployments. */ export interface Schema$ListMirroringDeploymentsResponse { /** - * The list of MirroringDeployment + * The deployments from the specified parent. */ mirroringDeployments?: Schema$MirroringDeployment[]; /** - * A token identifying a page of results the server should return. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. */ nextPageToken?: string | null; /** @@ -1330,28 +1468,28 @@ export namespace networksecurity_v1beta1 { unreachable?: string[] | null; } /** - * Message for response to listing MirroringEndpointGroupAssociations + * Response message for ListMirroringEndpointGroupAssociations. */ export interface Schema$ListMirroringEndpointGroupAssociationsResponse { /** - * The list of MirroringEndpointGroupAssociation + * The associations from the specified parent. */ mirroringEndpointGroupAssociations?: Schema$MirroringEndpointGroupAssociation[]; /** - * A token identifying a page of results the server should return. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. */ nextPageToken?: string | null; } /** - * Message for response to listing MirroringEndpointGroups + * Response message for ListMirroringEndpointGroups. */ export interface Schema$ListMirroringEndpointGroupsResponse { /** - * The list of MirroringEndpointGroup + * The endpoint groups from the specified parent. */ mirroringEndpointGroups?: Schema$MirroringEndpointGroup[]; /** - * A token identifying a page of results the server should return. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. See https://google.aip.dev/158 for more details. */ nextPageToken?: string | null; } @@ -1406,6 +1544,10 @@ export namespace networksecurity_v1beta1 { * List of ServerTlsPolicy resources. */ serverTlsPolicies?: Schema$ServerTlsPolicy[]; + /** + * Unreachable resources. Populated when the request opts into `return_partial_success` and reading across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response returned by the ListTlsInspectionPolicies method. @@ -1467,76 +1609,92 @@ export namespace networksecurity_v1beta1 { name?: string | null; } /** - * Message describing MirroringDeployment object NEXT ID: 10 + * A deployment represents a zonal mirroring backend ready to accept GENEVE-encapsulated replica traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global mirroring service. */ export interface Schema$MirroringDeployment { /** - * Output only. [Output only] Create time stamp + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. */ createTime?: string | null; /** - * Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project\}/regions/{region\}/forwardingRules/{forwardingRule\} + * Optional. User-provided description of the deployment. Used as additional context for the deployment. + */ + description?: string | null; + /** + * Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See https://google.aip.dev/124. */ forwardingRule?: string | null; /** - * Optional. Labels as key value pairs + * Optional. Labels are key/value pairs that help to organize and filter resources. */ labels?: {[key: string]: string} | null; /** - * Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project\}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup\}` + * Required. Immutable. The deployment group that this deployment is a part of, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124. */ mirroringDeploymentGroup?: string | null; /** - * Immutable. Identifier. The name of the MirroringDeployment. + * Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details. */ name?: string | null; /** - * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128. */ reconciling?: boolean | null; /** - * Output only. Current state of the deployment. + * Output only. The current state of the deployment. See https://google.aip.dev/216. */ state?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ updateTime?: string | null; } /** - * Message describing MirroringDeploymentGroup object NEXT ID: 10 + * A deployment group aggregates many zonal mirroring backends (deployments) into a single global mirroring service. Consumers can connect this service using an endpoint group. */ export interface Schema$MirroringDeploymentGroup { /** - * Output only. The list of Mirroring Endpoint Groups that are connected to this resource. + * Output only. The list of endpoint groups that are connected to this resource. */ connectedEndpointGroups?: Schema$MirroringDeploymentGroupConnectedEndpointGroup[]; /** - * Output only. [Output only] Create time stamp + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. */ createTime?: string | null; /** - * Optional. Labels as key value pairs + * Optional. User-provided description of the deployment group. Used as additional context for the deployment group. + */ + description?: string | null; + /** + * Optional. Labels are key/value pairs that help to organize and filter resources. */ labels?: {[key: string]: string} | null; /** - * Immutable. Identifier. Then name of the MirroringDeploymentGroup. + * Output only. The list of locations where the deployment group is present. + */ + locations?: Schema$MirroringLocation[]; + /** + * Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details. */ name?: string | null; /** - * Required. Immutable. The network that is being used for the deployment. Format is: projects/{project\}/global/networks/{network\}. + * Output only. The list of Mirroring Deployments that belong to this group. + */ + nestedDeployments?: Schema$MirroringDeploymentGroupDeployment[]; + /** + * Required. Immutable. The network that will be used for all child deployments, for example: `projects/{project\}/global/networks/{network\}`. See https://google.aip.dev/124. */ network?: string | null; /** - * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new deployment to the group) See https://google.aip.dev/128. */ reconciling?: boolean | null; /** - * Output only. Current state of the deployment group. + * Output only. The current state of the deployment group. See https://google.aip.dev/216. */ state?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ updateTime?: string | null; } @@ -1545,77 +1703,102 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$MirroringDeploymentGroupConnectedEndpointGroup { /** - * Output only. A connected mirroring endpoint group. + * Output only. The connected endpoint group's resource name, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124. + */ + name?: string | null; + } + /** + * A deployment belonging to this deployment group. + */ + export interface Schema$MirroringDeploymentGroupDeployment { + /** + * Output only. The name of the Mirroring Deployment, in the format: `projects/{project\}/locations/{location\}/mirroringDeployments/{mirroring_deployment\}`. */ name?: string | null; + /** + * Output only. Most recent known state of the deployment. + */ + state?: string | null; } /** - * Message describing MirroringEndpointGroup object. + * An endpoint group is a consumer frontend for a deployment group (backend). In order to configure mirroring for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A mirroring rule that references the security profile (group). */ export interface Schema$MirroringEndpointGroup { /** - * Output only. List of Mirroring Endpoint Group Associations that are associated to this endpoint group. + * Output only. List of associations to this endpoint group. */ associations?: Schema$MirroringEndpointGroupAssociationDetails[]; /** - * Output only. [Output only] Create time stamp + * Output only. List of details about the connected deployment groups to this endpoint group. + */ + connectedDeploymentGroups?: Schema$MirroringEndpointGroupConnectedDeploymentGroup[]; + /** + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. */ createTime?: string | null; /** - * Optional. Labels as key value pairs + * Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group. + */ + description?: string | null; + /** + * Optional. Labels are key/value pairs that help to organize and filter resources. */ labels?: {[key: string]: string} | null; /** - * Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project\}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup\}` + * Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124. */ mirroringDeploymentGroup?: string | null; /** - * Immutable. Identifier. Next ID: 11 The name of the MirroringEndpointGroup. + * Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. */ name?: string | null; /** - * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128. */ reconciling?: boolean | null; /** - * Output only. Current state of the endpoint group. + * Output only. The current state of the endpoint group. See https://google.aip.dev/216. */ state?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ updateTime?: string | null; } /** - * Message describing MirroringEndpointGroupAssociation object + * An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable mirroring by itself. To enable mirroring, the user must also create a network firewall policy containing mirroring rules and associate it with the network. */ export interface Schema$MirroringEndpointGroupAssociation { /** - * Output only. [Output only] Create time stamp + * Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. */ createTime?: string | null; /** - * Optional. Labels as key value pairs + * Optional. Labels are key/value pairs that help to organize and filter resources. */ labels?: {[key: string]: string} | null; /** - * Output only. The list of locations that this association is in and its details. + * Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group. + */ + locations?: Schema$MirroringLocation[]; + /** + * Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself. */ locationsDetails?: Schema$MirroringEndpointGroupAssociationLocationDetails[]; /** - * Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project\}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup\}` + * Immutable. The endpoint group that this association is connected to, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/124. */ mirroringEndpointGroup?: string | null; /** - * Immutable. Identifier. The name of the MirroringEndpointGroupAssociation. + * Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. */ name?: string | null; /** - * Required. Immutable. The VPC network associated. Format: projects/{project\}/global/networks/{network\}. + * Immutable. The VPC network that is associated. for example: `projects/123456789/global/networks/my-network`. See https://google.aip.dev/124. */ network?: string | null; /** - * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + * Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128. */ reconciling?: boolean | null; /** @@ -1623,37 +1806,63 @@ export namespace networksecurity_v1beta1 { */ state?: string | null; /** - * Output only. [Output only] Update time stamp + * Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. */ updateTime?: string | null; } /** - * This is a subset of the MirroringEndpointGroupAssociation message, containing fields to be used by the consumer. + * The endpoint group's view of a connected association. */ export interface Schema$MirroringEndpointGroupAssociationDetails { /** - * Output only. The resource name of the MirroringEndpointGroupAssociation. Format: projects/{project\}/locations/{location\}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociation\} + * Output only. The connected association's resource name, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-ega`. See https://google.aip.dev/124. */ name?: string | null; /** - * Output only. The VPC network associated. Format: projects/{project\}/global/networks/{name\}. + * Output only. The associated network, for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124. */ network?: string | null; /** - * Output only. Current state of the association. + * Output only. Most recent known state of the association. */ state?: string | null; } /** - * Details about the association status in a specific cloud location. + * Contains details about the state of an association in a specific cloud location. */ export interface Schema$MirroringEndpointGroupAssociationLocationDetails { /** - * Output only. The cloud location. + * Output only. The cloud location, e.g. "us-central1-a" or "asia-south1". + */ + location?: string | null; + /** + * Output only. The current state of the association in this location. + */ + state?: string | null; + } + /** + * The endpoint group's view of a connected deployment group. + */ + export interface Schema$MirroringEndpointGroupConnectedDeploymentGroup { + /** + * Output only. The list of locations where the deployment group is present. + */ + locations?: Schema$MirroringLocation[]; + /** + * Output only. The connected deployment group's resource name, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/124. + */ + name?: string | null; + } + /** + * Details about mirroring in a specific cloud location. + */ + export interface Schema$MirroringLocation { + /** + * Output only. The cloud location, e.g. "us-central1-a" or "asia-south1". */ location?: string | null; /** - * Output only. The association state in this location. + * Output only. The current state of the association in this location. */ state?: string | null; } @@ -1819,6 +2028,10 @@ export namespace networksecurity_v1beta1 { * Optional. Reference to a SecurityProfile with the CustomMirroring configuration. */ customMirroringProfile?: string | null; + /** + * Output only. Identifier used by the data-path. Unique within {container, location\}. + */ + dataPathId?: string | null; /** * Optional. An optional description of the profile group. Max length 2048 characters. */ @@ -1945,6 +2158,10 @@ export namespace networksecurity_v1beta1 { * ThreatPreventionProfile defines an action for specific threat signatures or severity levels. */ export interface Schema$ThreatPreventionProfile { + /** + * Optional. Configuration for overriding antivirus actions per protocol. + */ + antivirusOverrides?: Schema$AntivirusOverride[]; /** * Optional. Configuration for overriding threats actions by severity match. */ @@ -2973,6 +3190,10 @@ export namespace networksecurity_v1beta1 { * Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/x/locations/{location\}`. */ parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Organizations$Locations$Addressgroups$Listreferences extends StandardParameters { @@ -5036,6 +5257,7 @@ export namespace networksecurity_v1beta1 { addressGroups: Resource$Projects$Locations$Addressgroups; authorizationPolicies: Resource$Projects$Locations$Authorizationpolicies; authzPolicies: Resource$Projects$Locations$Authzpolicies; + backendAuthenticationConfigs: Resource$Projects$Locations$Backendauthenticationconfigs; clientTlsPolicies: Resource$Projects$Locations$Clienttlspolicies; firewallEndpointAssociations: Resource$Projects$Locations$Firewallendpointassociations; gatewaySecurityPolicies: Resource$Projects$Locations$Gatewaysecuritypolicies; @@ -5061,6 +5283,10 @@ export namespace networksecurity_v1beta1 { this.authzPolicies = new Resource$Projects$Locations$Authzpolicies( this.context ); + this.backendAuthenticationConfigs = + new Resource$Projects$Locations$Backendauthenticationconfigs( + this.context + ); this.clientTlsPolicies = new Resource$Projects$Locations$Clienttlspolicies(this.context); this.firewallEndpointAssociations = @@ -6502,6 +6728,10 @@ export namespace networksecurity_v1beta1 { * Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/x/locations/{location\}`. */ parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Addressgroups$Listreferences extends StandardParameters { @@ -8277,14 +8507,14 @@ export namespace networksecurity_v1beta1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Clienttlspolicies { + export class Resource$Projects$Locations$Backendauthenticationconfigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new ClientTlsPolicy in a given project and location. + * Creates a new BackendAuthenticationConfig in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8292,31 +8522,31 @@ export namespace networksecurity_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + params?: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Create + | Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8329,13 +8559,13 @@ export namespace networksecurity_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Create; + {}) as Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Create; + {} as Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create; options = {}; } @@ -8349,10 +8579,9 @@ export namespace networksecurity_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/clientTlsPolicies').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta1/{+parent}/backendAuthenticationConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -8374,7 +8603,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single ClientTlsPolicy. + * Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8382,31 +8611,31 @@ export namespace networksecurity_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + params?: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Delete + | Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8419,13 +8648,13 @@ export namespace networksecurity_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Delete; + {}) as Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Clienttlspolicies$Delete; + {} as Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete; options = {}; } @@ -8461,7 +8690,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single ClientTlsPolicy. + * Gets details of a single BackendAuthenticationConfig to BackendAuthenticationConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8469,49 +8698,57 @@ export namespace networksecurity_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + params?: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Clienttlspolicies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backendauthenticationconfigs$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$Clienttlspolicies$Get; + {}) as Params$Resource$Projects$Locations$Backendauthenticationconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Clienttlspolicies$Get; + params = + {} as Params$Resource$Projects$Locations$Backendauthenticationconfigs$Get; options = {}; } @@ -8537,43 +8774,564 @@ export namespace networksecurity_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 BackendAuthenticationConfigs 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$Clienttlspolicies$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Backendauthenticationconfigs$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backendauthenticationconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backendauthenticationconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backendauthenticationconfigs$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}/backendAuthenticationConfigs' + ).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 BackendAuthenticationConfig to BackendAuthenticationConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backendauthenticationconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backendauthenticationconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backendauthenticationconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backendauthenticationconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backendauthenticationconfigs$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); + } + } + } + + export interface Params$Resource$Projects$Locations$Backendauthenticationconfigs$Create + extends StandardParameters { + /** + * Required. Short name of the BackendAuthenticationConfig resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "backend-auth-config". + */ + backendAuthenticationConfigId?: string; + /** + * Required. The parent resource of the BackendAuthenticationConfig. Must be in the format `projects/x/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendAuthenticationConfig; + } + export interface Params$Resource$Projects$Locations$Backendauthenticationconfigs$Delete + extends StandardParameters { + /** + * Optional. Etag of the resource. If this is provided, it must match the server's etag. + */ + etag?: string; + /** + * Required. A name of the BackendAuthenticationConfig to delete. Must be in the format `projects/x/locations/{location\}/backendAuthenticationConfigs/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backendauthenticationconfigs$Get + extends StandardParameters { + /** + * Required. A name of the BackendAuthenticationConfig to get. Must be in the format `projects/x/locations/{location\}/backendAuthenticationConfigs/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backendauthenticationconfigs$List + extends StandardParameters { + /** + * Maximum number of BackendAuthenticationConfigs to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListBackendAuthenticationConfigsResponse` Indicates that this is a continuation of a prior `ListBackendAuthenticationConfigs` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the BackendAuthenticationConfigs should be listed, specified in the format `projects/x/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backendauthenticationconfigs$Patch + extends StandardParameters { + /** + * Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/x/locations/{location\}/backendAuthenticationConfigs/{backend_authentication_config\}` + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the BackendAuthenticationConfig 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$BackendAuthenticationConfig; + } + + export class Resource$Projects$Locations$Clienttlspolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ClientTlsPolicy 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$Clienttlspolicies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clienttlspolicies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clienttlspolicies$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}/clientTlsPolicies').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 ClientTlsPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Clienttlspolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clienttlspolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clienttlspolicies$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 ClientTlsPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Clienttlspolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clienttlspolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clienttlspolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clienttlspolicies$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$Clienttlspolicies$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Clienttlspolicies$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy( @@ -10721,7 +11479,7 @@ export namespace networksecurity_v1beta1 { } /** - * Creates a new InterceptDeploymentGroup in a given project and location. + * Creates a deployment group in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10810,7 +11568,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single InterceptDeploymentGroup. + * Deletes a deployment group. See https://google.aip.dev/135. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10897,7 +11655,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single InterceptDeploymentGroup. + * Gets a specific deployment group. See https://google.aip.dev/131. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10989,7 +11747,7 @@ export namespace networksecurity_v1beta1 { } /** - * Lists InterceptDeploymentGroups in a given project and location. + * Lists deployment groups in a given project and location. See https://google.aip.dev/132. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11087,7 +11845,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates a single InterceptDeploymentGroup. + * Updates a deployment group. See https://google.aip.dev/134. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11177,15 +11935,15 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$Create extends StandardParameters { /** - * Required. Id of the requesting object If auto-generating Id server-side, remove this field and intercept_deployment_group_id from the method_signature of Create RPC + * Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name. */ interceptDeploymentGroupId?: string; /** - * Required. Value for parent. + * Required. The parent resource where this deployment group will be created. 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 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; @@ -11197,56 +11955,56 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$Delete extends StandardParameters { /** - * Required. Name of the resource + * Required. The deployment group to delete. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$Get extends StandardParameters { /** - * Required. Name of the resource + * Required. The name of the deployment group to retrieve. Format: projects/{project\}/locations/{location\}/interceptDeploymentGroups/{intercept_deployment_group\} */ name?: string; } export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListInterceptDeploymentGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptDeploymentGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. */ pageToken?: string; /** - * Required. Parent value for ListInterceptDeploymentGroupsRequest + * Required. The parent, which owns this collection of deployment groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. */ parent?: string; } export interface Params$Resource$Projects$Locations$Interceptdeploymentgroups$Patch extends StandardParameters { /** - * Immutable. Identifier. Then name of the InterceptDeploymentGroup. + * Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the InterceptDeploymentGroup 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. The list of fields to update. Fields are specified relative to the deployment group (e.g. `description`; *not* `intercept_deployment_group.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; @@ -11263,7 +12021,7 @@ export namespace networksecurity_v1beta1 { } /** - * Creates a new InterceptDeployment in a given project and location. + * Creates a deployment in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11353,7 +12111,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single InterceptDeployment. + * Deletes a deployment. See https://google.aip.dev/135. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11440,7 +12198,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single InterceptDeployment. + * Gets a specific deployment. See https://google.aip.dev/131. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11530,7 +12288,7 @@ export namespace networksecurity_v1beta1 { } /** - * Lists InterceptDeployments in a given project and location. + * Lists deployments in a given project and location. See https://google.aip.dev/132. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11629,7 +12387,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates a single InterceptDeployment. + * Updates a deployment. See https://google.aip.dev/134. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11719,15 +12477,15 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Interceptdeployments$Create extends StandardParameters { /** - * Required. Id of the requesting object If auto-generating Id server-side, remove this field and intercept_deployment_id from the method_signature of Create RPC + * Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name. */ interceptDeploymentId?: string; /** - * Required. Value for parent. + * Required. The parent resource where this deployment will be created. 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 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; @@ -11743,52 +12501,52 @@ export namespace networksecurity_v1beta1 { */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Interceptdeployments$Get extends StandardParameters { /** - * Required. Name of the resource + * Required. The name of the deployment to retrieve. Format: projects/{project\}/locations/{location\}/interceptDeployments/{intercept_deployment\} */ name?: string; } export interface Params$Resource$Projects$Locations$Interceptdeployments$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListInterceptDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptDeployments` must match the call that provided the page token. See https://google.aip.dev/158 for more details. */ pageToken?: string; /** - * Required. Parent value for ListInterceptDeploymentsRequest + * Required. The parent, which owns this collection of deployments. Example: `projects/123456789/locations/us-central1-a`. See https://google.aip.dev/132 for more details. */ parent?: string; } export interface Params$Resource$Projects$Locations$Interceptdeployments$Patch extends StandardParameters { /** - * Immutable. Identifier. The name of the InterceptDeployment. + * Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/interceptDeployments/my-dep`. See https://google.aip.dev/122 for more details. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the InterceptDeployment 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. The list of fields to update. Fields are specified relative to the deployment (e.g. `description`; *not* `intercept_deployment.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; @@ -11805,7 +12563,7 @@ export namespace networksecurity_v1beta1 { } /** - * Creates a new InterceptEndpointGroupAssociation in a given project and location. + * Creates an association in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11894,7 +12652,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single InterceptEndpointGroupAssociation. + * Deletes an association. See https://google.aip.dev/135. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11981,7 +12739,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single InterceptEndpointGroupAssociation. + * Gets a specific association. See https://google.aip.dev/131. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12077,7 +12835,7 @@ export namespace networksecurity_v1beta1 { } /** - * Lists InterceptEndpointGroupAssociations in a given project and location. + * Lists associations in a given project and location. See https://google.aip.dev/132. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12175,7 +12933,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates a single InterceptEndpointGroupAssociation. + * Updates an association. See https://google.aip.dev/134. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12265,15 +13023,15 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Create extends StandardParameters { /** - * Optional. Id of the requesting object If auto-generating Id server-side, remove this field and intercept_endpoint_group_association_id from the method_signature of Create RPC + * Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID. */ interceptEndpointGroupAssociationId?: string; /** - * Required. Value for parent. + * Required. The parent resource where this association will be created. 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 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; @@ -12285,56 +13043,56 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Delete extends StandardParameters { /** - * Required. Name of the resource + * Required. The association to delete. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Get extends StandardParameters { /** - * Required. Name of the resource + * Required. The name of the association to retrieve. Format: projects/{project\}/locations/{location\}/interceptEndpointGroupAssociations/{intercept_endpoint_group_association\} */ name?: string; } export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListInterceptEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. */ pageToken?: string; /** - * Required. Parent value for ListInterceptEndpointGroupAssociationsRequest + * Required. The parent, which owns this collection of associations. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. */ parent?: string; } export interface Params$Resource$Projects$Locations$Interceptendpointgroupassociations$Patch extends StandardParameters { /** - * Immutable. Identifier. The name of the InterceptEndpointGroupAssociation. + * Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the InterceptEndpointGroupAssociation 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. The list of fields to update. Fields are specified relative to the association (e.g. `description`; *not* `intercept_endpoint_group_association.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; @@ -12351,7 +13109,7 @@ export namespace networksecurity_v1beta1 { } /** - * Creates a new InterceptEndpointGroup in a given project and location. + * Creates an endpoint group in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12440,7 +13198,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single InterceptEndpointGroup. + * Deletes an endpoint group. See https://google.aip.dev/135. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12527,7 +13285,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single InterceptEndpointGroup. + * Gets a specific endpoint group. See https://google.aip.dev/131. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12619,7 +13377,7 @@ export namespace networksecurity_v1beta1 { } /** - * Lists InterceptEndpointGroups in a given project and location. + * Lists endpoint groups in a given project and location. See https://google.aip.dev/132. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12717,7 +13475,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates a single InterceptEndpointGroup. + * Updates an endpoint group. See https://google.aip.dev/134. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12807,15 +13565,15 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Interceptendpointgroups$Create extends StandardParameters { /** - * Required. Id of the requesting object If auto-generating Id server-side, remove this field and intercept_endpoint_group_id from the method_signature of Create RPC + * Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name. */ interceptEndpointGroupId?: string; /** - * Required. Value for parent. + * Required. The parent resource where this endpoint group will be created. 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 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; @@ -12827,56 +13585,56 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Interceptendpointgroups$Delete extends StandardParameters { /** - * Required. Name of the resource + * Required. The endpoint group to delete. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Interceptendpointgroups$Get extends StandardParameters { /** - * Required. Name of the resource + * Required. The name of the endpoint group to retrieve. Format: projects/{project\}/locations/{location\}/interceptEndpointGroups/{intercept_endpoint_group\} */ name?: string; } export interface Params$Resource$Projects$Locations$Interceptendpointgroups$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListInterceptEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInterceptEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. */ pageToken?: string; /** - * Required. Parent value for ListInterceptEndpointGroupsRequest + * Required. The parent, which owns this collection of endpoint groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. */ parent?: string; } export interface Params$Resource$Projects$Locations$Interceptendpointgroups$Patch extends StandardParameters { /** - * Immutable. Identifier. The name of the InterceptEndpointGroup. + * Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the InterceptEndpointGroup 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. The list of fields to update. Fields are specified relative to the endpoint group (e.g. `description`; *not* `intercept_endpoint_group.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; @@ -12893,7 +13651,7 @@ export namespace networksecurity_v1beta1 { } /** - * Creates a new MirroringDeploymentGroup in a given project and location. + * Creates a deployment group in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12982,7 +13740,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single MirroringDeploymentGroup. + * Deletes a deployment group. See https://google.aip.dev/135. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13069,7 +13827,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single MirroringDeploymentGroup. + * Gets a specific deployment group. See https://google.aip.dev/131. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13161,7 +13919,7 @@ export namespace networksecurity_v1beta1 { } /** - * Lists MirroringDeploymentGroups in a given project and location. + * Lists deployment groups in a given project and location. See https://google.aip.dev/132. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13259,7 +14017,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates a single MirroringDeploymentGroup. + * Updates a deployment group. See https://google.aip.dev/134. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13349,15 +14107,15 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create extends StandardParameters { /** - * Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_group_id from the method_signature of Create RPC + * Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name. */ mirroringDeploymentGroupId?: string; /** - * Required. Value for parent. + * Required. The parent resource where this deployment group will be created. 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 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; @@ -13369,56 +14127,56 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete extends StandardParameters { /** - * Required. Name of the resource + * Required. The deployment group to delete. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get extends StandardParameters { /** - * Required. Name of the resource + * Required. The name of the deployment group to retrieve. Format: projects/{project\}/locations/{location\}/mirroringDeploymentGroups/{mirroring_deployment_group\} */ name?: string; } export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListMirroringDeploymentGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringDeploymentGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. */ pageToken?: string; /** - * Required. Parent value for ListMirroringDeploymentGroupsRequest + * Required. The parent, which owns this collection of deployment groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. */ parent?: string; } export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch extends StandardParameters { /** - * Immutable. Identifier. Then name of the MirroringDeploymentGroup. + * Immutable. Identifier. The resource name of this deployment group, for example: `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. See https://google.aip.dev/122 for more details. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the MirroringDeploymentGroup 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. The list of fields to update. Fields are specified relative to the deployment group (e.g. `description`; *not* `mirroring_deployment_group.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; @@ -13435,7 +14193,7 @@ export namespace networksecurity_v1beta1 { } /** - * Creates a new MirroringDeployment in a given project and location. + * Creates a deployment in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13525,7 +14283,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single MirroringDeployment. + * Deletes a deployment. See https://google.aip.dev/135. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13612,7 +14370,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single MirroringDeployment. + * Gets a specific deployment. See https://google.aip.dev/131. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13702,7 +14460,7 @@ export namespace networksecurity_v1beta1 { } /** - * Lists MirroringDeployments in a given project and location. + * Lists deployments in a given project and location. See https://google.aip.dev/132. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13801,7 +14559,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates a single MirroringDeployment. + * Updates a deployment. See https://google.aip.dev/134. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13891,15 +14649,15 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Mirroringdeployments$Create extends StandardParameters { /** - * Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC + * Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name. */ mirroringDeploymentId?: string; /** - * Required. Value for parent. + * Required. The parent resource where this deployment will be created. 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 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; @@ -13915,52 +14673,52 @@ export namespace networksecurity_v1beta1 { */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Mirroringdeployments$Get extends StandardParameters { /** - * Required. Name of the resource + * Required. The name of the deployment to retrieve. Format: projects/{project\}/locations/{location\}/mirroringDeployments/{mirroring_deployment\} */ name?: string; } export interface Params$Resource$Projects$Locations$Mirroringdeployments$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListMirroringDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringDeployments` must match the call that provided the page token. See https://google.aip.dev/158 for more details. */ pageToken?: string; /** - * Required. Parent value for ListMirroringDeploymentsRequest + * Required. The parent, which owns this collection of deployments. Example: `projects/123456789/locations/us-central1-a`. See https://google.aip.dev/132 for more details. */ parent?: string; } export interface Params$Resource$Projects$Locations$Mirroringdeployments$Patch extends StandardParameters { /** - * Immutable. Identifier. The name of the MirroringDeployment. + * Immutable. Identifier. The resource name of this deployment, for example: `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. See https://google.aip.dev/122 for more details. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the MirroringDeployment 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. The list of fields to update. Fields are specified relative to the deployment (e.g. `description`; *not* `mirroring_deployment.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; @@ -13977,7 +14735,7 @@ export namespace networksecurity_v1beta1 { } /** - * Creates a new MirroringEndpointGroupAssociation in a given project and location. + * Creates an association in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14066,7 +14824,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single MirroringEndpointGroupAssociation. + * Deletes an association. See https://google.aip.dev/135. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14153,7 +14911,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single MirroringEndpointGroupAssociation. + * Gets a specific association. See https://google.aip.dev/131. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14249,7 +15007,7 @@ export namespace networksecurity_v1beta1 { } /** - * Lists MirroringEndpointGroupAssociations in a given project and location. + * Lists associations in a given project and location. See https://google.aip.dev/132. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14347,7 +15105,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates a single MirroringEndpointGroupAssociation. + * Updates an association. See https://google.aip.dev/134. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14437,15 +15195,15 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create extends StandardParameters { /** - * Optional. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_association_id from the method_signature of Create RPC + * Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID. */ mirroringEndpointGroupAssociationId?: string; /** - * Required. Value for parent. + * Required. The parent resource where this association will be created. 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 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; @@ -14457,56 +15215,56 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete extends StandardParameters { /** - * Required. Name of the resource + * Required. The association to delete. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get extends StandardParameters { /** - * Required. Name of the resource + * Required. The name of the association to retrieve. Format: projects/{project\}/locations/{location\}/mirroringEndpointGroupAssociations/{mirroring_endpoint_group_association\} */ name?: string; } export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. */ pageToken?: string; /** - * Required. Parent value for ListMirroringEndpointGroupAssociationsRequest + * Required. The parent, which owns this collection of associations. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. */ parent?: string; } export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch extends StandardParameters { /** - * Immutable. Identifier. The name of the MirroringEndpointGroupAssociation. + * Immutable. Identifier. The resource name of this endpoint group association, for example: `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. See https://google.aip.dev/122 for more details. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the MirroringEndpointGroupAssociation 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. The list of fields to update. Fields are specified relative to the association (e.g. `description`; *not* `mirroring_endpoint_group_association.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; @@ -14523,7 +15281,7 @@ export namespace networksecurity_v1beta1 { } /** - * Creates a new MirroringEndpointGroup in a given project and location. + * Creates an endpoint group in a given project and location. See https://google.aip.dev/133. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14612,7 +15370,7 @@ export namespace networksecurity_v1beta1 { } /** - * Deletes a single MirroringEndpointGroup. + * Deletes an endpoint group. See https://google.aip.dev/135. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14699,7 +15457,7 @@ export namespace networksecurity_v1beta1 { } /** - * Gets details of a single MirroringEndpointGroup. + * Gets a specific endpoint group. See https://google.aip.dev/131. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14791,7 +15549,7 @@ export namespace networksecurity_v1beta1 { } /** - * Lists MirroringEndpointGroups in a given project and location. + * Lists endpoint groups in a given project and location. See https://google.aip.dev/132. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14889,7 +15647,7 @@ export namespace networksecurity_v1beta1 { } /** - * Updates a single MirroringEndpointGroup. + * Updates an endpoint group. See https://google.aip.dev/134. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14979,15 +15737,15 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$Create extends StandardParameters { /** - * Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_id from the method_signature of Create RPC + * Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name. */ mirroringEndpointGroupId?: string; /** - * Required. Value for parent. + * Required. The parent resource where this endpoint group will be created. 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 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; @@ -14999,56 +15757,56 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete extends StandardParameters { /** - * Required. Name of the resource + * Required. The endpoint group to delete. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; } export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$Get extends StandardParameters { /** - * Required. Name of the resource + * Required. The name of the endpoint group to retrieve. Format: projects/{project\}/locations/{location\}/mirroringEndpointGroups/{mirroring_endpoint_group\} */ name?: string; } export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$List extends StandardParameters { /** - * Optional. Filtering results + * Optional. Filter expression. See https://google.aip.dev/160#filtering for more details. */ filter?: string; /** - * Optional. Hint for how to order the results + * Optional. Sort expression. See https://google.aip.dev/132#ordering for more details. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMirroringEndpointGroups` must match the call that provided the page token. See https://google.aip.dev/158 for more details. */ pageToken?: string; /** - * Required. Parent value for ListMirroringEndpointGroupsRequest + * Required. The parent, which owns this collection of endpoint groups. Example: `projects/123456789/locations/global`. See https://google.aip.dev/132 for more details. */ parent?: string; } export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch extends StandardParameters { /** - * Immutable. Identifier. Next ID: 11 The name of the MirroringEndpointGroup. + * Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details. */ 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). + * Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a `request_id` is provided. See https://google.aip.dev/155 for more details. */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the MirroringEndpointGroup 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. The list of fields to update. Fields are specified relative to the endpoint group (e.g. `description`; *not* `mirroring_endpoint_group.description`). See https://google.aip.dev/161 for more details. */ updateMask?: string; @@ -16266,6 +17024,10 @@ export namespace networksecurity_v1beta1 { * Required. The project and location from which the ServerTlsPolicies should be listed, specified in the format `projects/x/locations/{location\}`. */ parent?: string; + /** + * Optional. Setting this field to `true` will opt the request into returning the resources that are reachable, and into including the names of those that were unreachable in the [ListServerTlsPoliciesResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Servertlspolicies$Patch extends StandardParameters { From 0d8b67539ea6553a642fe98a029b3c7ebb1ff235 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:47 +0000 Subject: [PATCH 093/144] feat(networkservices)!: update the API BREAKING CHANGE: This release has breaking changes. #### networkservices:v1beta1 The following keys were deleted: - resources.projects.resources.locations.resources.grpcRoutes.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.grpcRoutes.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.grpcRoutes.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.httpRoutes.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.httpRoutes.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.httpRoutes.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.tcpRoutes.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.tcpRoutes.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.tcpRoutes.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.tlsRoutes.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.tlsRoutes.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.tlsRoutes.methods.delete.parameters.etag.type - schemas.GrpcRoute.properties.etag.description - schemas.GrpcRoute.properties.etag.readOnly - schemas.GrpcRoute.properties.etag.type - schemas.HttpRoute.properties.etag.description - schemas.HttpRoute.properties.etag.readOnly - schemas.HttpRoute.properties.etag.type - schemas.TcpRoute.properties.etag.description - schemas.TcpRoute.properties.etag.readOnly - schemas.TcpRoute.properties.etag.type - schemas.TlsRoute.properties.etag.description - schemas.TlsRoute.properties.etag.readOnly - schemas.TlsRoute.properties.etag.type The following keys were added: - resources.projects.resources.locations.resources.meshes.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.meshes.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.meshes.methods.list.parameters.returnPartialSuccess.type - schemas.ListGatewayRouteViewsResponse.properties.unreachable.description - schemas.ListGatewayRouteViewsResponse.properties.unreachable.items.type - schemas.ListGatewayRouteViewsResponse.properties.unreachable.type - schemas.ListMeshRouteViewsResponse.properties.unreachable.description - schemas.ListMeshRouteViewsResponse.properties.unreachable.items.type - schemas.ListMeshRouteViewsResponse.properties.unreachable.type - schemas.ListMeshesResponse.properties.unreachable.description - schemas.ListMeshesResponse.properties.unreachable.items.type - schemas.ListMeshesResponse.properties.unreachable.type - schemas.ListServiceBindingsResponse.properties.unreachable.description - schemas.ListServiceBindingsResponse.properties.unreachable.items.type - schemas.ListServiceBindingsResponse.properties.unreachable.type - schemas.ListServiceLbPoliciesResponse.properties.unreachable.description - schemas.ListServiceLbPoliciesResponse.properties.unreachable.items.type - schemas.ListServiceLbPoliciesResponse.properties.unreachable.type The following keys were changed: - resources.projects.resources.locations.resources.authzExtensions.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.authzExtensions.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.authzExtensions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.authzExtensions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.authzExtensions.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.serviceBindings.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.serviceBindings.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.serviceBindings.methods.get.parameters.name.description - resources.projects.resources.locations.resources.serviceBindings.methods.list.parameters.parent.description - schemas.AuthzExtension.properties.wireFormat.description - schemas.AuthzExtension.properties.wireFormat.enumDescriptions - schemas.ExtensionChainExtension.properties.supportedEvents.description - schemas.LbTrafficExtension.properties.loadBalancingScheme.description - schemas.ServiceBinding.description - schemas.ServiceBinding.properties.name.description - schemas.ServiceBinding.properties.service.description - schemas.ServiceBinding.properties.serviceId.description - schemas.TlsRouteRouteMatch.description - schemas.TlsRouteRouteRule.properties.matches.description #### networkservices:v1 The following keys were deleted: - resources.projects.resources.locations.resources.grpcRoutes.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.grpcRoutes.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.grpcRoutes.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.httpRoutes.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.httpRoutes.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.httpRoutes.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.tcpRoutes.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.tcpRoutes.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.tcpRoutes.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.tlsRoutes.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.tlsRoutes.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.tlsRoutes.methods.delete.parameters.etag.type - schemas.GrpcRoute.properties.etag.description - schemas.GrpcRoute.properties.etag.readOnly - schemas.GrpcRoute.properties.etag.type - schemas.HttpRoute.properties.etag.description - schemas.HttpRoute.properties.etag.readOnly - schemas.HttpRoute.properties.etag.type - schemas.TcpRoute.properties.etag.description - schemas.TcpRoute.properties.etag.readOnly - schemas.TcpRoute.properties.etag.type - schemas.TlsRoute.properties.etag.description - schemas.TlsRoute.properties.etag.readOnly - schemas.TlsRoute.properties.etag.type The following keys were added: - resources.projects.resources.locations.resources.meshes.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.meshes.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.meshes.methods.list.parameters.returnPartialSuccess.type - schemas.ListGatewayRouteViewsResponse.properties.unreachable.description - schemas.ListGatewayRouteViewsResponse.properties.unreachable.items.type - schemas.ListGatewayRouteViewsResponse.properties.unreachable.type - schemas.ListMeshRouteViewsResponse.properties.unreachable.description - schemas.ListMeshRouteViewsResponse.properties.unreachable.items.type - schemas.ListMeshRouteViewsResponse.properties.unreachable.type - schemas.ListMeshesResponse.properties.unreachable.description - schemas.ListMeshesResponse.properties.unreachable.items.type - schemas.ListMeshesResponse.properties.unreachable.type - schemas.ListServiceBindingsResponse.properties.unreachable.description - schemas.ListServiceBindingsResponse.properties.unreachable.items.type - schemas.ListServiceBindingsResponse.properties.unreachable.type - schemas.ListServiceLbPoliciesResponse.properties.unreachable.description - schemas.ListServiceLbPoliciesResponse.properties.unreachable.items.type - schemas.ListServiceLbPoliciesResponse.properties.unreachable.type The following keys were changed: - resources.projects.resources.locations.resources.authzExtensions.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.authzExtensions.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.authzExtensions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.authzExtensions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.authzExtensions.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.serviceBindings.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.serviceBindings.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.serviceBindings.methods.get.parameters.name.description - resources.projects.resources.locations.resources.serviceBindings.methods.list.parameters.parent.description - schemas.AuthzExtension.properties.wireFormat.description - schemas.AuthzExtension.properties.wireFormat.enumDescriptions - schemas.ExtensionChainExtension.properties.supportedEvents.description - schemas.LbTrafficExtension.properties.loadBalancingScheme.description - schemas.ServiceBinding.description - schemas.ServiceBinding.properties.name.description - schemas.ServiceBinding.properties.service.description - schemas.ServiceBinding.properties.serviceId.description - schemas.TlsRouteRouteMatch.description - schemas.TlsRouteRouteRule.properties.matches.description --- discovery/networkservices-v1.json | 140 ++++++++++++------------- discovery/networkservices-v1beta1.json | 140 ++++++++++++------------- src/apis/networkservices/v1.ts | 112 +++++++++----------- src/apis/networkservices/v1beta1.ts | 112 +++++++++----------- 4 files changed, 244 insertions(+), 260 deletions(-) diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 12d13fc74b9..089e1ec2c19 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -201,7 +201,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -234,7 +234,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -287,7 +287,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results.", + "description": "Optional. Hint about how to order the results.", "location": "query", "type": "string" }, @@ -303,7 +303,7 @@ "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}`.", + "description": "Required. The project and location from which the `AuthzExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -335,7 +335,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" }, @@ -1057,11 +1057,6 @@ "name" ], "parameters": { - "etag": { - "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "location": "query", - "type": "string" - }, "name": { "description": "Required. A name of the GrpcRoute to delete. Must be in the format `projects/*/locations/global/grpcRoutes/*`.", "location": "path", @@ -1219,11 +1214,6 @@ "name" ], "parameters": { - "etag": { - "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "location": "query", - "type": "string" - }, "name": { "description": "Required. A name of the HttpRoute to delete. Must be in the format `projects/*/locations/global/httpRoutes/*`.", "location": "path", @@ -1361,7 +1351,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -1394,7 +1384,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -1447,7 +1437,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results.", + "description": "Optional. Hint about how to order the results.", "location": "query", "type": "string" }, @@ -1463,7 +1453,7 @@ "type": "string" }, "parent": { - "description": "Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", + "description": "Required. The project and location from which the `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1495,7 +1485,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" }, @@ -1543,7 +1533,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -1576,7 +1566,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -1629,7 +1619,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results.", + "description": "Optional. Hint about how to order the results.", "location": "query", "type": "string" }, @@ -1645,7 +1635,7 @@ "type": "string" }, "parent": { - "description": "Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", + "description": "Required. The project and location from which the `LbTrafficExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1677,7 +1667,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" }, @@ -1812,6 +1802,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/meshes", @@ -2060,7 +2055,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource of the ServiceBinding. Must be in the format `projects/*/locations/global`.", + "description": "Required. The parent resource of the ServiceBinding. Must be in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2093,7 +2088,7 @@ ], "parameters": { "name": { - "description": "Required. A name of the ServiceBinding to delete. Must be in the format `projects/*/locations/global/serviceBindings/*`.", + "description": "Required. A name of the ServiceBinding to delete. Must be in the format `projects/*/locations/*/serviceBindings/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", "required": true, @@ -2118,7 +2113,7 @@ ], "parameters": { "name": { - "description": "Required. A name of the ServiceBinding to get. Must be in the format `projects/*/locations/global/serviceBindings/*`.", + "description": "Required. A name of the ServiceBinding to get. Must be in the format `projects/*/locations/*/serviceBindings/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", "required": true, @@ -2154,7 +2149,7 @@ "type": "string" }, "parent": { - "description": "Required. The project and location from which the ServiceBindings should be listed, specified in the format `projects/*/locations/global`.", + "description": "Required. The project and location from which the ServiceBindings should be listed, specified in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2372,11 +2367,6 @@ "name" ], "parameters": { - "etag": { - "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "location": "query", - "type": "string" - }, "name": { "description": "Required. A name of the TcpRoute to delete. Must be in the format `projects/*/locations/global/tcpRoutes/*`.", "location": "path", @@ -2534,11 +2524,6 @@ "name" ], "parameters": { - "etag": { - "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "location": "query", - "type": "string" - }, "name": { "description": "Required. A name of the TlsRoute to delete. Must be in the format `projects/*/locations/global/tlsRoutes/*`.", "location": "path", @@ -2954,7 +2939,7 @@ } } }, - "revision": "20250120", + "revision": "20250310", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3083,14 +3068,14 @@ "type": "string" }, "wireFormat": { - "description": "Optional. The format of communication supported by the callout extension. If not specified, the default is `EXT_PROC_GRPC`.", + "description": "Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used.", "enum": [ "WIRE_FORMAT_UNSPECIFIED", "EXT_PROC_GRPC" ], "enumDescriptions": [ "Not specified.", - "The extension service uses ExtProc GRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request will be sent as part of the same gRPC stream." + "The extension service uses ExtProc GRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream." ], "type": "string" } @@ -3334,7 +3319,7 @@ "type": "string" }, "supportedEvents": { - "description": "Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource, otherwise a validation error is returned.", + "description": "Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It is optional for the `LbRouteExtension` resource. If unspecified `REQUEST_HEADERS` event is assumed as supported.", "items": { "enum": [ "EVENT_TYPE_UNSPECIFIED", @@ -3559,11 +3544,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, - "etag": { - "description": "Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "readOnly": true, - "type": "string" - }, "gateways": { "description": "Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -3861,11 +3841,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, - "etag": { - "description": "Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "readOnly": true, - "type": "string" - }, "gateways": { "description": "Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -4518,7 +4493,7 @@ "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 [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -4609,6 +4584,13 @@ "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" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4756,6 +4738,13 @@ "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" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4774,6 +4763,13 @@ "nextPageToken": { "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request opts into `return_partial_success` and reading across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4810,6 +4806,13 @@ "$ref": "ServiceBinding" }, "type": "array" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4828,6 +4831,13 @@ "$ref": "ServiceLbPolicy" }, "type": "array" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -5185,7 +5195,7 @@ "type": "object" }, "ServiceBinding": { - "description": "ServiceBinding is the resource that defines a Service Directory Service to be used in a BackendService resource.", + "description": "ServiceBinding can be used to: - Bind a Service Directory Service to be used in a BackendService resource. - Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers.", "id": "ServiceBinding", "properties": { "createTime": { @@ -5206,15 +5216,15 @@ "type": "object" }, "name": { - "description": "Identifier. 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/*/serviceBindings/`.", "type": "string" }, "service": { - "description": "Required. The full Service Directory Service name of the format projects/*/locations/*/namespaces/*/services/*", + "description": "Optional. The full Service Directory Service name of the format `projects/*/locations/*/namespaces/*/services/*`. This field must be set.", "type": "string" }, "serviceId": { - "description": "Output only. The unique identifier of the Service Directory Service against which the Service Binding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format.", + "description": "Output only. The unique identifier of the Service Directory Service against which the ServiceBinding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format.", "readOnly": true, "type": "string" }, @@ -5367,11 +5377,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, - "etag": { - "description": "Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "readOnly": true, - "type": "string" - }, "gateways": { "description": "Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -5532,11 +5537,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, - "etag": { - "description": "Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "readOnly": true, - "type": "string" - }, "gateways": { "description": "Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -5619,7 +5619,7 @@ "type": "object" }, "TlsRouteRouteMatch": { - "description": "RouteMatch defines the predicate used to match requests to a given action. Multiple match types are \"AND\"ed for evaluation. If no routeMatch field is specified, this rule will unconditionally match traffic.", + "description": "RouteMatch defines the predicate used to match requests to a given action. Multiple match types are \"AND\"ed for evaluation.", "id": "TlsRouteRouteMatch", "properties": { "alpn": { @@ -5648,7 +5648,7 @@ "description": "Required. The detailed rule defining how to route matched traffic." }, "matches": { - "description": "Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are \"OR\"ed for evaluation.", + "description": "Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are \"OR\"ed for evaluation. Atleast one RouteMatch must be supplied.", "items": { "$ref": "TlsRouteRouteMatch" }, diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 8c0c95610f4..906183477f9 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -201,7 +201,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -234,7 +234,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -287,7 +287,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results.", + "description": "Optional. Hint about how to order the results.", "location": "query", "type": "string" }, @@ -303,7 +303,7 @@ "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}`.", + "description": "Required. The project and location from which the `AuthzExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -335,7 +335,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" }, @@ -784,11 +784,6 @@ "name" ], "parameters": { - "etag": { - "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "location": "query", - "type": "string" - }, "name": { "description": "Required. A name of the GrpcRoute to delete. Must be in the format `projects/*/locations/global/grpcRoutes/*`.", "location": "path", @@ -946,11 +941,6 @@ "name" ], "parameters": { - "etag": { - "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "location": "query", - "type": "string" - }, "name": { "description": "Required. A name of the HttpRoute to delete. Must be in the format `projects/*/locations/global/httpRoutes/*`.", "location": "path", @@ -1088,7 +1078,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -1121,7 +1111,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -1174,7 +1164,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results.", + "description": "Optional. Hint about how to order the results.", "location": "query", "type": "string" }, @@ -1190,7 +1180,7 @@ "type": "string" }, "parent": { - "description": "Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", + "description": "Required. The project and location from which the `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1222,7 +1212,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" }, @@ -1270,7 +1260,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -1303,7 +1293,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" } @@ -1356,7 +1346,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. Hint for how to order the results.", + "description": "Optional. Hint about how to order the results.", "location": "query", "type": "string" }, @@ -1372,7 +1362,7 @@ "type": "string" }, "parent": { - "description": "Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", + "description": "Required. The project and location from which the `LbTrafficExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1404,7 +1394,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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).", + "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 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 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" }, @@ -1539,6 +1529,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+parent}/meshes", @@ -1787,7 +1782,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource of the ServiceBinding. Must be in the format `projects/*/locations/global`.", + "description": "Required. The parent resource of the ServiceBinding. Must be in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1820,7 +1815,7 @@ ], "parameters": { "name": { - "description": "Required. A name of the ServiceBinding to delete. Must be in the format `projects/*/locations/global/serviceBindings/*`.", + "description": "Required. A name of the ServiceBinding to delete. Must be in the format `projects/*/locations/*/serviceBindings/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", "required": true, @@ -1845,7 +1840,7 @@ ], "parameters": { "name": { - "description": "Required. A name of the ServiceBinding to get. Must be in the format `projects/*/locations/global/serviceBindings/*`.", + "description": "Required. A name of the ServiceBinding to get. Must be in the format `projects/*/locations/*/serviceBindings/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", "required": true, @@ -1881,7 +1876,7 @@ "type": "string" }, "parent": { - "description": "Required. The project and location from which the ServiceBindings should be listed, specified in the format `projects/*/locations/global`.", + "description": "Required. The project and location from which the ServiceBindings should be listed, specified in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2099,11 +2094,6 @@ "name" ], "parameters": { - "etag": { - "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "location": "query", - "type": "string" - }, "name": { "description": "Required. A name of the TcpRoute to delete. Must be in the format `projects/*/locations/global/tcpRoutes/*`.", "location": "path", @@ -2261,11 +2251,6 @@ "name" ], "parameters": { - "etag": { - "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "location": "query", - "type": "string" - }, "name": { "description": "Required. A name of the TlsRoute to delete. Must be in the format `projects/*/locations/global/tlsRoutes/*`.", "location": "path", @@ -2681,7 +2666,7 @@ } } }, - "revision": "20250120", + "revision": "20250310", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { @@ -2762,14 +2747,14 @@ "type": "string" }, "wireFormat": { - "description": "Optional. The format of communication supported by the callout extension. If not specified, the default is `EXT_PROC_GRPC`.", + "description": "Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used.", "enum": [ "WIRE_FORMAT_UNSPECIFIED", "EXT_PROC_GRPC" ], "enumDescriptions": [ "Not specified.", - "The extension service uses ExtProc GRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request will be sent as part of the same gRPC stream." + "The extension service uses ExtProc GRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream." ], "type": "string" } @@ -2925,7 +2910,7 @@ "type": "string" }, "supportedEvents": { - "description": "Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource, otherwise a validation error is returned.", + "description": "Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It is optional for the `LbRouteExtension` resource. If unspecified `REQUEST_HEADERS` event is assumed as supported.", "items": { "enum": [ "EVENT_TYPE_UNSPECIFIED", @@ -3150,11 +3135,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, - "etag": { - "description": "Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "readOnly": true, - "type": "string" - }, "gateways": { "description": "Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -3452,11 +3432,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, - "etag": { - "description": "Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "readOnly": true, - "type": "string" - }, "gateways": { "description": "Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -4109,7 +4084,7 @@ "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 [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).", "enum": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -4200,6 +4175,13 @@ "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" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4347,6 +4329,13 @@ "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" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4365,6 +4354,13 @@ "nextPageToken": { "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", "type": "string" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request opts into `return_partial_success` and reading across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4401,6 +4397,13 @@ "$ref": "ServiceBinding" }, "type": "array" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4419,6 +4422,13 @@ "$ref": "ServiceLbPolicy" }, "type": "array" + }, + "unreachable": { + "description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4788,7 +4798,7 @@ "type": "object" }, "ServiceBinding": { - "description": "ServiceBinding is the resource that defines a Service Directory Service to be used in a BackendService resource.", + "description": "ServiceBinding can be used to: - Bind a Service Directory Service to be used in a BackendService resource. - Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers.", "id": "ServiceBinding", "properties": { "createTime": { @@ -4809,15 +4819,15 @@ "type": "object" }, "name": { - "description": "Identifier. 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/*/serviceBindings/`.", "type": "string" }, "service": { - "description": "Required. The full Service Directory Service name of the format projects/*/locations/*/namespaces/*/services/*", + "description": "Optional. The full Service Directory Service name of the format `projects/*/locations/*/namespaces/*/services/*`. This field must be set.", "type": "string" }, "serviceId": { - "description": "Output only. The unique identifier of the Service Directory Service against which the Service Binding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format.", + "description": "Output only. The unique identifier of the Service Directory Service against which the ServiceBinding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format.", "readOnly": true, "type": "string" }, @@ -4954,11 +4964,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, - "etag": { - "description": "Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "readOnly": true, - "type": "string" - }, "gateways": { "description": "Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -5091,11 +5096,6 @@ "description": "Optional. A free-text description of the resource. Max length 1024 characters.", "type": "string" }, - "etag": { - "description": "Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", - "readOnly": true, - "type": "string" - }, "gateways": { "description": "Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`", "items": { @@ -5178,7 +5178,7 @@ "type": "object" }, "TlsRouteRouteMatch": { - "description": "RouteMatch defines the predicate used to match requests to a given action. Multiple match types are \"AND\"ed for evaluation. If no routeMatch field is specified, this rule will unconditionally match traffic.", + "description": "RouteMatch defines the predicate used to match requests to a given action. Multiple match types are \"AND\"ed for evaluation.", "id": "TlsRouteRouteMatch", "properties": { "alpn": { @@ -5207,7 +5207,7 @@ "description": "Required. The detailed rule defining how to route matched traffic." }, "matches": { - "description": "Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are \"OR\"ed for evaluation.", + "description": "Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are \"OR\"ed for evaluation. Atleast one RouteMatch must be supplied.", "items": { "$ref": "TlsRouteRouteMatch" }, diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index d777a561113..c604390d2af 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -203,7 +203,7 @@ export namespace networkservices_v1 { */ updateTime?: string | null; /** - * Optional. The format of communication supported by the callout extension. If not specified, the default is `EXT_PROC_GRPC`. + * Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used. */ wireFormat?: string | null; } @@ -383,7 +383,7 @@ export namespace networkservices_v1 { */ service?: string | null; /** - * Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource, otherwise a validation error is returned. + * Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It is optional for the `LbRouteExtension` resource. If unspecified `REQUEST_HEADERS` event is assumed as supported. */ supportedEvents?: string[] | null; /** @@ -514,10 +514,6 @@ export namespace networkservices_v1 { * Optional. A free-text description of the resource. Max length 1024 characters. */ description?: string | null; - /** - * Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string | null; /** * Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/x/locations/global/gateways/` */ @@ -730,10 +726,6 @@ export namespace networkservices_v1 { * Optional. A free-text description of the resource. Max length 1024 characters. */ description?: string | null; - /** - * Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string | null; /** * Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/x/locations/global/gateways/` */ @@ -1219,7 +1211,7 @@ export namespace networkservices_v1 { */ 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 [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** @@ -1277,6 +1269,10 @@ export namespace networkservices_v1 { * 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; + /** + * Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; } /** * Response returned by the ListGateways method. @@ -1380,6 +1376,10 @@ export namespace networkservices_v1 { * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. */ nextPageToken?: string | null; + /** + * Unreachable resources. Populated when the request opts into `return_partial_success` and reading across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response returned by the ListMeshRouteViews method. @@ -1393,6 +1393,10 @@ export namespace networkservices_v1 { * 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; + /** + * Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; } /** * The response message for Operations.ListOperations. @@ -1419,6 +1423,10 @@ export namespace networkservices_v1 { * List of ServiceBinding resources. */ serviceBindings?: Schema$ServiceBinding[]; + /** + * Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; } /** * Response returned by the ListServiceLbPolicies method. @@ -1432,6 +1440,10 @@ export namespace networkservices_v1 { * List of ServiceLbPolicy resources. */ serviceLbPolicies?: Schema$ServiceLbPolicy[]; + /** + * Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; } /** * Response returned by the ListTcpRoutes method. @@ -1667,7 +1679,7 @@ export namespace networkservices_v1 { cryptoKeyName?: string | null; } /** - * ServiceBinding is the resource that defines a Service Directory Service to be used in a BackendService resource. + * ServiceBinding can be used to: - Bind a Service Directory Service to be used in a BackendService resource. - Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers. */ export interface Schema$ServiceBinding { /** @@ -1683,15 +1695,15 @@ export namespace networkservices_v1 { */ labels?: {[key: string]: string} | null; /** - * Identifier. 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/x/serviceBindings/`. */ name?: string | null; /** - * Required. The full Service Directory Service name of the format projects/x/locations/x/namespaces/x/services/x + * Optional. The full Service Directory Service name of the format `projects/x/locations/x/namespaces/x/services/x`. This field must be set. */ service?: string | null; /** - * Output only. The unique identifier of the Service Directory Service against which the Service Binding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format. + * Output only. The unique identifier of the Service Directory Service against which the ServiceBinding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format. */ serviceId?: string | null; /** @@ -1796,10 +1808,6 @@ export namespace networkservices_v1 { * Optional. A free-text description of the resource. Max length 1024 characters. */ description?: string | null; - /** - * Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string | null; /** * Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/x/locations/global/gateways/` */ @@ -1915,10 +1923,6 @@ export namespace networkservices_v1 { * Optional. A free-text description of the resource. Max length 1024 characters. */ description?: string | null; - /** - * Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string | null; /** * Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/x/locations/global/gateways/` */ @@ -1975,7 +1979,7 @@ export namespace networkservices_v1 { weight?: number | null; } /** - * RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "AND"ed for evaluation. If no routeMatch field is specified, this rule will unconditionally match traffic. + * RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "AND"ed for evaluation. */ export interface Schema$TlsRouteRouteMatch { /** @@ -1996,7 +2000,7 @@ export namespace networkservices_v1 { */ action?: Schema$TlsRouteRouteAction; /** - * Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. + * Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. Atleast one RouteMatch must be supplied. */ matches?: Schema$TlsRouteRouteMatch[]; } @@ -2905,7 +2909,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; @@ -2921,7 +2925,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; } @@ -2939,7 +2943,7 @@ export namespace networkservices_v1 { */ filter?: string; /** - * Optional. Hint for how to order the results. + * Optional. Hint about how to order the results. */ orderBy?: string; /** @@ -2951,7 +2955,7 @@ export namespace networkservices_v1 { */ pageToken?: string; /** - * Required. The project and location from which the `AuthzExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the `AuthzExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } @@ -2962,7 +2966,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; /** @@ -5649,10 +5653,6 @@ export namespace networkservices_v1 { } export interface Params$Resource$Projects$Locations$Grpcroutes$Delete extends StandardParameters { - /** - * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string; /** * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ @@ -6163,10 +6163,6 @@ export namespace networkservices_v1 { } export interface Params$Resource$Projects$Locations$Httproutes$Delete extends StandardParameters { - /** - * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string; /** * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. */ @@ -6678,7 +6674,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; @@ -6694,7 +6690,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; } @@ -6712,7 +6708,7 @@ export namespace networkservices_v1 { */ filter?: string; /** - * Optional. Hint for how to order the results. + * Optional. Hint about how to order the results. */ orderBy?: string; /** @@ -6724,7 +6720,7 @@ export namespace networkservices_v1 { */ 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 `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } @@ -6735,7 +6731,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; /** @@ -7220,7 +7216,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; @@ -7236,7 +7232,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; } @@ -7254,7 +7250,7 @@ export namespace networkservices_v1 { */ filter?: string; /** - * Optional. Hint for how to order the results. + * Optional. Hint about how to order the results. */ orderBy?: string; /** @@ -7266,7 +7262,7 @@ export namespace networkservices_v1 { */ pageToken?: string; /** - * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the `LbTrafficExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } @@ -7277,7 +7273,7 @@ export namespace networkservices_v1 { */ 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). + * 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 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 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; /** @@ -7785,6 +7781,10 @@ export namespace networkservices_v1 { * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. */ parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Meshes$Patch extends StandardParameters { @@ -8790,7 +8790,7 @@ export namespace networkservices_v1 { export interface Params$Resource$Projects$Locations$Servicebindings$Create extends StandardParameters { /** - * Required. The parent resource of the ServiceBinding. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the ServiceBinding. Must be in the format `projects/x/locations/x`. */ parent?: string; /** @@ -8806,14 +8806,14 @@ export namespace networkservices_v1 { export interface Params$Resource$Projects$Locations$Servicebindings$Delete extends StandardParameters { /** - * Required. A name of the ServiceBinding to delete. Must be in the format `projects/x/locations/global/serviceBindings/x`. + * Required. A name of the ServiceBinding to delete. Must be in the format `projects/x/locations/x/serviceBindings/x`. */ name?: string; } export interface Params$Resource$Projects$Locations$Servicebindings$Get extends StandardParameters { /** - * Required. A name of the ServiceBinding to get. Must be in the format `projects/x/locations/global/serviceBindings/x`. + * Required. A name of the ServiceBinding to get. Must be in the format `projects/x/locations/x/serviceBindings/x`. */ name?: string; } @@ -8828,7 +8828,7 @@ export namespace networkservices_v1 { */ pageToken?: string; /** - * Required. The project and location from which the ServiceBindings should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the ServiceBindings should be listed, specified in the format `projects/x/locations/x`. */ parent?: string; } @@ -9817,10 +9817,6 @@ export namespace networkservices_v1 { } export interface Params$Resource$Projects$Locations$Tcproutes$Delete extends StandardParameters { - /** - * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string; /** * Required. A name of the TcpRoute to delete. Must be in the format `projects/x/locations/global/tcpRoutes/x`. */ @@ -10331,10 +10327,6 @@ export namespace networkservices_v1 { } export interface Params$Resource$Projects$Locations$Tlsroutes$Delete extends StandardParameters { - /** - * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string; /** * Required. A name of the TlsRoute to delete. Must be in the format `projects/x/locations/global/tlsRoutes/x`. */ diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 2da98a378ca..6341ecadc7b 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -177,7 +177,7 @@ export namespace networkservices_v1beta1 { */ updateTime?: string | null; /** - * Optional. The format of communication supported by the callout extension. If not specified, the default is `EXT_PROC_GRPC`. + * Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used. */ wireFormat?: string | null; } @@ -293,7 +293,7 @@ export namespace networkservices_v1beta1 { */ service?: string | null; /** - * Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It must not be set for the `LbRouteExtension` resource, otherwise a validation error is returned. + * Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It is optional for the `LbRouteExtension` resource. If unspecified `REQUEST_HEADERS` event is assumed as supported. */ supportedEvents?: string[] | null; /** @@ -424,10 +424,6 @@ export namespace networkservices_v1beta1 { * Optional. A free-text description of the resource. Max length 1024 characters. */ description?: string | null; - /** - * Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string | null; /** * Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/x/locations/global/gateways/` */ @@ -640,10 +636,6 @@ export namespace networkservices_v1beta1 { * Optional. A free-text description of the resource. Max length 1024 characters. */ description?: string | null; - /** - * Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string | null; /** * Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/x/locations/global/gateways/` */ @@ -1129,7 +1121,7 @@ export namespace networkservices_v1beta1 { */ 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 [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** @@ -1187,6 +1179,10 @@ export namespace networkservices_v1beta1 { * 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; + /** + * Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; } /** * Response returned by the ListGateways method. @@ -1290,6 +1286,10 @@ export namespace networkservices_v1beta1 { * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. */ nextPageToken?: string | null; + /** + * Unreachable resources. Populated when the request opts into `return_partial_success` and reading across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response returned by the ListMeshRouteViews method. @@ -1303,6 +1303,10 @@ export namespace networkservices_v1beta1 { * 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; + /** + * Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; } /** * The response message for Operations.ListOperations. @@ -1329,6 +1333,10 @@ export namespace networkservices_v1beta1 { * List of ServiceBinding resources. */ serviceBindings?: Schema$ServiceBinding[]; + /** + * Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; } /** * Response returned by the ListServiceLbPolicies method. @@ -1342,6 +1350,10 @@ export namespace networkservices_v1beta1 { * List of ServiceLbPolicy resources. */ serviceLbPolicies?: Schema$ServiceLbPolicy[]; + /** + * Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; } /** * Response returned by the ListTcpRoutes method. @@ -1582,7 +1594,7 @@ export namespace networkservices_v1beta1 { cryptoKeyName?: string | null; } /** - * ServiceBinding is the resource that defines a Service Directory Service to be used in a BackendService resource. + * ServiceBinding can be used to: - Bind a Service Directory Service to be used in a BackendService resource. - Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers. */ export interface Schema$ServiceBinding { /** @@ -1598,15 +1610,15 @@ export namespace networkservices_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Identifier. 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/x/serviceBindings/`. */ name?: string | null; /** - * Required. The full Service Directory Service name of the format projects/x/locations/x/namespaces/x/services/x + * Optional. The full Service Directory Service name of the format `projects/x/locations/x/namespaces/x/services/x`. This field must be set. */ service?: string | null; /** - * Output only. The unique identifier of the Service Directory Service against which the Service Binding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format. + * Output only. The unique identifier of the Service Directory Service against which the ServiceBinding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format. */ serviceId?: string | null; /** @@ -1698,10 +1710,6 @@ export namespace networkservices_v1beta1 { * Optional. A free-text description of the resource. Max length 1024 characters. */ description?: string | null; - /** - * Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string | null; /** * Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/x/locations/global/gateways/` */ @@ -1799,10 +1807,6 @@ export namespace networkservices_v1beta1 { * Optional. A free-text description of the resource. Max length 1024 characters. */ description?: string | null; - /** - * Optional. Output only. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string | null; /** * Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/x/locations/global/gateways/` */ @@ -1859,7 +1863,7 @@ export namespace networkservices_v1beta1 { weight?: number | null; } /** - * RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "AND"ed for evaluation. If no routeMatch field is specified, this rule will unconditionally match traffic. + * RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "AND"ed for evaluation. */ export interface Schema$TlsRouteRouteMatch { /** @@ -1880,7 +1884,7 @@ export namespace networkservices_v1beta1 { */ action?: Schema$TlsRouteRouteAction; /** - * Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. + * Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. Atleast one RouteMatch must be supplied. */ matches?: Schema$TlsRouteRouteMatch[]; } @@ -2778,7 +2782,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; @@ -2794,7 +2798,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; } @@ -2812,7 +2816,7 @@ export namespace networkservices_v1beta1 { */ filter?: string; /** - * Optional. Hint for how to order the results. + * Optional. Hint about how to order the results. */ orderBy?: string; /** @@ -2824,7 +2828,7 @@ export namespace networkservices_v1beta1 { */ pageToken?: string; /** - * Required. The project and location from which the `AuthzExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the `AuthzExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } @@ -2835,7 +2839,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; /** @@ -4562,10 +4566,6 @@ export namespace networkservices_v1beta1 { } export interface Params$Resource$Projects$Locations$Grpcroutes$Delete extends StandardParameters { - /** - * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string; /** * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ @@ -5076,10 +5076,6 @@ export namespace networkservices_v1beta1 { } export interface Params$Resource$Projects$Locations$Httproutes$Delete extends StandardParameters { - /** - * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string; /** * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. */ @@ -5591,7 +5587,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; @@ -5607,7 +5603,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; } @@ -5625,7 +5621,7 @@ export namespace networkservices_v1beta1 { */ filter?: string; /** - * Optional. Hint for how to order the results. + * Optional. Hint about how to order the results. */ orderBy?: string; /** @@ -5637,7 +5633,7 @@ export namespace networkservices_v1beta1 { */ 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 `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } @@ -5648,7 +5644,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; /** @@ -6133,7 +6129,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; @@ -6149,7 +6145,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; } @@ -6167,7 +6163,7 @@ export namespace networkservices_v1beta1 { */ filter?: string; /** - * Optional. Hint for how to order the results. + * Optional. Hint about how to order the results. */ orderBy?: string; /** @@ -6179,7 +6175,7 @@ export namespace networkservices_v1beta1 { */ pageToken?: string; /** - * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the `LbTrafficExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } @@ -6190,7 +6186,7 @@ export namespace networkservices_v1beta1 { */ 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). + * 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 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 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; /** @@ -6698,6 +6694,10 @@ export namespace networkservices_v1beta1 { * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. */ parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Meshes$Patch extends StandardParameters { @@ -7706,7 +7706,7 @@ export namespace networkservices_v1beta1 { export interface Params$Resource$Projects$Locations$Servicebindings$Create extends StandardParameters { /** - * Required. The parent resource of the ServiceBinding. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the ServiceBinding. Must be in the format `projects/x/locations/x`. */ parent?: string; /** @@ -7722,14 +7722,14 @@ export namespace networkservices_v1beta1 { export interface Params$Resource$Projects$Locations$Servicebindings$Delete extends StandardParameters { /** - * Required. A name of the ServiceBinding to delete. Must be in the format `projects/x/locations/global/serviceBindings/x`. + * Required. A name of the ServiceBinding to delete. Must be in the format `projects/x/locations/x/serviceBindings/x`. */ name?: string; } export interface Params$Resource$Projects$Locations$Servicebindings$Get extends StandardParameters { /** - * Required. A name of the ServiceBinding to get. Must be in the format `projects/x/locations/global/serviceBindings/x`. + * Required. A name of the ServiceBinding to get. Must be in the format `projects/x/locations/x/serviceBindings/x`. */ name?: string; } @@ -7744,7 +7744,7 @@ export namespace networkservices_v1beta1 { */ pageToken?: string; /** - * Required. The project and location from which the ServiceBindings should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the ServiceBindings should be listed, specified in the format `projects/x/locations/x`. */ parent?: string; } @@ -8733,10 +8733,6 @@ export namespace networkservices_v1beta1 { } export interface Params$Resource$Projects$Locations$Tcproutes$Delete extends StandardParameters { - /** - * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string; /** * Required. A name of the TcpRoute to delete. Must be in the format `projects/x/locations/global/tcpRoutes/x`. */ @@ -9247,10 +9243,6 @@ export namespace networkservices_v1beta1 { } export interface Params$Resource$Projects$Locations$Tlsroutes$Delete extends StandardParameters { - /** - * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - */ - etag?: string; /** * Required. A name of the TlsRoute to delete. Must be in the format `projects/x/locations/global/tlsRoutes/x`. */ From b797305aca92db85ca86367fbe3b5a384fec95a8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 094/144] feat(ondemandscanning): update the API #### ondemandscanning:v1beta1 The following keys were added: - schemas.BaseImage.description - schemas.BaseImage.id - schemas.BaseImage.properties.layerCount.description - schemas.BaseImage.properties.layerCount.format - schemas.BaseImage.properties.layerCount.type - schemas.BaseImage.properties.name.description - schemas.BaseImage.properties.name.type - schemas.BaseImage.properties.repository.description - schemas.BaseImage.properties.repository.type - schemas.BaseImage.type - schemas.FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1BaseImage.description - schemas.GrafeasV1BaseImage.id - schemas.GrafeasV1BaseImage.properties.layerCount.description - schemas.GrafeasV1BaseImage.properties.layerCount.format - schemas.GrafeasV1BaseImage.properties.layerCount.type - schemas.GrafeasV1BaseImage.properties.name.description - schemas.GrafeasV1BaseImage.properties.name.type - schemas.GrafeasV1BaseImage.properties.repository.description - schemas.GrafeasV1BaseImage.properties.repository.type - schemas.GrafeasV1BaseImage.type - schemas.GrafeasV1FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1FileLocation.properties.layerDetails.description - schemas.GrafeasV1LayerDetails.description - schemas.GrafeasV1LayerDetails.id - schemas.GrafeasV1LayerDetails.properties.baseImages.description - schemas.GrafeasV1LayerDetails.properties.baseImages.items.$ref - schemas.GrafeasV1LayerDetails.properties.baseImages.type - schemas.GrafeasV1LayerDetails.properties.command.description - schemas.GrafeasV1LayerDetails.properties.command.type - schemas.GrafeasV1LayerDetails.properties.diffId.description - schemas.GrafeasV1LayerDetails.properties.diffId.type - schemas.GrafeasV1LayerDetails.properties.index.description - schemas.GrafeasV1LayerDetails.properties.index.format - schemas.GrafeasV1LayerDetails.properties.index.type - schemas.GrafeasV1LayerDetails.type - schemas.LayerDetails.description - schemas.LayerDetails.id - schemas.LayerDetails.properties.baseImages.description - schemas.LayerDetails.properties.baseImages.items.$ref - schemas.LayerDetails.properties.baseImages.type - schemas.LayerDetails.properties.command.description - schemas.LayerDetails.properties.command.type - schemas.LayerDetails.properties.diffId.description - schemas.LayerDetails.properties.diffId.type - schemas.LayerDetails.properties.index.description - schemas.LayerDetails.properties.index.format - schemas.LayerDetails.properties.index.type - schemas.LayerDetails.type - schemas.PackageData.properties.layerDetails.$ref #### ondemandscanning:v1 The following keys were added: - schemas.BaseImage.description - schemas.BaseImage.id - schemas.BaseImage.properties.layerCount.description - schemas.BaseImage.properties.layerCount.format - schemas.BaseImage.properties.layerCount.type - schemas.BaseImage.properties.name.description - schemas.BaseImage.properties.name.type - schemas.BaseImage.properties.repository.description - schemas.BaseImage.properties.repository.type - schemas.BaseImage.type - schemas.FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1BaseImage.description - schemas.GrafeasV1BaseImage.id - schemas.GrafeasV1BaseImage.properties.layerCount.description - schemas.GrafeasV1BaseImage.properties.layerCount.format - schemas.GrafeasV1BaseImage.properties.layerCount.type - schemas.GrafeasV1BaseImage.properties.name.description - schemas.GrafeasV1BaseImage.properties.name.type - schemas.GrafeasV1BaseImage.properties.repository.description - schemas.GrafeasV1BaseImage.properties.repository.type - schemas.GrafeasV1BaseImage.type - schemas.GrafeasV1FileLocation.properties.layerDetails.$ref - schemas.GrafeasV1FileLocation.properties.layerDetails.description - schemas.GrafeasV1LayerDetails.description - schemas.GrafeasV1LayerDetails.id - schemas.GrafeasV1LayerDetails.properties.baseImages.description - schemas.GrafeasV1LayerDetails.properties.baseImages.items.$ref - schemas.GrafeasV1LayerDetails.properties.baseImages.type - schemas.GrafeasV1LayerDetails.properties.command.description - schemas.GrafeasV1LayerDetails.properties.command.type - schemas.GrafeasV1LayerDetails.properties.diffId.description - schemas.GrafeasV1LayerDetails.properties.diffId.type - schemas.GrafeasV1LayerDetails.properties.index.description - schemas.GrafeasV1LayerDetails.properties.index.format - schemas.GrafeasV1LayerDetails.properties.index.type - schemas.GrafeasV1LayerDetails.type - schemas.LayerDetails.description - schemas.LayerDetails.id - schemas.LayerDetails.properties.baseImages.description - schemas.LayerDetails.properties.baseImages.items.$ref - schemas.LayerDetails.properties.baseImages.type - schemas.LayerDetails.properties.command.description - schemas.LayerDetails.properties.command.type - schemas.LayerDetails.properties.diffId.description - schemas.LayerDetails.properties.diffId.type - schemas.LayerDetails.properties.index.description - schemas.LayerDetails.properties.index.format - schemas.LayerDetails.properties.index.type - schemas.LayerDetails.type - schemas.PackageData.properties.layerDetails.$ref --- discovery/ondemandscanning-v1.json | 106 +++++++++++++++++++++++- discovery/ondemandscanning-v1beta1.json | 106 +++++++++++++++++++++++- src/apis/ondemandscanning/v1.ts | 82 ++++++++++++++++++ src/apis/ondemandscanning/v1beta1.ts | 82 ++++++++++++++++++ 4 files changed, 374 insertions(+), 2 deletions(-) diff --git a/discovery/ondemandscanning-v1.json b/discovery/ondemandscanning-v1.json index 4df4940cb7c..fd5c6994d88 100644 --- a/discovery/ondemandscanning-v1.json +++ b/discovery/ondemandscanning-v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20241209", + "revision": "20250217", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -507,6 +507,26 @@ }, "type": "object" }, + "BaseImage": { + "description": "BaseImage describes a base image of a container image.", + "id": "BaseImage", + "properties": { + "layerCount": { + "description": "The number of layers that the base image is composed of.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "The name of the base image.", + "type": "string" + }, + "repository": { + "description": "The repository name in which the base image is from.", + "type": "string" + } + }, + "type": "object" + }, "BinarySourceInfo": { "id": "BinarySourceInfo", "properties": { @@ -1174,6 +1194,9 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" + }, + "layerDetails": { + "$ref": "LayerDetails" } }, "type": "object" @@ -1238,6 +1261,26 @@ }, "type": "object" }, + "GrafeasV1BaseImage": { + "description": "BaseImage describes a base image of a container image.", + "id": "GrafeasV1BaseImage", + "properties": { + "layerCount": { + "description": "The number of layers that the base image is composed of.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "The name of the base image.", + "type": "string" + }, + "repository": { + "description": "The repository name in which the base image is from.", + "type": "string" + } + }, + "type": "object" + }, "GrafeasV1FileLocation": { "description": "Indicates the location at which a package was found.", "id": "GrafeasV1FileLocation", @@ -1245,6 +1288,37 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" + }, + "layerDetails": { + "$ref": "GrafeasV1LayerDetails", + "description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package)." + } + }, + "type": "object" + }, + "GrafeasV1LayerDetails": { + "description": "Details about the layer a package was found in.", + "id": "GrafeasV1LayerDetails", + "properties": { + "baseImages": { + "description": "The base images the layer is found within.", + "items": { + "$ref": "GrafeasV1BaseImage" + }, + "type": "array" + }, + "command": { + "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", + "type": "string" + }, + "diffId": { + "description": "The diff ID (typically a sha256 hash) of the layer in the container image.", + "type": "string" + }, + "index": { + "description": "The index of the layer in the container image.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -1562,6 +1636,33 @@ }, "type": "object" }, + "LayerDetails": { + "description": "Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto.", + "id": "LayerDetails", + "properties": { + "baseImages": { + "description": "The base images the layer is found within.", + "items": { + "$ref": "BaseImage" + }, + "type": "array" + }, + "command": { + "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", + "type": "string" + }, + "diffId": { + "description": "The diff ID (sha256 hash) of the layer in the container image.", + "type": "string" + }, + "index": { + "description": "The index of the layer in the container image.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "License": { "description": "License information.", "id": "License", @@ -1903,6 +2004,9 @@ "description": "HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages.", "type": "string" }, + "layerDetails": { + "$ref": "LayerDetails" + }, "licenses": { "description": "The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses.", "items": { diff --git a/discovery/ondemandscanning-v1beta1.json b/discovery/ondemandscanning-v1beta1.json index ead5c1ab888..5a590a13c6d 100644 --- a/discovery/ondemandscanning-v1beta1.json +++ b/discovery/ondemandscanning-v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20241209", + "revision": "20250217", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -502,6 +502,26 @@ }, "type": "object" }, + "BaseImage": { + "description": "BaseImage describes a base image of a container image.", + "id": "BaseImage", + "properties": { + "layerCount": { + "description": "The number of layers that the base image is composed of.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "The name of the base image.", + "type": "string" + }, + "repository": { + "description": "The repository name in which the base image is from.", + "type": "string" + } + }, + "type": "object" + }, "BinarySourceInfo": { "id": "BinarySourceInfo", "properties": { @@ -1169,6 +1189,9 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" + }, + "layerDetails": { + "$ref": "LayerDetails" } }, "type": "object" @@ -1233,6 +1256,26 @@ }, "type": "object" }, + "GrafeasV1BaseImage": { + "description": "BaseImage describes a base image of a container image.", + "id": "GrafeasV1BaseImage", + "properties": { + "layerCount": { + "description": "The number of layers that the base image is composed of.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "The name of the base image.", + "type": "string" + }, + "repository": { + "description": "The repository name in which the base image is from.", + "type": "string" + } + }, + "type": "object" + }, "GrafeasV1FileLocation": { "description": "Indicates the location at which a package was found.", "id": "GrafeasV1FileLocation", @@ -1240,6 +1283,37 @@ "filePath": { "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.", "type": "string" + }, + "layerDetails": { + "$ref": "GrafeasV1LayerDetails", + "description": "Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package)." + } + }, + "type": "object" + }, + "GrafeasV1LayerDetails": { + "description": "Details about the layer a package was found in.", + "id": "GrafeasV1LayerDetails", + "properties": { + "baseImages": { + "description": "The base images the layer is found within.", + "items": { + "$ref": "GrafeasV1BaseImage" + }, + "type": "array" + }, + "command": { + "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", + "type": "string" + }, + "diffId": { + "description": "The diff ID (typically a sha256 hash) of the layer in the container image.", + "type": "string" + }, + "index": { + "description": "The index of the layer in the container image.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -1557,6 +1631,33 @@ }, "type": "object" }, + "LayerDetails": { + "description": "Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto.", + "id": "LayerDetails", + "properties": { + "baseImages": { + "description": "The base images the layer is found within.", + "items": { + "$ref": "BaseImage" + }, + "type": "array" + }, + "command": { + "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", + "type": "string" + }, + "diffId": { + "description": "The diff ID (sha256 hash) of the layer in the container image.", + "type": "string" + }, + "index": { + "description": "The index of the layer in the container image.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "License": { "description": "License information.", "id": "License", @@ -1898,6 +1999,9 @@ "description": "HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages.", "type": "string" }, + "layerDetails": { + "$ref": "LayerDetails" + }, "licenses": { "description": "The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses.", "items": { diff --git a/src/apis/ondemandscanning/v1.ts b/src/apis/ondemandscanning/v1.ts index 260077cd65f..fb48464058b 100644 --- a/src/apis/ondemandscanning/v1.ts +++ b/src/apis/ondemandscanning/v1.ts @@ -238,6 +238,23 @@ export namespace ondemandscanning_v1 { */ signatures?: Schema$Signature[]; } + /** + * BaseImage describes a base image of a container image. + */ + export interface Schema$BaseImage { + /** + * The number of layers that the base image is composed of. + */ + layerCount?: number | null; + /** + * The name of the base image. + */ + name?: string | null; + /** + * The repository name in which the base image is from. + */ + repository?: string | null; + } export interface Schema$BinarySourceInfo { /** * The binary package. This is significant when the source is different than the binary itself. Historically if they've differed, we've stored the name of the source and its version in the package/version fields, but we should also store the binary package info, as that's what's actually installed. See b/175908657#comment15. @@ -585,6 +602,7 @@ export namespace ondemandscanning_v1 { * For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. */ filePath?: string | null; + layerDetails?: Schema$LayerDetails; } /** * A set of properties that uniquely identify a given Docker image. @@ -637,6 +655,23 @@ export namespace ondemandscanning_v1 { */ url?: string | null; } + /** + * BaseImage describes a base image of a container image. + */ + export interface Schema$GrafeasV1BaseImage { + /** + * The number of layers that the base image is composed of. + */ + layerCount?: number | null; + /** + * The name of the base image. + */ + name?: string | null; + /** + * The repository name in which the base image is from. + */ + repository?: string | null; + } /** * Indicates the location at which a package was found. */ @@ -645,6 +680,31 @@ export namespace ondemandscanning_v1 { * For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. */ filePath?: string | null; + /** + * Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package). + */ + layerDetails?: Schema$GrafeasV1LayerDetails; + } + /** + * Details about the layer a package was found in. + */ + export interface Schema$GrafeasV1LayerDetails { + /** + * The base images the layer is found within. + */ + baseImages?: Schema$GrafeasV1BaseImage[]; + /** + * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + */ + command?: string | null; + /** + * The diff ID (typically a sha256 hash) of the layer in the container image. + */ + diffId?: string | null; + /** + * The index of the layer in the container image. + */ + index?: number | null; } /** * Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance. @@ -820,6 +880,27 @@ export namespace ondemandscanning_v1 { */ directive?: string | null; } + /** + * Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto. + */ + export interface Schema$LayerDetails { + /** + * The base images the layer is found within. + */ + baseImages?: Schema$BaseImage[]; + /** + * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + */ + command?: string | null; + /** + * The diff ID (sha256 hash) of the layer in the container image. + */ + diffId?: string | null; + /** + * The index of the layer in the container image. + */ + index?: number | null; + } /** * License information. */ @@ -1063,6 +1144,7 @@ export namespace ondemandscanning_v1 { * HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages. */ hashDigest?: string | null; + layerDetails?: Schema$LayerDetails; /** * The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses. */ diff --git a/src/apis/ondemandscanning/v1beta1.ts b/src/apis/ondemandscanning/v1beta1.ts index 7826ac2d3f4..c889360a3c1 100644 --- a/src/apis/ondemandscanning/v1beta1.ts +++ b/src/apis/ondemandscanning/v1beta1.ts @@ -234,6 +234,23 @@ export namespace ondemandscanning_v1beta1 { */ signatures?: Schema$Signature[]; } + /** + * BaseImage describes a base image of a container image. + */ + export interface Schema$BaseImage { + /** + * The number of layers that the base image is composed of. + */ + layerCount?: number | null; + /** + * The name of the base image. + */ + name?: string | null; + /** + * The repository name in which the base image is from. + */ + repository?: string | null; + } export interface Schema$BinarySourceInfo { /** * The binary package. This is significant when the source is different than the binary itself. Historically if they've differed, we've stored the name of the source and its version in the package/version fields, but we should also store the binary package info, as that's what's actually installed. See b/175908657#comment15. @@ -581,6 +598,7 @@ export namespace ondemandscanning_v1beta1 { * For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. */ filePath?: string | null; + layerDetails?: Schema$LayerDetails; } /** * A set of properties that uniquely identify a given Docker image. @@ -633,6 +651,23 @@ export namespace ondemandscanning_v1beta1 { */ url?: string | null; } + /** + * BaseImage describes a base image of a container image. + */ + export interface Schema$GrafeasV1BaseImage { + /** + * The number of layers that the base image is composed of. + */ + layerCount?: number | null; + /** + * The name of the base image. + */ + name?: string | null; + /** + * The repository name in which the base image is from. + */ + repository?: string | null; + } /** * Indicates the location at which a package was found. */ @@ -641,6 +676,31 @@ export namespace ondemandscanning_v1beta1 { * For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. */ filePath?: string | null; + /** + * Each package found in a file should have its own layer metadata (that is, information from the origin layer of the package). + */ + layerDetails?: Schema$GrafeasV1LayerDetails; + } + /** + * Details about the layer a package was found in. + */ + export interface Schema$GrafeasV1LayerDetails { + /** + * The base images the layer is found within. + */ + baseImages?: Schema$GrafeasV1BaseImage[]; + /** + * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + */ + command?: string | null; + /** + * The diff ID (typically a sha256 hash) of the layer in the container image. + */ + diffId?: string | null; + /** + * The index of the layer in the container image. + */ + index?: number | null; } /** * Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance. @@ -816,6 +876,27 @@ export namespace ondemandscanning_v1beta1 { */ directive?: string | null; } + /** + * Details about the layer a package was found in. This should be the same as the LayerDetails message in google3/third_party/scalibr/binary/proto/scan_result.proto. + */ + export interface Schema$LayerDetails { + /** + * The base images the layer is found within. + */ + baseImages?: Schema$BaseImage[]; + /** + * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. + */ + command?: string | null; + /** + * The diff ID (sha256 hash) of the layer in the container image. + */ + diffId?: string | null; + /** + * The index of the layer in the container image. + */ + index?: number | null; + } /** * License information. */ @@ -1059,6 +1140,7 @@ export namespace ondemandscanning_v1beta1 { * HashDigest stores the SHA512 hash digest of the jar file if the package is of type Maven. This field will be unset for non Maven packages. */ hashDigest?: string | null; + layerDetails?: Schema$LayerDetails; /** * The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses. */ From cd205d956b5f00dd9200baef25daa3b193fbf351 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 095/144] fix(oracledatabase): update the API #### oracledatabase:v1 The following keys were changed: - schemas.AutonomousDatabase.properties.cidr.description - schemas.AutonomousDatabase.properties.network.description - schemas.Entitlement.properties.state.enum - schemas.Entitlement.properties.state.enumDescriptions --- discovery/oracledatabase-v1.json | 12 +++++++----- src/apis/oracledatabase/v1.ts | 4 ++-- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/discovery/oracledatabase-v1.json b/discovery/oracledatabase-v1.json index 6985828adbe..04eac59d9be 100644 --- a/discovery/oracledatabase-v1.json +++ b/discovery/oracledatabase-v1.json @@ -1119,7 +1119,7 @@ } } }, - "revision": "20241210", + "revision": "20250223", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -1153,7 +1153,7 @@ "type": "string" }, "cidr": { - "description": "Required. The subnet CIDR range for the Autonmous Database.", + "description": "Optional. The subnet CIDR range for the Autonmous Database.", "type": "string" }, "createTime": { @@ -1187,7 +1187,7 @@ "type": "string" }, "network": { - "description": "Required. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", + "description": "Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", "type": "string" }, "properties": { @@ -3068,14 +3068,16 @@ "ACCOUNT_NOT_LINKED", "ACCOUNT_NOT_ACTIVE", "ACTIVE", - "ACCOUNT_SUSPENDED" + "ACCOUNT_SUSPENDED", + "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" ], "enumDescriptions": [ "Default unspecified value.", "Account not linked.", "Account is linked but not active.", "Entitlement and Account are active.", - "Account is suspended." + "Account is suspended.", + "Entitlement is not approved in private marketplace." ], "readOnly": true, "type": "string" diff --git a/src/apis/oracledatabase/v1.ts b/src/apis/oracledatabase/v1.ts index 17dfea1076f..a13d92ea6be 100644 --- a/src/apis/oracledatabase/v1.ts +++ b/src/apis/oracledatabase/v1.ts @@ -150,7 +150,7 @@ export namespace oracledatabase_v1 { */ adminPassword?: string | null; /** - * Required. The subnet CIDR range for the Autonmous Database. + * Optional. The subnet CIDR range for the Autonmous Database. */ cidr?: string | null; /** @@ -178,7 +178,7 @@ export namespace oracledatabase_v1 { */ name?: string | null; /** - * Required. The name of the VPC network used by the Autonomous Database in the following format: projects/{project\}/global/networks/{network\} + * Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project\}/global/networks/{network\} */ network?: string | null; /** From e82e5c642d46c087323ffcf53e6e80f19fc7a21b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 096/144] feat(oslogin): update the API #### oslogin:v1alpha The following keys were added: - resources.projects.resources.locations.methods.signSshPublicKey.description - resources.projects.resources.locations.methods.signSshPublicKey.flatPath - resources.projects.resources.locations.methods.signSshPublicKey.httpMethod - resources.projects.resources.locations.methods.signSshPublicKey.id - resources.projects.resources.locations.methods.signSshPublicKey.parameterOrder - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.description - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.location - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.pattern - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.required - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.type - resources.projects.resources.locations.methods.signSshPublicKey.path - resources.projects.resources.locations.methods.signSshPublicKey.request.$ref - resources.projects.resources.locations.methods.signSshPublicKey.response.$ref - resources.projects.resources.locations.methods.signSshPublicKey.scopes - resources.users.resources.projects.methods.provisionPosixAccount.description - resources.users.resources.projects.methods.provisionPosixAccount.flatPath - resources.users.resources.projects.methods.provisionPosixAccount.httpMethod - resources.users.resources.projects.methods.provisionPosixAccount.id - resources.users.resources.projects.methods.provisionPosixAccount.parameterOrder - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.description - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.location - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.pattern - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.required - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.type - resources.users.resources.projects.methods.provisionPosixAccount.path - resources.users.resources.projects.methods.provisionPosixAccount.request.$ref - resources.users.resources.projects.methods.provisionPosixAccount.response.$ref - resources.users.resources.projects.methods.provisionPosixAccount.scopes - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.id - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.appEngineInstance.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.appEngineInstance.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.computeInstance.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.computeInstance.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.serviceAccount.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.serviceAccount.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.sshPublicKey.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.sshPublicKey.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.id - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.properties.signedSshPublicKey.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.properties.signedSshPublicKey.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.type - schemas.ProvisionPosixAccountRequest.description - schemas.ProvisionPosixAccountRequest.id - schemas.ProvisionPosixAccountRequest.properties.regions.description - schemas.ProvisionPosixAccountRequest.properties.regions.items.type - schemas.ProvisionPosixAccountRequest.properties.regions.type - schemas.ProvisionPosixAccountRequest.type #### oslogin:v1beta The following keys were added: - resources.projects.resources.locations.methods.signSshPublicKey.description - resources.projects.resources.locations.methods.signSshPublicKey.flatPath - resources.projects.resources.locations.methods.signSshPublicKey.httpMethod - resources.projects.resources.locations.methods.signSshPublicKey.id - resources.projects.resources.locations.methods.signSshPublicKey.parameterOrder - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.description - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.location - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.pattern - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.required - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.type - resources.projects.resources.locations.methods.signSshPublicKey.path - resources.projects.resources.locations.methods.signSshPublicKey.request.$ref - resources.projects.resources.locations.methods.signSshPublicKey.response.$ref - resources.projects.resources.locations.methods.signSshPublicKey.scopes - resources.users.resources.projects.methods.provisionPosixAccount.description - resources.users.resources.projects.methods.provisionPosixAccount.flatPath - resources.users.resources.projects.methods.provisionPosixAccount.httpMethod - resources.users.resources.projects.methods.provisionPosixAccount.id - resources.users.resources.projects.methods.provisionPosixAccount.parameterOrder - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.description - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.location - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.pattern - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.required - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.type - resources.users.resources.projects.methods.provisionPosixAccount.path - resources.users.resources.projects.methods.provisionPosixAccount.request.$ref - resources.users.resources.projects.methods.provisionPosixAccount.response.$ref - resources.users.resources.projects.methods.provisionPosixAccount.scopes - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.id - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.appEngineInstance.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.appEngineInstance.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.computeInstance.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.computeInstance.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.serviceAccount.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.serviceAccount.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.sshPublicKey.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.sshPublicKey.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.id - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.properties.signedSshPublicKey.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.properties.signedSshPublicKey.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.type - schemas.ProvisionPosixAccountRequest.description - schemas.ProvisionPosixAccountRequest.id - schemas.ProvisionPosixAccountRequest.properties.regions.description - schemas.ProvisionPosixAccountRequest.properties.regions.items.type - schemas.ProvisionPosixAccountRequest.properties.regions.type - schemas.ProvisionPosixAccountRequest.type --- discovery/oslogin-v1alpha.json | 115 +++++++++++++- discovery/oslogin-v1beta.json | 115 +++++++++++++- src/apis/oslogin/v1alpha.ts | 266 +++++++++++++++++++++++++++++++++ src/apis/oslogin/v1beta.ts | 266 +++++++++++++++++++++++++++++++++ 4 files changed, 760 insertions(+), 2 deletions(-) diff --git a/discovery/oslogin-v1alpha.json b/discovery/oslogin-v1alpha.json index 6795614f6ca..2e6a67b8cd7 100644 --- a/discovery/oslogin-v1alpha.json +++ b/discovery/oslogin-v1alpha.json @@ -114,6 +114,42 @@ }, "protocol": "rest", "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "signSshPublicKey": { + "description": "Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:signSshPublicKey", + "httpMethod": "POST", + "id": "oslogin.projects.locations.signSshPublicKey", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent for the signing request. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:signSshPublicKey", + "request": { + "$ref": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest" + }, + "response": { + "$ref": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "users": { "methods": { "getLoginProfile": { @@ -283,6 +319,35 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "provisionPosixAccount": { + "description": "Create a POSIX account if it doesn't exist.", + "flatPath": "v1alpha/users/{usersId}/projects/{projectsId}", + "httpMethod": "POST", + "id": "oslogin.users.projects.provisionPosixAccount", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique ID for the user in format `users/{user}/projects/{project}`.", + "location": "path", + "pattern": "^users/[^/]+/projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "ProvisionPosixAccountRequest" + }, + "response": { + "$ref": "PosixAccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } }, "resources": { @@ -477,7 +542,7 @@ } } }, - "revision": "20241208", + "revision": "20250302", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { @@ -486,6 +551,40 @@ "properties": {}, "type": "object" }, + "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest": { + "description": "A request message for signing an SSH public key.", + "id": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest", + "properties": { + "appEngineInstance": { + "description": "The App Engine instance to sign the SSH public key for. Expected format: services/{service}/versions/{version}/instances/{instance}", + "type": "string" + }, + "computeInstance": { + "description": "The compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}", + "type": "string" + }, + "serviceAccount": { + "description": "Optional. The service account for the Compute instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM. During rollout of the new regionalized SignSshPublicKey API, this field will be required for all requests, but the VM will not initially carry out the", + "type": "string" + }, + "sshPublicKey": { + "description": "Required. The SSH public key to sign.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse": { + "description": "The response message for signing an SSH public key.", + "id": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse", + "properties": { + "signedSshPublicKey": { + "description": "The signed SSH public key to use in the SSH handshake.", + "type": "string" + } + }, + "type": "object" + }, "ImportSshPublicKeyResponse": { "description": "A response message for importing an SSH public key.", "id": "ImportSshPublicKeyResponse", @@ -598,6 +697,20 @@ }, "type": "object" }, + "ProvisionPosixAccountRequest": { + "description": "A request message for creating a POSIX account entry.", + "id": "ProvisionPosixAccountRequest", + "properties": { + "regions": { + "description": "Optional. The regions to wait for a POSIX account to be written to before returning a response. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SecurityKey": { "description": "The credential information for a Google registered security key.", "id": "SecurityKey", diff --git a/discovery/oslogin-v1beta.json b/discovery/oslogin-v1beta.json index 0dda13aecf4..731fd0f1460 100644 --- a/discovery/oslogin-v1beta.json +++ b/discovery/oslogin-v1beta.json @@ -114,6 +114,42 @@ }, "protocol": "rest", "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "signSshPublicKey": { + "description": "Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:signSshPublicKey", + "httpMethod": "POST", + "id": "oslogin.projects.locations.signSshPublicKey", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent for the signing request. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}:signSshPublicKey", + "request": { + "$ref": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest" + }, + "response": { + "$ref": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "users": { "methods": { "getLoginProfile": { @@ -253,6 +289,35 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "provisionPosixAccount": { + "description": "Create a POSIX account if it doesn't exist.", + "flatPath": "v1beta/users/{usersId}/projects/{projectsId}", + "httpMethod": "POST", + "id": "oslogin.users.projects.provisionPosixAccount", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique ID for the user in format `users/{user}/projects/{project}`.", + "location": "path", + "pattern": "^users/[^/]+/projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "ProvisionPosixAccountRequest" + }, + "response": { + "$ref": "PosixAccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } }, "resources": { @@ -447,7 +512,7 @@ } } }, - "revision": "20240616", + "revision": "20250302", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { @@ -456,6 +521,40 @@ "properties": {}, "type": "object" }, + "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest": { + "description": "A request message for signing an SSH public key.", + "id": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest", + "properties": { + "appEngineInstance": { + "description": "The App Engine instance to sign the SSH public key for. Expected format: services/{service}/versions/{version}/instances/{instance}", + "type": "string" + }, + "computeInstance": { + "description": "The compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}", + "type": "string" + }, + "serviceAccount": { + "description": "Optional. The service account for the Compute instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM. During rollout of the new regionalized SignSshPublicKey API, this field will be required for all requests, but the VM will not initially carry out the", + "type": "string" + }, + "sshPublicKey": { + "description": "Required. The SSH public key to sign.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse": { + "description": "The response message for signing an SSH public key.", + "id": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse", + "properties": { + "signedSshPublicKey": { + "description": "The signed SSH public key to use in the SSH handshake.", + "type": "string" + } + }, + "type": "object" + }, "ImportSshPublicKeyResponse": { "description": "A response message for importing an SSH public key.", "id": "ImportSshPublicKeyResponse", @@ -568,6 +667,20 @@ }, "type": "object" }, + "ProvisionPosixAccountRequest": { + "description": "A request message for creating a POSIX account entry.", + "id": "ProvisionPosixAccountRequest", + "properties": { + "regions": { + "description": "Optional. The regions to wait for a POSIX account to be written to before returning a response. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SecurityKey": { "description": "The credential information for a Google registered security key.", "id": "SecurityKey", diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index 9f0bf8b87d3..133775d5c3e 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -112,6 +112,7 @@ export namespace oslogin_v1alpha { */ export class Oslogin { context: APIRequestContext; + projects: Resource$Projects; users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace oslogin_v1alpha { google, }; + this.projects = new Resource$Projects(this.context); this.users = new Resource$Users(this.context); } } @@ -128,6 +130,36 @@ export namespace oslogin_v1alpha { * 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 request message for signing an SSH public key. + */ + export interface Schema$GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest { + /** + * The App Engine instance to sign the SSH public key for. Expected format: services/{service\}/versions/{version\}/instances/{instance\} + */ + appEngineInstance?: string | null; + /** + * The compute instance to sign the SSH public key for. Expected format: projects/{project\}/zones/{zone\}/instances/{numeric_instance_id\} + */ + computeInstance?: string | null; + /** + * Optional. The service account for the Compute instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM. During rollout of the new regionalized SignSshPublicKey API, this field will be required for all requests, but the VM will not initially carry out the + */ + serviceAccount?: string | null; + /** + * Required. The SSH public key to sign. + */ + sshPublicKey?: string | null; + } + /** + * The response message for signing an SSH public key. + */ + export interface Schema$GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse { + /** + * The signed SSH public key to use in the SSH handshake. + */ + signedSshPublicKey?: string | null; + } /** * A response message for importing an SSH public key. */ @@ -211,6 +243,15 @@ export namespace oslogin_v1alpha { */ username?: string | null; } + /** + * A request message for creating a POSIX account entry. + */ + export interface Schema$ProvisionPosixAccountRequest { + /** + * Optional. The regions to wait for a POSIX account to be written to before returning a response. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region. + */ + regions?: string[] | null; + } /** * The credential information for a Google registered security key. */ @@ -288,6 +329,132 @@ export namespace oslogin_v1alpha { rpId?: 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; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute 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. + */ + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions + ): GaxiosPromise; + signSshPublicKey( + params?: Params$Resource$Projects$Locations$Signsshpublickey, + options?: MethodOptions + ): GaxiosPromise; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + callback: BodyResponseCallback + ): void; + signSshPublicKey( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Signsshpublickey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Signsshpublickey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Signsshpublickey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://oslogin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}:signSshPublicKey').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$Signsshpublickey + extends StandardParameters { + /** + * Required. The parent for the signing request. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest; + } + export class Resource$Users { context: APIRequestContext; projects: Resource$Users$Projects; @@ -624,6 +791,93 @@ export namespace oslogin_v1alpha { return createAPIRequest(parameters); } } + + /** + * Create a POSIX account if it doesn't 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. + */ + provisionPosixAccount( + params: Params$Resource$Users$Projects$Provisionposixaccount, + options: StreamMethodOptions + ): GaxiosPromise; + provisionPosixAccount( + params?: Params$Resource$Users$Projects$Provisionposixaccount, + options?: MethodOptions + ): GaxiosPromise; + provisionPosixAccount( + params: Params$Resource$Users$Projects$Provisionposixaccount, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provisionPosixAccount( + params: Params$Resource$Users$Projects$Provisionposixaccount, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provisionPosixAccount( + params: Params$Resource$Users$Projects$Provisionposixaccount, + callback: BodyResponseCallback + ): void; + provisionPosixAccount( + callback: BodyResponseCallback + ): void; + provisionPosixAccount( + paramsOrCallback?: + | Params$Resource$Users$Projects$Provisionposixaccount + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Projects$Provisionposixaccount; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Projects$Provisionposixaccount; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://oslogin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').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$Users$Projects$Delete @@ -637,6 +891,18 @@ export namespace oslogin_v1alpha { */ operatingSystemType?: string; } + export interface Params$Resource$Users$Projects$Provisionposixaccount + extends StandardParameters { + /** + * Required. The unique ID for the user in format `users/{user\}/projects/{project\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProvisionPosixAccountRequest; + } export class Resource$Users$Projects$Locations { context: APIRequestContext; diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index 657cc7b1424..f306dc29f43 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -112,6 +112,7 @@ export namespace oslogin_v1beta { */ export class Oslogin { context: APIRequestContext; + projects: Resource$Projects; users: Resource$Users; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace oslogin_v1beta { google, }; + this.projects = new Resource$Projects(this.context); this.users = new Resource$Users(this.context); } } @@ -128,6 +130,36 @@ export namespace oslogin_v1beta { * 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 request message for signing an SSH public key. + */ + export interface Schema$GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest { + /** + * The App Engine instance to sign the SSH public key for. Expected format: services/{service\}/versions/{version\}/instances/{instance\} + */ + appEngineInstance?: string | null; + /** + * The compute instance to sign the SSH public key for. Expected format: projects/{project\}/zones/{zone\}/instances/{numeric_instance_id\} + */ + computeInstance?: string | null; + /** + * Optional. The service account for the Compute instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM. During rollout of the new regionalized SignSshPublicKey API, this field will be required for all requests, but the VM will not initially carry out the + */ + serviceAccount?: string | null; + /** + * Required. The SSH public key to sign. + */ + sshPublicKey?: string | null; + } + /** + * The response message for signing an SSH public key. + */ + export interface Schema$GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse { + /** + * The signed SSH public key to use in the SSH handshake. + */ + signedSshPublicKey?: string | null; + } /** * A response message for importing an SSH public key. */ @@ -211,6 +243,15 @@ export namespace oslogin_v1beta { */ username?: string | null; } + /** + * A request message for creating a POSIX account entry. + */ + export interface Schema$ProvisionPosixAccountRequest { + /** + * Optional. The regions to wait for a POSIX account to be written to before returning a response. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region. + */ + regions?: string[] | null; + } /** * The credential information for a Google registered security key. */ @@ -288,6 +329,132 @@ export namespace oslogin_v1beta { rpId?: 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; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute 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. + */ + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions + ): GaxiosPromise; + signSshPublicKey( + params?: Params$Resource$Projects$Locations$Signsshpublickey, + options?: MethodOptions + ): GaxiosPromise; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Projects$Locations$Signsshpublickey, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + callback: BodyResponseCallback + ): void; + signSshPublicKey( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Signsshpublickey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Signsshpublickey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Signsshpublickey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://oslogin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}:signSshPublicKey').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$Signsshpublickey + extends StandardParameters { + /** + * Required. The parent for the signing request. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest; + } + export class Resource$Users { context: APIRequestContext; projects: Resource$Users$Projects; @@ -620,6 +787,93 @@ export namespace oslogin_v1beta { return createAPIRequest(parameters); } } + + /** + * Create a POSIX account if it doesn't 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. + */ + provisionPosixAccount( + params: Params$Resource$Users$Projects$Provisionposixaccount, + options: StreamMethodOptions + ): GaxiosPromise; + provisionPosixAccount( + params?: Params$Resource$Users$Projects$Provisionposixaccount, + options?: MethodOptions + ): GaxiosPromise; + provisionPosixAccount( + params: Params$Resource$Users$Projects$Provisionposixaccount, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provisionPosixAccount( + params: Params$Resource$Users$Projects$Provisionposixaccount, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provisionPosixAccount( + params: Params$Resource$Users$Projects$Provisionposixaccount, + callback: BodyResponseCallback + ): void; + provisionPosixAccount( + callback: BodyResponseCallback + ): void; + provisionPosixAccount( + paramsOrCallback?: + | Params$Resource$Users$Projects$Provisionposixaccount + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Projects$Provisionposixaccount; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Projects$Provisionposixaccount; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://oslogin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').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$Users$Projects$Delete @@ -629,6 +883,18 @@ export namespace oslogin_v1beta { */ name?: string; } + export interface Params$Resource$Users$Projects$Provisionposixaccount + extends StandardParameters { + /** + * Required. The unique ID for the user in format `users/{user\}/projects/{project\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProvisionPosixAccountRequest; + } export class Resource$Users$Projects$Locations { context: APIRequestContext; From ea383cfd44b567695b8bbabdb0606a5cf43163cc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 097/144] feat(parallelstore): update the API #### parallelstore:v1beta The following keys were added: - schemas.ExportDataRequest.properties.metadataOptions.$ref - schemas.ExportDataRequest.properties.metadataOptions.description - schemas.ImportDataRequest.properties.metadataOptions.$ref - schemas.ImportDataRequest.properties.metadataOptions.description - schemas.Instance.properties.daosVersion.deprecated - schemas.Instance.properties.daosVersion.description - schemas.Instance.properties.daosVersion.readOnly - schemas.Instance.properties.daosVersion.type - schemas.ReconciliationOperationMetadata.description - schemas.ReconciliationOperationMetadata.id - schemas.ReconciliationOperationMetadata.properties.deleteResource.deprecated - schemas.ReconciliationOperationMetadata.properties.deleteResource.description - schemas.ReconciliationOperationMetadata.properties.deleteResource.type - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.description - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.enum - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.enumDeprecated - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.enumDescriptions - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.type - schemas.ReconciliationOperationMetadata.type - schemas.TransferMetadataOptions.description - schemas.TransferMetadataOptions.id - schemas.TransferMetadataOptions.properties.gid.description - schemas.TransferMetadataOptions.properties.gid.enum - schemas.TransferMetadataOptions.properties.gid.enumDescriptions - schemas.TransferMetadataOptions.properties.gid.type - schemas.TransferMetadataOptions.properties.mode.description - schemas.TransferMetadataOptions.properties.mode.enum - schemas.TransferMetadataOptions.properties.mode.enumDescriptions - schemas.TransferMetadataOptions.properties.mode.type - schemas.TransferMetadataOptions.properties.uid.description - schemas.TransferMetadataOptions.properties.uid.enum - schemas.TransferMetadataOptions.properties.uid.enumDescriptions - schemas.TransferMetadataOptions.properties.uid.type - schemas.TransferMetadataOptions.type The following keys were changed: - schemas.Instance.properties.deploymentType.description - schemas.Instance.properties.directoryStripeLevel.description - schemas.Instance.properties.fileStripeLevel.description #### parallelstore:v1 The following keys were added: - schemas.ExportDataRequest.properties.metadataOptions.$ref - schemas.ExportDataRequest.properties.metadataOptions.description - schemas.ImportDataRequest.properties.metadataOptions.$ref - schemas.ImportDataRequest.properties.metadataOptions.description - schemas.Instance.properties.daosVersion.deprecated - schemas.Instance.properties.daosVersion.description - schemas.Instance.properties.daosVersion.readOnly - schemas.Instance.properties.daosVersion.type - schemas.ReconciliationOperationMetadata.description - schemas.ReconciliationOperationMetadata.id - schemas.ReconciliationOperationMetadata.properties.deleteResource.deprecated - schemas.ReconciliationOperationMetadata.properties.deleteResource.description - schemas.ReconciliationOperationMetadata.properties.deleteResource.type - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.description - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.enum - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.enumDeprecated - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.enumDescriptions - schemas.ReconciliationOperationMetadata.properties.exclusiveAction.type - schemas.ReconciliationOperationMetadata.type - schemas.TransferMetadataOptions.description - schemas.TransferMetadataOptions.id - schemas.TransferMetadataOptions.properties.gid.description - schemas.TransferMetadataOptions.properties.gid.enum - schemas.TransferMetadataOptions.properties.gid.enumDescriptions - schemas.TransferMetadataOptions.properties.gid.type - schemas.TransferMetadataOptions.properties.mode.description - schemas.TransferMetadataOptions.properties.mode.enum - schemas.TransferMetadataOptions.properties.mode.enumDescriptions - schemas.TransferMetadataOptions.properties.mode.type - schemas.TransferMetadataOptions.properties.uid.description - schemas.TransferMetadataOptions.properties.uid.enum - schemas.TransferMetadataOptions.properties.uid.enumDescriptions - schemas.TransferMetadataOptions.properties.uid.type - schemas.TransferMetadataOptions.type The following keys were changed: - schemas.Instance.properties.deploymentType.description - schemas.Instance.properties.directoryStripeLevel.description - schemas.Instance.properties.fileStripeLevel.description --- discovery/parallelstore-v1.json | 102 ++++++++++++++++++++++++++-- discovery/parallelstore-v1beta.json | 102 ++++++++++++++++++++++++++-- src/apis/parallelstore/v1.ts | 48 ++++++++++++- src/apis/parallelstore/v1beta.ts | 48 ++++++++++++- 4 files changed, 286 insertions(+), 14 deletions(-) diff --git a/discovery/parallelstore-v1.json b/discovery/parallelstore-v1.json index a6bbdf3fd9a..093eeb53246 100644 --- a/discovery/parallelstore-v1.json +++ b/discovery/parallelstore-v1.json @@ -543,7 +543,7 @@ } } }, - "revision": "20250102", + "revision": "20250303", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -582,6 +582,10 @@ "$ref": "DestinationGcsBucket", "description": "Cloud Storage destination." }, + "metadataOptions": { + "$ref": "TransferMetadataOptions", + "description": "Optional. The metadata options for the export data." + }, "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).", "type": "string" @@ -611,6 +615,10 @@ "$ref": "DestinationParallelstore", "description": "Parallelstore destination." }, + "metadataOptions": { + "$ref": "TransferMetadataOptions", + "description": "Optional. The transfer metadata options for the import data." + }, "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).", "type": "string" @@ -649,8 +657,14 @@ "readOnly": true, "type": "string" }, + "daosVersion": { + "deprecated": true, + "description": "Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance.", + "readOnly": true, + "type": "string" + }, "deploymentType": { - "description": "Optional. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance.", + "description": "Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance.", "enum": [ "DEPLOYMENT_TYPE_UNSPECIFIED", "SCRATCH", @@ -668,7 +682,7 @@ "type": "string" }, "directoryStripeLevel": { - "description": "Optional. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files.", + "description": "Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files.", "enum": [ "DIRECTORY_STRIPE_LEVEL_UNSPECIFIED", "DIRECTORY_STRIPE_LEVEL_MIN", @@ -689,7 +703,7 @@ "type": "string" }, "fileStripeLevel": { - "description": "Optional. Stripe level for files. Allowed values are: * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large files. * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files.", + "description": "Optional. Immutable. Stripe level for files. Allowed values are: * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large files. * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files.", "enum": [ "FILE_STRIPE_LEVEL_UNSPECIFIED", "FILE_STRIPE_LEVEL_MIN", @@ -929,6 +943,37 @@ }, "type": "object" }, + "ReconciliationOperationMetadata": { + "description": "Operation metadata returned by the CLH during resource state reconciliation.", + "id": "ReconciliationOperationMetadata", + "properties": { + "deleteResource": { + "deprecated": true, + "description": "DEPRECATED. Use exclusive_action instead.", + "type": "boolean" + }, + "exclusiveAction": { + "description": "Excluisive action returned by the CLH.", + "enum": [ + "UNKNOWN_REPAIR_ACTION", + "DELETE", + "RETRY" + ], + "enumDeprecated": [ + false, + true, + false + ], + "enumDescriptions": [ + "Unknown repair action.", + "The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", + "This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." + ], + "type": "string" + } + }, + "type": "object" + }, "SourceGcsBucket": { "description": "Cloud Storage as the source of a data transfer.", "id": "SourceGcsBucket", @@ -977,6 +1022,55 @@ } }, "type": "object" + }, + "TransferMetadataOptions": { + "description": "Transfer metadata options for the instance.", + "id": "TransferMetadataOptions", + "properties": { + "gid": { + "description": "Optional. The GID preservation behavior.", + "enum": [ + "GID_UNSPECIFIED", + "GID_SKIP", + "GID_NUMBER_PRESERVE" + ], + "enumDescriptions": [ + "default is GID_NUMBER_PRESERVE.", + "Do not preserve GID during a transfer job.", + "Preserve GID that is in number format during a transfer job." + ], + "type": "string" + }, + "mode": { + "description": "Optional. The mode preservation behavior.", + "enum": [ + "MODE_UNSPECIFIED", + "MODE_SKIP", + "MODE_PRESERVE" + ], + "enumDescriptions": [ + "default is MODE_PRESERVE.", + "Do not preserve mode during a transfer job.", + "Preserve mode during a transfer job." + ], + "type": "string" + }, + "uid": { + "description": "Optional. The UID preservation behavior.", + "enum": [ + "UID_UNSPECIFIED", + "UID_SKIP", + "UID_NUMBER_PRESERVE" + ], + "enumDescriptions": [ + "default is UID_NUMBER_PRESERVE.", + "Do not preserve UID during a transfer job.", + "Preserve UID that is in number format during a transfer job." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/parallelstore-v1beta.json b/discovery/parallelstore-v1beta.json index bc3066364e5..05254867c9b 100644 --- a/discovery/parallelstore-v1beta.json +++ b/discovery/parallelstore-v1beta.json @@ -540,7 +540,7 @@ } } }, - "revision": "20250102", + "revision": "20250303", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "DestinationGcsBucket": { @@ -573,6 +573,10 @@ "$ref": "DestinationGcsBucket", "description": "Cloud Storage destination." }, + "metadataOptions": { + "$ref": "TransferMetadataOptions", + "description": "Optional. The metadata options for the export data." + }, "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).", "type": "string" @@ -602,6 +606,10 @@ "$ref": "DestinationParallelstore", "description": "Parallelstore destination." }, + "metadataOptions": { + "$ref": "TransferMetadataOptions", + "description": "Optional. The transfer metadata options for the import data." + }, "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).", "type": "string" @@ -640,8 +648,14 @@ "readOnly": true, "type": "string" }, + "daosVersion": { + "deprecated": true, + "description": "Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance.", + "readOnly": true, + "type": "string" + }, "deploymentType": { - "description": "Optional. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance.", + "description": "Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance.", "enum": [ "DEPLOYMENT_TYPE_UNSPECIFIED", "SCRATCH", @@ -659,7 +673,7 @@ "type": "string" }, "directoryStripeLevel": { - "description": "Optional. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files.", + "description": "Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files.", "enum": [ "DIRECTORY_STRIPE_LEVEL_UNSPECIFIED", "DIRECTORY_STRIPE_LEVEL_MIN", @@ -680,7 +694,7 @@ "type": "string" }, "fileStripeLevel": { - "description": "Optional. Stripe level for files. Allowed values are: * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large files. * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files.", + "description": "Optional. Immutable. Stripe level for files. Allowed values are: * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large files. * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files.", "enum": [ "FILE_STRIPE_LEVEL_UNSPECIFIED", "FILE_STRIPE_LEVEL_MIN", @@ -920,6 +934,37 @@ }, "type": "object" }, + "ReconciliationOperationMetadata": { + "description": "Operation metadata returned by the CLH during resource state reconciliation.", + "id": "ReconciliationOperationMetadata", + "properties": { + "deleteResource": { + "deprecated": true, + "description": "DEPRECATED. Use exclusive_action instead.", + "type": "boolean" + }, + "exclusiveAction": { + "description": "Excluisive action returned by the CLH.", + "enum": [ + "UNKNOWN_REPAIR_ACTION", + "DELETE", + "RETRY" + ], + "enumDeprecated": [ + false, + true, + false + ], + "enumDescriptions": [ + "Unknown repair action.", + "The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", + "This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." + ], + "type": "string" + } + }, + "type": "object" + }, "SourceGcsBucket": { "description": "Cloud Storage as the source of a data transfer.", "id": "SourceGcsBucket", @@ -968,6 +1013,55 @@ } }, "type": "object" + }, + "TransferMetadataOptions": { + "description": "Transfer metadata options for the instance.", + "id": "TransferMetadataOptions", + "properties": { + "gid": { + "description": "Optional. The GID preservation behavior.", + "enum": [ + "GID_UNSPECIFIED", + "GID_SKIP", + "GID_NUMBER_PRESERVE" + ], + "enumDescriptions": [ + "default is GID_NUMBER_PRESERVE.", + "Do not preserve GID during a transfer job.", + "Preserve GID that is in number format during a transfer job." + ], + "type": "string" + }, + "mode": { + "description": "Optional. The mode preservation behavior.", + "enum": [ + "MODE_UNSPECIFIED", + "MODE_SKIP", + "MODE_PRESERVE" + ], + "enumDescriptions": [ + "default is MODE_PRESERVE.", + "Do not preserve mode during a transfer job.", + "Preserve mode during a transfer job." + ], + "type": "string" + }, + "uid": { + "description": "Optional. The UID preservation behavior.", + "enum": [ + "UID_UNSPECIFIED", + "UID_SKIP", + "UID_NUMBER_PRESERVE" + ], + "enumDescriptions": [ + "default is UID_NUMBER_PRESERVE.", + "Do not preserve UID during a transfer job.", + "Preserve UID that is in number format during a transfer job." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/src/apis/parallelstore/v1.ts b/src/apis/parallelstore/v1.ts index ffae59a674b..06f54a3157e 100644 --- a/src/apis/parallelstore/v1.ts +++ b/src/apis/parallelstore/v1.ts @@ -154,6 +154,10 @@ export namespace parallelstore_v1 { * Cloud Storage destination. */ destinationGcsBucket?: Schema$DestinationGcsBucket; + /** + * Optional. The metadata options for the export data. + */ + metadataOptions?: Schema$TransferMetadataOptions; /** * 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). */ @@ -179,6 +183,10 @@ export namespace parallelstore_v1 { * Parallelstore destination. */ destinationParallelstore?: Schema$DestinationParallelstore; + /** + * Optional. The transfer metadata options for the import data. + */ + metadataOptions?: Schema$TransferMetadataOptions; /** * 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). */ @@ -209,7 +217,11 @@ export namespace parallelstore_v1 { */ createTime?: string | null; /** - * Optional. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. + * Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. + */ + daosVersion?: string | null; + /** + * Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. */ deploymentType?: string | null; /** @@ -217,7 +229,7 @@ export namespace parallelstore_v1 { */ description?: string | null; /** - * Optional. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. + * Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. */ directoryStripeLevel?: string | null; /** @@ -225,7 +237,7 @@ export namespace parallelstore_v1 { */ effectiveReservedIpRange?: string | null; /** - * Optional. Stripe level for files. Allowed values are: * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large files. * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files. + * Optional. Immutable. Stripe level for files. Allowed values are: * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large files. * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files. */ fileStripeLevel?: string | null; /** @@ -379,6 +391,19 @@ export namespace parallelstore_v1 { */ verb?: string | null; } + /** + * Operation metadata returned by the CLH during resource state reconciliation. + */ + export interface Schema$ReconciliationOperationMetadata { + /** + * DEPRECATED. Use exclusive_action instead. + */ + deleteResource?: boolean | null; + /** + * Excluisive action returned by the CLH. + */ + exclusiveAction?: string | null; + } /** * Cloud Storage as the source of a data transfer. */ @@ -414,6 +439,23 @@ export namespace parallelstore_v1 { */ message?: string | null; } + /** + * Transfer metadata options for the instance. + */ + export interface Schema$TransferMetadataOptions { + /** + * Optional. The GID preservation behavior. + */ + gid?: string | null; + /** + * Optional. The mode preservation behavior. + */ + mode?: string | null; + /** + * Optional. The UID preservation behavior. + */ + uid?: string | null; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/parallelstore/v1beta.ts b/src/apis/parallelstore/v1beta.ts index 709c60c5347..09dae764217 100644 --- a/src/apis/parallelstore/v1beta.ts +++ b/src/apis/parallelstore/v1beta.ts @@ -150,6 +150,10 @@ export namespace parallelstore_v1beta { * Cloud Storage destination. */ destinationGcsBucket?: Schema$DestinationGcsBucket; + /** + * Optional. The metadata options for the export data. + */ + metadataOptions?: Schema$TransferMetadataOptions; /** * 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). */ @@ -175,6 +179,10 @@ export namespace parallelstore_v1beta { * Parallelstore destination. */ destinationParallelstore?: Schema$DestinationParallelstore; + /** + * Optional. The transfer metadata options for the import data. + */ + metadataOptions?: Schema$TransferMetadataOptions; /** * 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). */ @@ -205,7 +213,11 @@ export namespace parallelstore_v1beta { */ createTime?: string | null; /** - * Optional. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. + * Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance. + */ + daosVersion?: string | null; + /** + * Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance. */ deploymentType?: string | null; /** @@ -213,7 +225,7 @@ export namespace parallelstore_v1beta { */ description?: string | null; /** - * Optional. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. + * Optional. Immutable. Stripe level for directories. Allowed values are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories contain a small number of files. * `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large directories. * `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a large number of files. */ directoryStripeLevel?: string | null; /** @@ -221,7 +233,7 @@ export namespace parallelstore_v1beta { */ effectiveReservedIpRange?: string | null; /** - * Optional. Stripe level for files. Allowed values are: * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large files. * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files. + * Optional. Immutable. Stripe level for files. Allowed values are: * `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for workloads involving a mix of small and large files. * `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger files. */ fileStripeLevel?: string | null; /** @@ -375,6 +387,19 @@ export namespace parallelstore_v1beta { */ verb?: string | null; } + /** + * Operation metadata returned by the CLH during resource state reconciliation. + */ + export interface Schema$ReconciliationOperationMetadata { + /** + * DEPRECATED. Use exclusive_action instead. + */ + deleteResource?: boolean | null; + /** + * Excluisive action returned by the CLH. + */ + exclusiveAction?: string | null; + } /** * Cloud Storage as the source of a data transfer. */ @@ -410,6 +435,23 @@ export namespace parallelstore_v1beta { */ message?: string | null; } + /** + * Transfer metadata options for the instance. + */ + export interface Schema$TransferMetadataOptions { + /** + * Optional. The GID preservation behavior. + */ + gid?: string | null; + /** + * Optional. The mode preservation behavior. + */ + mode?: string | null; + /** + * Optional. The UID preservation behavior. + */ + uid?: string | null; + } export class Resource$Projects { context: APIRequestContext; From 905f6521430a488591682c2aa3fe1e3b0d0b33c8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 098/144] feat(paymentsresellersubscription): update the API #### paymentsresellersubscription:v1 The following keys were added: - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.id - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.attachedToGoogleStructure.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.attachedToGoogleStructure.readOnly - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.attachedToGoogleStructure.type - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.partnerStructureId.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.partnerStructureId.type - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.type - schemas.GoogleCloudPaymentsResellerSubscriptionV1ProductPayload.properties.googleHomePayload.$ref - schemas.GoogleCloudPaymentsResellerSubscriptionV1ProductPayload.properties.googleHomePayload.description The following keys were changed: - resources.partners.resources.products.methods.list.description - resources.partners.resources.promotions.methods.findEligible.description - resources.partners.resources.promotions.methods.list.description - resources.partners.resources.subscriptions.methods.cancel.description - resources.partners.resources.subscriptions.methods.entitle.description - resources.partners.resources.subscriptions.methods.extend.description - resources.partners.resources.subscriptions.methods.get.description - resources.partners.resources.subscriptions.methods.undoCancel.description - resources.partners.resources.userSessions.methods.generate.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1Product.properties.bundleDetails.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1Product.properties.productType.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1Promotion.properties.promotionType.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetailsIntroductoryPricingSpec.properties.recurrenceCount.description --- .../paymentsresellersubscription-v1.json | 48 +++++++++++++------ src/apis/paymentsresellersubscription/v1.ts | 43 ++++++++++++----- 2 files changed, 64 insertions(+), 27 deletions(-) diff --git a/discovery/paymentsresellersubscription-v1.json b/discovery/paymentsresellersubscription-v1.json index a62a5226855..76ae39181d9 100644 --- a/discovery/paymentsresellersubscription-v1.json +++ b/discovery/paymentsresellersubscription-v1.json @@ -110,7 +110,7 @@ "products": { "methods": { "list": { - "description": "To retrieve the products that can be resold by the partner. It should be autenticated with a service account. - This API doesn't apply to YouTube products currently.", + "description": "Currently, it doesn't support **YouTube** products. Retrieves the products that can be resold by the partner. It should be autenticated with a service account.", "flatPath": "v1/partners/{partnersId}/products", "httpMethod": "GET", "id": "paymentsresellersubscription.partners.products.list", @@ -155,7 +155,7 @@ "promotions": { "methods": { "findEligible": { - "description": "To find eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen.", + "description": "Currently, it is only enabeld for **YouTube**. Finds eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen.", "flatPath": "v1/partners/{partnersId}/promotions:findEligible", "httpMethod": "POST", "id": "paymentsresellersubscription.partners.promotions.findEligible", @@ -183,7 +183,7 @@ ] }, "list": { - "description": "Retrieves the promotions, such as free trial, that can be used by the partner. - This API doesn't apply to YouTube promotions currently. It should be autenticated with a service account.", + "description": "Currently, it doesn't support **YouTube** promotions. Retrieves the promotions, such as free trial, that can be used by the partner. It should be autenticated with a service account.", "flatPath": "v1/partners/{partnersId}/promotions", "httpMethod": "GET", "id": "paymentsresellersubscription.partners.promotions.list", @@ -228,7 +228,7 @@ "subscriptions": { "methods": { "cancel": { - "description": "Used by partners to cancel a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts.", + "description": "Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts.", "flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:cancel", "httpMethod": "POST", "id": "paymentsresellersubscription.partners.subscriptions.cancel", @@ -289,7 +289,7 @@ ] }, "entitle": { - "description": "Used by partners to entitle a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth.", + "description": "Entitles a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth.", "flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:entitle", "httpMethod": "POST", "id": "paymentsresellersubscription.partners.subscriptions.entitle", @@ -317,7 +317,7 @@ ] }, "extend": { - "description": "[Opt-in only] Most partners should be on auto-extend by default. Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.", + "description": "[Opt-in only] Most partners should be on auto-extend by default. Extends a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.", "flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:extend", "httpMethod": "POST", "id": "paymentsresellersubscription.partners.subscriptions.extend", @@ -345,7 +345,7 @@ ] }, "get": { - "description": "Used by partners to get a subscription by id. It should be called directly by the partner using service accounts.", + "description": "Gets a subscription by id. It should be called directly by the partner using service accounts.", "flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}", "httpMethod": "GET", "id": "paymentsresellersubscription.partners.subscriptions.get", @@ -403,7 +403,7 @@ ] }, "undoCancel": { - "description": "Revokes the pending cancellation of a subscription, which is currently in `STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already cancelled, the request will fail. - **This API doesn't apply to YouTube subscriptions.** It should be called directly by the partner using service accounts.", + "description": "Currently, it is used by **Google One, Play Pass** partners. Revokes the pending cancellation of a subscription, which is currently in `STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already cancelled, the request will fail. It should be called directly by the partner using service accounts.", "flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:undoCancel", "httpMethod": "POST", "id": "paymentsresellersubscription.partners.subscriptions.undoCancel", @@ -435,7 +435,7 @@ "userSessions": { "methods": { "generate": { - "description": "This API replaces user authorized OAuth consent based APIs (Create, Entitle). Generates a short-lived token for a user session based on the user intent. You can use the session token to redirect the user to Google to finish the signup flow. You can re-generate new session token repeatedly for the same request if necessary, regardless of the previous tokens being expired or not.", + "description": "This API replaces user authorized OAuth consent based APIs (Create, Entitle). Issues a timed session token for the given user intent. You can use the session token to redirect the user to Google to finish the signup flow. You can re-generate new session token repeatedly for the same request if necessary, regardless of the previous tokens being expired or not.", "flatPath": "v1/partners/{partnersId}/userSessions:generate", "httpMethod": "POST", "id": "paymentsresellersubscription.partners.userSessions.generate", @@ -467,7 +467,7 @@ } } }, - "revision": "20241211", + "revision": "20250312", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { @@ -765,6 +765,22 @@ }, "type": "object" }, + "GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload": { + "description": "Payload specific for Google Home products.", + "id": "GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload", + "properties": { + "attachedToGoogleStructure": { + "description": "Output only. This identifies whether the subscription is attached to a Google Home structure.", + "readOnly": true, + "type": "boolean" + }, + "partnerStructureId": { + "description": "Optional. This identifies the structure ID on partner side that the subscription should be applied to. Only required when the partner requires structure mapping.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload": { "description": "Payload specific to Google One products.", "id": "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload", @@ -891,7 +907,7 @@ "properties": { "bundleDetails": { "$ref": "ProductBundleDetails", - "description": "Output only. Output Only. Specifies the details for a bundle product.", + "description": "Output only. Specifies the details for a bundle product.", "readOnly": true }, "finiteBillingCycleDetails": { @@ -911,7 +927,7 @@ "type": "array" }, "productType": { - "description": "Output only. Output Only. Specifies the type of the product.", + "description": "Output only. Specifies the type of the product.", "enum": [ "PRODUCT_TYPE_UNSPECIFIED", "PRODUCT_TYPE_SUBSCRIPTION", @@ -965,6 +981,10 @@ "description": "Specifies product specific payload.", "id": "GoogleCloudPaymentsResellerSubscriptionV1ProductPayload", "properties": { + "googleHomePayload": { + "$ref": "GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload", + "description": "Payload specific to Google Home products." + }, "googleOnePayload": { "$ref": "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload", "description": "Product-specific payloads. Payload specific to Google One products." @@ -1023,7 +1043,7 @@ "type": "string" }, "promotionType": { - "description": "Output only. Output Only. Specifies the type of the promotion.", + "description": "Output only. Specifies the type of the promotion.", "enum": [ "PROMOTION_TYPE_UNSPECIFIED", "PROMOTION_TYPE_FREE_TRIAL", @@ -1092,7 +1112,7 @@ "type": "string" }, "recurrenceCount": { - "description": "Output only. Output Only. The duration of an introductory offer in billing cycles.", + "description": "Output only. The duration of an introductory offer in billing cycles.", "format": "int32", "readOnly": true, "type": "integer" diff --git a/src/apis/paymentsresellersubscription/v1.ts b/src/apis/paymentsresellersubscription/v1.ts index a504355a6dc..9d01d98ad15 100644 --- a/src/apis/paymentsresellersubscription/v1.ts +++ b/src/apis/paymentsresellersubscription/v1.ts @@ -329,6 +329,19 @@ export namespace paymentsresellersubscription_v1 { */ userSession?: Schema$GoogleCloudPaymentsResellerSubscriptionV1UserSession; } + /** + * Payload specific for Google Home products. + */ + export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload { + /** + * Output only. This identifies whether the subscription is attached to a Google Home structure. + */ + attachedToGoogleStructure?: boolean | null; + /** + * Optional. This identifies the structure ID on partner side that the subscription should be applied to. Only required when the partner requires structure mapping. + */ + partnerStructureId?: string | null; + } /** * Payload specific to Google One products. */ @@ -407,7 +420,7 @@ export namespace paymentsresellersubscription_v1 { */ export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1Product { /** - * Output only. Output Only. Specifies the details for a bundle product. + * Output only. Specifies the details for a bundle product. */ bundleDetails?: Schema$ProductBundleDetails; /** @@ -423,7 +436,7 @@ export namespace paymentsresellersubscription_v1 { */ priceConfigs?: Schema$GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig[]; /** - * Output only. Output Only. Specifies the type of the product. + * Output only. Specifies the type of the product. */ productType?: string | null; /** @@ -452,6 +465,10 @@ export namespace paymentsresellersubscription_v1 { * Specifies product specific payload. */ export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1ProductPayload { + /** + * Payload specific to Google Home products. + */ + googleHomePayload?: Schema$GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload; /** * Product-specific payloads. Payload specific to Google One products. */ @@ -499,7 +516,7 @@ export namespace paymentsresellersubscription_v1 { */ name?: string | null; /** - * Output only. Output Only. Specifies the type of the promotion. + * Output only. Specifies the type of the promotion. */ promotionType?: string | null; /** @@ -537,7 +554,7 @@ export namespace paymentsresellersubscription_v1 { */ discountRatioMicros?: string | null; /** - * Output only. Output Only. The duration of an introductory offer in billing cycles. + * Output only. The duration of an introductory offer in billing cycles. */ recurrenceCount?: number | null; /** @@ -871,7 +888,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * To retrieve the products that can be resold by the partner. It should be autenticated with a service account. - This API doesn't apply to YouTube products currently. + * Currently, it doesn't support **YouTube** products. Retrieves the products that can be resold by the partner. It should be autenticated with a service account. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -997,7 +1014,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * To find eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen. + * Currently, it is only enabeld for **YouTube**. Finds eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1096,7 +1113,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * Retrieves the promotions, such as free trial, that can be used by the partner. - This API doesn't apply to YouTube promotions currently. It should be autenticated with a service account. + * Currently, it doesn't support **YouTube** promotions. Retrieves the promotions, such as free trial, that can be used by the partner. It should be autenticated with a service account. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1234,7 +1251,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * Used by partners to cancel a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts. + * Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1429,7 +1446,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * Used by partners to entitle a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth. + * Entitles a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1528,7 +1545,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * [Opt-in only] Most partners should be on auto-extend by default. Used by partners to extend a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts. + * [Opt-in only] Most partners should be on auto-extend by default. Extends a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1624,7 +1641,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * Used by partners to get a subscription by id. It should be called directly by the partner using service accounts. + * Gets a subscription by id. It should be called directly by the partner using service accounts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1819,7 +1836,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * Revokes the pending cancellation of a subscription, which is currently in `STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already cancelled, the request will fail. - **This API doesn't apply to YouTube subscriptions.** It should be called directly by the partner using service accounts. + * Currently, it is used by **Google One, Play Pass** partners. Revokes the pending cancellation of a subscription, which is currently in `STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already cancelled, the request will fail. It should be called directly by the partner using service accounts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2013,7 +2030,7 @@ export namespace paymentsresellersubscription_v1 { } /** - * This API replaces user authorized OAuth consent based APIs (Create, Entitle). Generates a short-lived token for a user session based on the user intent. You can use the session token to redirect the user to Google to finish the signup flow. You can re-generate new session token repeatedly for the same request if necessary, regardless of the previous tokens being expired or not. + * This API replaces user authorized OAuth consent based APIs (Create, Entitle). Issues a timed session token for the given user intent. You can use the session token to redirect the user to Google to finish the signup flow. You can re-generate new session token repeatedly for the same request if necessary, regardless of the previous tokens being expired or not. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From 7bef82e3e5fec4d99c9e8c22461fe3ac839832fe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 099/144] feat(places): update the API #### places:v1 The following keys were added: - schemas.GoogleMapsPlacesV1Place.properties.postalAddress.$ref - schemas.GoogleMapsPlacesV1Place.properties.postalAddress.description - schemas.GoogleMapsPlacesV1Place.properties.timeZone.$ref - schemas.GoogleMapsPlacesV1Place.properties.timeZone.description - schemas.GoogleTypePostalAddress.description - schemas.GoogleTypePostalAddress.id - schemas.GoogleTypePostalAddress.properties.addressLines.description - schemas.GoogleTypePostalAddress.properties.addressLines.items.type - schemas.GoogleTypePostalAddress.properties.addressLines.type - schemas.GoogleTypePostalAddress.properties.administrativeArea.description - schemas.GoogleTypePostalAddress.properties.administrativeArea.type - schemas.GoogleTypePostalAddress.properties.languageCode.description - schemas.GoogleTypePostalAddress.properties.languageCode.type - schemas.GoogleTypePostalAddress.properties.locality.description - schemas.GoogleTypePostalAddress.properties.locality.type - schemas.GoogleTypePostalAddress.properties.organization.description - schemas.GoogleTypePostalAddress.properties.organization.type - schemas.GoogleTypePostalAddress.properties.postalCode.description - schemas.GoogleTypePostalAddress.properties.postalCode.type - schemas.GoogleTypePostalAddress.properties.recipients.description - schemas.GoogleTypePostalAddress.properties.recipients.items.type - schemas.GoogleTypePostalAddress.properties.recipients.type - schemas.GoogleTypePostalAddress.properties.regionCode.description - schemas.GoogleTypePostalAddress.properties.regionCode.type - schemas.GoogleTypePostalAddress.properties.revision.description - schemas.GoogleTypePostalAddress.properties.revision.format - schemas.GoogleTypePostalAddress.properties.revision.type - schemas.GoogleTypePostalAddress.properties.sortingCode.description - schemas.GoogleTypePostalAddress.properties.sortingCode.type - schemas.GoogleTypePostalAddress.properties.sublocality.description - schemas.GoogleTypePostalAddress.properties.sublocality.type - schemas.GoogleTypePostalAddress.type - schemas.GoogleTypeTimeZone.description - schemas.GoogleTypeTimeZone.id - schemas.GoogleTypeTimeZone.properties.id.description - schemas.GoogleTypeTimeZone.properties.id.type - schemas.GoogleTypeTimeZone.properties.version.description - schemas.GoogleTypeTimeZone.properties.version.type - schemas.GoogleTypeTimeZone.type The following keys were changed: - schemas.GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation.properties.type.enum - schemas.GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation.properties.type.enumDescriptions - schemas.GoogleMapsPlacesV1PlaceSubDestination.description - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.connectorTypes.items.enum - schemas.GoogleMapsPlacesV1SearchTextRequestEVOptions.properties.connectorTypes.items.enumDescriptions --- discovery/places-v1.json | 97 +++++++++++++++++++++++++++++++++++++--- src/apis/places/v1.ts | 72 ++++++++++++++++++++++++++++- 2 files changed, 162 insertions(+), 7 deletions(-) diff --git a/discovery/places-v1.json b/discovery/places-v1.json index 27bf2b3339c..b4d82d74618 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -280,7 +280,7 @@ } } }, - "revision": "20250115", + "revision": "20250312", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -855,7 +855,8 @@ "EV_CONNECTOR_TYPE_CCS_COMBO_2", "EV_CONNECTOR_TYPE_TESLA", "EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T", - "EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET" + "EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET", + "EV_CONNECTOR_TYPE_NACS" ], "enumDescriptions": [ "Unspecified connector.", @@ -867,7 +868,8 @@ "Combined Charging System (AC and DC). Based on Type-2 Mennekes connector", "The generic TESLA connector. This is NACS in the North America but can be non-NACS in other parts of the world (e.g. CCS Combo 2 (CCS2) or GB/T). This value is less representative of an actual connector type, and more represents the ability to charge a Tesla brand vehicle at a Tesla owned charging station.", "GB/T type corresponds to the GB/T standard in China. This type covers all GB_T types.", - "Unspecified wall outlet." + "Unspecified wall outlet.", + "The North American Charging System (NACS), standardized as SAE J3400." ], "type": "string" } @@ -1192,6 +1194,10 @@ "$ref": "GoogleMapsPlacesV1PlacePlusCode", "description": "Plus code of the place location lat/long." }, + "postalAddress": { + "$ref": "GoogleTypePostalAddress", + "description": "The address in postal address format." + }, "priceLevel": { "description": "Price level of the place.", "enum": [ @@ -1314,6 +1320,10 @@ "description": "Specifies if the business supports takeout.", "type": "boolean" }, + "timeZone": { + "$ref": "GoogleTypeTimeZone", + "description": "IANA Time Zone Database time zone. For example \"America/New_York\"." + }, "types": { "description": "A set of type tags for this result. For example, \"political\" and \"locality\". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types", "items": { @@ -1701,7 +1711,7 @@ "type": "object" }, "GoogleMapsPlacesV1PlaceSubDestination": { - "description": "Place resource name and id of sub destinations that relate to the place. For example, different terminals are different destinations of an airport.", + "description": "Sub-destinations are specific places associated with a main place. These provide more specific destinations for users who are searching inside a large or complex place, like an airport, national park, university, or stadium. For example, sub-destinations at an airport might include associated terminals and parking lots. Sub-destinations return the place ID and place resource name, which can be used in subsequent Place Details (new) requests to fetch richer details, including the sub-destination's display name and location.", "id": "GoogleMapsPlacesV1PlaceSubDestination", "properties": { "id": { @@ -2145,7 +2155,8 @@ "EV_CONNECTOR_TYPE_CCS_COMBO_2", "EV_CONNECTOR_TYPE_TESLA", "EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T", - "EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET" + "EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET", + "EV_CONNECTOR_TYPE_NACS" ], "enumDescriptions": [ "Unspecified connector.", @@ -2157,7 +2168,8 @@ "Combined Charging System (AC and DC). Based on Type-2 Mennekes connector", "The generic TESLA connector. This is NACS in the North America but can be non-NACS in other parts of the world (e.g. CCS Combo 2 (CCS2) or GB/T). This value is less representative of an actual connector type, and more represents the ability to charge a Tesla brand vehicle at a Tesla owned charging station.", "GB/T type corresponds to the GB/T standard in China. This type covers all GB_T types.", - "Unspecified wall outlet." + "Unspecified wall outlet.", + "The North American Charging System (NACS), standardized as SAE J3400." ], "type": "string" }, @@ -2318,6 +2330,79 @@ } }, "type": "object" + }, + "GoogleTypePostalAddress": { + "description": "Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478", + "id": "GoogleTypePostalAddress", + "properties": { + "addressLines": { + "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", + "items": { + "type": "string" + }, + "type": "array" + }, + "administrativeArea": { + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.", + "type": "string" + }, + "languageCode": { + "description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", + "type": "string" + }, + "locality": { + "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", + "type": "string" + }, + "organization": { + "description": "Optional. The name of the organization at the address.", + "type": "string" + }, + "postalCode": { + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).", + "type": "string" + }, + "recipients": { + "description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", + "items": { + "type": "string" + }, + "type": "array" + }, + "regionCode": { + "description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", + "type": "string" + }, + "revision": { + "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", + "format": "int32", + "type": "integer" + }, + "sortingCode": { + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (For example \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (For example Côte d'Ivoire).", + "type": "string" + }, + "sublocality": { + "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleTypeTimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "GoogleTypeTimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index bff65de89c3..1cb1746a732 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -777,6 +777,10 @@ export namespace places_v1 { * Plus code of the place location lat/long. */ plusCode?: Schema$GoogleMapsPlacesV1PlacePlusCode; + /** + * The address in postal address format. + */ + postalAddress?: Schema$GoogleTypePostalAddress; /** * Price level of the place. */ @@ -873,6 +877,10 @@ export namespace places_v1 { * Specifies if the business supports takeout. */ takeout?: boolean | null; + /** + * IANA Time Zone Database time zone. For example "America/New_York". + */ + timeZone?: Schema$GoogleTypeTimeZone; /** * A set of type tags for this result. For example, "political" and "locality". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types */ @@ -1173,7 +1181,7 @@ export namespace places_v1 { globalCode?: string | null; } /** - * Place resource name and id of sub destinations that relate to the place. For example, different terminals are different destinations of an airport. + * Sub-destinations are specific places associated with a main place. These provide more specific destinations for users who are searching inside a large or complex place, like an airport, national park, university, or stadium. For example, sub-destinations at an airport might include associated terminals and parking lots. Sub-destinations return the place ID and place resource name, which can be used in subsequent Place Details (new) requests to fetch richer details, including the sub-destination's display name and location. */ export interface Schema$GoogleMapsPlacesV1PlaceSubDestination { /** @@ -1602,6 +1610,68 @@ export namespace places_v1 { */ units?: string | null; } + /** + * Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 + */ + export interface Schema$GoogleTypePostalAddress { + /** + * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + */ + addressLines?: string[] | null; + /** + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated. + */ + administrativeArea?: string | null; + /** + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + */ + languageCode?: string | null; + /** + * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. + */ + locality?: string | null; + /** + * Optional. The name of the organization at the address. + */ + organization?: string | null; + /** + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.). + */ + postalCode?: string | null; + /** + * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. + */ + recipients?: string[] | null; + /** + * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + */ + regionCode?: string | null; + /** + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + */ + revision?: number | null; + /** + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire). + */ + sortingCode?: string | null; + /** + * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + */ + sublocality?: string | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$GoogleTypeTimeZone { + /** + * IANA Time Zone Database time zone. For example "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number. For example "2019a". + */ + version?: string | null; + } export class Resource$Places { context: APIRequestContext; From 3ca6e1b5b7821e44951277c79fdbb402bac2f75f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 100/144] feat(playdeveloperreporting): update the API #### playdeveloperreporting:v1alpha1 The following keys were added: - resources.vitals.resources.lmkrate.methods.get.description - resources.vitals.resources.lmkrate.methods.get.flatPath - resources.vitals.resources.lmkrate.methods.get.httpMethod - resources.vitals.resources.lmkrate.methods.get.id - resources.vitals.resources.lmkrate.methods.get.parameterOrder - resources.vitals.resources.lmkrate.methods.get.parameters.name.description - resources.vitals.resources.lmkrate.methods.get.parameters.name.location - resources.vitals.resources.lmkrate.methods.get.parameters.name.pattern - resources.vitals.resources.lmkrate.methods.get.parameters.name.required - resources.vitals.resources.lmkrate.methods.get.parameters.name.type - resources.vitals.resources.lmkrate.methods.get.path - resources.vitals.resources.lmkrate.methods.get.response.$ref - resources.vitals.resources.lmkrate.methods.get.scopes - resources.vitals.resources.lmkrate.methods.query.description - resources.vitals.resources.lmkrate.methods.query.flatPath - resources.vitals.resources.lmkrate.methods.query.httpMethod - resources.vitals.resources.lmkrate.methods.query.id - resources.vitals.resources.lmkrate.methods.query.parameterOrder - resources.vitals.resources.lmkrate.methods.query.parameters.name.description - resources.vitals.resources.lmkrate.methods.query.parameters.name.location - resources.vitals.resources.lmkrate.methods.query.parameters.name.pattern - resources.vitals.resources.lmkrate.methods.query.parameters.name.required - resources.vitals.resources.lmkrate.methods.query.parameters.name.type - resources.vitals.resources.lmkrate.methods.query.path - resources.vitals.resources.lmkrate.methods.query.request.$ref - resources.vitals.resources.lmkrate.methods.query.response.$ref - resources.vitals.resources.lmkrate.methods.query.scopes - schemas.GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet.description - schemas.GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet.id - schemas.GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet.properties.freshnessInfo.$ref - schemas.GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet.properties.freshnessInfo.description - schemas.GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet.properties.name.description - schemas.GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet.properties.name.type - schemas.GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.id - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.dimensions.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.dimensions.items.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.dimensions.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.filter.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.filter.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.metrics.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.metrics.items.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.metrics.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.pageSize.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.pageSize.format - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.pageSize.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.pageToken.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.pageToken.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.timelineSpec.$ref - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.timelineSpec.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.userCohort.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.userCohort.enum - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.userCohort.enumDescriptions - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.properties.userCohort.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse.id - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse.properties.nextPageToken.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse.properties.nextPageToken.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse.properties.rows.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse.properties.rows.items.$ref - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse.properties.rows.type - schemas.GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse.type The following keys were changed: - schemas.GooglePlayDeveloperReportingV1alpha1QueryExcessiveWakeupRateMetricSetRequest.properties.userCohort.description - schemas.GooglePlayDeveloperReportingV1alpha1QuerySlowRenderingRateMetricSetRequest.properties.userCohort.description - schemas.GooglePlayDeveloperReportingV1alpha1QuerySlowStartRateMetricSetRequest.properties.userCohort.description - schemas.GooglePlayDeveloperReportingV1alpha1QueryStuckBackgroundWakelockRateMetricSetRequest.properties.userCohort.description #### playdeveloperreporting:v1beta1 The following keys were added: - resources.vitals.resources.lmkrate.methods.get.description - resources.vitals.resources.lmkrate.methods.get.flatPath - resources.vitals.resources.lmkrate.methods.get.httpMethod - resources.vitals.resources.lmkrate.methods.get.id - resources.vitals.resources.lmkrate.methods.get.parameterOrder - resources.vitals.resources.lmkrate.methods.get.parameters.name.description - resources.vitals.resources.lmkrate.methods.get.parameters.name.location - resources.vitals.resources.lmkrate.methods.get.parameters.name.pattern - resources.vitals.resources.lmkrate.methods.get.parameters.name.required - resources.vitals.resources.lmkrate.methods.get.parameters.name.type - resources.vitals.resources.lmkrate.methods.get.path - resources.vitals.resources.lmkrate.methods.get.response.$ref - resources.vitals.resources.lmkrate.methods.get.scopes - resources.vitals.resources.lmkrate.methods.query.description - resources.vitals.resources.lmkrate.methods.query.flatPath - resources.vitals.resources.lmkrate.methods.query.httpMethod - resources.vitals.resources.lmkrate.methods.query.id - resources.vitals.resources.lmkrate.methods.query.parameterOrder - resources.vitals.resources.lmkrate.methods.query.parameters.name.description - resources.vitals.resources.lmkrate.methods.query.parameters.name.location - resources.vitals.resources.lmkrate.methods.query.parameters.name.pattern - resources.vitals.resources.lmkrate.methods.query.parameters.name.required - resources.vitals.resources.lmkrate.methods.query.parameters.name.type - resources.vitals.resources.lmkrate.methods.query.path - resources.vitals.resources.lmkrate.methods.query.request.$ref - resources.vitals.resources.lmkrate.methods.query.response.$ref - resources.vitals.resources.lmkrate.methods.query.scopes - schemas.GooglePlayDeveloperReportingV1beta1LmkRateMetricSet.description - schemas.GooglePlayDeveloperReportingV1beta1LmkRateMetricSet.id - schemas.GooglePlayDeveloperReportingV1beta1LmkRateMetricSet.properties.freshnessInfo.$ref - schemas.GooglePlayDeveloperReportingV1beta1LmkRateMetricSet.properties.freshnessInfo.description - schemas.GooglePlayDeveloperReportingV1beta1LmkRateMetricSet.properties.name.description - schemas.GooglePlayDeveloperReportingV1beta1LmkRateMetricSet.properties.name.type - schemas.GooglePlayDeveloperReportingV1beta1LmkRateMetricSet.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.id - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.dimensions.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.dimensions.items.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.dimensions.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.filter.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.filter.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.metrics.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.metrics.items.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.metrics.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.pageSize.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.pageSize.format - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.pageSize.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.pageToken.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.pageToken.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.timelineSpec.$ref - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.timelineSpec.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.userCohort.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.userCohort.enum - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.userCohort.enumDescriptions - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.properties.userCohort.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse.id - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse.properties.nextPageToken.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse.properties.nextPageToken.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse.properties.rows.description - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse.properties.rows.items.$ref - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse.properties.rows.type - schemas.GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse.type The following keys were changed: - schemas.GooglePlayDeveloperReportingV1beta1QueryExcessiveWakeupRateMetricSetRequest.properties.userCohort.description - schemas.GooglePlayDeveloperReportingV1beta1QuerySlowRenderingRateMetricSetRequest.properties.userCohort.description - schemas.GooglePlayDeveloperReportingV1beta1QuerySlowStartRateMetricSetRequest.properties.userCohort.description - schemas.GooglePlayDeveloperReportingV1beta1QueryStuckBackgroundWakelockRateMetricSetRequest.properties.userCohort.description --- .../playdeveloperreporting-v1alpha1.json | 154 +++++++++- discovery/playdeveloperreporting-v1beta1.json | 154 +++++++++- src/apis/playdeveloperreporting/v1alpha1.ts | 289 +++++++++++++++++- src/apis/playdeveloperreporting/v1beta1.ts | 289 +++++++++++++++++- 4 files changed, 868 insertions(+), 18 deletions(-) diff --git a/discovery/playdeveloperreporting-v1alpha1.json b/discovery/playdeveloperreporting-v1alpha1.json index bccc572e307..0ca5a44fc5e 100644 --- a/discovery/playdeveloperreporting-v1alpha1.json +++ b/discovery/playdeveloperreporting-v1alpha1.json @@ -773,6 +773,63 @@ } } }, + "lmkrate": { + "methods": { + "get": { + "description": "Describes the properties of the metric set.", + "flatPath": "v1alpha1/apps/{appsId}/lmkRateMetricSet", + "httpMethod": "GET", + "id": "playdeveloperreporting.vitals.lmkrate.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name. Format: apps/{app}/lmkRateMetricSet", + "location": "path", + "pattern": "^apps/[^/]+/lmkRateMetricSet$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/playdeveloperreporting" + ] + }, + "query": { + "description": "Queries the metrics in the metric set.", + "flatPath": "v1alpha1/apps/{appsId}/lmkRateMetricSet:query", + "httpMethod": "POST", + "id": "playdeveloperreporting.vitals.lmkrate.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name. Format: apps/{app}/lmkRateMetricSet", + "location": "path", + "pattern": "^apps/[^/]+/lmkRateMetricSet$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}:query", + "request": { + "$ref": "GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest" + }, + "response": { + "$ref": "GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/playdeveloperreporting" + ] + } + } + }, "slowrenderingrate": { "methods": { "get": { @@ -947,7 +1004,7 @@ } } }, - "revision": "20241128", + "revision": "20250311", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { @@ -1367,6 +1424,21 @@ }, "type": "object" }, + "GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet": { + "description": "Singleton resource representing the set of LMK (Low Memory Kill) metrics. This metric set contains LMKs data combined with usage data to produce a normalized metric independent of user counts. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`. **Supported metrics:** * `userPerceivedLmkRate` (`google.type.Decimal`): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * `userPerceivedLmkRate7dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 7 days. The daily values are weighted by the count of distinct users for the day. * `userPerceivedLmkRate28dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 28 days. The daily values are weighted by the count of distinct users for the day. * `distinctUsers` (`google.type.Decimal`): Count of distinct users in the aggregation period that were used as normalization value for the `userPerceivedLmkRate` metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): version of the app that was running on the user's device. * `deviceModel` (string): 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. * `deviceBrand` (string): unique identifier of the user's device brand, e.g., google. * `deviceType` (string): the type (also known as form factor) of the user's device, e.g., PHONE. * `countryCode` (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * `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. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app. **Related metric sets:** * vitals.errors contains normalized metrics about crashes, another stability metric. * vitals.errors contains normalized metrics about ANRs, another stability metric.", + "id": "GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet", + "properties": { + "freshnessInfo": { + "$ref": "GooglePlayDeveloperReportingV1alpha1FreshnessInfo", + "description": "Summary about data freshness in this resource." + }, + "name": { + "description": "Identifier. The resource name. Format: apps/{app}/lmkRateMetricSet", + "type": "string" + } + }, + "type": "object" + }, "GooglePlayDeveloperReportingV1alpha1MetricValue": { "description": "Represents the value of a metric.", "id": "GooglePlayDeveloperReportingV1alpha1MetricValue", @@ -1675,7 +1747,7 @@ "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`." }, "userCohort": { - "description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.", "enum": [ "USER_COHORT_UNSPECIFIED", "OS_PUBLIC", @@ -1711,6 +1783,78 @@ }, "type": "object" }, + "GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest": { + "description": "Request message for QueryLmkRateMetricSet.", + "id": "GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest", + "properties": { + "dimensions": { + "description": "Optional. Dimensions to slice the metrics by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): version of the app that was running on the user's device. * `deviceModel` (string): 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. * `deviceBrand` (string): unique identifier of the user's device brand, e.g., google. * `deviceType` (string): the type (also known as form factor) of the user's device, e.g., PHONE. * `countryCode` (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * `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": "Optional. 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.", + "type": "string" + }, + "metrics": { + "description": "Optional. Metrics to aggregate. **Supported metrics:** * `userPerceivedLmkRate` (`google.type.Decimal`): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * `userPerceivedLmkRate7dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 7 days. The daily values are weighted by the count of distinct users for the day. * `userPerceivedLmkRate28dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 28 days. The daily values are weighted by the count of distinct users for the day. * `distinctUsers` (`google.type.Decimal`): Count of distinct users in the aggregation period that were used as normalization value for the `userPerceivedLmkRate` metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pageSize": { + "description": "Optional. Maximum size of the returned data. If unspecified, at most 1000 rows will be returned. The maximum value is 100,000; values above 100,000 will be coerced to 100,000.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to the request must match the call that provided the page token.", + "type": "string" + }, + "timelineSpec": { + "$ref": "GooglePlayDeveloperReportingV1alpha1TimelineSpec", + "description": "Optional. Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the default and only supported timezone is `America/Los_Angeles`." + }, + "userCohort": { + "description": "Optional. User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "enum": [ + "USER_COHORT_UNSPECIFIED", + "OS_PUBLIC", + "OS_BETA", + "APP_TESTERS" + ], + "enumDescriptions": [ + "Unspecified User cohort. This will automatically choose the default value.", + "This is default view. Contains data from public released android versions only.", + "This is the view with just android beta data excluding released OS version data.", + "This is the view with data only from users who have opted in to be testers for a given app, excluding OS beta data." + ], + "type": "string" + } + }, + "type": "object" + }, + "GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse": { + "description": "Response message for QueryLmkRateMetricSet.", + "id": "GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token to fetch the next page of data.", + "type": "string" + }, + "rows": { + "description": "Returned rows of data.", + "items": { + "$ref": "GooglePlayDeveloperReportingV1alpha1MetricsRow" + }, + "type": "array" + } + }, + "type": "object" + }, "GooglePlayDeveloperReportingV1alpha1QuerySlowRenderingRateMetricSetRequest": { "description": "Request message for QuerySlowRenderingRateMetricSet.", "id": "GooglePlayDeveloperReportingV1alpha1QuerySlowRenderingRateMetricSetRequest", @@ -1747,7 +1891,7 @@ "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`." }, "userCohort": { - "description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.", "enum": [ "USER_COHORT_UNSPECIFIED", "OS_PUBLIC", @@ -1819,7 +1963,7 @@ "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`." }, "userCohort": { - "description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.", "enum": [ "USER_COHORT_UNSPECIFIED", "OS_PUBLIC", @@ -1891,7 +2035,7 @@ "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`." }, "userCohort": { - "description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.", "enum": [ "USER_COHORT_UNSPECIFIED", "OS_PUBLIC", diff --git a/discovery/playdeveloperreporting-v1beta1.json b/discovery/playdeveloperreporting-v1beta1.json index f00883dd8db..2f6afc80129 100644 --- a/discovery/playdeveloperreporting-v1beta1.json +++ b/discovery/playdeveloperreporting-v1beta1.json @@ -773,6 +773,63 @@ } } }, + "lmkrate": { + "methods": { + "get": { + "description": "Describes the properties of the metric set.", + "flatPath": "v1beta1/apps/{appsId}/lmkRateMetricSet", + "httpMethod": "GET", + "id": "playdeveloperreporting.vitals.lmkrate.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name. Format: apps/{app}/lmkRateMetricSet", + "location": "path", + "pattern": "^apps/[^/]+/lmkRateMetricSet$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GooglePlayDeveloperReportingV1beta1LmkRateMetricSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/playdeveloperreporting" + ] + }, + "query": { + "description": "Queries the metrics in the metric set.", + "flatPath": "v1beta1/apps/{appsId}/lmkRateMetricSet:query", + "httpMethod": "POST", + "id": "playdeveloperreporting.vitals.lmkrate.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name. Format: apps/{app}/lmkRateMetricSet", + "location": "path", + "pattern": "^apps/[^/]+/lmkRateMetricSet$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:query", + "request": { + "$ref": "GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest" + }, + "response": { + "$ref": "GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/playdeveloperreporting" + ] + } + } + }, "slowrenderingrate": { "methods": { "get": { @@ -947,7 +1004,7 @@ } } }, - "revision": "20241128", + "revision": "20250311", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { @@ -1367,6 +1424,21 @@ }, "type": "object" }, + "GooglePlayDeveloperReportingV1beta1LmkRateMetricSet": { + "description": "Singleton resource representing the set of LMK (Low Memory Kill) metrics. This metric set contains LMKs data combined with usage data to produce a normalized metric independent of user counts. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`. **Supported metrics:** * `userPerceivedLmkRate` (`google.type.Decimal`): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * `userPerceivedLmkRate7dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 7 days. The daily values are weighted by the count of distinct users for the day. * `userPerceivedLmkRate28dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 28 days. The daily values are weighted by the count of distinct users for the day. * `distinctUsers` (`google.type.Decimal`): Count of distinct users in the aggregation period that were used as normalization value for the `userPerceivedLmkRate` metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): version of the app that was running on the user's device. * `deviceModel` (string): 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. * `deviceBrand` (string): unique identifier of the user's device brand, e.g., google. * `deviceType` (string): the type (also known as form factor) of the user's device, e.g., PHONE. * `countryCode` (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * `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. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app. **Related metric sets:** * vitals.errors contains normalized metrics about crashes, another stability metric. * vitals.errors contains normalized metrics about ANRs, another stability metric.", + "id": "GooglePlayDeveloperReportingV1beta1LmkRateMetricSet", + "properties": { + "freshnessInfo": { + "$ref": "GooglePlayDeveloperReportingV1beta1FreshnessInfo", + "description": "Summary about data freshness in this resource." + }, + "name": { + "description": "Identifier. The resource name. Format: apps/{app}/lmkRateMetricSet", + "type": "string" + } + }, + "type": "object" + }, "GooglePlayDeveloperReportingV1beta1MetricValue": { "description": "Represents the value of a metric.", "id": "GooglePlayDeveloperReportingV1beta1MetricValue", @@ -1675,7 +1747,7 @@ "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`." }, "userCohort": { - "description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.", "enum": [ "USER_COHORT_UNSPECIFIED", "OS_PUBLIC", @@ -1711,6 +1783,78 @@ }, "type": "object" }, + "GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest": { + "description": "Request message for QueryLmkRateMetricSet.", + "id": "GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest", + "properties": { + "dimensions": { + "description": "Optional. Dimensions to slice the metrics by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): version of the app that was running on the user's device. * `deviceModel` (string): 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. * `deviceBrand` (string): unique identifier of the user's device brand, e.g., google. * `deviceType` (string): the type (also known as form factor) of the user's device, e.g., PHONE. * `countryCode` (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * `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": "Optional. 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.", + "type": "string" + }, + "metrics": { + "description": "Optional. Metrics to aggregate. **Supported metrics:** * `userPerceivedLmkRate` (`google.type.Decimal`): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * `userPerceivedLmkRate7dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 7 days. The daily values are weighted by the count of distinct users for the day. * `userPerceivedLmkRate28dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 28 days. The daily values are weighted by the count of distinct users for the day. * `distinctUsers` (`google.type.Decimal`): Count of distinct users in the aggregation period that were used as normalization value for the `userPerceivedLmkRate` metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pageSize": { + "description": "Optional. Maximum size of the returned data. If unspecified, at most 1000 rows will be returned. The maximum value is 100,000; values above 100,000 will be coerced to 100,000.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to the request must match the call that provided the page token.", + "type": "string" + }, + "timelineSpec": { + "$ref": "GooglePlayDeveloperReportingV1beta1TimelineSpec", + "description": "Optional. Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the default and only supported timezone is `America/Los_Angeles`." + }, + "userCohort": { + "description": "Optional. User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "enum": [ + "USER_COHORT_UNSPECIFIED", + "OS_PUBLIC", + "OS_BETA", + "APP_TESTERS" + ], + "enumDescriptions": [ + "Unspecified User cohort. This will automatically choose the default value.", + "This is default view. Contains data from public released android versions only.", + "This is the view with just android beta data excluding released OS version data.", + "This is the view with data only from users who have opted in to be testers for a given app, excluding OS beta data." + ], + "type": "string" + } + }, + "type": "object" + }, + "GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse": { + "description": "Response message for QueryLmkRateMetricSet.", + "id": "GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token to fetch the next page of data.", + "type": "string" + }, + "rows": { + "description": "Returned rows of data.", + "items": { + "$ref": "GooglePlayDeveloperReportingV1beta1MetricsRow" + }, + "type": "array" + } + }, + "type": "object" + }, "GooglePlayDeveloperReportingV1beta1QuerySlowRenderingRateMetricSetRequest": { "description": "Request message for QuerySlowRenderingRateMetricSet.", "id": "GooglePlayDeveloperReportingV1beta1QuerySlowRenderingRateMetricSetRequest", @@ -1747,7 +1891,7 @@ "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`." }, "userCohort": { - "description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.", "enum": [ "USER_COHORT_UNSPECIFIED", "OS_PUBLIC", @@ -1819,7 +1963,7 @@ "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`." }, "userCohort": { - "description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.", "enum": [ "USER_COHORT_UNSPECIFIED", "OS_PUBLIC", @@ -1891,7 +2035,7 @@ "description": "Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`." }, "userCohort": { - "description": "User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., \"T1B2.220916.004\".", + "description": "User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`.", "enum": [ "USER_COHORT_UNSPECIFIED", "OS_PUBLIC", diff --git a/src/apis/playdeveloperreporting/v1alpha1.ts b/src/apis/playdeveloperreporting/v1alpha1.ts index 2971c7a4dc2..a863c0cee4e 100644 --- a/src/apis/playdeveloperreporting/v1alpha1.ts +++ b/src/apis/playdeveloperreporting/v1alpha1.ts @@ -453,6 +453,19 @@ export namespace playdeveloperreporting_v1alpha1 { */ nextPageToken?: string | null; } + /** + * Singleton resource representing the set of LMK (Low Memory Kill) metrics. This metric set contains LMKs data combined with usage data to produce a normalized metric independent of user counts. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`. **Supported metrics:** * `userPerceivedLmkRate` (`google.type.Decimal`): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * `userPerceivedLmkRate7dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 7 days. The daily values are weighted by the count of distinct users for the day. * `userPerceivedLmkRate28dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 28 days. The daily values are weighted by the count of distinct users for the day. * `distinctUsers` (`google.type.Decimal`): Count of distinct users in the aggregation period that were used as normalization value for the `userPerceivedLmkRate` metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): version of the app that was running on the user's device. * `deviceModel` (string): 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. * `deviceBrand` (string): unique identifier of the user's device brand, e.g., google. * `deviceType` (string): the type (also known as form factor) of the user's device, e.g., PHONE. * `countryCode` (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * `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. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app. **Related metric sets:** * vitals.errors contains normalized metrics about crashes, another stability metric. * vitals.errors contains normalized metrics about ANRs, another stability metric. + */ + export interface Schema$GooglePlayDeveloperReportingV1alpha1LmkRateMetricSet { + /** + * Summary about data freshness in this resource. + */ + freshnessInfo?: Schema$GooglePlayDeveloperReportingV1alpha1FreshnessInfo; + /** + * Identifier. The resource name. Format: apps/{app\}/lmkRateMetricSet + */ + name?: string | null; + } /** * Represents a row of dimensions and metrics. */ @@ -663,7 +676,7 @@ export namespace playdeveloperreporting_v1alpha1 { */ timelineSpec?: Schema$GooglePlayDeveloperReportingV1alpha1TimelineSpec; /** - * User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + * User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. */ userCohort?: string | null; } @@ -680,6 +693,52 @@ export namespace playdeveloperreporting_v1alpha1 { */ rows?: Schema$GooglePlayDeveloperReportingV1alpha1MetricsRow[]; } + /** + * Request message for QueryLmkRateMetricSet. + */ + export interface Schema$GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest { + /** + * Optional. Dimensions to slice the metrics by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): version of the app that was running on the user's device. * `deviceModel` (string): 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. * `deviceBrand` (string): unique identifier of the user's device brand, e.g., google. * `deviceType` (string): the type (also known as form factor) of the user's device, e.g., PHONE. * `countryCode` (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * `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; + /** + * Optional. 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. + */ + filter?: string | null; + /** + * Optional. Metrics to aggregate. **Supported metrics:** * `userPerceivedLmkRate` (`google.type.Decimal`): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * `userPerceivedLmkRate7dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 7 days. The daily values are weighted by the count of distinct users for the day. * `userPerceivedLmkRate28dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 28 days. The daily values are weighted by the count of distinct users for the day. * `distinctUsers` (`google.type.Decimal`): Count of distinct users in the aggregation period that were used as normalization value for the `userPerceivedLmkRate` metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value. + */ + metrics?: string[] | null; + /** + * Optional. Maximum size of the returned data. If unspecified, at most 1000 rows will be returned. The maximum value is 100,000; values above 100,000 will be coerced to 100,000. + */ + pageSize?: number | null; + /** + * Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to the request must match the call that provided the page token. + */ + pageToken?: string | null; + /** + * Optional. Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the default and only supported timezone is `America/Los_Angeles`. + */ + timelineSpec?: Schema$GooglePlayDeveloperReportingV1alpha1TimelineSpec; + /** + * Optional. User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + */ + userCohort?: string | null; + } + /** + * Response message for QueryLmkRateMetricSet. + */ + export interface Schema$GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetResponse { + /** + * Continuation token to fetch the next page of data. + */ + nextPageToken?: string | null; + /** + * Returned rows of data. + */ + rows?: Schema$GooglePlayDeveloperReportingV1alpha1MetricsRow[]; + } /** * Request message for QuerySlowRenderingRateMetricSet. */ @@ -709,7 +768,7 @@ export namespace playdeveloperreporting_v1alpha1 { */ timelineSpec?: Schema$GooglePlayDeveloperReportingV1alpha1TimelineSpec; /** - * User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + * User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. */ userCohort?: string | null; } @@ -755,7 +814,7 @@ export namespace playdeveloperreporting_v1alpha1 { */ timelineSpec?: Schema$GooglePlayDeveloperReportingV1alpha1TimelineSpec; /** - * User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + * User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. */ userCohort?: string | null; } @@ -801,7 +860,7 @@ export namespace playdeveloperreporting_v1alpha1 { */ timelineSpec?: Schema$GooglePlayDeveloperReportingV1alpha1TimelineSpec; /** - * User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + * User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. */ userCohort?: string | null; } @@ -1364,6 +1423,7 @@ export namespace playdeveloperreporting_v1alpha1 { crashrate: Resource$Vitals$Crashrate; errors: Resource$Vitals$Errors; excessivewakeuprate: Resource$Vitals$Excessivewakeuprate; + lmkrate: Resource$Vitals$Lmkrate; slowrenderingrate: Resource$Vitals$Slowrenderingrate; slowstartrate: Resource$Vitals$Slowstartrate; stuckbackgroundwakelockrate: Resource$Vitals$Stuckbackgroundwakelockrate; @@ -1375,6 +1435,7 @@ export namespace playdeveloperreporting_v1alpha1 { this.excessivewakeuprate = new Resource$Vitals$Excessivewakeuprate( this.context ); + this.lmkrate = new Resource$Vitals$Lmkrate(this.context); this.slowrenderingrate = new Resource$Vitals$Slowrenderingrate( this.context ); @@ -2695,6 +2756,226 @@ export namespace playdeveloperreporting_v1alpha1 { requestBody?: Schema$GooglePlayDeveloperReportingV1alpha1QueryExcessiveWakeupRateMetricSetRequest; } + export class Resource$Vitals$Lmkrate { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Describes the properties of the metric 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$Vitals$Lmkrate$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Vitals$Lmkrate$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Vitals$Lmkrate$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Vitals$Lmkrate$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Vitals$Lmkrate$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Vitals$Lmkrate$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vitals$Lmkrate$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vitals$Lmkrate$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://playdeveloperreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+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 + ); + } + } + + /** + * Queries the metrics in the metric 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. + */ + query( + params: Params$Resource$Vitals$Lmkrate$Query, + options: StreamMethodOptions + ): GaxiosPromise; + query( + params?: Params$Resource$Vitals$Lmkrate$Query, + options?: MethodOptions + ): GaxiosPromise; + query( + params: Params$Resource$Vitals$Lmkrate$Query, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Vitals$Lmkrate$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Vitals$Lmkrate$Query, + callback: BodyResponseCallback + ): void; + query( + callback: BodyResponseCallback + ): void; + query( + paramsOrCallback?: + | Params$Resource$Vitals$Lmkrate$Query + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vitals$Lmkrate$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vitals$Lmkrate$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://playdeveloperreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:query').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$Vitals$Lmkrate$Get + extends StandardParameters { + /** + * Required. The resource name. Format: apps/{app\}/lmkRateMetricSet + */ + name?: string; + } + export interface Params$Resource$Vitals$Lmkrate$Query + extends StandardParameters { + /** + * Required. The resource name. Format: apps/{app\}/lmkRateMetricSet + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest; + } + export class Resource$Vitals$Slowrenderingrate { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/playdeveloperreporting/v1beta1.ts b/src/apis/playdeveloperreporting/v1beta1.ts index efff273514f..9079ffbba03 100644 --- a/src/apis/playdeveloperreporting/v1beta1.ts +++ b/src/apis/playdeveloperreporting/v1beta1.ts @@ -453,6 +453,19 @@ export namespace playdeveloperreporting_v1beta1 { */ nextPageToken?: string | null; } + /** + * Singleton resource representing the set of LMK (Low Memory Kill) metrics. This metric set contains LMKs data combined with usage data to produce a normalized metric independent of user counts. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the only supported timezone is `America/Los_Angeles`. **Supported metrics:** * `userPerceivedLmkRate` (`google.type.Decimal`): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * `userPerceivedLmkRate7dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 7 days. The daily values are weighted by the count of distinct users for the day. * `userPerceivedLmkRate28dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 28 days. The daily values are weighted by the count of distinct users for the day. * `distinctUsers` (`google.type.Decimal`): Count of distinct users in the aggregation period that were used as normalization value for the `userPerceivedLmkRate` metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): version of the app that was running on the user's device. * `deviceModel` (string): 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. * `deviceBrand` (string): unique identifier of the user's device brand, e.g., google. * `deviceType` (string): the type (also known as form factor) of the user's device, e.g., PHONE. * `countryCode` (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * `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. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app. **Related metric sets:** * vitals.errors contains normalized metrics about crashes, another stability metric. * vitals.errors contains normalized metrics about ANRs, another stability metric. + */ + export interface Schema$GooglePlayDeveloperReportingV1beta1LmkRateMetricSet { + /** + * Summary about data freshness in this resource. + */ + freshnessInfo?: Schema$GooglePlayDeveloperReportingV1beta1FreshnessInfo; + /** + * Identifier. The resource name. Format: apps/{app\}/lmkRateMetricSet + */ + name?: string | null; + } /** * Represents a row of dimensions and metrics. */ @@ -663,7 +676,7 @@ export namespace playdeveloperreporting_v1beta1 { */ timelineSpec?: Schema$GooglePlayDeveloperReportingV1beta1TimelineSpec; /** - * User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + * User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. */ userCohort?: string | null; } @@ -680,6 +693,52 @@ export namespace playdeveloperreporting_v1beta1 { */ rows?: Schema$GooglePlayDeveloperReportingV1beta1MetricsRow[]; } + /** + * Request message for QueryLmkRateMetricSet. + */ + export interface Schema$GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest { + /** + * Optional. Dimensions to slice the metrics by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): version of the app that was running on the user's device. * `deviceModel` (string): 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. * `deviceBrand` (string): unique identifier of the user's device brand, e.g., google. * `deviceType` (string): the type (also known as form factor) of the user's device, e.g., PHONE. * `countryCode` (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * `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; + /** + * Optional. 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. + */ + filter?: string | null; + /** + * Optional. Metrics to aggregate. **Supported metrics:** * `userPerceivedLmkRate` (`google.type.Decimal`): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * `userPerceivedLmkRate7dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 7 days. The daily values are weighted by the count of distinct users for the day. * `userPerceivedLmkRate28dUserWeighted` (`google.type.Decimal`): Rolling average value of `userPerceivedLmkRate` in the last 28 days. The daily values are weighted by the count of distinct users for the day. * `distinctUsers` (`google.type.Decimal`): Count of distinct users in the aggregation period that were used as normalization value for the `userPerceivedLmkRate` metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value. + */ + metrics?: string[] | null; + /** + * Optional. Maximum size of the returned data. If unspecified, at most 1000 rows will be returned. The maximum value is 100,000; values above 100,000 will be coerced to 100,000. + */ + pageSize?: number | null; + /** + * Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to the request must match the call that provided the page token. + */ + pageToken?: string | null; + /** + * Optional. Specification of the timeline aggregation parameters. **Supported aggregation periods:** * DAILY: metrics are aggregated in calendar date intervals. Due to historical constraints, the default and only supported timezone is `America/Los_Angeles`. + */ + timelineSpec?: Schema$GooglePlayDeveloperReportingV1beta1TimelineSpec; + /** + * Optional. User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + */ + userCohort?: string | null; + } + /** + * Response message for QueryLmkRateMetricSet. + */ + export interface Schema$GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetResponse { + /** + * Continuation token to fetch the next page of data. + */ + nextPageToken?: string | null; + /** + * Returned rows of data. + */ + rows?: Schema$GooglePlayDeveloperReportingV1beta1MetricsRow[]; + } /** * Request message for QuerySlowRenderingRateMetricSet. */ @@ -709,7 +768,7 @@ export namespace playdeveloperreporting_v1beta1 { */ timelineSpec?: Schema$GooglePlayDeveloperReportingV1beta1TimelineSpec; /** - * User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + * User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. */ userCohort?: string | null; } @@ -755,7 +814,7 @@ export namespace playdeveloperreporting_v1beta1 { */ timelineSpec?: Schema$GooglePlayDeveloperReportingV1beta1TimelineSpec; /** - * User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta Android versions only, excluding data from released Android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + * User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. */ userCohort?: string | null; } @@ -801,7 +860,7 @@ export namespace playdeveloperreporting_v1beta1 { */ timelineSpec?: Schema$GooglePlayDeveloperReportingV1beta1TimelineSpec; /** - * User view to select. The output data will correspond to the selected view. **Supported values:** * `OS_PUBLIC` To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * `APP_TESTERS` To select data from users who have opted in to be testers. Supports all the above dimensions. * `OS_BETA` To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * `versionCode` (int64): version of the app that was running on the user's device. * `osBuild` (string): OS build of the user's device, e.g., "T1B2.220916.004". + * User view to select. The output data will correspond to the selected view. The only supported value is `OS_PUBLIC`. */ userCohort?: string | null; } @@ -1364,6 +1423,7 @@ export namespace playdeveloperreporting_v1beta1 { crashrate: Resource$Vitals$Crashrate; errors: Resource$Vitals$Errors; excessivewakeuprate: Resource$Vitals$Excessivewakeuprate; + lmkrate: Resource$Vitals$Lmkrate; slowrenderingrate: Resource$Vitals$Slowrenderingrate; slowstartrate: Resource$Vitals$Slowstartrate; stuckbackgroundwakelockrate: Resource$Vitals$Stuckbackgroundwakelockrate; @@ -1375,6 +1435,7 @@ export namespace playdeveloperreporting_v1beta1 { this.excessivewakeuprate = new Resource$Vitals$Excessivewakeuprate( this.context ); + this.lmkrate = new Resource$Vitals$Lmkrate(this.context); this.slowrenderingrate = new Resource$Vitals$Slowrenderingrate( this.context ); @@ -2695,6 +2756,226 @@ export namespace playdeveloperreporting_v1beta1 { requestBody?: Schema$GooglePlayDeveloperReportingV1beta1QueryExcessiveWakeupRateMetricSetRequest; } + export class Resource$Vitals$Lmkrate { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Describes the properties of the metric 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$Vitals$Lmkrate$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Vitals$Lmkrate$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Vitals$Lmkrate$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Vitals$Lmkrate$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Vitals$Lmkrate$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Vitals$Lmkrate$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vitals$Lmkrate$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vitals$Lmkrate$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://playdeveloperreporting.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 + ); + } + } + + /** + * Queries the metrics in the metric 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. + */ + query( + params: Params$Resource$Vitals$Lmkrate$Query, + options: StreamMethodOptions + ): GaxiosPromise; + query( + params?: Params$Resource$Vitals$Lmkrate$Query, + options?: MethodOptions + ): GaxiosPromise; + query( + params: Params$Resource$Vitals$Lmkrate$Query, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Vitals$Lmkrate$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Vitals$Lmkrate$Query, + callback: BodyResponseCallback + ): void; + query( + callback: BodyResponseCallback + ): void; + query( + paramsOrCallback?: + | Params$Resource$Vitals$Lmkrate$Query + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Vitals$Lmkrate$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Vitals$Lmkrate$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://playdeveloperreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:query').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$Vitals$Lmkrate$Get + extends StandardParameters { + /** + * Required. The resource name. Format: apps/{app\}/lmkRateMetricSet + */ + name?: string; + } + export interface Params$Resource$Vitals$Lmkrate$Query + extends StandardParameters { + /** + * Required. The resource name. Format: apps/{app\}/lmkRateMetricSet + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest; + } + export class Resource$Vitals$Slowrenderingrate { context: APIRequestContext; constructor(context: APIRequestContext) { From 2a04993a78a6a4d7b2e0e8ea4e769574d3a48f25 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 101/144] feat(playintegrity)!: update the API BREAKING CHANGE: This release has breaking changes. #### playintegrity:v1 The following keys were deleted: - schemas.AppAccessRiskVerdict.properties.otherApps.deprecated - schemas.AppAccessRiskVerdict.properties.otherApps.description - schemas.AppAccessRiskVerdict.properties.otherApps.enum - schemas.AppAccessRiskVerdict.properties.otherApps.enumDescriptions - schemas.AppAccessRiskVerdict.properties.otherApps.type - schemas.AppAccessRiskVerdict.properties.playOrSystemApps.deprecated - schemas.AppAccessRiskVerdict.properties.playOrSystemApps.description - schemas.AppAccessRiskVerdict.properties.playOrSystemApps.enum - schemas.AppAccessRiskVerdict.properties.playOrSystemApps.enumDescriptions - schemas.AppAccessRiskVerdict.properties.playOrSystemApps.type --- discovery/playintegrity-v1.json | 44 +-------------------------------- src/apis/playintegrity/v1.ts | 8 ------ 2 files changed, 1 insertion(+), 51 deletions(-) diff --git a/discovery/playintegrity-v1.json b/discovery/playintegrity-v1.json index e4506f0bddb..330af926311 100644 --- a/discovery/playintegrity-v1.json +++ b/discovery/playintegrity-v1.json @@ -170,7 +170,7 @@ } } }, - "revision": "20241127", + "revision": "20250223", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -259,48 +259,6 @@ "type": "string" }, "type": "array" - }, - "otherApps": { - "deprecated": true, - "description": "Deprecated: this field will be removed, please use apps_detected instead. App access risk verdict related to apps that are not installed by Google Play, and are not preloaded on the system image by the device manufacturer.", - "enum": [ - "UNKNOWN", - "UNEVALUATED", - "NOT_INSTALLED", - "INSTALLED", - "CAPTURING", - "CONTROLLING" - ], - "enumDescriptions": [ - "Risk type is unknown.", - "App access risk was not evaluated because a requirement was missed, such as the device not being trusted enough.", - "No apps under this field are installed on the device. This is only valid for the other apps field.", - "One or more apps under this field are installed on the device.", - "Apps under this field are running that could be used to read or capture inputs and outputs of the requesting app, such as screen recording apps.", - "Apps under this field are running that could be used to control the device and inputs and outputs of the requesting app, such as remote controlling apps." - ], - "type": "string" - }, - "playOrSystemApps": { - "deprecated": true, - "description": "Deprecated: this field will be removed, please use apps_detected instead. App access risk verdict related to apps that are not installed by the Google Play Store, and are not preloaded on the system image by the device manufacturer.", - "enum": [ - "UNKNOWN", - "UNEVALUATED", - "NOT_INSTALLED", - "INSTALLED", - "CAPTURING", - "CONTROLLING" - ], - "enumDescriptions": [ - "Risk type is unknown.", - "App access risk was not evaluated because a requirement was missed, such as the device not being trusted enough.", - "No apps under this field are installed on the device. This is only valid for the other apps field.", - "One or more apps under this field are installed on the device.", - "Apps under this field are running that could be used to read or capture inputs and outputs of the requesting app, such as screen recording apps.", - "Apps under this field are running that could be used to control the device and inputs and outputs of the requesting app, such as remote controlling apps." - ], - "type": "string" } }, "type": "object" diff --git a/src/apis/playintegrity/v1.ts b/src/apis/playintegrity/v1.ts index 79b24e1e5c7..019229a9a60 100644 --- a/src/apis/playintegrity/v1.ts +++ b/src/apis/playintegrity/v1.ts @@ -156,14 +156,6 @@ export namespace playintegrity_v1 { * List of detected app types signalled for App Access Risk. */ appsDetected?: string[] | null; - /** - * Deprecated: this field will be removed, please use apps_detected instead. App access risk verdict related to apps that are not installed by Google Play, and are not preloaded on the system image by the device manufacturer. - */ - otherApps?: string | null; - /** - * Deprecated: this field will be removed, please use apps_detected instead. App access risk verdict related to apps that are not installed by the Google Play Store, and are not preloaded on the system image by the device manufacturer. - */ - playOrSystemApps?: string | null; } /** * Contains the application integrity information. From 3fe49ca6af386170b2d8b648654765417d8c8467 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 102/144] feat(privateca): update the API #### privateca:v1 The following keys were added: - schemas.CertificateAuthority.properties.userDefinedAccessUrls.$ref - schemas.CertificateAuthority.properties.userDefinedAccessUrls.description - schemas.IssuancePolicy.properties.backdateDuration.description - schemas.IssuancePolicy.properties.backdateDuration.format - schemas.IssuancePolicy.properties.backdateDuration.type - schemas.UserDefinedAccessUrls.description - schemas.UserDefinedAccessUrls.id - schemas.UserDefinedAccessUrls.properties.aiaIssuingCertificateUrls.description - schemas.UserDefinedAccessUrls.properties.aiaIssuingCertificateUrls.items.type - schemas.UserDefinedAccessUrls.properties.aiaIssuingCertificateUrls.type - schemas.UserDefinedAccessUrls.properties.crlAccessUrls.description - schemas.UserDefinedAccessUrls.properties.crlAccessUrls.items.type - schemas.UserDefinedAccessUrls.properties.crlAccessUrls.type - schemas.UserDefinedAccessUrls.type --- discovery/privateca-v1.json | 32 +++++++++++++++++++++++++++++++- src/apis/privateca/v1.ts | 21 +++++++++++++++++++++ 2 files changed, 52 insertions(+), 1 deletion(-) diff --git a/discovery/privateca-v1.json b/discovery/privateca-v1.json index 161d7ea3315..c2eb3bf5d07 100644 --- a/discovery/privateca-v1.json +++ b/discovery/privateca-v1.json @@ -1605,7 +1605,7 @@ } } }, - "revision": "20241204", + "revision": "20250226", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -2034,6 +2034,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "userDefinedAccessUrls": { + "$ref": "UserDefinedAccessUrls", + "description": "Optional. User-defined URLs for CA certificate and CRLs. The service does not publish content to these URLs. It is up to the user to mirror content to these URLs." } }, "type": "object" @@ -2491,6 +2495,11 @@ }, "type": "array" }, + "backdateDuration": { + "description": "Optional. The duration to backdate all certificates issued from this CaPool. If not set, the certificates will be issued with a not_before_time of the issuance time (i.e. the current time). If set, the certificates will be issued with a not_before_time of the issuance time minus the backdate_duration. The not_after_time will be adjusted to preserve the requested lifetime. The backdate_duration must be less than or equal to 48 hours.", + "format": "google-duration", + "type": "string" + }, "baselineValues": { "$ref": "X509Parameters", "description": "Optional. A set of X.509 values that will be applied to all certificates issued through this CaPool. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a CertificateTemplate that defines conflicting predefined_values for the same properties, the certificate issuance request will fail." @@ -3469,6 +3478,27 @@ }, "type": "object" }, + "UserDefinedAccessUrls": { + "description": "User-defined URLs for accessing content published by this CertificateAuthority.", + "id": "UserDefinedAccessUrls", + "properties": { + "aiaIssuingCertificateUrls": { + "description": "Optional. A list of URLs where the issuer CA certificate may be downloaded, which appears in the \"Authority Information Access\" extension in the certificate. If specified, the default Cloud Storage URLs will be omitted.", + "items": { + "type": "string" + }, + "type": "array" + }, + "crlAccessUrls": { + "description": "Optional. A list of URLs where to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13. If specified, the default Cloud Storage URLs will be omitted.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "X509Extension": { "description": "An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.", "id": "X509Extension", diff --git a/src/apis/privateca/v1.ts b/src/apis/privateca/v1.ts index 3cd7d10d6e9..22352614628 100644 --- a/src/apis/privateca/v1.ts +++ b/src/apis/privateca/v1.ts @@ -399,6 +399,10 @@ export namespace privateca_v1 { * Output only. The time at which this CertificateAuthority was last updated. */ updateTime?: string | null; + /** + * Optional. User-defined URLs for CA certificate and CRLs. The service does not publish content to these URLs. It is up to the user to mirror content to these URLs. + */ + userDefinedAccessUrls?: Schema$UserDefinedAccessUrls; } /** * A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. @@ -733,6 +737,10 @@ export namespace privateca_v1 { * Optional. If any AllowedKeyType is specified, then the certificate request's public key must match one of the key types listed here. Otherwise, any key may be used. */ allowedKeyTypes?: Schema$AllowedKeyType[]; + /** + * Optional. The duration to backdate all certificates issued from this CaPool. If not set, the certificates will be issued with a not_before_time of the issuance time (i.e. the current time). If set, the certificates will be issued with a not_before_time of the issuance time minus the backdate_duration. The not_after_time will be adjusted to preserve the requested lifetime. The backdate_duration must be less than or equal to 48 hours. + */ + backdateDuration?: string | null; /** * Optional. A set of X.509 values that will be applied to all certificates issued through this CaPool. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a CertificateTemplate that defines conflicting predefined_values for the same properties, the certificate issuance request will fail. */ @@ -1377,6 +1385,19 @@ export namespace privateca_v1 { */ requestId?: string | null; } + /** + * User-defined URLs for accessing content published by this CertificateAuthority. + */ + export interface Schema$UserDefinedAccessUrls { + /** + * Optional. A list of URLs where the issuer CA certificate may be downloaded, which appears in the "Authority Information Access" extension in the certificate. If specified, the default Cloud Storage URLs will be omitted. + */ + aiaIssuingCertificateUrls?: string[] | null; + /** + * Optional. A list of URLs where to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13. If specified, the default Cloud Storage URLs will be omitted. + */ + crlAccessUrls?: string[] | null; + } /** * An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. */ From 3eeb7739c2d0082c76e44b86fb0c10f4b0c245e5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 103/144] feat(pubsub): update the API #### pubsub:v1 The following keys were added: - schemas.JavaScriptUDF.description - schemas.JavaScriptUDF.id - schemas.JavaScriptUDF.properties.code.description - schemas.JavaScriptUDF.properties.code.type - schemas.JavaScriptUDF.properties.functionName.description - schemas.JavaScriptUDF.properties.functionName.type - schemas.JavaScriptUDF.type - schemas.MessageTransform.description - schemas.MessageTransform.id - schemas.MessageTransform.properties.enabled.description - schemas.MessageTransform.properties.enabled.type - schemas.MessageTransform.properties.javascriptUdf.$ref - schemas.MessageTransform.properties.javascriptUdf.description - schemas.MessageTransform.type - schemas.Subscription.properties.messageTransforms.description - schemas.Subscription.properties.messageTransforms.items.$ref - schemas.Subscription.properties.messageTransforms.type - schemas.Topic.properties.messageTransforms.description - schemas.Topic.properties.messageTransforms.items.$ref - schemas.Topic.properties.messageTransforms.type The following keys were changed: - schemas.CloudStorageConfig.properties.maxDuration.description - schemas.DeadLetterPolicy.properties.maxDeliveryAttempts.description - schemas.RetryPolicy.description - schemas.Subscription.properties.enableExactlyOnceDelivery.description - schemas.Subscription.properties.retryPolicy.description --- discovery/pubsub-v1.json | 56 +++++++++++++++++++++++++++++++++++----- src/apis/pubsub/v1.ts | 44 +++++++++++++++++++++++++++---- 2 files changed, 89 insertions(+), 11 deletions(-) diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 8b6806959a6..7372cc70dca 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -1638,7 +1638,7 @@ } } }, - "revision": "20241231", + "revision": "20250218", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1996,7 +1996,7 @@ "type": "string" }, "maxDuration": { - "description": "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.", + "description": "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 acknowledgment deadline.", "format": "google-duration", "type": "string" }, @@ -2125,7 +2125,7 @@ "type": "string" }, "maxDeliveryAttempts": { - "description": "Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.", + "description": "Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgment deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.", "format": "int32", "type": "integer" } @@ -2210,6 +2210,21 @@ }, "type": "object" }, + "JavaScriptUDF": { + "description": "User-defined JavaScript function that can transform or filter a Pub/Sub message.", + "id": "JavaScriptUDF", + "properties": { + "code": { + "description": "Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ```", + "type": "string" + }, + "functionName": { + "description": "Required. Name of the JavasScript function that should applied to Pub/Sub messages.", + "type": "string" + } + }, + "type": "object" + }, "ListSchemaRevisionsResponse": { "description": "Response for the `ListSchemaRevisions` method.", "id": "ListSchemaRevisionsResponse", @@ -2354,6 +2369,21 @@ }, "type": "object" }, + "MessageTransform": { + "description": "All supported message transforms types.", + "id": "MessageTransform", + "properties": { + "enabled": { + "description": "Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`.", + "type": "boolean" + }, + "javascriptUdf": { + "$ref": "JavaScriptUDF", + "description": "Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`." + } + }, + "type": "object" + }, "ModifyAckDeadlineRequest": { "description": "Request for the ModifyAckDeadline method.", "id": "ModifyAckDeadlineRequest", @@ -2615,7 +2645,7 @@ "type": "object" }, "RetryPolicy": { - "description": "A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.", + "description": "A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.", "id": "RetryPolicy", "properties": { "maximumBackoff": { @@ -2806,7 +2836,7 @@ "type": "boolean" }, "enableExactlyOnceDelivery": { - "description": "Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.", + "description": "Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgment deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.", "type": "boolean" }, "enableMessageOrdering": { @@ -2833,6 +2863,13 @@ "format": "google-duration", "type": "string" }, + "messageTransforms": { + "description": "Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.", + "items": { + "$ref": "MessageTransform" + }, + "type": "array" + }, "name": { "description": "Required. The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "type": "string" @@ -2847,7 +2884,7 @@ }, "retryPolicy": { "$ref": "RetryPolicy", - "description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message." + "description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message." }, "state": { "description": "Output only. An output-only field indicating whether or not the subscription can receive messages.", @@ -2950,6 +2987,13 @@ "$ref": "MessageStoragePolicy", "description": "Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect." }, + "messageTransforms": { + "description": "Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.", + "items": { + "$ref": "MessageTransform" + }, + "type": "array" + }, "name": { "description": "Required. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "type": "string" diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index c658d51c412..a0dc7ec76f5 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -362,7 +362,7 @@ export namespace pubsub_v1 { */ maxBytes?: string | null; /** - * 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. + * 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 acknowledgment deadline. */ maxDuration?: string | null; /** @@ -442,7 +442,7 @@ export namespace pubsub_v1 { */ deadLetterTopic?: string | null; /** - * Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. + * Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgment deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. */ maxDeliveryAttempts?: number | null; } @@ -513,6 +513,19 @@ export namespace pubsub_v1 { */ platformLogsSettings?: Schema$PlatformLogsSettings; } + /** + * User-defined JavaScript function that can transform or filter a Pub/Sub message. + */ + export interface Schema$JavaScriptUDF { + /** + * Required. JavaScript code that contains a function `function_name` with the below signature: ``` /x* * Transforms a Pub/Sub message. * @return {(Object)\>|null)\} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string\} * - (optional) 'attributes' : {Object\} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)\>\} Pub/Sub * message. Keys: * - (required) 'data' : {string\} * - (required) 'attributes' : {Object\} * * @param {Object\} metadata - Pub/Sub message metadata. * Keys: * - (required) 'message_id' : {string\} * - (optional) 'publish_time': {string\} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string\} x/ function (message, metadata) { \} ``` + */ + code?: string | null; + /** + * Required. Name of the JavasScript function that should applied to Pub/Sub messages. + */ + functionName?: string | null; + } /** * Response for the `ListSchemaRevisions` method. */ @@ -617,6 +630,19 @@ export namespace pubsub_v1 { */ enforceInTransit?: boolean | null; } + /** + * All supported message transforms types. + */ + export interface Schema$MessageTransform { + /** + * Optional. If set to true, the transform is enabled. If false, the transform is disabled and will not be applied to messages. Defaults to `true`. + */ + enabled?: boolean | null; + /** + * Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. + */ + javascriptUdf?: Schema$JavaScriptUDF; + } /** * Request for the ModifyAckDeadline method. */ @@ -803,7 +829,7 @@ export namespace pubsub_v1 { message?: Schema$PubsubMessage; } /** - * A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. + * A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. */ export interface Schema$RetryPolicy { /** @@ -946,7 +972,7 @@ export namespace pubsub_v1 { */ detached?: boolean | null; /** - * Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. + * Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgment deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. */ enableExactlyOnceDelivery?: boolean | null; /** @@ -969,6 +995,10 @@ export namespace pubsub_v1 { * Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. */ messageRetentionDuration?: string | null; + /** + * Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. + */ + messageTransforms?: Schema$MessageTransform[]; /** * Required. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ @@ -982,7 +1012,7 @@ export namespace pubsub_v1 { */ retainAckedMessages?: boolean | null; /** - * Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. + * Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. */ retryPolicy?: Schema$RetryPolicy; /** @@ -1053,6 +1083,10 @@ export namespace pubsub_v1 { * Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect. */ messageStoragePolicy?: Schema$MessageStoragePolicy; + /** + * Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified. + */ + messageTransforms?: Schema$MessageTransform[]; /** * Required. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ From 6ca203067add4df64c5c51d0beb56c445e1ae6b8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 104/144] fix(rapidmigrationassessment): update the API #### rapidmigrationassessment:v1 The following keys were changed: - resources.projects.resources.locations.resources.collectors.methods.delete.description --- discovery/rapidmigrationassessment-v1.json | 4 ++-- src/apis/rapidmigrationassessment/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/rapidmigrationassessment-v1.json b/discovery/rapidmigrationassessment-v1.json index 49bd859772d..14719c42413 100644 --- a/discovery/rapidmigrationassessment-v1.json +++ b/discovery/rapidmigrationassessment-v1.json @@ -280,7 +280,7 @@ ] }, "delete": { - "description": "Deletes a single Collector - changes state of collector to \"Deleting\". Background jobs does final deletion thorugh producer api.", + "description": "Deletes a single Collector - changes state of collector to \"Deleting\". Background jobs does final deletion through producer API.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}", "httpMethod": "DELETE", "id": "rapidmigrationassessment.projects.locations.collectors.delete", @@ -633,7 +633,7 @@ } } }, - "revision": "20241211", + "revision": "20250214", "rootUrl": "https://rapidmigrationassessment.googleapis.com/", "schemas": { "Annotation": { diff --git a/src/apis/rapidmigrationassessment/v1.ts b/src/apis/rapidmigrationassessment/v1.ts index 4fa95e9b918..a53311b3cc3 100644 --- a/src/apis/rapidmigrationassessment/v1.ts +++ b/src/apis/rapidmigrationassessment/v1.ts @@ -948,7 +948,7 @@ export namespace rapidmigrationassessment_v1 { } /** - * Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api. + * Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion through producer API. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From 42c22f52b13b587cb822802babf7ffd8b46ce5dd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 105/144] feat(realtimebidding): update the API #### realtimebidding:v1 The following keys were added: - schemas.Creative.properties.declaredRestrictedCategories.deprecated The following keys were changed: - description - schemas.Bidder.properties.bypassNonguaranteedDealsPretargeting.description - schemas.CreativeServingDecision.properties.detectedCategories.description - schemas.CreativeServingDecision.properties.detectedCategoriesTaxonomy.enum - schemas.CreativeServingDecision.properties.detectedCategoriesTaxonomy.enumDescriptions --- discovery/realtimebidding-v1.json | 11 +++++++---- src/apis/realtimebidding/README.md | 2 +- src/apis/realtimebidding/v1.ts | 6 +++--- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/discovery/realtimebidding-v1.json b/discovery/realtimebidding-v1.json index 1a002af6754..b3c8c196ad6 100644 --- a/discovery/realtimebidding-v1.json +++ b/discovery/realtimebidding-v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://realtimebidding.googleapis.com/", "batchPath": "batch", "canonicalName": "Real-time Bidding", - "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.", + "description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive with pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", "fullyEncodeReservedExpansion": true, @@ -1305,7 +1305,7 @@ } } }, - "revision": "20240930", + "revision": "20250306", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -1529,7 +1529,7 @@ "id": "Bidder", "properties": { "bypassNonguaranteedDealsPretargeting": { - "description": "Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.", + "description": "Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this option. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.", "readOnly": true, "type": "boolean" }, @@ -1764,6 +1764,7 @@ "type": "array" }, "declaredRestrictedCategories": { + "deprecated": true, "description": "All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.", "items": { "enum": [ @@ -1970,7 +1971,7 @@ "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.", + "description": "Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method.", "items": { "type": "string" }, @@ -1981,10 +1982,12 @@ "description": "Output only. The taxonomy in which the detected_categories field is expressed.", "enum": [ "AD_CATEGORY_TAXONOMY_UNSPECIFIED", + "GOOGLE_AD_CATEGORY_TAXONOMY", "IAB_CONTENT_1_0" ], "enumDescriptions": [ "Default value that should never be used.", + "Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at https://developers.google.com/authorized-buyers/rtb/data#reference-data", "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, diff --git a/src/apis/realtimebidding/README.md b/src/apis/realtimebidding/README.md index 0f318b74054..c787c510d88 100644 --- a/src/apis/realtimebidding/README.md +++ b/src/apis/realtimebidding/README.md @@ -2,7 +2,7 @@ # realtimebidding -> 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. +> Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive with pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status. ## Installation diff --git a/src/apis/realtimebidding/v1.ts b/src/apis/realtimebidding/v1.ts index a7a42ebc633..f3b61a7d3f1 100644 --- a/src/apis/realtimebidding/v1.ts +++ b/src/apis/realtimebidding/v1.ts @@ -102,7 +102,7 @@ export namespace realtimebidding_v1 { /** * Real-time Bidding API * - * 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. + * Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive with pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status. * * @example * ```js @@ -261,7 +261,7 @@ export namespace realtimebidding_v1 { */ export interface Schema$Bidder { /** - * Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. + * Output only. An option to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this option. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations. */ bypassNonguaranteedDealsPretargeting?: boolean | null; /** @@ -441,7 +441,7 @@ export namespace realtimebidding_v1 { */ 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. + * Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method. */ detectedCategories?: string[] | null; /** From 52951e24a1bdb8c0df1ac7306e55b48077eac90f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 106/144] feat(recaptchaenterprise): update the API #### recaptchaenterprise:v1 The following keys were added: - schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.ja4.description - schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.ja4.type The following keys were changed: - schemas.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest.properties.reasons.items.enumDescriptions - schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.fraudPrevention.enumDescriptions - schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.ja3.description - schemas.GoogleCloudRecaptchaenterpriseV1Metrics.properties.startTime.description --- discovery/recaptchaenterprise-v1.json | 14 +++++++++----- src/apis/recaptchaenterprise/v1.ts | 8 ++++++-- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index 86ff171d3f9..4e67265b689 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -786,7 +786,7 @@ } } }, - "revision": "20241208", + "revision": "20250209", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -968,7 +968,7 @@ "SOCIAL_SPAM" ], "enumDescriptions": [ - "Default unspecified reason.", + "Unspecified reason. Do not use.", "Indicates that the transaction had a chargeback issued with no other details. When possible, specify the type by using CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead.", "Indicates that the transaction had a chargeback issued related to an alleged unauthorized transaction from the cardholder's perspective (for example, the card number was stolen).", "Indicates that the transaction had a chargeback issued related to the cardholder having provided their card details but allegedly not being satisfied with the purchase (for example, misrepresentation, attempted cancellation).", @@ -1177,7 +1177,7 @@ "enumDescriptions": [ "Default, unspecified setting. `fraud_prevention_assessment` is returned if `transaction_data` is present in `Event` and Fraud Prevention is enabled in the Google Cloud console.", "Enable Fraud Prevention for this assessment, if Fraud Prevention is enabled in the Google Cloud console.", - "Disable Fraud Prevention for this assessment, regardless of Google Cloud console settings." + "Disable Fraud Prevention for this assessment, regardless of the Google Cloud console settings." ], "type": "string" }, @@ -1195,7 +1195,11 @@ "type": "array" }, "ja3": { - "description": "Optional. JA3 fingerprint for SSL clients.", + "description": "Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3.", + "type": "string" + }, + "ja4": { + "description": "Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.", "type": "string" }, "requestedUri": { @@ -1708,7 +1712,7 @@ "type": "array" }, "startTime": { - "description": "Inclusive start time aligned to a day (UTC).", + "description": "Inclusive start time aligned to a day in the America/Los_Angeles (Pacific) timezone.", "format": "google-datetime", "type": "string" } diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index 301f3c2a0b1..b4e1605528d 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -367,9 +367,13 @@ export namespace recaptchaenterprise_v1 { */ headers?: string[] | null; /** - * Optional. JA3 fingerprint for SSL clients. + * Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3. */ ja3?: string | null; + /** + * Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4. + */ + ja4?: string | null; /** * Optional. The URI resource the user requested that triggered an assessment. */ @@ -752,7 +756,7 @@ export namespace recaptchaenterprise_v1 { */ scoreMetrics?: Schema$GoogleCloudRecaptchaenterpriseV1ScoreMetrics[]; /** - * Inclusive start time aligned to a day (UTC). + * Inclusive start time aligned to a day in the America/Los_Angeles (Pacific) timezone. */ startTime?: string | null; } From 668b7c6935b98b1591b5cb2b582890f8665c25a8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:48 +0000 Subject: [PATCH 107/144] feat(redis): update the API #### redis:v1beta1 The following keys were added: - schemas.Cluster.properties.ondemandMaintenance.description - schemas.Cluster.properties.ondemandMaintenance.type - schemas.DatabaseResourceMetadata.properties.gcbdrConfiguration.$ref - schemas.DatabaseResourceMetadata.properties.gcbdrConfiguration.description - schemas.DatabaseResourceMetadata.properties.suspensionReason.description - schemas.DatabaseResourceMetadata.properties.suspensionReason.enum - schemas.DatabaseResourceMetadata.properties.suspensionReason.enumDescriptions - schemas.DatabaseResourceMetadata.properties.suspensionReason.type - schemas.Entitlement.properties.type.enumDeprecated - schemas.GCBDRConfiguration.description - schemas.GCBDRConfiguration.id - schemas.GCBDRConfiguration.properties.gcbdrManaged.description - schemas.GCBDRConfiguration.properties.gcbdrManaged.type - schemas.GCBDRConfiguration.type - schemas.InternalResourceMetadata.properties.isDeletionProtectionEnabled.description - schemas.InternalResourceMetadata.properties.isDeletionProtectionEnabled.type - schemas.PscConnection.properties.port.description - schemas.PscConnection.properties.port.format - schemas.PscConnection.properties.port.readOnly - schemas.PscConnection.properties.port.type - schemas.UpdateInfo.properties.targetNodeType.description - schemas.UpdateInfo.properties.targetNodeType.enum - schemas.UpdateInfo.properties.targetNodeType.enumDescriptions - schemas.UpdateInfo.properties.targetNodeType.type The following keys were changed: - resources.projects.resources.locations.resources.clusters.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.requestId.description - schemas.Cluster.properties.clusterEndpoints.description - schemas.ClusterEndpoint.properties.connections.description - schemas.ClusterMaintenanceSchedule.description - schemas.DatabaseResourceHealthSignalData.properties.signalType.enum - schemas.DatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.DatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.DatabaseResourceMetadata.description - schemas.DatabaseResourceMetadata.properties.instanceType.enum - schemas.DatabaseResourceMetadata.properties.instanceType.enumDeprecated - schemas.DatabaseResourceMetadata.properties.instanceType.enumDescriptions - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.Entitlement.properties.type.enum - schemas.Entitlement.properties.type.enumDescriptions - schemas.GcsBackupSource.properties.uris.description - schemas.MachineConfiguration.properties.cpuCount.description - schemas.MachineConfiguration.properties.memorySizeInBytes.description - schemas.MachineConfiguration.properties.vcpuCount.description - schemas.ObservabilityMetricData.properties.metricType.enum - schemas.ObservabilityMetricData.properties.metricType.enumDescriptions #### redis:v1 The following keys were added: - schemas.Cluster.properties.ondemandMaintenance.description - schemas.Cluster.properties.ondemandMaintenance.type - schemas.DatabaseResourceMetadata.properties.gcbdrConfiguration.$ref - schemas.DatabaseResourceMetadata.properties.gcbdrConfiguration.description - schemas.DatabaseResourceMetadata.properties.suspensionReason.description - schemas.DatabaseResourceMetadata.properties.suspensionReason.enum - schemas.DatabaseResourceMetadata.properties.suspensionReason.enumDescriptions - schemas.DatabaseResourceMetadata.properties.suspensionReason.type - schemas.Entitlement.properties.type.enumDeprecated - schemas.GCBDRConfiguration.description - schemas.GCBDRConfiguration.id - schemas.GCBDRConfiguration.properties.gcbdrManaged.description - schemas.GCBDRConfiguration.properties.gcbdrManaged.type - schemas.GCBDRConfiguration.type - schemas.InternalResourceMetadata.properties.isDeletionProtectionEnabled.description - schemas.InternalResourceMetadata.properties.isDeletionProtectionEnabled.type - schemas.PscConnection.properties.port.description - schemas.PscConnection.properties.port.format - schemas.PscConnection.properties.port.readOnly - schemas.PscConnection.properties.port.type - schemas.UpdateInfo.properties.targetNodeType.description - schemas.UpdateInfo.properties.targetNodeType.enum - schemas.UpdateInfo.properties.targetNodeType.enumDescriptions - schemas.UpdateInfo.properties.targetNodeType.type The following keys were changed: - resources.projects.resources.locations.resources.clusters.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.requestId.description - schemas.Cluster.properties.clusterEndpoints.description - schemas.ClusterEndpoint.properties.connections.description - schemas.ClusterMaintenanceSchedule.description - schemas.DatabaseResourceHealthSignalData.properties.signalType.enum - schemas.DatabaseResourceHealthSignalData.properties.signalType.enumDeprecated - schemas.DatabaseResourceHealthSignalData.properties.signalType.enumDescriptions - schemas.DatabaseResourceMetadata.description - schemas.DatabaseResourceMetadata.properties.instanceType.enum - schemas.DatabaseResourceMetadata.properties.instanceType.enumDeprecated - schemas.DatabaseResourceMetadata.properties.instanceType.enumDescriptions - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enum - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enumDeprecated - schemas.DatabaseResourceRecommendationSignalData.properties.signalType.enumDescriptions - schemas.Entitlement.properties.type.enum - schemas.Entitlement.properties.type.enumDescriptions - schemas.GcsBackupSource.properties.uris.description - schemas.Instance.properties.redisVersion.description - schemas.MachineConfiguration.properties.cpuCount.description - schemas.MachineConfiguration.properties.memorySizeInBytes.description - schemas.MachineConfiguration.properties.vcpuCount.description - schemas.ObservabilityMetricData.properties.metricType.enum - schemas.ObservabilityMetricData.properties.metricType.enumDescriptions --- discovery/redis-v1.json | 186 ++++++++++++++++++++++++++++++----- discovery/redis-v1beta1.json | 184 +++++++++++++++++++++++++++++----- src/apis/redis/v1.ts | 57 ++++++++--- src/apis/redis/v1beta1.ts | 55 ++++++++--- 4 files changed, 412 insertions(+), 70 deletions(-) diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index b179e41606a..688a6ebe342 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-v1.json @@ -419,7 +419,7 @@ "type": "string" }, "requestId": { - "description": "Idempotent request UUID.", + "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } @@ -452,7 +452,7 @@ "type": "string" }, "requestId": { - "description": "Idempotent request UUID.", + "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } @@ -568,7 +568,7 @@ "type": "string" }, "requestId": { - "description": "Idempotent request UUID.", + "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" }, @@ -1067,7 +1067,7 @@ } } }, - "revision": "20250121", + "revision": "20250311", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1479,7 +1479,7 @@ "type": "string" }, "clusterEndpoints": { - "description": "Optional. A list of cluster enpoints.", + "description": "Optional. A list of cluster endpoints.", "items": { "$ref": "ClusterEndpoint" }, @@ -1555,6 +1555,10 @@ ], "type": "string" }, + "ondemandMaintenance": { + "description": "Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.", + "type": "boolean" + }, "persistenceConfig": { "$ref": "ClusterPersistenceConfig", "description": "Optional. Persistence config (RDB, AOF) for the cluster." @@ -1666,7 +1670,7 @@ "id": "ClusterEndpoint", "properties": { "connections": { - "description": "A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", + "description": "Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", "items": { "$ref": "ConnectionDetail" }, @@ -1702,7 +1706,7 @@ "type": "object" }, "ClusterMaintenanceSchedule": { - "description": "Upcoming maitenance schedule.", + "description": "Upcoming maintenance schedule.", "id": "ClusterMaintenanceSchedule", "properties": { "endTime": { @@ -2113,7 +2117,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -2196,6 +2209,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2279,7 +2301,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" }, @@ -2343,7 +2374,7 @@ "type": "object" }, "DatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 23", + "description": "Common model for database resource instance metadata. Next ID: 25", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -2428,6 +2459,10 @@ ], "type": "string" }, + "gcbdrConfiguration": { + "$ref": "GCBDRConfiguration", + "description": "GCBDR configuration for the resource." + }, "id": { "$ref": "DatabaseResourceId", "description": "Required. Unique identifier for a Database resource" @@ -2444,6 +2479,7 @@ "SUB_RESOURCE_TYPE_PRIMARY", "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", + "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -2456,10 +2492,11 @@ false, false, false, + false, false ], "enumDescriptions": [ - "", + "Unspecified.", "For rest of the other categories.", "A regular primary database instance.", "A cluster or an instance acting as a secondary.", @@ -2468,6 +2505,7 @@ "A regular primary database instance.", "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", + "An instance acting as an external primary.", "For rest of the other categories." ], "type": "string" @@ -2500,6 +2538,28 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "suspensionReason": { + "description": "Optional. Suspension reason for the resource.", + "enum": [ + "SUSPENSION_REASON_UNSPECIFIED", + "WIPEOUT_HIDE_EVENT", + "WIPEOUT_PURGE_EVENT", + "BILLING_DISABLED", + "ABUSER_DETECTED", + "ENCRYPTION_KEY_INACCESSIBLE", + "REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE" + ], + "enumDescriptions": [ + "Suspension reason is unspecified.", + "Wipeout hide event.", + "Wipeout purge event.", + "Billing disabled for project", + "Abuse detected for resource", + "Encryption key inaccessible.", + "Replicated cluster encryption key inaccessible." + ], + "type": "string" + }, "tagsSet": { "$ref": "Tags", "description": "Optional. Tags associated with this resources." @@ -2652,7 +2712,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -2735,6 +2804,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2818,7 +2896,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" } @@ -2939,11 +3026,21 @@ "description": "An enum that represents the type of this entitlement.", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", - "GEMINI" + "GEMINI", + "NATIVE", + "GCA_STANDARD" + ], + "enumDeprecated": [ + false, + true, + false, + false ], "enumDescriptions": [ - "", - "The root entitlement representing Gemini package ownership." + "The entitlement type is unspecified.", + "The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", + "The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", + "The entitlement representing GCA-Standard Tier." ], "type": "string" } @@ -3004,12 +3101,23 @@ }, "type": "object" }, + "GCBDRConfiguration": { + "description": "GCBDR Configuration for the resource.", + "id": "GCBDRConfiguration", + "properties": { + "gcbdrManaged": { + "description": "Whether the resource is managed by GCBDR.", + "type": "boolean" + } + }, + "type": "object" + }, "GcsBackupSource": { "description": "Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters.", "id": "GcsBackupSource", "properties": { "uris": { - "description": "Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", + "description": "Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", "items": { "type": "string" }, @@ -3270,7 +3378,7 @@ "type": "object" }, "redisVersion": { - "description": "Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility", + "description": "Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility", "type": "string" }, "replicaCount": { @@ -3405,6 +3513,10 @@ "$ref": "BackupRun", "description": "Information about the last backup attempt for this database" }, + "isDeletionProtectionEnabled": { + "description": "Whether deletion protection is enabled for this internal resource.", + "type": "boolean" + }, "product": { "$ref": "Product" }, @@ -3594,12 +3706,12 @@ "properties": { "cpuCount": { "deprecated": true, - "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, "memorySizeInBytes": { - "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64", "type": "string" }, @@ -3609,7 +3721,7 @@ "type": "integer" }, "vcpuCount": { - "description": "Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", "format": "double", "type": "number" } @@ -3768,7 +3880,8 @@ "STORAGE_UTILIZATION", "STORAGE_USED_BYTES", "NODE_COUNT", - "MEMORY_USED_BYTES" + "MEMORY_USED_BYTES", + "PROCESSING_UNIT_COUNT" ], "enumDescriptions": [ "Unspecified metric type.", @@ -3777,8 +3890,9 @@ "Number of network connections for a resource.", "Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Sotrage used by a resource.", - "Node count for a resource. It represents the number of nodes units in a bigtable/spanner instance.", - "Memory used by a resource (in bytes)." + "Node count for a resource. It represents the number of node units in a bigtable/spanner instance.", + "Memory used by a resource (in bytes).", + "Processing units used by a resource. It represents the number of processing units in a spanner instance." ], "type": "string" }, @@ -4199,6 +4313,12 @@ "description": "Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", "type": "string" }, + "port": { + "description": "Output only. The port number of the exposed discovery endpoint.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "projectId": { "description": "Optional. Project ID of the consumer project where the forwarding rule is created in.", "type": "string" @@ -4571,6 +4691,24 @@ "description": "Represents information about an updating cluster.", "id": "UpdateInfo", "properties": { + "targetNodeType": { + "description": "Target node type for redis cluster.", + "enum": [ + "NODE_TYPE_UNSPECIFIED", + "REDIS_SHARED_CORE_NANO", + "REDIS_HIGHMEM_MEDIUM", + "REDIS_HIGHMEM_XLARGE", + "REDIS_STANDARD_SMALL" + ], + "enumDescriptions": [ + "Node type unspecified", + "Redis shared core nano node_type.", + "Redis highmem medium node_type.", + "Redis highmem xlarge node_type.", + "Redis standard small node_type." + ], + "type": "string" + }, "targetReplicaCount": { "description": "Target number of replica nodes per shard.", "format": "int32", diff --git a/discovery/redis-v1beta1.json b/discovery/redis-v1beta1.json index 5dd0d6cb029..e1c656852f7 100644 --- a/discovery/redis-v1beta1.json +++ b/discovery/redis-v1beta1.json @@ -419,7 +419,7 @@ "type": "string" }, "requestId": { - "description": "Idempotent request UUID.", + "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } @@ -452,7 +452,7 @@ "type": "string" }, "requestId": { - "description": "Idempotent request UUID.", + "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } @@ -568,7 +568,7 @@ "type": "string" }, "requestId": { - "description": "Idempotent request UUID.", + "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" }, @@ -1067,7 +1067,7 @@ } } }, - "revision": "20250121", + "revision": "20250311", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1479,7 +1479,7 @@ "type": "string" }, "clusterEndpoints": { - "description": "Optional. A list of cluster enpoints.", + "description": "Optional. A list of cluster endpoints.", "items": { "$ref": "ClusterEndpoint" }, @@ -1555,6 +1555,10 @@ ], "type": "string" }, + "ondemandMaintenance": { + "description": "Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.", + "type": "boolean" + }, "persistenceConfig": { "$ref": "ClusterPersistenceConfig", "description": "Optional. Persistence config (RDB, AOF) for the cluster." @@ -1666,7 +1670,7 @@ "id": "ClusterEndpoint", "properties": { "connections": { - "description": "A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", + "description": "Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", "items": { "$ref": "ConnectionDetail" }, @@ -1702,7 +1706,7 @@ "type": "object" }, "ClusterMaintenanceSchedule": { - "description": "Upcoming maitenance schedule.", + "description": "Upcoming maintenance schedule.", "id": "ClusterMaintenanceSchedule", "properties": { "endTime": { @@ -2113,7 +2117,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -2196,6 +2209,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2279,7 +2301,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" }, @@ -2343,7 +2374,7 @@ "type": "object" }, "DatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 23", + "description": "Common model for database resource instance metadata. Next ID: 25", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -2428,6 +2459,10 @@ ], "type": "string" }, + "gcbdrConfiguration": { + "$ref": "GCBDRConfiguration", + "description": "GCBDR configuration for the resource." + }, "id": { "$ref": "DatabaseResourceId", "description": "Required. Unique identifier for a Database resource" @@ -2444,6 +2479,7 @@ "SUB_RESOURCE_TYPE_PRIMARY", "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", + "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -2456,10 +2492,11 @@ false, false, false, + false, false ], "enumDescriptions": [ - "", + "Unspecified.", "For rest of the other categories.", "A regular primary database instance.", "A cluster or an instance acting as a secondary.", @@ -2468,6 +2505,7 @@ "A regular primary database instance.", "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", + "An instance acting as an external primary.", "For rest of the other categories." ], "type": "string" @@ -2500,6 +2538,28 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "suspensionReason": { + "description": "Optional. Suspension reason for the resource.", + "enum": [ + "SUSPENSION_REASON_UNSPECIFIED", + "WIPEOUT_HIDE_EVENT", + "WIPEOUT_PURGE_EVENT", + "BILLING_DISABLED", + "ABUSER_DETECTED", + "ENCRYPTION_KEY_INACCESSIBLE", + "REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE" + ], + "enumDescriptions": [ + "Suspension reason is unspecified.", + "Wipeout hide event.", + "Wipeout purge event.", + "Billing disabled for project", + "Abuse detected for resource", + "Encryption key inaccessible.", + "Replicated cluster encryption key inaccessible." + ], + "type": "string" + }, "tagsSet": { "$ref": "Tags", "description": "Optional. Tags associated with this resources." @@ -2652,7 +2712,16 @@ "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", - "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY" + "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", + "SIGNAL_TYPE_HOT_NODE", + "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", + "SIGNAL_TYPE_RESOURCE_SUSPENDED", + "SIGNAL_TYPE_EXPENSIVE_COMMANDS", + "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", + "SIGNAL_TYPE_NO_DELETION_PROTECTION", + "SIGNAL_TYPE_INEFFICIENT_QUERY", + "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", + "SIGNAL_TYPE_MEMORY_LIMIT" ], "enumDeprecated": [ false, @@ -2735,6 +2804,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2818,7 +2896,16 @@ "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", - "Detects if a database instance has no user password policy set." + "Detects if a database instance has no user password policy set.", + "Detects if a database instance/cluster has a hot node.", + "Detects if a database instance has no point in time recovery enabled.", + "Detects if a database instance/cluster is suspended.", + "Detects that expensive commands are being run on a database instance impacting overall performance.", + "Indicates that the instance does not have a maintenance policy configured.", + "Deletion Protection Disabled for the resource", + "Indicates that the instance has inefficient queries detected.", + "Indicates that the instance has read intensive workload.", + "Indicates that the instance is nearing memory limit." ], "type": "string" } @@ -2939,11 +3026,21 @@ "description": "An enum that represents the type of this entitlement.", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", - "GEMINI" + "GEMINI", + "NATIVE", + "GCA_STANDARD" + ], + "enumDeprecated": [ + false, + true, + false, + false ], "enumDescriptions": [ - "", - "The root entitlement representing Gemini package ownership." + "The entitlement type is unspecified.", + "The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", + "The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", + "The entitlement representing GCA-Standard Tier." ], "type": "string" } @@ -3004,12 +3101,23 @@ }, "type": "object" }, + "GCBDRConfiguration": { + "description": "GCBDR Configuration for the resource.", + "id": "GCBDRConfiguration", + "properties": { + "gcbdrManaged": { + "description": "Whether the resource is managed by GCBDR.", + "type": "boolean" + } + }, + "type": "object" + }, "GcsBackupSource": { "description": "Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters.", "id": "GcsBackupSource", "properties": { "uris": { - "description": "Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", + "description": "Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", "items": { "type": "string" }, @@ -3412,6 +3520,10 @@ "$ref": "BackupRun", "description": "Information about the last backup attempt for this database" }, + "isDeletionProtectionEnabled": { + "description": "Whether deletion protection is enabled for this internal resource.", + "type": "boolean" + }, "product": { "$ref": "Product" }, @@ -3601,12 +3713,12 @@ "properties": { "cpuCount": { "deprecated": true, - "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, "memorySizeInBytes": { - "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64", "type": "string" }, @@ -3616,7 +3728,7 @@ "type": "integer" }, "vcpuCount": { - "description": "Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", + "description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", "format": "double", "type": "number" } @@ -3775,7 +3887,8 @@ "STORAGE_UTILIZATION", "STORAGE_USED_BYTES", "NODE_COUNT", - "MEMORY_USED_BYTES" + "MEMORY_USED_BYTES", + "PROCESSING_UNIT_COUNT" ], "enumDescriptions": [ "Unspecified metric type.", @@ -3784,8 +3897,9 @@ "Number of network connections for a resource.", "Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Sotrage used by a resource.", - "Node count for a resource. It represents the number of nodes units in a bigtable/spanner instance.", - "Memory used by a resource (in bytes)." + "Node count for a resource. It represents the number of node units in a bigtable/spanner instance.", + "Memory used by a resource (in bytes).", + "Processing units used by a resource. It represents the number of processing units in a spanner instance." ], "type": "string" }, @@ -4206,6 +4320,12 @@ "description": "Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", "type": "string" }, + "port": { + "description": "Output only. The port number of the exposed discovery endpoint.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "projectId": { "description": "Optional. Project ID of the consumer project where the forwarding rule is created in.", "type": "string" @@ -4578,6 +4698,24 @@ "description": "Represents information about an updating cluster.", "id": "UpdateInfo", "properties": { + "targetNodeType": { + "description": "Target node type for redis cluster.", + "enum": [ + "NODE_TYPE_UNSPECIFIED", + "REDIS_SHARED_CORE_NANO", + "REDIS_HIGHMEM_MEDIUM", + "REDIS_HIGHMEM_XLARGE", + "REDIS_STANDARD_SMALL" + ], + "enumDescriptions": [ + "Node type unspecified", + "Redis shared core nano node_type.", + "Redis highmem medium node_type.", + "Redis highmem xlarge node_type.", + "Redis standard small node_type." + ], + "type": "string" + }, "targetReplicaCount": { "description": "Target number of replica nodes per shard.", "format": "int32", diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index 4aa237a8712..0690d02c70f 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -368,7 +368,7 @@ export namespace redis_v1 { */ backupCollection?: string | null; /** - * Optional. A list of cluster enpoints. + * Optional. A list of cluster endpoints. */ clusterEndpoints?: Schema$ClusterEndpoint[]; /** @@ -419,6 +419,10 @@ export namespace redis_v1 { * Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. */ nodeType?: string | null; + /** + * Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster. + */ + ondemandMaintenance?: boolean | null; /** * Optional. Persistence config (RDB, AOF) for the cluster. */ @@ -481,7 +485,7 @@ export namespace redis_v1 { */ export interface Schema$ClusterEndpoint { /** - * A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + * Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. */ connections?: Schema$ConnectionDetail[]; } @@ -503,7 +507,7 @@ export namespace redis_v1 { weeklyMaintenanceWindow?: Schema$ClusterWeeklyMaintenanceWindow[]; } /** - * Upcoming maitenance schedule. + * Upcoming maintenance schedule. */ export interface Schema$ClusterMaintenanceSchedule { /** @@ -706,7 +710,7 @@ export namespace redis_v1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 23 + * Common model for database resource instance metadata. Next ID: 25 */ export interface Schema$DatabaseResourceMetadata { /** @@ -745,6 +749,10 @@ export namespace redis_v1 { * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. */ expectedState?: string | null; + /** + * GCBDR configuration for the resource. + */ + gcbdrConfiguration?: Schema$GCBDRConfiguration; /** * Required. Unique identifier for a Database resource */ @@ -781,6 +789,10 @@ export namespace redis_v1 { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Suspension reason for the resource. + */ + suspensionReason?: string | null; /** * Optional. Tags associated with this resources. */ @@ -922,12 +934,21 @@ export namespace redis_v1 { */ startTime?: Schema$TimeOfDay; } + /** + * GCBDR Configuration for the resource. + */ + export interface Schema$GCBDRConfiguration { + /** + * Whether the resource is managed by GCBDR. + */ + gcbdrManaged?: boolean | null; + } /** * Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. */ export interface Schema$GcsBackupSource { /** - * Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + * Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 */ uris?: string[] | null; } @@ -1120,7 +1141,7 @@ export namespace redis_v1 { */ redisConfigs?: {[key: string]: string} | null; /** - * Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility + * Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility */ redisVersion?: string | null; /** @@ -1189,6 +1210,10 @@ export namespace redis_v1 { * Information about the last backup attempt for this database */ backupRun?: Schema$BackupRun; + /** + * Whether deletion protection is enabled for this internal resource. + */ + isDeletionProtectionEnabled?: boolean | null; product?: Schema$Product; resourceId?: Schema$DatabaseResourceId; /** @@ -1320,11 +1345,11 @@ export namespace redis_v1 { */ export interface Schema$MachineConfiguration { /** - * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix. */ cpuCount?: number | null; /** - * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; /** @@ -1332,7 +1357,7 @@ export namespace redis_v1 { */ shardCount?: number | null; /** - * Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix. */ vcpuCount?: number | null; } @@ -1623,6 +1648,10 @@ export namespace redis_v1 { * Required. The consumer network where the IP address resides, in the form of projects/{project_id\}/global/networks/{network_id\}. */ network?: string | null; + /** + * Output only. The port number of the exposed discovery endpoint. + */ + port?: number | null; /** * Optional. Project ID of the consumer project where the forwarding rule is created in. */ @@ -1840,6 +1869,10 @@ export namespace redis_v1 { * Represents information about an updating cluster. */ export interface Schema$UpdateInfo { + /** + * Target node type for redis cluster. + */ + targetNodeType?: string | null; /** * Target number of replica nodes per shard. */ @@ -3482,7 +3515,7 @@ export namespace redis_v1 { */ parent?: string; /** - * Idempotent request UUID. + * Optional. Idempotent request UUID. */ requestId?: string; @@ -3498,7 +3531,7 @@ export namespace redis_v1 { */ name?: string; /** - * Idempotent request UUID. + * Optional. Idempotent request UUID. */ requestId?: string; } @@ -3538,7 +3571,7 @@ export namespace redis_v1 { */ name?: string; /** - * Idempotent request UUID. + * Optional. Idempotent request UUID. */ requestId?: string; /** diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 2eb024bf0a5..91b3e8af11e 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -368,7 +368,7 @@ export namespace redis_v1beta1 { */ backupCollection?: string | null; /** - * Optional. A list of cluster enpoints. + * Optional. A list of cluster endpoints. */ clusterEndpoints?: Schema$ClusterEndpoint[]; /** @@ -419,6 +419,10 @@ export namespace redis_v1beta1 { * Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. */ nodeType?: string | null; + /** + * Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster. + */ + ondemandMaintenance?: boolean | null; /** * Optional. Persistence config (RDB, AOF) for the cluster. */ @@ -481,7 +485,7 @@ export namespace redis_v1beta1 { */ export interface Schema$ClusterEndpoint { /** - * A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. + * Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. */ connections?: Schema$ConnectionDetail[]; } @@ -503,7 +507,7 @@ export namespace redis_v1beta1 { weeklyMaintenanceWindow?: Schema$ClusterWeeklyMaintenanceWindow[]; } /** - * Upcoming maitenance schedule. + * Upcoming maintenance schedule. */ export interface Schema$ClusterMaintenanceSchedule { /** @@ -706,7 +710,7 @@ export namespace redis_v1beta1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. Next ID: 23 + * Common model for database resource instance metadata. Next ID: 25 */ export interface Schema$DatabaseResourceMetadata { /** @@ -745,6 +749,10 @@ export namespace redis_v1beta1 { * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. */ expectedState?: string | null; + /** + * GCBDR configuration for the resource. + */ + gcbdrConfiguration?: Schema$GCBDRConfiguration; /** * Required. Unique identifier for a Database resource */ @@ -781,6 +789,10 @@ export namespace redis_v1beta1 { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Suspension reason for the resource. + */ + suspensionReason?: string | null; /** * Optional. Tags associated with this resources. */ @@ -922,12 +934,21 @@ export namespace redis_v1beta1 { */ startTime?: Schema$TimeOfDay; } + /** + * GCBDR Configuration for the resource. + */ + export interface Schema$GCBDRConfiguration { + /** + * Whether the resource is managed by GCBDR. + */ + gcbdrManaged?: boolean | null; + } /** * Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. */ export interface Schema$GcsBackupSource { /** - * Optional. URIs of the GCS objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 + * Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 */ uris?: string[] | null; } @@ -1189,6 +1210,10 @@ export namespace redis_v1beta1 { * Information about the last backup attempt for this database */ backupRun?: Schema$BackupRun; + /** + * Whether deletion protection is enabled for this internal resource. + */ + isDeletionProtectionEnabled?: boolean | null; product?: Schema$Product; resourceId?: Schema$DatabaseResourceId; /** @@ -1320,11 +1345,11 @@ export namespace redis_v1beta1 { */ export interface Schema$MachineConfiguration { /** - * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix. */ cpuCount?: number | null; /** - * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; /** @@ -1332,7 +1357,7 @@ export namespace redis_v1beta1 { */ shardCount?: number | null; /** - * Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix. + * Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix. */ vcpuCount?: number | null; } @@ -1623,6 +1648,10 @@ export namespace redis_v1beta1 { * Required. The consumer network where the IP address resides, in the form of projects/{project_id\}/global/networks/{network_id\}. */ network?: string | null; + /** + * Output only. The port number of the exposed discovery endpoint. + */ + port?: number | null; /** * Optional. Project ID of the consumer project where the forwarding rule is created in. */ @@ -1840,6 +1869,10 @@ export namespace redis_v1beta1 { * Represents information about an updating cluster. */ export interface Schema$UpdateInfo { + /** + * Target node type for redis cluster. + */ + targetNodeType?: string | null; /** * Target number of replica nodes per shard. */ @@ -3487,7 +3520,7 @@ export namespace redis_v1beta1 { */ parent?: string; /** - * Idempotent request UUID. + * Optional. Idempotent request UUID. */ requestId?: string; @@ -3503,7 +3536,7 @@ export namespace redis_v1beta1 { */ name?: string; /** - * Idempotent request UUID. + * Optional. Idempotent request UUID. */ requestId?: string; } @@ -3543,7 +3576,7 @@ export namespace redis_v1beta1 { */ name?: string; /** - * Idempotent request UUID. + * Optional. Idempotent request UUID. */ requestId?: string; /** From 5b8cc2564b41cb7dc29892b7198f557b7c00f91f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 108/144] feat(retail): update the API #### retail:v2alpha The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.description - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.flatPath - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.httpMethod - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.id - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameterOrder - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.description - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.location - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.pattern - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.required - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.type - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.path - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.request.$ref - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.response.$ref - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.scopes - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.description - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.flatPath - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.httpMethod - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.id - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameterOrder - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.description - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.location - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.pattern - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.required - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.type - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.path - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.request.$ref - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.response.$ref - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.scopes - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.branch.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.branch.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.conversationId.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.conversationId.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.conversationalFilteringSpec.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.conversationalFilteringSpec.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.pageCategories.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.pageCategories.items.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.pageCategories.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.query.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.query.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.searchParams.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.searchParams.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.userInfo.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.userInfo.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.visitorId.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.visitorId.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.conversationalFilteringMode.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.conversationalFilteringMode.enum - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.conversationalFilteringMode.enumDescriptions - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.conversationalFilteringMode.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.enableConversationalFiltering.deprecated - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.enableConversationalFiltering.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.enableConversationalFiltering.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.userAnswer.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.userAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.boostSpec.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.boostSpec.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.canonicalFilter.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.canonicalFilter.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.filter.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.filter.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.sortBy.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.sortBy.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.properties.selectedAnswer.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.properties.selectedAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.properties.textAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.properties.textAnswer.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.properties.productAttributeValue.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.properties.productAttributeValue.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.conversationId.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.conversationId.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.conversationalFilteringResult.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.conversationalFilteringResult.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.refinedSearch.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.refinedSearch.items.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.refinedSearch.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.rephrasedQuery.deprecated - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.rephrasedQuery.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.rephrasedQuery.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.properties.additionalFilter.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.properties.additionalFilter.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.properties.followupQuestion.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.properties.followupQuestion.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.properties.productAttributeValue.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.properties.productAttributeValue.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.followupQuestion.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.followupQuestion.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.suggestedAnswers.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.suggestedAnswers.items.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.suggestedAnswers.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.properties.productAttributeValue.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.properties.productAttributeValue.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.properties.query.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.properties.query.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.type - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.languageCode.description - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.languageCode.type - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.placeId.description - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.placeId.type - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.regionCode.description - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.regionCode.type The following keys were changed: - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.entity.description - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.visitorId.description - schemas.GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec.properties.appliedTiles.description - schemas.GoogleCloudRetailV2alphaUserEvent.properties.eventType.description #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2betaSearchRequest.properties.languageCode.description - schemas.GoogleCloudRetailV2betaSearchRequest.properties.languageCode.type - schemas.GoogleCloudRetailV2betaSearchRequest.properties.placeId.description - schemas.GoogleCloudRetailV2betaSearchRequest.properties.placeId.type - schemas.GoogleCloudRetailV2betaSearchRequest.properties.regionCode.description - schemas.GoogleCloudRetailV2betaSearchRequest.properties.regionCode.type The following keys were changed: - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.entity.description - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.visitorId.description - schemas.GoogleCloudRetailV2betaSearchRequestTileNavigationSpec.properties.appliedTiles.description - schemas.GoogleCloudRetailV2betaUserEvent.properties.eventType.description #### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2SearchRequest.properties.languageCode.description - schemas.GoogleCloudRetailV2SearchRequest.properties.languageCode.type - schemas.GoogleCloudRetailV2SearchRequest.properties.placeId.description - schemas.GoogleCloudRetailV2SearchRequest.properties.placeId.type - schemas.GoogleCloudRetailV2SearchRequest.properties.regionCode.description - schemas.GoogleCloudRetailV2SearchRequest.properties.regionCode.type The following keys were changed: - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.entity.description - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.visitorId.description - schemas.GoogleCloudRetailV2SearchRequestTileNavigationSpec.properties.appliedTiles.description - schemas.GoogleCloudRetailV2UserEvent.properties.eventType.description --- discovery/retail-v2.json | 22 +- discovery/retail-v2alpha.json | 290 +++++++++++++++++++++++- discovery/retail-v2beta.json | 22 +- src/apis/retail/v2.ts | 20 +- src/apis/retail/v2alpha.ts | 409 +++++++++++++++++++++++++++++++++- src/apis/retail/v2beta.ts | 20 +- 6 files changed, 756 insertions(+), 27 deletions(-) diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index 2d85512112f..ac8c3edcb1d 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -143,7 +143,7 @@ "type": "boolean" }, "entity": { - "description": "The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results.", + "description": "The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.", "location": "query", "type": "string" }, @@ -165,7 +165,7 @@ "type": "string" }, "visitorId": { - "description": "Required field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Recommended field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "query", "type": "string" } @@ -2223,7 +2223,7 @@ } } }, - "revision": "20250116", + "revision": "20250314", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5181,6 +5181,10 @@ "description": "The 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. For more information, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) in the Resource Manager documentation.", "type": "object" }, + "languageCode": { + "description": "Optional. The BCP-47 language code, such as \"en-US\" or \"sr-Latn\" [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more information, see [Standardized codes](https://google.aip.dev/143). 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 Products 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", @@ -5210,6 +5214,10 @@ "$ref": "GoogleCloudRetailV2SearchRequestPersonalizationSpec", "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec." }, + "placeId": { + "description": "Optional. An id corresponding to a place, such as a store id or region id. When specified, we use the price from the local inventory with the matching product's LocalInventory.place_id for revenue optimization.", + "type": "string" + }, "query": { "description": "Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.", "type": "string" @@ -5218,6 +5226,10 @@ "$ref": "GoogleCloudRetailV2SearchRequestQueryExpansionSpec", "description": "The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see [Query expansion](https://cloud.google.com/retail/docs/result-size#query_expansion)." }, + "regionCode": { + "description": "Optional. The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\" [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html). For more information, see [Standardized codes](https://google.aip.dev/143). If set, then results will be boosted based on the region_code provided.", + "type": "string" + }, "searchMode": { "description": "The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.", "enum": [ @@ -5520,7 +5532,7 @@ "id": "GoogleCloudRetailV2SearchRequestTileNavigationSpec", "properties": { "appliedTiles": { - "description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", + "description": "This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", "items": { "$ref": "GoogleCloudRetailV2Tile" }, @@ -6080,7 +6092,7 @@ "type": "string" }, "eventType": { - "description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.", + "description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.", "type": "string" }, "experimentIds": { diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index d37f3c0f3fa..51084518d98 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -341,7 +341,7 @@ "type": "boolean" }, "entity": { - "description": "The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results.", + "description": "The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.", "location": "query", "type": "string" }, @@ -363,7 +363,7 @@ "type": "string" }, "visitorId": { - "description": "Required field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Recommended field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "query", "type": "string" } @@ -2061,6 +2061,34 @@ }, "placements": { "methods": { + "conversationalSearch": { + "description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:conversationalSearch", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.placements.conversationalSearch", + "parameterOrder": [ + "placement" + ], + "parameters": { + "placement": { + "description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/placements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+placement}:conversationalSearch", + "request": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "predict": { "description": "Makes a recommendation prediction.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:predict", @@ -2149,6 +2177,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "conversationalSearch": { + "description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:conversationalSearch", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.servingConfigs.conversationalSearch", + "parameterOrder": [ + "placement" + ], + "parameters": { + "placement": { + "description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+placement}:conversationalSearch", + "request": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs", @@ -2744,7 +2800,7 @@ } } }, - "revision": "20250116", + "revision": "20250314", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4501,6 +4557,218 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaConversationalSearchRequest": { + "description": "Request message for ConversationalSearchService.ConversationalSearch method.", + "id": "GoogleCloudRetailV2alphaConversationalSearchRequest", + "properties": { + "branch": { + "description": "Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use \"default_branch\" as the branch ID or leave this field empty, to search products under the default branch.", + "type": "string" + }, + "conversationId": { + "description": "Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.", + "type": "string" + }, + "conversationalFilteringSpec": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec", + "description": "Optional. This field specifies all conversational filtering related parameters." + }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; 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: \"pageCategories\" : [\"Sales > 2017 Black Friday Deals\"].", + "items": { + "type": "string" + }, + "type": "array" + }, + "query": { + "description": "Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.", + "type": "string" + }, + "searchParams": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams", + "description": "Optional. Search parameters." + }, + "userInfo": { + "$ref": "GoogleCloudRetailV2alphaUserInfo", + "description": "Optional. User information." + }, + "visitorId": { + "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 logs in or out of the website. This should be the same identifier as UserEvent.visitor_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" + }, + "GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec": { + "description": "This field specifies all conversational filtering related parameters addition to conversational retail search.", + "id": "GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec", + "properties": { + "conversationalFilteringMode": { + "description": "Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.", + "enum": [ + "MODE_UNSPECIFIED", + "CONVERSATIONAL_FILTER_ONLY" + ], + "enumDescriptions": [ + "Default value.", + "Enabled Conversational Filtering without default Conversational Search." + ], + "type": "string" + }, + "enableConversationalFiltering": { + "deprecated": true, + "description": "Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.", + "type": "boolean" + }, + "userAnswer": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer", + "description": "Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams": { + "description": "Search parameters.", + "id": "GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams", + "properties": { + "boostSpec": { + "$ref": "GoogleCloudRetailV2alphaSearchRequestBoostSpec", + "description": "Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec." + }, + "canonicalFilter": { + "description": "Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.", + "type": "string" + }, + "filter": { + "description": "Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.", + "type": "string" + }, + "sortBy": { + "description": "Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer": { + "description": "This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text.", + "id": "GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer", + "properties": { + "selectedAnswer": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer", + "description": "Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers." + }, + "textAnswer": { + "description": "This field specifies the incremental input text from the user during the conversational search.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer": { + "description": "This field specifies the selected answers during the conversational search.", + "id": "GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeValue", + "description": "Optional. This field specifies the selected answer which is a attribute key-value." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchResponse": { + "description": "Response message for ConversationalSearchService.ConversationalSearch method.", + "id": "GoogleCloudRetailV2alphaConversationalSearchResponse", + "properties": { + "conversationId": { + "description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.", + "type": "string" + }, + "conversationalFilteringResult": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult", + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search." + }, + "refinedSearch": { + "description": "The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.", + "items": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch" + }, + "type": "array" + }, + "rephrasedQuery": { + "deprecated": true, + "description": "This field is deprecated. Please find the refinded_query from search response when using CONVERSATIONAL_FILTER_ONLY mode in ConversationalSearchResponse.refined_search instead. The rephrased query based on the user's query and the conversation history. It can be used to fetch the relevant search results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult": { + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.", + "id": "GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult", + "properties": { + "additionalFilter": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter", + "description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests." + }, + "followupQuestion": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion", + "description": "The conversational filtering question." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter": { + "description": "Additional filter that client side need to apply.", + "id": "GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion": { + "description": "The conversational followup question generated for Intent refinement.", + "id": "GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion", + "properties": { + "followupQuestion": { + "description": "The conversational followup question generated for Intent refinement.", + "type": "string" + }, + "suggestedAnswers": { + "description": "The answer options provided to client for the follow-up question.", + "items": { + "$ref": "GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer": { + "description": "Suggested answers to the follow-up question.", + "id": "GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch": { + "description": "The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.", + "id": "GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch", + "properties": { + "query": { + "description": "The query to be used for search.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata": { "description": "Common metadata related to the progress of the operations.", "id": "GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata", @@ -7034,6 +7302,10 @@ "description": "The 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. For more information, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) in the Resource Manager documentation.", "type": "object" }, + "languageCode": { + "description": "Optional. The BCP-47 language code, such as \"en-US\" or \"sr-Latn\" [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more information, see [Standardized codes](https://google.aip.dev/143). 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 Products 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", @@ -7063,6 +7335,10 @@ "$ref": "GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec", "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec." }, + "placeId": { + "description": "Optional. An id corresponding to a place, such as a store id or region id. When specified, we use the price from the local inventory with the matching product's LocalInventory.place_id for revenue optimization.", + "type": "string" + }, "query": { "description": "Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.", "type": "string" @@ -7071,6 +7347,10 @@ "$ref": "GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec", "description": "The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see [Query expansion](https://cloud.google.com/retail/docs/result-size#query_expansion)." }, + "regionCode": { + "description": "Optional. The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\" [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html). For more information, see [Standardized codes](https://google.aip.dev/143). If set, then results will be boosted based on the region_code provided.", + "type": "string" + }, "relevanceThreshold": { "description": "The relevance threshold of the search results. Defaults to RelevanceThreshold.HIGH, which means only the most relevant results are shown, and the least number of results are returned. For more information, see [Adjust result size](https://cloud.google.com/retail/docs/result-size#relevance_thresholding).", "enum": [ @@ -7391,7 +7671,7 @@ "id": "GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec", "properties": { "appliedTiles": { - "description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", + "description": "This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", "items": { "$ref": "GoogleCloudRetailV2alphaTile" }, @@ -7968,7 +8248,7 @@ "type": "string" }, "eventType": { - "description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.", + "description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.", "type": "string" }, "experimentIds": { diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 11218f6de35..021e78249d1 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -204,7 +204,7 @@ "type": "boolean" }, "entity": { - "description": "The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results.", + "description": "The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.", "location": "query", "type": "string" }, @@ -226,7 +226,7 @@ "type": "string" }, "visitorId": { - "description": "Required field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Recommended field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "query", "type": "string" } @@ -2368,7 +2368,7 @@ } } }, - "revision": "20250116", + "revision": "20250314", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6982,6 +6982,10 @@ "description": "The 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. For more information, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) in the Resource Manager documentation.", "type": "object" }, + "languageCode": { + "description": "Optional. The BCP-47 language code, such as \"en-US\" or \"sr-Latn\" [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more information, see [Standardized codes](https://google.aip.dev/143). 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 Products 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", @@ -7011,6 +7015,10 @@ "$ref": "GoogleCloudRetailV2betaSearchRequestPersonalizationSpec", "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec." }, + "placeId": { + "description": "Optional. An id corresponding to a place, such as a store id or region id. When specified, we use the price from the local inventory with the matching product's LocalInventory.place_id for revenue optimization.", + "type": "string" + }, "query": { "description": "Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.", "type": "string" @@ -7019,6 +7027,10 @@ "$ref": "GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec", "description": "The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see [Query expansion](https://cloud.google.com/retail/docs/result-size#query_expansion)." }, + "regionCode": { + "description": "Optional. The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\" [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html). For more information, see [Standardized codes](https://google.aip.dev/143). If set, then results will be boosted based on the region_code provided.", + "type": "string" + }, "searchMode": { "description": "The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.", "enum": [ @@ -7321,7 +7333,7 @@ "id": "GoogleCloudRetailV2betaSearchRequestTileNavigationSpec", "properties": { "appliedTiles": { - "description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", + "description": "This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", "items": { "$ref": "GoogleCloudRetailV2betaTile" }, @@ -7881,7 +7893,7 @@ "type": "string" }, "eventType": { - "description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.", + "description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.", "type": "string" }, "experimentIds": { diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index 25d96b25fa6..e378b1b7ba9 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -3218,6 +3218,10 @@ export namespace retail_v2 { * The 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. For more information, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) in the Resource Manager documentation. */ labels?: {[key: string]: string} | null; + /** + * Optional. The BCP-47 language code, such as "en-US" or "sr-Latn" [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more information, see [Standardized codes](https://google.aip.dev/143). 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; /** * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products 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. */ @@ -3242,6 +3246,10 @@ export namespace retail_v2 { * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec. */ personalizationSpec?: Schema$GoogleCloudRetailV2SearchRequestPersonalizationSpec; + /** + * Optional. An id corresponding to a place, such as a store id or region id. When specified, we use the price from the local inventory with the matching product's LocalInventory.place_id for revenue optimization. + */ + placeId?: string | null; /** * Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories. */ @@ -3250,6 +3258,10 @@ export namespace retail_v2 { * The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see [Query expansion](https://cloud.google.com/retail/docs/result-size#query_expansion). */ queryExpansionSpec?: Schema$GoogleCloudRetailV2SearchRequestQueryExpansionSpec; + /** + * Optional. The Unicode country/region code (CLDR) of a location, such as "US" and "419" [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html). For more information, see [Standardized codes](https://google.aip.dev/143). If set, then results will be boosted based on the region_code provided. + */ + regionCode?: string | null; /** * The search mode of the search request. If not specified, a single search request triggers both product search and faceted search. */ @@ -3451,7 +3463,7 @@ export namespace retail_v2 { */ export interface Schema$GoogleCloudRetailV2SearchRequestTileNavigationSpec { /** - * This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + * This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. */ appliedTiles?: Schema$GoogleCloudRetailV2Tile[]; /** @@ -3869,7 +3881,7 @@ export namespace retail_v2 { */ eventTime?: string | null; /** - * Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. + * Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. */ eventType?: string | null; /** @@ -5408,7 +5420,7 @@ export namespace retail_v2 { */ enableAttributeSuggestions?: boolean; /** - * The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. + * The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters. */ entity?: string; /** @@ -5424,7 +5436,7 @@ export namespace retail_v2 { */ query?: string; /** - * Required field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Recommended field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ visitorId?: string; } diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index de799020f82..203fb30503a 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -957,6 +957,177 @@ export namespace retail_v2alpha { */ solutionTypes?: string[] | null; } + /** + * Request message for ConversationalSearchService.ConversationalSearch method. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchRequest { + /** + * Required. The branch resource name, such as `projects/x/locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch. + */ + branch?: string | null; + /** + * Optional. This field specifies all conversational filtering related parameters. + */ + conversationalFilteringSpec?: Schema$GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec; + /** + * Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty. + */ + conversationId?: string | null; + /** + * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; 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: "pageCategories" : ["Sales \> 2017 Black Friday Deals"]. + */ + pageCategories?: string[] | null; + /** + * Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request. + */ + query?: string | null; + /** + * Optional. Search parameters. + */ + searchParams?: Schema$GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams; + /** + * Optional. User information. + */ + userInfo?: Schema$GoogleCloudRetailV2alphaUserInfo; + /** + * 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 logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + visitorId?: string | null; + } + /** + * This field specifies all conversational filtering related parameters addition to conversational retail search. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec { + /** + * Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset. + */ + conversationalFilteringMode?: string | null; + /** + * Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead. + */ + enableConversationalFiltering?: boolean | null; + /** + * Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text. + */ + userAnswer?: Schema$GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer; + } + /** + * Search parameters. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams { + /** + * Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec. + */ + boostSpec?: Schema$GoogleCloudRetailV2alphaSearchRequestBoostSpec; + /** + * Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter. + */ + canonicalFilter?: string | null; + /** + * Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter. + */ + filter?: string | null; + /** + * Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort. + */ + sortBy?: string | null; + } + /** + * This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer { + /** + * Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers. + */ + selectedAnswer?: Schema$GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer; + /** + * This field specifies the incremental input text from the user during the conversational search. + */ + textAnswer?: string | null; + } + /** + * This field specifies the selected answers during the conversational search. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer { + /** + * Optional. This field specifies the selected answer which is a attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2alphaProductAttributeValue; + } + /** + * Response message for ConversationalSearchService.ConversationalSearch method. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchResponse { + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. + */ + conversationalFilteringResult?: Schema$GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult; + /** + * Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server. + */ + conversationId?: string | null; + /** + * The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here. + */ + refinedSearch?: Schema$GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch[]; + /** + * This field is deprecated. Please find the refinded_query from search response when using CONVERSATIONAL_FILTER_ONLY mode in ConversationalSearchResponse.refined_search instead. The rephrased query based on the user's query and the conversation history. It can be used to fetch the relevant search results. + */ + rephrasedQuery?: string | null; + } + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult { + /** + * This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests. + */ + additionalFilter?: Schema$GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter; + /** + * The conversational filtering question. + */ + followupQuestion?: Schema$GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion; + } + /** + * Additional filter that client side need to apply. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2alphaProductAttributeValue; + } + /** + * The conversational followup question generated for Intent refinement. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion { + /** + * The conversational followup question generated for Intent refinement. + */ + followupQuestion?: string | null; + /** + * The answer options provided to client for the follow-up question. + */ + suggestedAnswers?: Schema$GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer[]; + } + /** + * Suggested answers to the follow-up question. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2alphaProductAttributeValue; + } + /** + * The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here. + */ + export interface Schema$GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch { + /** + * The query to be used for search. + */ + query?: string | null; + } /** * Common metadata related to the progress of the operations. */ @@ -2764,6 +2935,10 @@ export namespace retail_v2alpha { * The 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. For more information, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) in the Resource Manager documentation. */ labels?: {[key: string]: string} | null; + /** + * Optional. The BCP-47 language code, such as "en-US" or "sr-Latn" [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more information, see [Standardized codes](https://google.aip.dev/143). 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; /** * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products 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. */ @@ -2788,6 +2963,10 @@ export namespace retail_v2alpha { * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec. */ personalizationSpec?: Schema$GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec; + /** + * Optional. An id corresponding to a place, such as a store id or region id. When specified, we use the price from the local inventory with the matching product's LocalInventory.place_id for revenue optimization. + */ + placeId?: string | null; /** * Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories. */ @@ -2796,6 +2975,10 @@ export namespace retail_v2alpha { * The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see [Query expansion](https://cloud.google.com/retail/docs/result-size#query_expansion). */ queryExpansionSpec?: Schema$GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec; + /** + * Optional. The Unicode country/region code (CLDR) of a location, such as "US" and "419" [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html). For more information, see [Standardized codes](https://google.aip.dev/143). If set, then results will be boosted based on the region_code provided. + */ + regionCode?: string | null; /** * The relevance threshold of the search results. Defaults to RelevanceThreshold.HIGH, which means only the most relevant results are shown, and the least number of results are returned. For more information, see [Adjust result size](https://cloud.google.com/retail/docs/result-size#relevance_thresholding). */ @@ -3001,7 +3184,7 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec { /** - * This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + * This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. */ appliedTiles?: Schema$GoogleCloudRetailV2alphaTile[]; /** @@ -3432,7 +3615,7 @@ export namespace retail_v2alpha { */ eventTime?: string | null; /** - * Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. + * Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. */ eventType?: string | null; /** @@ -6486,7 +6669,7 @@ export namespace retail_v2alpha { */ enableAttributeSuggestions?: boolean; /** - * The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. + * The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters. */ entity?: string; /** @@ -6502,7 +6685,7 @@ export namespace retail_v2alpha { */ query?: string; /** - * Required field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Recommended field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ visitorId?: string; } @@ -11293,6 +11476,103 @@ export namespace retail_v2alpha { this.context = context; } + /** + * Performs a conversational search. This feature is only available for users who have Conversational Search enabled. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: StreamMethodOptions + ): GaxiosPromise; + conversationalSearch( + params?: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options?: MethodOptions + ): GaxiosPromise; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch, + callback: BodyResponseCallback + ): void; + conversationalSearch( + callback: BodyResponseCallback + ): void; + conversationalSearch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2alpha/{+placement}:conversationalSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['placement'], + pathParams: ['placement'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Makes a recommendation prediction. * @@ -11490,6 +11770,18 @@ export namespace retail_v2alpha { } } + export interface Params$Resource$Projects$Locations$Catalogs$Placements$Conversationalsearch + extends StandardParameters { + /** + * Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + */ + placement?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaConversationalSearchRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Placements$Predict extends StandardParameters { /** @@ -11619,6 +11911,103 @@ export namespace retail_v2alpha { } } + /** + * Performs a conversational search. This feature is only available for users who have Conversational Search enabled. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: StreamMethodOptions + ): GaxiosPromise; + conversationalSearch( + params?: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options?: MethodOptions + ): GaxiosPromise; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + conversationalSearch( + params: Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch, + callback: BodyResponseCallback + ): void; + conversationalSearch( + callback: BodyResponseCallback + ): void; + conversationalSearch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2alpha/{+placement}:conversationalSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['placement'], + pathParams: ['placement'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. * @@ -12401,6 +12790,18 @@ export namespace retail_v2alpha { */ requestBody?: Schema$GoogleCloudRetailV2alphaAddControlRequest; } + export interface Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Conversationalsearch + extends StandardParameters { + /** + * Required. The resource name of the search engine placement, such as `projects/x/locations/global/catalogs/default_catalog/placements/default_search` or `projects/x/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. + */ + placement?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaConversationalSearchRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Servingconfigs$Create extends StandardParameters { /** diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index cbb8032f64a..05d20a2c56f 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -3010,6 +3010,10 @@ export namespace retail_v2beta { * The 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. For more information, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) in the Resource Manager documentation. */ labels?: {[key: string]: string} | null; + /** + * Optional. The BCP-47 language code, such as "en-US" or "sr-Latn" [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more information, see [Standardized codes](https://google.aip.dev/143). 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; /** * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products 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. */ @@ -3034,6 +3038,10 @@ export namespace retail_v2beta { * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec. */ personalizationSpec?: Schema$GoogleCloudRetailV2betaSearchRequestPersonalizationSpec; + /** + * Optional. An id corresponding to a place, such as a store id or region id. When specified, we use the price from the local inventory with the matching product's LocalInventory.place_id for revenue optimization. + */ + placeId?: string | null; /** * Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories. */ @@ -3042,6 +3050,10 @@ export namespace retail_v2beta { * The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see [Query expansion](https://cloud.google.com/retail/docs/result-size#query_expansion). */ queryExpansionSpec?: Schema$GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec; + /** + * Optional. The Unicode country/region code (CLDR) of a location, such as "US" and "419" [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html). For more information, see [Standardized codes](https://google.aip.dev/143). If set, then results will be boosted based on the region_code provided. + */ + regionCode?: string | null; /** * The search mode of the search request. If not specified, a single search request triggers both product search and faceted search. */ @@ -3243,7 +3255,7 @@ export namespace retail_v2beta { */ export interface Schema$GoogleCloudRetailV2betaSearchRequestTileNavigationSpec { /** - * This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + * This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. */ appliedTiles?: Schema$GoogleCloudRetailV2betaTile[]; /** @@ -3661,7 +3673,7 @@ export namespace retail_v2beta { */ eventTime?: string | null; /** - * Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. + * Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. */ eventType?: string | null; /** @@ -5773,7 +5785,7 @@ export namespace retail_v2beta { */ enableAttributeSuggestions?: boolean; /** - * The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. + * The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters. */ entity?: string; /** @@ -5789,7 +5801,7 @@ export namespace retail_v2beta { */ query?: string; /** - * Required field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Recommended field. 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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ visitorId?: string; } From e1a747318e192c11cdf39fd11b5be745b96c7d99 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 109/144] feat(run): update the API #### run:v1 The following keys were added: - schemas.GoogleDevtoolsCloudbuildV1Build.properties.dependencies.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.dependencies.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.dependencies.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.type - schemas.GoogleDevtoolsCloudbuildV1Dependency.description - schemas.GoogleDevtoolsCloudbuildV1Dependency.id - schemas.GoogleDevtoolsCloudbuildV1Dependency.properties.empty.description - schemas.GoogleDevtoolsCloudbuildV1Dependency.properties.empty.type - schemas.GoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.$ref - schemas.GoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.description - schemas.GoogleDevtoolsCloudbuildV1Dependency.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.id - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.depth.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.depth.format - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.depth.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.destPath.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.destPath.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.recurseSubmodules.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.recurseSubmodules.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.repository.$ref - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.revision.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.revision.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.id - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.properties.developerConnect.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.properties.developerConnect.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.properties.url.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.properties.url.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.type - schemas.TaskSpec.properties.nodeSelector.additionalProperties.type - schemas.TaskSpec.properties.nodeSelector.description - schemas.TaskSpec.properties.nodeSelector.type The following keys were changed: - endpoints - schemas.ExecutionSpec.properties.parallelism.description #### run:v2 The following keys were added: - resources.projects.resources.locations.resources.workerPools.methods.create.description - resources.projects.resources.locations.resources.workerPools.methods.create.flatPath - resources.projects.resources.locations.resources.workerPools.methods.create.httpMethod - resources.projects.resources.locations.resources.workerPools.methods.create.id - resources.projects.resources.locations.resources.workerPools.methods.create.parameterOrder - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.validateOnly.description - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.validateOnly.location - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.validateOnly.type - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.workerPoolId.description - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.workerPoolId.location - resources.projects.resources.locations.resources.workerPools.methods.create.parameters.workerPoolId.type - resources.projects.resources.locations.resources.workerPools.methods.create.path - resources.projects.resources.locations.resources.workerPools.methods.create.request.$ref - resources.projects.resources.locations.resources.workerPools.methods.create.response.$ref - resources.projects.resources.locations.resources.workerPools.methods.create.scopes - resources.projects.resources.locations.resources.workerPools.methods.delete.description - resources.projects.resources.locations.resources.workerPools.methods.delete.flatPath - resources.projects.resources.locations.resources.workerPools.methods.delete.httpMethod - resources.projects.resources.locations.resources.workerPools.methods.delete.id - resources.projects.resources.locations.resources.workerPools.methods.delete.parameterOrder - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.validateOnly.description - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.validateOnly.location - resources.projects.resources.locations.resources.workerPools.methods.delete.parameters.validateOnly.type - resources.projects.resources.locations.resources.workerPools.methods.delete.path - resources.projects.resources.locations.resources.workerPools.methods.delete.response.$ref - resources.projects.resources.locations.resources.workerPools.methods.delete.scopes - resources.projects.resources.locations.resources.workerPools.methods.get.description - resources.projects.resources.locations.resources.workerPools.methods.get.flatPath - resources.projects.resources.locations.resources.workerPools.methods.get.httpMethod - resources.projects.resources.locations.resources.workerPools.methods.get.id - resources.projects.resources.locations.resources.workerPools.methods.get.parameterOrder - resources.projects.resources.locations.resources.workerPools.methods.get.parameters.name.description - resources.projects.resources.locations.resources.workerPools.methods.get.parameters.name.location - resources.projects.resources.locations.resources.workerPools.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.workerPools.methods.get.parameters.name.required - resources.projects.resources.locations.resources.workerPools.methods.get.parameters.name.type - resources.projects.resources.locations.resources.workerPools.methods.get.path - resources.projects.resources.locations.resources.workerPools.methods.get.response.$ref - resources.projects.resources.locations.resources.workerPools.methods.get.scopes - resources.projects.resources.locations.resources.workerPools.methods.list.description - resources.projects.resources.locations.resources.workerPools.methods.list.flatPath - resources.projects.resources.locations.resources.workerPools.methods.list.httpMethod - resources.projects.resources.locations.resources.workerPools.methods.list.id - resources.projects.resources.locations.resources.workerPools.methods.list.parameterOrder - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.showDeleted.description - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.showDeleted.location - resources.projects.resources.locations.resources.workerPools.methods.list.parameters.showDeleted.type - resources.projects.resources.locations.resources.workerPools.methods.list.path - resources.projects.resources.locations.resources.workerPools.methods.list.response.$ref - resources.projects.resources.locations.resources.workerPools.methods.list.scopes - resources.projects.resources.locations.resources.workerPools.methods.patch.description - resources.projects.resources.locations.resources.workerPools.methods.patch.flatPath - resources.projects.resources.locations.resources.workerPools.methods.patch.httpMethod - resources.projects.resources.locations.resources.workerPools.methods.patch.id - resources.projects.resources.locations.resources.workerPools.methods.patch.parameterOrder - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.allowMissing.description - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.allowMissing.location - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.allowMissing.type - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.forceNewRevision.description - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.forceNewRevision.location - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.forceNewRevision.type - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.validateOnly.description - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.validateOnly.location - resources.projects.resources.locations.resources.workerPools.methods.patch.parameters.validateOnly.type - resources.projects.resources.locations.resources.workerPools.methods.patch.path - resources.projects.resources.locations.resources.workerPools.methods.patch.request.$ref - resources.projects.resources.locations.resources.workerPools.methods.patch.response.$ref - resources.projects.resources.locations.resources.workerPools.methods.patch.scopes - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.description - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.id - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.path - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.request.$ref - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.workerPools.methods.testIamPermissions.scopes - schemas.GoogleCloudRunV2InstanceSplit.description - schemas.GoogleCloudRunV2InstanceSplit.id - schemas.GoogleCloudRunV2InstanceSplit.properties.percent.description - schemas.GoogleCloudRunV2InstanceSplit.properties.percent.format - schemas.GoogleCloudRunV2InstanceSplit.properties.percent.type - schemas.GoogleCloudRunV2InstanceSplit.properties.revision.description - schemas.GoogleCloudRunV2InstanceSplit.properties.revision.type - schemas.GoogleCloudRunV2InstanceSplit.properties.type.description - schemas.GoogleCloudRunV2InstanceSplit.properties.type.enum - schemas.GoogleCloudRunV2InstanceSplit.properties.type.enumDescriptions - schemas.GoogleCloudRunV2InstanceSplit.properties.type.type - schemas.GoogleCloudRunV2InstanceSplit.type - schemas.GoogleCloudRunV2InstanceSplitStatus.description - schemas.GoogleCloudRunV2InstanceSplitStatus.id - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.percent.description - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.percent.format - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.percent.type - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.revision.description - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.revision.type - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.type.description - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.type.enum - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.type.enumDescriptions - schemas.GoogleCloudRunV2InstanceSplitStatus.properties.type.type - schemas.GoogleCloudRunV2InstanceSplitStatus.type - schemas.GoogleCloudRunV2ListWorkerPoolsResponse.description - schemas.GoogleCloudRunV2ListWorkerPoolsResponse.id - schemas.GoogleCloudRunV2ListWorkerPoolsResponse.properties.nextPageToken.description - schemas.GoogleCloudRunV2ListWorkerPoolsResponse.properties.nextPageToken.type - schemas.GoogleCloudRunV2ListWorkerPoolsResponse.properties.workerPools.description - schemas.GoogleCloudRunV2ListWorkerPoolsResponse.properties.workerPools.items.$ref - schemas.GoogleCloudRunV2ListWorkerPoolsResponse.properties.workerPools.type - schemas.GoogleCloudRunV2ListWorkerPoolsResponse.type - schemas.GoogleCloudRunV2Revision.properties.creator.description - schemas.GoogleCloudRunV2Revision.properties.creator.readOnly - schemas.GoogleCloudRunV2Revision.properties.creator.type - schemas.GoogleCloudRunV2Task.properties.nodeSelector.$ref - schemas.GoogleCloudRunV2Task.properties.nodeSelector.description - schemas.GoogleCloudRunV2Task.properties.nodeSelector.readOnly - schemas.GoogleCloudRunV2TaskTemplate.properties.nodeSelector.$ref - schemas.GoogleCloudRunV2TaskTemplate.properties.nodeSelector.description - schemas.GoogleCloudRunV2WorkerPool.description - schemas.GoogleCloudRunV2WorkerPool.id - schemas.GoogleCloudRunV2WorkerPool.properties.annotations.additionalProperties.type - schemas.GoogleCloudRunV2WorkerPool.properties.annotations.description - schemas.GoogleCloudRunV2WorkerPool.properties.annotations.type - schemas.GoogleCloudRunV2WorkerPool.properties.binaryAuthorization.$ref - schemas.GoogleCloudRunV2WorkerPool.properties.binaryAuthorization.description - schemas.GoogleCloudRunV2WorkerPool.properties.client.description - schemas.GoogleCloudRunV2WorkerPool.properties.client.type - schemas.GoogleCloudRunV2WorkerPool.properties.clientVersion.description - schemas.GoogleCloudRunV2WorkerPool.properties.clientVersion.type - schemas.GoogleCloudRunV2WorkerPool.properties.conditions.description - schemas.GoogleCloudRunV2WorkerPool.properties.conditions.items.$ref - schemas.GoogleCloudRunV2WorkerPool.properties.conditions.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.conditions.type - schemas.GoogleCloudRunV2WorkerPool.properties.createTime.description - schemas.GoogleCloudRunV2WorkerPool.properties.createTime.format - schemas.GoogleCloudRunV2WorkerPool.properties.createTime.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.createTime.type - schemas.GoogleCloudRunV2WorkerPool.properties.creator.description - schemas.GoogleCloudRunV2WorkerPool.properties.creator.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.creator.type - schemas.GoogleCloudRunV2WorkerPool.properties.customAudiences.description - schemas.GoogleCloudRunV2WorkerPool.properties.customAudiences.items.type - schemas.GoogleCloudRunV2WorkerPool.properties.customAudiences.type - schemas.GoogleCloudRunV2WorkerPool.properties.deleteTime.description - schemas.GoogleCloudRunV2WorkerPool.properties.deleteTime.format - schemas.GoogleCloudRunV2WorkerPool.properties.deleteTime.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.deleteTime.type - schemas.GoogleCloudRunV2WorkerPool.properties.description.description - schemas.GoogleCloudRunV2WorkerPool.properties.description.type - schemas.GoogleCloudRunV2WorkerPool.properties.etag.description - schemas.GoogleCloudRunV2WorkerPool.properties.etag.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.etag.type - schemas.GoogleCloudRunV2WorkerPool.properties.expireTime.description - schemas.GoogleCloudRunV2WorkerPool.properties.expireTime.format - schemas.GoogleCloudRunV2WorkerPool.properties.expireTime.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.expireTime.type - schemas.GoogleCloudRunV2WorkerPool.properties.generation.description - schemas.GoogleCloudRunV2WorkerPool.properties.generation.format - schemas.GoogleCloudRunV2WorkerPool.properties.generation.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.generation.type - schemas.GoogleCloudRunV2WorkerPool.properties.instanceSplitStatuses.description - schemas.GoogleCloudRunV2WorkerPool.properties.instanceSplitStatuses.items.$ref - schemas.GoogleCloudRunV2WorkerPool.properties.instanceSplitStatuses.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.instanceSplitStatuses.type - schemas.GoogleCloudRunV2WorkerPool.properties.instanceSplits.description - schemas.GoogleCloudRunV2WorkerPool.properties.instanceSplits.items.$ref - schemas.GoogleCloudRunV2WorkerPool.properties.instanceSplits.type - schemas.GoogleCloudRunV2WorkerPool.properties.labels.additionalProperties.type - schemas.GoogleCloudRunV2WorkerPool.properties.labels.description - schemas.GoogleCloudRunV2WorkerPool.properties.labels.type - schemas.GoogleCloudRunV2WorkerPool.properties.lastModifier.description - schemas.GoogleCloudRunV2WorkerPool.properties.lastModifier.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.lastModifier.type - schemas.GoogleCloudRunV2WorkerPool.properties.latestCreatedRevision.description - schemas.GoogleCloudRunV2WorkerPool.properties.latestCreatedRevision.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.latestCreatedRevision.type - schemas.GoogleCloudRunV2WorkerPool.properties.latestReadyRevision.description - schemas.GoogleCloudRunV2WorkerPool.properties.latestReadyRevision.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.latestReadyRevision.type - schemas.GoogleCloudRunV2WorkerPool.properties.launchStage.description - schemas.GoogleCloudRunV2WorkerPool.properties.launchStage.enum - schemas.GoogleCloudRunV2WorkerPool.properties.launchStage.enumDescriptions - schemas.GoogleCloudRunV2WorkerPool.properties.launchStage.type - schemas.GoogleCloudRunV2WorkerPool.properties.name.description - schemas.GoogleCloudRunV2WorkerPool.properties.name.type - schemas.GoogleCloudRunV2WorkerPool.properties.observedGeneration.description - schemas.GoogleCloudRunV2WorkerPool.properties.observedGeneration.format - schemas.GoogleCloudRunV2WorkerPool.properties.observedGeneration.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.observedGeneration.type - schemas.GoogleCloudRunV2WorkerPool.properties.reconciling.description - schemas.GoogleCloudRunV2WorkerPool.properties.reconciling.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.reconciling.type - schemas.GoogleCloudRunV2WorkerPool.properties.satisfiesPzs.description - schemas.GoogleCloudRunV2WorkerPool.properties.satisfiesPzs.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.satisfiesPzs.type - schemas.GoogleCloudRunV2WorkerPool.properties.scaling.$ref - schemas.GoogleCloudRunV2WorkerPool.properties.scaling.description - schemas.GoogleCloudRunV2WorkerPool.properties.template.$ref - schemas.GoogleCloudRunV2WorkerPool.properties.template.description - schemas.GoogleCloudRunV2WorkerPool.properties.terminalCondition.$ref - schemas.GoogleCloudRunV2WorkerPool.properties.terminalCondition.description - schemas.GoogleCloudRunV2WorkerPool.properties.terminalCondition.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.uid.description - schemas.GoogleCloudRunV2WorkerPool.properties.uid.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.uid.type - schemas.GoogleCloudRunV2WorkerPool.properties.updateTime.description - schemas.GoogleCloudRunV2WorkerPool.properties.updateTime.format - schemas.GoogleCloudRunV2WorkerPool.properties.updateTime.readOnly - schemas.GoogleCloudRunV2WorkerPool.properties.updateTime.type - schemas.GoogleCloudRunV2WorkerPool.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.id - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.annotations.additionalProperties.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.annotations.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.annotations.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.containers.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.containers.items.$ref - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.containers.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKey.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKey.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKeyRevocationAction.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKeyRevocationAction.enum - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKeyRevocationAction.enumDescriptions - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKeyRevocationAction.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKeyShutdownDuration.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKeyShutdownDuration.format - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.encryptionKeyShutdownDuration.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.labels.additionalProperties.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.labels.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.labels.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.nodeSelector.$ref - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.nodeSelector.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.revision.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.revision.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.serviceAccount.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.serviceAccount.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.serviceMesh.$ref - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.serviceMesh.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.sessionAffinity.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.sessionAffinity.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.volumes.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.volumes.items.$ref - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.volumes.type - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.vpcAccess.$ref - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.properties.vpcAccess.description - schemas.GoogleCloudRunV2WorkerPoolRevisionTemplate.type - schemas.GoogleCloudRunV2WorkerPoolScaling.description - schemas.GoogleCloudRunV2WorkerPoolScaling.id - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.manualInstanceCount.description - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.manualInstanceCount.format - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.manualInstanceCount.type - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxInstanceCount.description - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxInstanceCount.format - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxInstanceCount.type - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxSurge.description - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxSurge.format - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxSurge.type - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxUnavailable.description - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxUnavailable.format - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.maxUnavailable.type - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.minInstanceCount.description - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.minInstanceCount.format - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.minInstanceCount.type - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.scalingMode.description - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.scalingMode.enum - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.scalingMode.enumDescriptions - schemas.GoogleCloudRunV2WorkerPoolScaling.properties.scalingMode.type - schemas.GoogleCloudRunV2WorkerPoolScaling.type - schemas.GoogleDevtoolsCloudbuildV1Build.properties.dependencies.description - schemas.GoogleDevtoolsCloudbuildV1Build.properties.dependencies.items.$ref - schemas.GoogleDevtoolsCloudbuildV1Build.properties.dependencies.type - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.description - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.pubsubTopic.type - schemas.GoogleDevtoolsCloudbuildV1Dependency.description - schemas.GoogleDevtoolsCloudbuildV1Dependency.id - schemas.GoogleDevtoolsCloudbuildV1Dependency.properties.empty.description - schemas.GoogleDevtoolsCloudbuildV1Dependency.properties.empty.type - schemas.GoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.$ref - schemas.GoogleDevtoolsCloudbuildV1Dependency.properties.gitSource.description - schemas.GoogleDevtoolsCloudbuildV1Dependency.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.id - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.depth.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.depth.format - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.depth.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.destPath.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.destPath.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.recurseSubmodules.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.recurseSubmodules.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.repository.$ref - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.repository.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.revision.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.properties.revision.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceDependency.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.id - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.properties.developerConnect.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.properties.developerConnect.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.properties.url.description - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.properties.url.type - schemas.GoogleDevtoolsCloudbuildV1GitSourceRepository.type The following keys were changed: - endpoints - resources.projects.resources.locations.methods.exportMetadata.parameters.name.description - schemas.GoogleCloudRunV2BuildConfig.properties.workerPool.description - schemas.GoogleCloudRunV2Container.properties.baseImageUri.description - schemas.GoogleCloudRunV2ExecutionTemplate.properties.parallelism.description - schemas.GoogleCloudRunV2Service.properties.expireTime.description - schemas.GoogleCloudRunV2Service.properties.reconciling.description - schemas.UtilStatusProto.properties.canonicalCode.description - schemas.UtilStatusProto.properties.space.description --- discovery/run-v1.json | 90 +++- discovery/run-v2.json | 733 +++++++++++++++++++++++++++++- src/apis/run/v1.ts | 65 ++- src/apis/run/v2.ts | 1009 ++++++++++++++++++++++++++++++++++++++++- 4 files changed, 1870 insertions(+), 27 deletions(-) diff --git a/discovery/run-v1.json b/discovery/run-v1.json index 12811a4afbd..deb808eaccd 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -86,6 +86,11 @@ "endpointUrl": "https://europe-north1-run.googleapis.com/", "location": "europe-north1" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-north2-run.googleapis.com/", + "location": "europe-north2" + }, { "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-run.googleapis.com/", @@ -161,6 +166,11 @@ "endpointUrl": "https://northamerica-northeast2-run.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://northamerica-south1-run.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-run.googleapis.com/", @@ -2614,7 +2624,7 @@ } } }, - "revision": "20250117", + "revision": "20250309", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -3276,7 +3286,7 @@ "id": "ExecutionSpec", "properties": { "parallelism": { - "description": "Optional. Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed, i.e. when the work left to do is less than max parallelism.", + "description": "Optional. Specifies the maximum desired number of tasks the execution should run at given time. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed, i.e. when the work left to do is less than max parallelism.", "format": "int32", "type": "integer" }, @@ -3584,6 +3594,13 @@ "readOnly": true, "type": "string" }, + "dependencies": { + "description": "Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Dependency" + }, + "type": "array" + }, "failureInfo": { "$ref": "GoogleDevtoolsCloudbuildV1FailureInfo", "description": "Output only. Contains information about the build when status=FAILURE.", @@ -3912,6 +3929,10 @@ "$ref": "GoogleDevtoolsCloudbuildV1PoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, + "pubsubTopic": { + "description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", + "type": "string" + }, "requestedVerifyOption": { "description": "Requested verifiability options.", "enum": [ @@ -4146,6 +4167,21 @@ }, "type": "object" }, + "GoogleDevtoolsCloudbuildV1Dependency": { + "description": "A dependency that the Cloud Build worker will fetch before executing user steps.", + "id": "GoogleDevtoolsCloudbuildV1Dependency", + "properties": { + "empty": { + "description": "If set to true disable all dependency fetching (ignoring the default source as well).", + "type": "boolean" + }, + "gitSource": { + "$ref": "GoogleDevtoolsCloudbuildV1GitSourceDependency", + "description": "Represents a git repository as a build dependency." + } + }, + "type": "object" + }, "GoogleDevtoolsCloudbuildV1DeveloperConnectConfig": { "description": "This config defines the location of a source through Developer Connect.", "id": "GoogleDevtoolsCloudbuildV1DeveloperConnectConfig", @@ -4242,6 +4278,49 @@ }, "type": "object" }, + "GoogleDevtoolsCloudbuildV1GitSourceDependency": { + "description": "Represents a git repository as a build dependency.", + "id": "GoogleDevtoolsCloudbuildV1GitSourceDependency", + "properties": { + "depth": { + "description": "Optional. How much history should be fetched for the build (default 1, -1 for all history).", + "format": "int64", + "type": "string" + }, + "destPath": { + "description": "Required. Where should the files be placed on the worker.", + "type": "string" + }, + "recurseSubmodules": { + "description": "Optional. True if submodules should be fetched too (default false).", + "type": "boolean" + }, + "repository": { + "$ref": "GoogleDevtoolsCloudbuildV1GitSourceRepository", + "description": "Required. The kind of repo (url or dev connect)." + }, + "revision": { + "description": "Required. The revision that we will fetch the repo at.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1GitSourceRepository": { + "description": "A repository for a git source.", + "id": "GoogleDevtoolsCloudbuildV1GitSourceRepository", + "properties": { + "developerConnect": { + "description": "The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", + "type": "string" + }, + "url": { + "description": "Location of the Git repository.", + "type": "string" + } + }, + "type": "object" + }, "GoogleDevtoolsCloudbuildV1GoModule": { "description": "Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.", "id": "GoogleDevtoolsCloudbuildV1GoModule", @@ -6286,6 +6365,13 @@ "format": "int32", "type": "integer" }, + "nodeSelector": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The Node Selector configuration. Map of selector key to a value which matches a node.", + "type": "object" + }, "serviceAccountName": { "description": "Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.", "type": "string" diff --git a/discovery/run-v2.json b/discovery/run-v2.json index a51a03e012d..5471aaadc75 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -86,6 +86,11 @@ "endpointUrl": "https://europe-north1-run.googleapis.com/", "location": "europe-north1" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-north2-run.googleapis.com/", + "location": "europe-north2" + }, { "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-run.googleapis.com/", @@ -161,6 +166,11 @@ "endpointUrl": "https://northamerica-northeast2-run.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://northamerica-south1-run.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-run.googleapis.com/", @@ -374,7 +384,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the resource of which metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}` for Service `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution", + "description": "Required. The name of the resource of which metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}` for Service `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution {project_id_or_number} may contains domain-scoped project IDs", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/.*$", "required": true, @@ -1522,6 +1532,224 @@ } }, "workerPools": { + "methods": { + "create": { + "description": "Creates a new WorkerPool in a given project and location.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools", + "httpMethod": "POST", + "id": "run.projects.locations.workerPools.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + }, + "workerPoolId": { + "description": "Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/workerPools", + "request": { + "$ref": "GoogleCloudRunV2WorkerPool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a WorkerPool.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", + "httpMethod": "DELETE", + "id": "run.projects.locations.workerPools.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated without actually deleting any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a WorkerPool.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", + "httpMethod": "GET", + "id": "run.projects.locations.workerPools.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudRunV2WorkerPool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists WorkerPools. Results are sorted by creation time, descending.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools", + "httpMethod": "GET", + "id": "run.projects.locations.workerPools.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of WorkerPools to return in this call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous call to ListWorkerPools. All other parameters must match.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the \"-\" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "If true, returns deleted (but unexpired) resources along with active ones.", + "location": "query", + "type": "boolean" + } + }, + "path": "v2/{+parent}/workerPools", + "response": { + "$ref": "GoogleCloudRunV2ListWorkerPoolsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a WorkerPool.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", + "httpMethod": "PATCH", + "id": "run.projects.locations.workerPools.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and if the WorkerPool does not exist, it will create a new one. The caller must have 'run.workerpools.create' permissions if this is set to true and the WorkerPool does not exist.", + "location": "query", + "type": "boolean" + }, + "forceNewRevision": { + "description": "Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision. This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudRunV2WorkerPool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:testIamPermissions", + "httpMethod": "POST", + "id": "run.projects.locations.workerPools.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/[^/]+/workerPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "revisions": { "methods": { @@ -1635,7 +1863,7 @@ } } }, - "revision": "20250117", + "revision": "20250309", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -1698,7 +1926,7 @@ "type": "string" }, "workerPool": { - "description": "Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.", + "description": "Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where `{project}` and `{region}` are the project id and region respectively where the worker pool is defined and `{workerPool}` is the short name of the worker pool.", "type": "string" } }, @@ -1950,7 +2178,7 @@ "type": "array" }, "baseImageUri": { - "description": "Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.", + "description": "Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.", "type": "string" }, "buildInfo": { @@ -2379,7 +2607,7 @@ "type": "object" }, "parallelism": { - "description": "Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.", + "description": "Optional. Specifies the maximum desired number of tasks the execution should run at given time. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.", "format": "int32", "type": "integer" }, @@ -2560,6 +2788,66 @@ }, "type": "object" }, + "GoogleCloudRunV2InstanceSplit": { + "description": "Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.", + "id": "GoogleCloudRunV2InstanceSplit", + "properties": { + "percent": { + "description": "Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.", + "format": "int32", + "type": "integer" + }, + "revision": { + "description": "Revision to which to assign this portion of instances, if split allocation is by revision.", + "type": "string" + }, + "type": { + "description": "The allocation type for this instance split.", + "enum": [ + "INSTANCE_SPLIT_ALLOCATION_TYPE_UNSPECIFIED", + "INSTANCE_SPLIT_ALLOCATION_TYPE_LATEST", + "INSTANCE_SPLIT_ALLOCATION_TYPE_REVISION" + ], + "enumDescriptions": [ + "Unspecified instance allocation type.", + "Allocates instances to the Service's latest ready Revision.", + "Allocates instances to a Revision by name." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRunV2InstanceSplitStatus": { + "description": "Represents the observed state of a single `InstanceSplit` entry.", + "id": "GoogleCloudRunV2InstanceSplitStatus", + "properties": { + "percent": { + "description": "Specifies percent of the instance split to this Revision.", + "format": "int32", + "type": "integer" + }, + "revision": { + "description": "Revision to which this instance split is assigned.", + "type": "string" + }, + "type": { + "description": "The allocation type for this instance split.", + "enum": [ + "INSTANCE_SPLIT_ALLOCATION_TYPE_UNSPECIFIED", + "INSTANCE_SPLIT_ALLOCATION_TYPE_LATEST", + "INSTANCE_SPLIT_ALLOCATION_TYPE_REVISION" + ], + "enumDescriptions": [ + "Unspecified instance allocation type.", + "Allocates instances to the Service's latest ready Revision.", + "Allocates instances to a Revision by name." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRunV2Job": { "description": "Job represents the configuration of a single job, which references a container image that is run to completion.", "id": "GoogleCloudRunV2Job", @@ -2813,6 +3101,24 @@ }, "type": "object" }, + "GoogleCloudRunV2ListWorkerPoolsResponse": { + "description": "Response message containing a list of WorkerPools.", + "id": "GoogleCloudRunV2ListWorkerPoolsResponse", + "properties": { + "nextPageToken": { + "description": "A token indicating there are more items than page_size. Use it in the next ListWorkerPools request to continue.", + "type": "string" + }, + "workerPools": { + "description": "The resulting list of WorkerPools.", + "items": { + "$ref": "GoogleCloudRunV2WorkerPool" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRunV2Metadata": { "description": "Metadata represents the JSON encoded generated customer metadata.", "id": "GoogleCloudRunV2Metadata", @@ -2994,6 +3300,11 @@ "readOnly": true, "type": "string" }, + "creator": { + "description": "Output only. Email address of the authenticated creator.", + "readOnly": true, + "type": "string" + }, "deleteTime": { "description": "Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.", "format": "google-datetime", @@ -3450,7 +3761,7 @@ "type": "string" }, "expireTime": { - "description": "Output only. For a deleted resource, the time after which it will be permamently deleted.", + "description": "Output only. For a deleted resource, the time after which it will be permanently deleted.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3540,7 +3851,7 @@ "type": "string" }, "reconciling": { - "description": "Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`.", + "description": "Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revision`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`.", "readOnly": true, "type": "boolean" }, @@ -3865,6 +4176,11 @@ "readOnly": true, "type": "string" }, + "nodeSelector": { + "$ref": "GoogleCloudRunV2NodeSelector", + "description": "Output only. The node selector for the task.", + "readOnly": true + }, "observedGeneration": { "description": "Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.", "format": "int64", @@ -3986,6 +4302,10 @@ "format": "int32", "type": "integer" }, + "nodeSelector": { + "$ref": "GoogleCloudRunV2NodeSelector", + "description": "Optional. The node selector for the task template." + }, "serviceAccount": { "description": "Optional. Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.", "type": "string" @@ -4179,14 +4499,326 @@ }, "type": "object" }, - "GoogleDevtoolsCloudbuildV1ApprovalConfig": { - "description": "ApprovalConfig describes configuration for manual approval of a build.", - "id": "GoogleDevtoolsCloudbuildV1ApprovalConfig", + "GoogleCloudRunV2WorkerPool": { + "description": "WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.", + "id": "GoogleCloudRunV2WorkerPool", "properties": { - "approvalRequired": { - "description": "Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.", - "type": "boolean" - } + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.", + "type": "object" + }, + "binaryAuthorization": { + "$ref": "GoogleCloudRunV2BinaryAuthorization", + "description": "Optional. Settings for the Binary Authorization feature." + }, + "client": { + "description": "Arbitrary identifier for the API client.", + "type": "string" + }, + "clientVersion": { + "description": "Arbitrary version identifier for the API client.", + "type": "string" + }, + "conditions": { + "description": "Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", + "items": { + "$ref": "GoogleCloudRunV2Condition" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. The creation time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creator": { + "description": "Output only. Email address of the authenticated creator.", + "readOnly": true, + "type": "string" + }, + "customAudiences": { + "description": "One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.", + "items": { + "type": "string" + }, + "type": "array" + }, + "deleteTime": { + "description": "Output only. The deletion time. It is only populated as a response to a Delete request.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "User-provided description of the WorkerPool. This field currently has a 512-character limit.", + "type": "string" + }, + "etag": { + "description": "Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", + "readOnly": true, + "type": "string" + }, + "expireTime": { + "description": "Output only. For a deleted resource, the time after which it will be permamently deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "generation": { + "description": "Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "instanceSplitStatuses": { + "description": "Output only. Detailed status information for corresponding instance splits. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", + "items": { + "$ref": "GoogleCloudRunV2InstanceSplitStatus" + }, + "readOnly": true, + "type": "array" + }, + "instanceSplits": { + "description": "Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision.", + "items": { + "$ref": "GoogleCloudRunV2InstanceSplit" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.", + "type": "object" + }, + "lastModifier": { + "description": "Output only. Email address of the last authenticated modifier.", + "readOnly": true, + "type": "string" + }, + "latestCreatedRevision": { + "description": "Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", + "readOnly": true, + "type": "string" + }, + "latestReadyRevision": { + "description": "Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", + "readOnly": true, + "type": "string" + }, + "launchStage": { + "description": "Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.", + "enum": [ + "LAUNCH_STAGE_UNSPECIFIED", + "UNIMPLEMENTED", + "PRELAUNCH", + "EARLY_ACCESS", + "ALPHA", + "BETA", + "GA", + "DEPRECATED" + ], + "enumDescriptions": [ + "Do not use this default value.", + "The feature is not yet implemented. Users can not use it.", + "Prelaunch features are hidden from users and are only visible internally.", + "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", + "GA features are open to all developers and are considered stable and fully qualified for production use.", + "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." + ], + "type": "string" + }, + "name": { + "description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}", + "type": "string" + }, + "observedGeneration": { + "description": "Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "reconciling": { + "description": "Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "scaling": { + "$ref": "GoogleCloudRunV2WorkerPoolScaling", + "description": "Optional. Specifies worker-pool-level scaling settings" + }, + "template": { + "$ref": "GoogleCloudRunV2WorkerPoolRevisionTemplate", + "description": "Required. The template used to create revisions for this WorkerPool." + }, + "terminalCondition": { + "$ref": "GoogleCloudRunV2Condition", + "description": "Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", + "readOnly": true + }, + "uid": { + "description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The last-modified time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRunV2WorkerPoolRevisionTemplate": { + "description": "WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template.", + "id": "GoogleCloudRunV2WorkerPoolRevisionTemplate", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.", + "type": "object" + }, + "containers": { + "description": "Holds list of the containers that defines the unit of execution for this Revision.", + "items": { + "$ref": "GoogleCloudRunV2Container" + }, + "type": "array" + }, + "encryptionKey": { + "description": "A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek", + "type": "string" + }, + "encryptionKeyRevocationAction": { + "description": "Optional. The action to take if the encryption key is revoked.", + "enum": [ + "ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED", + "PREVENT_NEW", + "SHUTDOWN" + ], + "enumDescriptions": [ + "Unspecified", + "Prevents the creation of new instances.", + "Shuts down existing instances, and prevents creation of new ones." + ], + "type": "string" + }, + "encryptionKeyShutdownDuration": { + "description": "Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.", + "format": "google-duration", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate.", + "type": "object" + }, + "nodeSelector": { + "$ref": "GoogleCloudRunV2NodeSelector", + "description": "Optional. The node selector for the revision template." + }, + "revision": { + "description": "Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the WorkerPool name.", + "type": "string" + }, + "serviceAccount": { + "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" + }, + "volumes": { + "description": "Optional. A list of Volumes to make available to containers.", + "items": { + "$ref": "GoogleCloudRunV2Volume" + }, + "type": "array" + }, + "vpcAccess": { + "$ref": "GoogleCloudRunV2VpcAccess", + "description": "Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc." + } + }, + "type": "object" + }, + "GoogleCloudRunV2WorkerPoolScaling": { + "description": "Worker pool scaling settings.", + "id": "GoogleCloudRunV2WorkerPoolScaling", + "properties": { + "manualInstanceCount": { + "description": "Optional. The total number of instances in manual scaling mode.", + "format": "int32", + "type": "integer" + }, + "maxInstanceCount": { + "description": "Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages.", + "format": "int32", + "type": "integer" + }, + "maxSurge": { + "description": "Optional. A maximum percentage of instances that will be moved in each step of traffic split changes. When set to a positive value, the server will bring up, at most, that percentage of new instances at a time before moving traffic to them. After moving traffic, the server will bring down instances of the old revision. This can reduce a spike of total active instances during changes from one revision to another but specifying how many extra instances can be brought up at a time.", + "format": "int32", + "type": "integer" + }, + "maxUnavailable": { + "description": "Optional. A maximum percentage of instances that may be unavailable during changes from one revision to another. When set to a positive value, the server may bring down instances before bringing up new instances. This can prevent a spike of total active instances during changes from one revision by reducing the pool of instances before bringing up new ones. Some requests may be slow or fail to serve during the transition.", + "format": "int32", + "type": "integer" + }, + "minInstanceCount": { + "description": "Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages.", + "format": "int32", + "type": "integer" + }, + "scalingMode": { + "description": "Optional. The scaling mode for the worker pool.", + "enum": [ + "SCALING_MODE_UNSPECIFIED", + "AUTOMATIC", + "MANUAL" + ], + "enumDescriptions": [ + "Unspecified.", + "Automatically scale between min and max instances.", + "Scale to exactly min instances and ignore the max instances." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1ApprovalConfig": { + "description": "ApprovalConfig describes configuration for manual approval of a build.", + "id": "GoogleDevtoolsCloudbuildV1ApprovalConfig", + "properties": { + "approvalRequired": { + "description": "Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.", + "type": "boolean" + } }, "type": "object" }, @@ -4327,6 +4959,13 @@ "readOnly": true, "type": "string" }, + "dependencies": { + "description": "Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.", + "items": { + "$ref": "GoogleDevtoolsCloudbuildV1Dependency" + }, + "type": "array" + }, "failureInfo": { "$ref": "GoogleDevtoolsCloudbuildV1FailureInfo", "description": "Output only. Contains information about the build when status=FAILURE.", @@ -4655,6 +5294,10 @@ "$ref": "GoogleDevtoolsCloudbuildV1PoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, + "pubsubTopic": { + "description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", + "type": "string" + }, "requestedVerifyOption": { "description": "Requested verifiability options.", "enum": [ @@ -4889,6 +5532,21 @@ }, "type": "object" }, + "GoogleDevtoolsCloudbuildV1Dependency": { + "description": "A dependency that the Cloud Build worker will fetch before executing user steps.", + "id": "GoogleDevtoolsCloudbuildV1Dependency", + "properties": { + "empty": { + "description": "If set to true disable all dependency fetching (ignoring the default source as well).", + "type": "boolean" + }, + "gitSource": { + "$ref": "GoogleDevtoolsCloudbuildV1GitSourceDependency", + "description": "Represents a git repository as a build dependency." + } + }, + "type": "object" + }, "GoogleDevtoolsCloudbuildV1DeveloperConnectConfig": { "description": "This config defines the location of a source through Developer Connect.", "id": "GoogleDevtoolsCloudbuildV1DeveloperConnectConfig", @@ -4985,6 +5643,49 @@ }, "type": "object" }, + "GoogleDevtoolsCloudbuildV1GitSourceDependency": { + "description": "Represents a git repository as a build dependency.", + "id": "GoogleDevtoolsCloudbuildV1GitSourceDependency", + "properties": { + "depth": { + "description": "Optional. How much history should be fetched for the build (default 1, -1 for all history).", + "format": "int64", + "type": "string" + }, + "destPath": { + "description": "Required. Where should the files be placed on the worker.", + "type": "string" + }, + "recurseSubmodules": { + "description": "Optional. True if submodules should be fetched too (default false).", + "type": "boolean" + }, + "repository": { + "$ref": "GoogleDevtoolsCloudbuildV1GitSourceRepository", + "description": "Required. The kind of repo (url or dev connect)." + }, + "revision": { + "description": "Required. The revision that we will fetch the repo at.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleDevtoolsCloudbuildV1GitSourceRepository": { + "description": "A repository for a git source.", + "id": "GoogleDevtoolsCloudbuildV1GitSourceRepository", + "properties": { + "developerConnect": { + "description": "The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", + "type": "string" + }, + "url": { + "description": "Location of the Git repository.", + "type": "string" + } + }, + "type": "object" + }, "GoogleDevtoolsCloudbuildV1GoModule": { "description": "Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.", "id": "GoogleDevtoolsCloudbuildV1GoModule", @@ -5852,7 +6553,7 @@ "id": "UtilStatusProto", "properties": { "canonicalCode": { - "description": "The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", "format": "int32", "type": "integer" }, @@ -5870,7 +6571,7 @@ "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" }, "space": { - "description": "The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2;", + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", "type": "string" } }, diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 764ae5b0471..147eaa847a0 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -629,7 +629,7 @@ export namespace run_v1 { */ export interface Schema$ExecutionSpec { /** - * Optional. Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed, i.e. when the work left to do is less than max parallelism. + * Optional. Specifies the maximum desired number of tasks the execution should run at given time. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed, i.e. when the work left to do is less than max parallelism. */ parallelism?: number | null; /** @@ -853,6 +853,10 @@ export namespace run_v1 { * Output only. Time at which the request to create the build was received. */ createTime?: string | null; + /** + * Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. + */ + dependencies?: Schema$GoogleDevtoolsCloudbuildV1Dependency[]; /** * Output only. Contains information about the build when status=FAILURE. */ @@ -1024,6 +1028,10 @@ export namespace run_v1 { * Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. */ pool?: Schema$GoogleDevtoolsCloudbuildV1PoolOption; + /** + * Optional. Option to specify the Pub/Sub topic to receive build status updates. + */ + pubsubTopic?: string | null; /** * Requested verifiability options. */ @@ -1160,6 +1168,19 @@ export namespace run_v1 { */ revision?: string | null; } + /** + * A dependency that the Cloud Build worker will fetch before executing user steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Dependency { + /** + * If set to true disable all dependency fetching (ignoring the default source as well). + */ + empty?: boolean | null; + /** + * Represents a git repository as a build dependency. + */ + gitSource?: Schema$GoogleDevtoolsCloudbuildV1GitSourceDependency; + } /** * This config defines the location of a source through Developer Connect. */ @@ -1225,6 +1246,44 @@ export namespace run_v1 { */ url?: string | null; } + /** + * Represents a git repository as a build dependency. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1GitSourceDependency { + /** + * Optional. How much history should be fetched for the build (default 1, -1 for all history). + */ + depth?: string | null; + /** + * Required. Where should the files be placed on the worker. + */ + destPath?: string | null; + /** + * Optional. True if submodules should be fetched too (default false). + */ + recurseSubmodules?: boolean | null; + /** + * Required. The kind of repo (url or dev connect). + */ + repository?: Schema$GoogleDevtoolsCloudbuildV1GitSourceRepository; + /** + * Required. The revision that we will fetch the repo at. + */ + revision?: string | null; + } + /** + * A repository for a git source. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1GitSourceRepository { + /** + * The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/x/locations/x/connections/x/gitRepositoryLink/x` + */ + developerConnect?: string | null; + /** + * Location of the Git repository. + */ + url?: string | null; + } /** * Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. */ @@ -2817,6 +2876,10 @@ export namespace run_v1 { * Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. */ maxRetries?: number | null; + /** + * Optional. The Node Selector configuration. Map of selector key to a value which matches a node. + */ + nodeSelector?: {[key: string]: string} | null; /** * Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. */ diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 5274ad06509..678926cdf3e 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -178,7 +178,7 @@ export namespace run_v2 { */ sourceLocation?: string | null; /** - * Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run function. The format of this field is `projects/{project\}/locations/{region\}/workerPools/{workerPool\}` where {project\} and {region\} are the project id and region respectively where the worker pool is defined and {workerPool\} is the short name of the worker pool. + * Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run function. The format of this field is `projects/{project\}/locations/{region\}/workerPools/{workerPool\}` where `{project\}` and `{region\}` are the project id and region respectively where the worker pool is defined and `{workerPool\}` is the short name of the worker pool. */ workerPool?: string | null; } @@ -296,7 +296,7 @@ export namespace run_v2 { */ args?: string[] | null; /** - * Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update. + * Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. */ baseImageUri?: string | null; /** @@ -580,7 +580,7 @@ export namespace run_v2 { */ labels?: {[key: string]: string} | null; /** - * Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism. + * Optional. Specifies the maximum desired number of tasks the execution should run at given time. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism. */ parallelism?: number | null; /** @@ -708,6 +708,40 @@ export namespace run_v2 { */ tag?: string | null; } + /** + * Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision. + */ + export interface Schema$GoogleCloudRunV2InstanceSplit { + /** + * Specifies percent of the instance split to this Revision. This defaults to zero if unspecified. + */ + percent?: number | null; + /** + * Revision to which to assign this portion of instances, if split allocation is by revision. + */ + revision?: string | null; + /** + * The allocation type for this instance split. + */ + type?: string | null; + } + /** + * Represents the observed state of a single `InstanceSplit` entry. + */ + export interface Schema$GoogleCloudRunV2InstanceSplitStatus { + /** + * Specifies percent of the instance split to this Revision. + */ + percent?: number | null; + /** + * Revision to which this instance split is assigned. + */ + revision?: string | null; + /** + * The allocation type for this instance split. + */ + type?: string | null; + } /** * Job represents the configuration of a single job, which references a container image that is run to completion. */ @@ -882,6 +916,19 @@ export namespace run_v2 { */ tasks?: Schema$GoogleCloudRunV2Task[]; } + /** + * Response message containing a list of WorkerPools. + */ + export interface Schema$GoogleCloudRunV2ListWorkerPoolsResponse { + /** + * A token indicating there are more items than page_size. Use it in the next ListWorkerPools request to continue. + */ + nextPageToken?: string | null; + /** + * The resulting list of WorkerPools. + */ + workerPools?: Schema$GoogleCloudRunV2WorkerPool[]; + } /** * Metadata represents the JSON encoded generated customer metadata. */ @@ -1021,6 +1068,10 @@ export namespace run_v2 { * Output only. The creation time. */ createTime?: string | null; + /** + * Output only. Email address of the authenticated creator. + */ + creator?: string | null; /** * Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. */ @@ -1337,7 +1388,7 @@ export namespace run_v2 { */ etag?: string | null; /** - * Output only. For a deleted resource, the time after which it will be permamently deleted. + * Output only. For a deleted resource, the time after which it will be permanently deleted. */ expireTime?: string | null; /** @@ -1381,7 +1432,7 @@ export namespace run_v2 { */ observedGeneration?: string | null; /** - * Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. + * Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revision`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. */ reconciling?: boolean | null; /** @@ -1602,6 +1653,10 @@ export namespace run_v2 { * Output only. The unique name of this Task. */ name?: string | null; + /** + * Output only. The node selector for the task. + */ + nodeSelector?: Schema$GoogleCloudRunV2NodeSelector; /** * Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. */ @@ -1684,6 +1739,10 @@ export namespace run_v2 { * Number of retries allowed per Task, before marking this Task failed. Defaults to 3. */ maxRetries?: number | null; + /** + * Optional. The node selector for the task template. + */ + nodeSelector?: Schema$GoogleCloudRunV2NodeSelector; /** * Optional. Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. */ @@ -1832,6 +1891,213 @@ export namespace run_v2 { */ networkInterfaces?: Schema$GoogleCloudRunV2NetworkInterface[]; } + /** + * WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership. + */ + export interface Schema$GoogleCloudRunV2WorkerPool { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules. + */ + annotations?: {[key: string]: string} | null; + /** + * Optional. Settings for the Binary Authorization feature. + */ + binaryAuthorization?: Schema$GoogleCloudRunV2BinaryAuthorization; + /** + * Arbitrary identifier for the API client. + */ + client?: string | null; + /** + * Arbitrary version identifier for the API client. + */ + clientVersion?: string | null; + /** + * Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. + */ + conditions?: Schema$GoogleCloudRunV2Condition[]; + /** + * Output only. The creation time. + */ + createTime?: string | null; + /** + * Output only. Email address of the authenticated creator. + */ + creator?: string | null; + /** + * One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. + */ + customAudiences?: string[] | null; + /** + * Output only. The deletion time. It is only populated as a response to a Delete request. + */ + deleteTime?: string | null; + /** + * User-provided description of the WorkerPool. This field currently has a 512-character limit. + */ + description?: string | null; + /** + * Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. + */ + etag?: string | null; + /** + * Output only. For a deleted resource, the time after which it will be permamently deleted. + */ + expireTime?: string | null; + /** + * Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. + */ + generation?: string | null; + /** + * Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision. + */ + instanceSplits?: Schema$GoogleCloudRunV2InstanceSplit[]; + /** + * Output only. Detailed status information for corresponding instance splits. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. + */ + instanceSplitStatuses?: Schema$GoogleCloudRunV2InstanceSplitStatus[]; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Email address of the last authenticated modifier. + */ + lastModifier?: string | null; + /** + * Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. + */ + latestCreatedRevision?: string | null; + /** + * Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. + */ + latestReadyRevision?: string | null; + /** + * Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. + */ + launchStage?: string | null; + /** + * The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project\}/locations/{location\}/workerPools/{worker_id\} + */ + name?: string | null; + /** + * Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. + */ + observedGeneration?: string | null; + /** + * Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. + */ + reconciling?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Optional. Specifies worker-pool-level scaling settings + */ + scaling?: Schema$GoogleCloudRunV2WorkerPoolScaling; + /** + * Required. The template used to create revisions for this WorkerPool. + */ + template?: Schema$GoogleCloudRunV2WorkerPoolRevisionTemplate; + /** + * Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. + */ + terminalCondition?: Schema$GoogleCloudRunV2Condition; + /** + * Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. + */ + uid?: string | null; + /** + * Output only. The last-modified time. + */ + updateTime?: string | null; + } + /** + * WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. + */ + export interface Schema$GoogleCloudRunV2WorkerPoolRevisionTemplate { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. + */ + annotations?: {[key: string]: string} | null; + /** + * Holds list of the containers that defines the unit of execution for this Revision. + */ + containers?: Schema$GoogleCloudRunV2Container[]; + /** + * A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek + */ + encryptionKey?: string | null; + /** + * Optional. The action to take if the encryption key is revoked. + */ + encryptionKeyRevocationAction?: string | null; + /** + * Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. + */ + encryptionKeyShutdownDuration?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. The node selector for the revision template. + */ + nodeSelector?: Schema$GoogleCloudRunV2NodeSelector; + /** + * Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the WorkerPool name. + */ + revision?: string | null; + /** + * 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. + */ + sessionAffinity?: boolean | null; + /** + * Optional. A list of Volumes to make available to containers. + */ + volumes?: Schema$GoogleCloudRunV2Volume[]; + /** + * Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. + */ + vpcAccess?: Schema$GoogleCloudRunV2VpcAccess; + } + /** + * Worker pool scaling settings. + */ + export interface Schema$GoogleCloudRunV2WorkerPoolScaling { + /** + * Optional. The total number of instances in manual scaling mode. + */ + manualInstanceCount?: number | null; + /** + * Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages. + */ + maxInstanceCount?: number | null; + /** + * Optional. A maximum percentage of instances that will be moved in each step of traffic split changes. When set to a positive value, the server will bring up, at most, that percentage of new instances at a time before moving traffic to them. After moving traffic, the server will bring down instances of the old revision. This can reduce a spike of total active instances during changes from one revision to another but specifying how many extra instances can be brought up at a time. + */ + maxSurge?: number | null; + /** + * Optional. A maximum percentage of instances that may be unavailable during changes from one revision to another. When set to a positive value, the server may bring down instances before bringing up new instances. This can prevent a spike of total active instances during changes from one revision by reducing the pool of instances before bringing up new ones. Some requests may be slow or fail to serve during the transition. + */ + maxUnavailable?: number | null; + /** + * Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages. + */ + minInstanceCount?: number | null; + /** + * Optional. The scaling mode for the worker pool. + */ + scalingMode?: string | null; + } /** * ApprovalConfig describes configuration for manual approval of a build. */ @@ -1936,6 +2202,10 @@ export namespace run_v2 { * Output only. Time at which the request to create the build was received. */ createTime?: string | null; + /** + * Optional. Dependencies that the Cloud Build worker will fetch before executing user steps. + */ + dependencies?: Schema$GoogleDevtoolsCloudbuildV1Dependency[]; /** * Output only. Contains information about the build when status=FAILURE. */ @@ -2107,6 +2377,10 @@ export namespace run_v2 { * Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. */ pool?: Schema$GoogleDevtoolsCloudbuildV1PoolOption; + /** + * Optional. Option to specify the Pub/Sub topic to receive build status updates. + */ + pubsubTopic?: string | null; /** * Requested verifiability options. */ @@ -2243,6 +2517,19 @@ export namespace run_v2 { */ revision?: string | null; } + /** + * A dependency that the Cloud Build worker will fetch before executing user steps. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1Dependency { + /** + * If set to true disable all dependency fetching (ignoring the default source as well). + */ + empty?: boolean | null; + /** + * Represents a git repository as a build dependency. + */ + gitSource?: Schema$GoogleDevtoolsCloudbuildV1GitSourceDependency; + } /** * This config defines the location of a source through Developer Connect. */ @@ -2308,6 +2595,44 @@ export namespace run_v2 { */ url?: string | null; } + /** + * Represents a git repository as a build dependency. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1GitSourceDependency { + /** + * Optional. How much history should be fetched for the build (default 1, -1 for all history). + */ + depth?: string | null; + /** + * Required. Where should the files be placed on the worker. + */ + destPath?: string | null; + /** + * Optional. True if submodules should be fetched too (default false). + */ + recurseSubmodules?: boolean | null; + /** + * Required. The kind of repo (url or dev connect). + */ + repository?: Schema$GoogleDevtoolsCloudbuildV1GitSourceRepository; + /** + * Required. The revision that we will fetch the repo at. + */ + revision?: string | null; + } + /** + * A repository for a git source. + */ + export interface Schema$GoogleDevtoolsCloudbuildV1GitSourceRepository { + /** + * The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/x/locations/x/connections/x/gitRepositoryLink/x` + */ + developerConnect?: string | null; + /** + * Location of the Git repository. + */ + url?: string | null; + } /** * Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. */ @@ -2951,7 +3276,7 @@ export namespace run_v2 { */ export interface Schema$UtilStatusProto { /** - * The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; */ canonicalCode?: number | null; /** @@ -2967,7 +3292,7 @@ export namespace run_v2 { */ messageSet?: Schema$Proto2BridgeMessageSet; /** - * The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2; + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs */ space?: string | null; } @@ -3406,7 +3731,7 @@ export namespace run_v2 { export interface Params$Resource$Projects$Locations$Exportmetadata extends StandardParameters { /** - * Required. The name of the resource of which metadata should be exported. Format: `projects/{project_id_or_number\}/locations/{location\}/services/{service\}` for Service `projects/{project_id_or_number\}/locations/{location\}/services/{service\}/revisions/{revision\}` for Revision `projects/{project_id_or_number\}/locations/{location\}/jobs/{job\}/executions/{execution\}` for Execution + * Required. The name of the resource of which metadata should be exported. Format: `projects/{project_id_or_number\}/locations/{location\}/services/{service\}` for Service `projects/{project_id_or_number\}/locations/{location\}/services/{service\}/revisions/{revision\}` for Revision `projects/{project_id_or_number\}/locations/{location\}/jobs/{job\}/executions/{execution\}` for Execution {project_id_or_number\} may contains domain-scoped project IDs */ name?: string; } @@ -7032,6 +7357,674 @@ export namespace run_v2 { this.context ); } + + /** + * Creates a new WorkerPool 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$Workerpools$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Workerpools$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Workerpools$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Workerpools$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Workerpools$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workerpools$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/workerPools').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 WorkerPool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workerpools$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Workerpools$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Workerpools$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Workerpools$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Workerpools$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workerpools$Delete; + 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}').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 information about a WorkerPool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workerpools$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Workerpools$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Workerpools$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Workerpools$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Workerpools$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workerpools$Get; + 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}').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 WorkerPools. Results are sorted by creation time, descending. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workerpools$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Workerpools$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Workerpools$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Workerpools$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Workerpools$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workerpools$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/workerPools').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 WorkerPool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workerpools$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Workerpools$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Workerpools$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Workerpools$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Workerpools$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Workerpools$Patch; + 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}').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 permissions that a caller has on the specified Project. There are no permissions required for making this API call. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workerpools$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Workerpools$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workerpools$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workerpools$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workerpools$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workerpools$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Workerpools$Create + extends StandardParameters { + /** + * Required. The location and project in which this worker pool should be created. Format: projects/{project\}/locations/{location\}, where {project\} can be project id or number. Only lowercase characters, digits, and hyphens. + */ + parent?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + /** + * Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent\}/workerPools/{worker_pool_id\}. + */ + workerPoolId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRunV2WorkerPool; + } + export interface Params$Resource$Projects$Locations$Workerpools$Delete + extends StandardParameters { + /** + * A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. + */ + etag?: string; + /** + * Required. The full name of the WorkerPool. Format: projects/{project\}/locations/{location\}/workerPools/{worker_pool\}, where {project\} can be project id or number. + */ + name?: string; + /** + * Optional. Indicates that the request should be validated without actually deleting any resources. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Workerpools$Get + extends StandardParameters { + /** + * Required. The full name of the WorkerPool. Format: projects/{project\}/locations/{location\}/workerPools/{worker_pool\}, where {project\} can be project id or number. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Workerpools$List + extends StandardParameters { + /** + * Maximum number of WorkerPools to return in this call. + */ + pageSize?: number; + /** + * A page token received from a previous call to ListWorkerPools. All other parameters must match. + */ + pageToken?: string; + /** + * Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the "-" wildcard. Format: projects/{project\}/locations/{location\}, where {project\} can be project id or number. + */ + parent?: string; + /** + * If true, returns deleted (but unexpired) resources along with active ones. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Locations$Workerpools$Patch + extends StandardParameters { + /** + * Optional. If set to true, and if the WorkerPool does not exist, it will create a new one. The caller must have 'run.workerpools.create' permissions if this is set to true and the WorkerPool does not exist. + */ + allowMissing?: boolean; + /** + * Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision. This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again. + */ + forceNewRevision?: boolean; + /** + * The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project\}/locations/{location\}/workerPools/{worker_id\} + */ + name?: string; + /** + * Optional. The list of fields to be updated. + */ + updateMask?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRunV2WorkerPool; + } + export interface Params$Resource$Projects$Locations$Workerpools$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$Workerpools$Revisions { From d058e38c106fed22b16649777773d00fe7bc895e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 110/144] fix(script): update the API --- discovery/script-v1.json | 4 ++-- src/apis/script/v1.ts | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/discovery/script-v1.json b/discovery/script-v1.json index ac1ed897991..f6d4bb1ea66 100644 --- a/discovery/script-v1.json +++ b/discovery/script-v1.json @@ -851,7 +851,7 @@ "scripts": { "methods": { "run": { - "description": "Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the script project **Overview** page and scroll down to \"Project OAuth Scopes.\" The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.", + "description": "", "flatPath": "v1/scripts/{scriptId}:run", "httpMethod": "POST", "id": "script.scripts.run", @@ -891,7 +891,7 @@ } } }, - "revision": "20240121", + "revision": "20250130", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index 7a95f89d7f9..c6abbd40ab9 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -2344,7 +2344,6 @@ export namespace script_v1 { } /** - * Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the script project **Overview** page and scroll down to "Project OAuth Scopes." The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From 744a6dbe98f33b81d5c4324957bc5bec335b53a2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 111/144] feat(securitycenter): update the API #### securitycenter:v1beta1 The following keys were added: - schemas.Allowed.description - schemas.Allowed.id - schemas.Allowed.properties.ipRules.description - schemas.Allowed.properties.ipRules.items.$ref - schemas.Allowed.properties.ipRules.type - schemas.Allowed.type - schemas.Cwe.description - schemas.Cwe.id - schemas.Cwe.properties.id.description - schemas.Cwe.properties.id.type - schemas.Cwe.properties.references.description - schemas.Cwe.properties.references.items.$ref - schemas.Cwe.properties.references.type - schemas.Cwe.type - schemas.Denied.description - schemas.Denied.id - schemas.Denied.properties.ipRules.description - schemas.Denied.properties.ipRules.items.$ref - schemas.Denied.properties.ipRules.type - schemas.Denied.type - schemas.Finding.properties.ipRules.$ref - schemas.Finding.properties.ipRules.description - schemas.Finding.properties.job.$ref - schemas.Finding.properties.job.description - schemas.Finding.properties.networks.description - schemas.Finding.properties.networks.items.$ref - schemas.Finding.properties.networks.type - schemas.GoogleCloudSecuritycenterV2Allowed.description - schemas.GoogleCloudSecuritycenterV2Allowed.id - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.items.$ref - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.type - schemas.GoogleCloudSecuritycenterV2Allowed.type - schemas.GoogleCloudSecuritycenterV2Cwe.description - schemas.GoogleCloudSecuritycenterV2Cwe.id - schemas.GoogleCloudSecuritycenterV2Cwe.properties.id.description - schemas.GoogleCloudSecuritycenterV2Cwe.properties.id.type - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.description - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.items.$ref - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.type - schemas.GoogleCloudSecuritycenterV2Cwe.type - schemas.GoogleCloudSecuritycenterV2Denied.description - schemas.GoogleCloudSecuritycenterV2Denied.id - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.items.$ref - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.type - schemas.GoogleCloudSecuritycenterV2Denied.type - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.items.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.type - schemas.GoogleCloudSecuritycenterV2IpRule.description - schemas.GoogleCloudSecuritycenterV2IpRule.id - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.description - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.items.$ref - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.type - schemas.GoogleCloudSecuritycenterV2IpRule.properties.protocol.description - schemas.GoogleCloudSecuritycenterV2IpRule.properties.protocol.type - schemas.GoogleCloudSecuritycenterV2IpRule.type - schemas.GoogleCloudSecuritycenterV2IpRules.description - schemas.GoogleCloudSecuritycenterV2IpRules.id - schemas.GoogleCloudSecuritycenterV2IpRules.properties.allowed.$ref - schemas.GoogleCloudSecuritycenterV2IpRules.properties.allowed.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.denied.$ref - schemas.GoogleCloudSecuritycenterV2IpRules.properties.denied.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.enum - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.enumDescriptions - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.type - schemas.GoogleCloudSecuritycenterV2IpRules.type - schemas.GoogleCloudSecuritycenterV2Job.description - schemas.GoogleCloudSecuritycenterV2Job.id - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.description - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.format - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.type - schemas.GoogleCloudSecuritycenterV2Job.properties.location.description - schemas.GoogleCloudSecuritycenterV2Job.properties.location.type - schemas.GoogleCloudSecuritycenterV2Job.properties.name.description - schemas.GoogleCloudSecuritycenterV2Job.properties.name.type - schemas.GoogleCloudSecuritycenterV2Job.properties.state.description - schemas.GoogleCloudSecuritycenterV2Job.properties.state.enum - schemas.GoogleCloudSecuritycenterV2Job.properties.state.enumDescriptions - schemas.GoogleCloudSecuritycenterV2Job.properties.state.readOnly - schemas.GoogleCloudSecuritycenterV2Job.properties.state.type - schemas.GoogleCloudSecuritycenterV2Job.type - schemas.GoogleCloudSecuritycenterV2Network.description - schemas.GoogleCloudSecuritycenterV2Network.id - schemas.GoogleCloudSecuritycenterV2Network.properties.name.description - schemas.GoogleCloudSecuritycenterV2Network.properties.name.type - schemas.GoogleCloudSecuritycenterV2Network.type - schemas.GoogleCloudSecuritycenterV2PortRange.description - schemas.GoogleCloudSecuritycenterV2PortRange.id - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.description - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.format - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.type - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.description - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.format - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.type - schemas.GoogleCloudSecuritycenterV2PortRange.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.items.$ref - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.format - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.reachable.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.reachable.type - schemas.IpRule.description - schemas.IpRule.id - schemas.IpRule.properties.portRanges.description - schemas.IpRule.properties.portRanges.items.$ref - schemas.IpRule.properties.portRanges.type - schemas.IpRule.properties.protocol.description - schemas.IpRule.properties.protocol.type - schemas.IpRule.type - schemas.IpRules.description - schemas.IpRules.id - schemas.IpRules.properties.allowed.$ref - schemas.IpRules.properties.allowed.description - schemas.IpRules.properties.denied.$ref - schemas.IpRules.properties.denied.description - schemas.IpRules.properties.destinationIpRanges.description - schemas.IpRules.properties.destinationIpRanges.items.type - schemas.IpRules.properties.destinationIpRanges.type - schemas.IpRules.properties.direction.description - schemas.IpRules.properties.direction.enum - schemas.IpRules.properties.direction.enumDescriptions - schemas.IpRules.properties.direction.type - schemas.IpRules.properties.exposedServices.description - schemas.IpRules.properties.exposedServices.items.type - schemas.IpRules.properties.exposedServices.type - schemas.IpRules.properties.sourceIpRanges.description - schemas.IpRules.properties.sourceIpRanges.items.type - schemas.IpRules.properties.sourceIpRanges.type - schemas.IpRules.type - schemas.Job.description - schemas.Job.id - schemas.Job.properties.errorCode.description - schemas.Job.properties.errorCode.format - schemas.Job.properties.errorCode.type - schemas.Job.properties.location.description - schemas.Job.properties.location.type - schemas.Job.properties.name.description - schemas.Job.properties.name.type - schemas.Job.properties.state.description - schemas.Job.properties.state.enum - schemas.Job.properties.state.enumDescriptions - schemas.Job.properties.state.readOnly - schemas.Job.properties.state.type - schemas.Job.type - schemas.Network.description - schemas.Network.id - schemas.Network.properties.name.description - schemas.Network.properties.name.type - schemas.Network.type - schemas.PortRange.description - schemas.PortRange.id - schemas.PortRange.properties.max.description - schemas.PortRange.properties.max.format - schemas.PortRange.properties.max.type - schemas.PortRange.properties.min.description - schemas.PortRange.properties.min.format - schemas.PortRange.properties.min.type - schemas.PortRange.type - schemas.Vulnerability.properties.cwes.description - schemas.Vulnerability.properties.cwes.items.$ref - schemas.Vulnerability.properties.cwes.type - schemas.Vulnerability.properties.providerRiskScore.description - schemas.Vulnerability.properties.providerRiskScore.format - schemas.Vulnerability.properties.providerRiskScore.type - schemas.Vulnerability.properties.reachable.description - schemas.Vulnerability.properties.reachable.type The following keys were changed: - schemas.DataRetentionDeletionEvent.properties.maxRetentionAllowed.description - schemas.Disk.properties.name.description - schemas.GoogleCloudSecuritycenterV2DataRetentionDeletionEvent.properties.maxRetentionAllowed.description - schemas.GoogleCloudSecuritycenterV2Disk.properties.name.description - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.additionalTechniques.items.enum - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.additionalTechniques.items.enumDescriptions - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.primaryTechniques.items.enum - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.primaryTechniques.items.enumDescriptions - schemas.GoogleCloudSecuritycenterV2OrgPolicy.properties.name.description - schemas.MitreAttack.properties.additionalTechniques.items.enum - schemas.MitreAttack.properties.additionalTechniques.items.enumDescriptions - schemas.MitreAttack.properties.primaryTechniques.items.enum - schemas.MitreAttack.properties.primaryTechniques.items.enumDescriptions #### securitycenter:v1beta2 The following keys were added: - schemas.Allowed.description - schemas.Allowed.id - schemas.Allowed.properties.ipRules.description - schemas.Allowed.properties.ipRules.items.$ref - schemas.Allowed.properties.ipRules.type - schemas.Allowed.type - schemas.Cwe.description - schemas.Cwe.id - schemas.Cwe.properties.id.description - schemas.Cwe.properties.id.type - schemas.Cwe.properties.references.description - schemas.Cwe.properties.references.items.$ref - schemas.Cwe.properties.references.type - schemas.Cwe.type - schemas.Denied.description - schemas.Denied.id - schemas.Denied.properties.ipRules.description - schemas.Denied.properties.ipRules.items.$ref - schemas.Denied.properties.ipRules.type - schemas.Denied.type - schemas.Finding.properties.ipRules.$ref - schemas.Finding.properties.ipRules.description - schemas.Finding.properties.job.$ref - schemas.Finding.properties.job.description - schemas.Finding.properties.networks.description - schemas.Finding.properties.networks.items.$ref - schemas.Finding.properties.networks.type - schemas.GoogleCloudSecuritycenterV2Allowed.description - schemas.GoogleCloudSecuritycenterV2Allowed.id - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.items.$ref - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.type - schemas.GoogleCloudSecuritycenterV2Allowed.type - schemas.GoogleCloudSecuritycenterV2Cwe.description - schemas.GoogleCloudSecuritycenterV2Cwe.id - schemas.GoogleCloudSecuritycenterV2Cwe.properties.id.description - schemas.GoogleCloudSecuritycenterV2Cwe.properties.id.type - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.description - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.items.$ref - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.type - schemas.GoogleCloudSecuritycenterV2Cwe.type - schemas.GoogleCloudSecuritycenterV2Denied.description - schemas.GoogleCloudSecuritycenterV2Denied.id - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.items.$ref - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.type - schemas.GoogleCloudSecuritycenterV2Denied.type - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.items.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.type - schemas.GoogleCloudSecuritycenterV2IpRule.description - schemas.GoogleCloudSecuritycenterV2IpRule.id - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.description - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.items.$ref - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.type - schemas.GoogleCloudSecuritycenterV2IpRule.properties.protocol.description - schemas.GoogleCloudSecuritycenterV2IpRule.properties.protocol.type - schemas.GoogleCloudSecuritycenterV2IpRule.type - schemas.GoogleCloudSecuritycenterV2IpRules.description - schemas.GoogleCloudSecuritycenterV2IpRules.id - schemas.GoogleCloudSecuritycenterV2IpRules.properties.allowed.$ref - schemas.GoogleCloudSecuritycenterV2IpRules.properties.allowed.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.denied.$ref - schemas.GoogleCloudSecuritycenterV2IpRules.properties.denied.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.enum - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.enumDescriptions - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.type - schemas.GoogleCloudSecuritycenterV2IpRules.type - schemas.GoogleCloudSecuritycenterV2Job.description - schemas.GoogleCloudSecuritycenterV2Job.id - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.description - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.format - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.type - schemas.GoogleCloudSecuritycenterV2Job.properties.location.description - schemas.GoogleCloudSecuritycenterV2Job.properties.location.type - schemas.GoogleCloudSecuritycenterV2Job.properties.name.description - schemas.GoogleCloudSecuritycenterV2Job.properties.name.type - schemas.GoogleCloudSecuritycenterV2Job.properties.state.description - schemas.GoogleCloudSecuritycenterV2Job.properties.state.enum - schemas.GoogleCloudSecuritycenterV2Job.properties.state.enumDescriptions - schemas.GoogleCloudSecuritycenterV2Job.properties.state.readOnly - schemas.GoogleCloudSecuritycenterV2Job.properties.state.type - schemas.GoogleCloudSecuritycenterV2Job.type - schemas.GoogleCloudSecuritycenterV2Network.description - schemas.GoogleCloudSecuritycenterV2Network.id - schemas.GoogleCloudSecuritycenterV2Network.properties.name.description - schemas.GoogleCloudSecuritycenterV2Network.properties.name.type - schemas.GoogleCloudSecuritycenterV2Network.type - schemas.GoogleCloudSecuritycenterV2PortRange.description - schemas.GoogleCloudSecuritycenterV2PortRange.id - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.description - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.format - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.type - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.description - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.format - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.type - schemas.GoogleCloudSecuritycenterV2PortRange.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.items.$ref - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.format - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.reachable.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.reachable.type - schemas.IpRule.description - schemas.IpRule.id - schemas.IpRule.properties.portRanges.description - schemas.IpRule.properties.portRanges.items.$ref - schemas.IpRule.properties.portRanges.type - schemas.IpRule.properties.protocol.description - schemas.IpRule.properties.protocol.type - schemas.IpRule.type - schemas.IpRules.description - schemas.IpRules.id - schemas.IpRules.properties.allowed.$ref - schemas.IpRules.properties.allowed.description - schemas.IpRules.properties.denied.$ref - schemas.IpRules.properties.denied.description - schemas.IpRules.properties.destinationIpRanges.description - schemas.IpRules.properties.destinationIpRanges.items.type - schemas.IpRules.properties.destinationIpRanges.type - schemas.IpRules.properties.direction.description - schemas.IpRules.properties.direction.enum - schemas.IpRules.properties.direction.enumDescriptions - schemas.IpRules.properties.direction.type - schemas.IpRules.properties.exposedServices.description - schemas.IpRules.properties.exposedServices.items.type - schemas.IpRules.properties.exposedServices.type - schemas.IpRules.properties.sourceIpRanges.description - schemas.IpRules.properties.sourceIpRanges.items.type - schemas.IpRules.properties.sourceIpRanges.type - schemas.IpRules.type - schemas.Job.description - schemas.Job.id - schemas.Job.properties.errorCode.description - schemas.Job.properties.errorCode.format - schemas.Job.properties.errorCode.type - schemas.Job.properties.location.description - schemas.Job.properties.location.type - schemas.Job.properties.name.description - schemas.Job.properties.name.type - schemas.Job.properties.state.description - schemas.Job.properties.state.enum - schemas.Job.properties.state.enumDescriptions - schemas.Job.properties.state.readOnly - schemas.Job.properties.state.type - schemas.Job.type - schemas.Network.description - schemas.Network.id - schemas.Network.properties.name.description - schemas.Network.properties.name.type - schemas.Network.type - schemas.PortRange.description - schemas.PortRange.id - schemas.PortRange.properties.max.description - schemas.PortRange.properties.max.format - schemas.PortRange.properties.max.type - schemas.PortRange.properties.min.description - schemas.PortRange.properties.min.format - schemas.PortRange.properties.min.type - schemas.PortRange.type - schemas.Vulnerability.properties.cwes.description - schemas.Vulnerability.properties.cwes.items.$ref - schemas.Vulnerability.properties.cwes.type - schemas.Vulnerability.properties.providerRiskScore.description - schemas.Vulnerability.properties.providerRiskScore.format - schemas.Vulnerability.properties.providerRiskScore.type - schemas.Vulnerability.properties.reachable.description - schemas.Vulnerability.properties.reachable.type The following keys were changed: - schemas.DataRetentionDeletionEvent.properties.maxRetentionAllowed.description - schemas.Disk.properties.name.description - schemas.GoogleCloudSecuritycenterV2DataRetentionDeletionEvent.properties.maxRetentionAllowed.description - schemas.GoogleCloudSecuritycenterV2Disk.properties.name.description - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.additionalTechniques.items.enum - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.additionalTechniques.items.enumDescriptions - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.primaryTechniques.items.enum - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.primaryTechniques.items.enumDescriptions - schemas.GoogleCloudSecuritycenterV2OrgPolicy.properties.name.description - schemas.MitreAttack.properties.additionalTechniques.items.enum - schemas.MitreAttack.properties.additionalTechniques.items.enumDescriptions - schemas.MitreAttack.properties.primaryTechniques.items.enum - schemas.MitreAttack.properties.primaryTechniques.items.enumDescriptions #### securitycenter:v1 The following keys were added: - schemas.Allowed.description - schemas.Allowed.id - schemas.Allowed.properties.ipRules.description - schemas.Allowed.properties.ipRules.items.$ref - schemas.Allowed.properties.ipRules.type - schemas.Allowed.type - schemas.Cwe.description - schemas.Cwe.id - schemas.Cwe.properties.id.description - schemas.Cwe.properties.id.type - schemas.Cwe.properties.references.description - schemas.Cwe.properties.references.items.$ref - schemas.Cwe.properties.references.type - schemas.Cwe.type - schemas.Denied.description - schemas.Denied.id - schemas.Denied.properties.ipRules.description - schemas.Denied.properties.ipRules.items.$ref - schemas.Denied.properties.ipRules.type - schemas.Denied.type - schemas.Finding.properties.ipRules.$ref - schemas.Finding.properties.ipRules.description - schemas.Finding.properties.job.$ref - schemas.Finding.properties.job.description - schemas.Finding.properties.networks.description - schemas.Finding.properties.networks.items.$ref - schemas.Finding.properties.networks.type - schemas.GoogleCloudSecuritycenterV2Allowed.description - schemas.GoogleCloudSecuritycenterV2Allowed.id - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.items.$ref - schemas.GoogleCloudSecuritycenterV2Allowed.properties.ipRules.type - schemas.GoogleCloudSecuritycenterV2Allowed.type - schemas.GoogleCloudSecuritycenterV2Cwe.description - schemas.GoogleCloudSecuritycenterV2Cwe.id - schemas.GoogleCloudSecuritycenterV2Cwe.properties.id.description - schemas.GoogleCloudSecuritycenterV2Cwe.properties.id.type - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.description - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.items.$ref - schemas.GoogleCloudSecuritycenterV2Cwe.properties.references.type - schemas.GoogleCloudSecuritycenterV2Cwe.type - schemas.GoogleCloudSecuritycenterV2Denied.description - schemas.GoogleCloudSecuritycenterV2Denied.id - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.items.$ref - schemas.GoogleCloudSecuritycenterV2Denied.properties.ipRules.type - schemas.GoogleCloudSecuritycenterV2Denied.type - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.ipRules.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.job.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.description - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.items.$ref - schemas.GoogleCloudSecuritycenterV2Finding.properties.networks.type - schemas.GoogleCloudSecuritycenterV2IpRule.description - schemas.GoogleCloudSecuritycenterV2IpRule.id - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.description - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.items.$ref - schemas.GoogleCloudSecuritycenterV2IpRule.properties.portRanges.type - schemas.GoogleCloudSecuritycenterV2IpRule.properties.protocol.description - schemas.GoogleCloudSecuritycenterV2IpRule.properties.protocol.type - schemas.GoogleCloudSecuritycenterV2IpRule.type - schemas.GoogleCloudSecuritycenterV2IpRules.description - schemas.GoogleCloudSecuritycenterV2IpRules.id - schemas.GoogleCloudSecuritycenterV2IpRules.properties.allowed.$ref - schemas.GoogleCloudSecuritycenterV2IpRules.properties.allowed.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.denied.$ref - schemas.GoogleCloudSecuritycenterV2IpRules.properties.denied.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.destinationIpRanges.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.enum - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.enumDescriptions - schemas.GoogleCloudSecuritycenterV2IpRules.properties.direction.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.exposedServices.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.description - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.items.type - schemas.GoogleCloudSecuritycenterV2IpRules.properties.sourceIpRanges.type - schemas.GoogleCloudSecuritycenterV2IpRules.type - schemas.GoogleCloudSecuritycenterV2Job.description - schemas.GoogleCloudSecuritycenterV2Job.id - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.description - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.format - schemas.GoogleCloudSecuritycenterV2Job.properties.errorCode.type - schemas.GoogleCloudSecuritycenterV2Job.properties.location.description - schemas.GoogleCloudSecuritycenterV2Job.properties.location.type - schemas.GoogleCloudSecuritycenterV2Job.properties.name.description - schemas.GoogleCloudSecuritycenterV2Job.properties.name.type - schemas.GoogleCloudSecuritycenterV2Job.properties.state.description - schemas.GoogleCloudSecuritycenterV2Job.properties.state.enum - schemas.GoogleCloudSecuritycenterV2Job.properties.state.enumDescriptions - schemas.GoogleCloudSecuritycenterV2Job.properties.state.readOnly - schemas.GoogleCloudSecuritycenterV2Job.properties.state.type - schemas.GoogleCloudSecuritycenterV2Job.type - schemas.GoogleCloudSecuritycenterV2Network.description - schemas.GoogleCloudSecuritycenterV2Network.id - schemas.GoogleCloudSecuritycenterV2Network.properties.name.description - schemas.GoogleCloudSecuritycenterV2Network.properties.name.type - schemas.GoogleCloudSecuritycenterV2Network.type - schemas.GoogleCloudSecuritycenterV2PortRange.description - schemas.GoogleCloudSecuritycenterV2PortRange.id - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.description - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.format - schemas.GoogleCloudSecuritycenterV2PortRange.properties.max.type - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.description - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.format - schemas.GoogleCloudSecuritycenterV2PortRange.properties.min.type - schemas.GoogleCloudSecuritycenterV2PortRange.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.items.$ref - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.cwes.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.format - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.providerRiskScore.type - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.reachable.description - schemas.GoogleCloudSecuritycenterV2Vulnerability.properties.reachable.type - schemas.IpRule.description - schemas.IpRule.id - schemas.IpRule.properties.portRanges.description - schemas.IpRule.properties.portRanges.items.$ref - schemas.IpRule.properties.portRanges.type - schemas.IpRule.properties.protocol.description - schemas.IpRule.properties.protocol.type - schemas.IpRule.type - schemas.IpRules.description - schemas.IpRules.id - schemas.IpRules.properties.allowed.$ref - schemas.IpRules.properties.allowed.description - schemas.IpRules.properties.denied.$ref - schemas.IpRules.properties.denied.description - schemas.IpRules.properties.destinationIpRanges.description - schemas.IpRules.properties.destinationIpRanges.items.type - schemas.IpRules.properties.destinationIpRanges.type - schemas.IpRules.properties.direction.description - schemas.IpRules.properties.direction.enum - schemas.IpRules.properties.direction.enumDescriptions - schemas.IpRules.properties.direction.type - schemas.IpRules.properties.exposedServices.description - schemas.IpRules.properties.exposedServices.items.type - schemas.IpRules.properties.exposedServices.type - schemas.IpRules.properties.sourceIpRanges.description - schemas.IpRules.properties.sourceIpRanges.items.type - schemas.IpRules.properties.sourceIpRanges.type - schemas.IpRules.type - schemas.Job.description - schemas.Job.id - schemas.Job.properties.errorCode.description - schemas.Job.properties.errorCode.format - schemas.Job.properties.errorCode.type - schemas.Job.properties.location.description - schemas.Job.properties.location.type - schemas.Job.properties.name.description - schemas.Job.properties.name.type - schemas.Job.properties.state.description - schemas.Job.properties.state.enum - schemas.Job.properties.state.enumDescriptions - schemas.Job.properties.state.readOnly - schemas.Job.properties.state.type - schemas.Job.type - schemas.Network.description - schemas.Network.id - schemas.Network.properties.name.description - schemas.Network.properties.name.type - schemas.Network.type - schemas.PortRange.description - schemas.PortRange.id - schemas.PortRange.properties.max.description - schemas.PortRange.properties.max.format - schemas.PortRange.properties.max.type - schemas.PortRange.properties.min.description - schemas.PortRange.properties.min.format - schemas.PortRange.properties.min.type - schemas.PortRange.type - schemas.Vulnerability.properties.cwes.description - schemas.Vulnerability.properties.cwes.items.$ref - schemas.Vulnerability.properties.cwes.type - schemas.Vulnerability.properties.providerRiskScore.description - schemas.Vulnerability.properties.providerRiskScore.format - schemas.Vulnerability.properties.providerRiskScore.type - schemas.Vulnerability.properties.reachable.description - schemas.Vulnerability.properties.reachable.type The following keys were changed: - schemas.DataRetentionDeletionEvent.properties.maxRetentionAllowed.description - schemas.Disk.properties.name.description - schemas.GoogleCloudSecuritycenterV2DataRetentionDeletionEvent.properties.maxRetentionAllowed.description - schemas.GoogleCloudSecuritycenterV2Disk.properties.name.description - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.additionalTechniques.items.enum - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.additionalTechniques.items.enumDescriptions - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.primaryTechniques.items.enum - schemas.GoogleCloudSecuritycenterV2MitreAttack.properties.primaryTechniques.items.enumDescriptions - schemas.GoogleCloudSecuritycenterV2OrgPolicy.properties.name.description - schemas.MitreAttack.properties.additionalTechniques.items.enum - schemas.MitreAttack.properties.additionalTechniques.items.enumDescriptions - schemas.MitreAttack.properties.primaryTechniques.items.enum - schemas.MitreAttack.properties.primaryTechniques.items.enumDescriptions --- discovery/securitycenter-v1.json | 460 +++++++++++++++++++++++++- discovery/securitycenter-v1beta1.json | 460 +++++++++++++++++++++++++- discovery/securitycenter-v1beta2.json | 460 +++++++++++++++++++++++++- src/apis/securitycenter/v1.ts | 290 +++++++++++++++- src/apis/securitycenter/v1beta1.ts | 290 +++++++++++++++- src/apis/securitycenter/v1beta2.ts | 290 +++++++++++++++- 6 files changed, 2217 insertions(+), 33 deletions(-) diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index 6a707b7ff3c..dbc747c36a4 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -5938,7 +5938,7 @@ } } }, - "revision": "20250116", + "revision": "20250308", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6042,6 +6042,20 @@ }, "type": "object" }, + "Allowed": { + "description": "Allowed IP rule.", + "id": "Allowed", + "properties": { + "ipRules": { + "description": "Optional. Optional list of allowed IP rules.", + "items": { + "$ref": "IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "Application": { "description": "Represents an application associated with a finding.", "id": "Application", @@ -7225,6 +7239,24 @@ }, "type": "object" }, + "Cwe": { + "description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", + "id": "Cwe", + "properties": { + "id": { + "description": "The CWE identifier, e.g. CWE-94", + "type": "string" + }, + "references": { + "description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", + "items": { + "$ref": "Reference" + }, + "type": "array" + } + }, + "type": "object" + }, "DataAccessEvent": { "description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "DataAccessEvent", @@ -7328,7 +7360,7 @@ "type": "string" }, "maxRetentionAllowed": { - "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", + "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" } @@ -7369,6 +7401,20 @@ }, "type": "object" }, + "Denied": { + "description": "Denied IP rule.", + "id": "Denied", + "properties": { + "ipRules": { + "description": "Optional. Optional list of denied IP rules.", + "items": { + "$ref": "IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "Detection", @@ -7390,7 +7436,7 @@ "id": "Disk", "properties": { "name": { - "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id\".", + "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, @@ -7877,6 +7923,14 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, + "ipRules": { + "$ref": "IpRules", + "description": "IP rules associated with the finding." + }, + "job": { + "$ref": "Job", + "description": "Job associated with the finding." + }, "kernelRootkit": { "$ref": "KernelRootkit", "description": "Signature of the kernel rootkit." @@ -7942,6 +7996,13 @@ "description": "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}\".", "type": "string" }, + "networks": { + "description": "Represents the VPC networks that the resource is attached to.", + "items": { + "$ref": "Network" + }, + "type": "array" + }, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -9120,6 +9181,20 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Allowed": { + "description": "Allowed IP rule.", + "id": "GoogleCloudSecuritycenterV2Allowed", + "properties": { + "ipRules": { + "description": "Optional. Optional list of allowed IP rules.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Application": { "description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", @@ -9948,6 +10023,24 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Cwe": { + "description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", + "id": "GoogleCloudSecuritycenterV2Cwe", + "properties": { + "id": { + "description": "The CWE identifier, e.g. CWE-94", + "type": "string" + }, + "references": { + "description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Reference" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2DataAccessEvent": { "description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataAccessEvent", @@ -10051,7 +10144,7 @@ "type": "string" }, "maxRetentionAllowed": { - "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", + "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" } @@ -10092,6 +10185,20 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Denied": { + "description": "Denied IP rule.", + "id": "GoogleCloudSecuritycenterV2Denied", + "properties": { + "ipRules": { + "description": "Optional. Optional list of denied IP rules.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", @@ -10113,7 +10220,7 @@ "id": "GoogleCloudSecuritycenterV2Disk", "properties": { "name": { - "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id\".", + "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, @@ -10485,6 +10592,14 @@ "$ref": "GoogleCloudSecuritycenterV2Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, + "ipRules": { + "$ref": "GoogleCloudSecuritycenterV2IpRules", + "description": "IP rules associated with the finding." + }, + "job": { + "$ref": "GoogleCloudSecuritycenterV2Job", + "description": "Job associated with the finding." + }, "kernelRootkit": { "$ref": "GoogleCloudSecuritycenterV2KernelRootkit", "description": "Signature of the kernel rootkit." @@ -10550,6 +10665,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, + "networks": { + "description": "Represents the VPC networks that the resource is attached to.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Network" + }, + "type": "array" + }, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -10758,6 +10880,74 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IpRule": { + "description": "IP rule information.", + "id": "GoogleCloudSecuritycenterV2IpRule", + "properties": { + "portRanges": { + "description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2PortRange" + }, + "type": "array" + }, + "protocol": { + "description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IpRules": { + "description": "IP rules associated with the finding.", + "id": "GoogleCloudSecuritycenterV2IpRules", + "properties": { + "allowed": { + "$ref": "GoogleCloudSecuritycenterV2Allowed", + "description": "Tuple with allowed rules." + }, + "denied": { + "$ref": "GoogleCloudSecuritycenterV2Denied", + "description": "Tuple with denied rules." + }, + "destinationIpRanges": { + "description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + }, + "direction": { + "description": "The direction that the rule is applicable to, one of ingress or egress.", + "enum": [ + "DIRECTION_UNSPECIFIED", + "INGRESS", + "EGRESS" + ], + "enumDescriptions": [ + "Unspecified direction value.", + "Ingress direction value.", + "Egress direction value." + ], + "type": "string" + }, + "exposedServices": { + "description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceIpRanges": { + "description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Issue": { "description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", @@ -11155,6 +11345,45 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Job": { + "description": "Describes a job", + "id": "GoogleCloudSecuritycenterV2Job", + "properties": { + "errorCode": { + "description": "Optional. If the job did not complete successfully, this field describes why.", + "format": "int32", + "type": "integer" + }, + "location": { + "description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", + "type": "string" + }, + "name": { + "description": "The fully-qualified name for a job. e.g. `projects//jobs/`", + "type": "string" + }, + "state": { + "description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", + "enum": [ + "JOB_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified represents an unknown state and should not be used.", + "Job is scheduled and pending for run", + "Job in progress", + "Job has completed with success", + "Job has completed but with failure" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", @@ -11359,6 +11588,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -11384,6 +11614,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -11393,6 +11624,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -11428,6 +11660,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -11453,6 +11686,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -11462,6 +11696,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -11542,6 +11777,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -11567,6 +11803,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -11576,6 +11813,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -11611,6 +11849,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -11636,6 +11875,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -11645,6 +11885,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -11762,6 +12003,17 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Network": { + "description": "Contains information about a VPC network associated with the finding.", + "id": "GoogleCloudSecuritycenterV2Network", + "properties": { + "name": { + "description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -11869,7 +12121,7 @@ "id": "GoogleCloudSecuritycenterV2OrgPolicy", "properties": { "name": { - "description": "The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", + "description": "Identifier. The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, @@ -11946,6 +12198,23 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2PortRange": { + "description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", + "id": "GoogleCloudSecuritycenterV2PortRange", + "properties": { + "max": { + "description": "Maximum port value.", + "format": "int64", + "type": "string" + }, + "min": { + "description": "Minimum port value.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Process": { "description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", @@ -12590,6 +12859,13 @@ "$ref": "GoogleCloudSecuritycenterV2Cve", "description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" }, + "cwes": { + "description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Cwe" + }, + "type": "array" + }, "fixedPackage": { "$ref": "GoogleCloudSecuritycenterV2Package", "description": "The fixed package is relevant to the finding." @@ -12598,6 +12874,15 @@ "$ref": "GoogleCloudSecuritycenterV2Package", "description": "The offending package is relevant to the finding." }, + "providerRiskScore": { + "description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", + "format": "int64", + "type": "string" + }, + "reachable": { + "description": "Represents whether the vulnerability is reachable (detected via static analysis)", + "type": "boolean" + }, "securityBulletin": { "$ref": "GoogleCloudSecuritycenterV2SecurityBulletin", "description": "The security bulletin is relevant to this finding." @@ -12859,6 +13144,113 @@ }, "type": "object" }, + "IpRule": { + "description": "IP rule information.", + "id": "IpRule", + "properties": { + "portRanges": { + "description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", + "items": { + "$ref": "PortRange" + }, + "type": "array" + }, + "protocol": { + "description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", + "type": "string" + } + }, + "type": "object" + }, + "IpRules": { + "description": "IP rules associated with the finding.", + "id": "IpRules", + "properties": { + "allowed": { + "$ref": "Allowed", + "description": "Tuple with allowed rules." + }, + "denied": { + "$ref": "Denied", + "description": "Tuple with denied rules." + }, + "destinationIpRanges": { + "description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + }, + "direction": { + "description": "The direction that the rule is applicable to, one of ingress or egress.", + "enum": [ + "DIRECTION_UNSPECIFIED", + "INGRESS", + "EGRESS" + ], + "enumDescriptions": [ + "Unspecified direction value.", + "Ingress direction value.", + "Egress direction value." + ], + "type": "string" + }, + "exposedServices": { + "description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceIpRanges": { + "description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Job": { + "description": "Describes a job", + "id": "Job", + "properties": { + "errorCode": { + "description": "Optional. If the job did not complete successfully, this field describes why.", + "format": "int32", + "type": "integer" + }, + "location": { + "description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", + "type": "string" + }, + "name": { + "description": "The fully-qualified name for a job. e.g. `projects//jobs/`", + "type": "string" + }, + "state": { + "description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", + "enum": [ + "JOB_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified represents an unknown state and should not be used.", + "Job is scheduled and pending for run", + "Job in progress", + "Job has completed with success", + "Job has completed but with failure" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", @@ -13437,6 +13829,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -13462,6 +13855,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -13471,6 +13865,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -13506,6 +13901,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -13531,6 +13927,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -13540,6 +13937,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -13620,6 +14018,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -13645,6 +14044,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -13654,6 +14054,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -13689,6 +14090,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -13714,6 +14116,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -13723,6 +14126,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -13785,6 +14189,17 @@ }, "type": "object" }, + "Network": { + "description": "Contains information about a VPC network associated with the finding.", + "id": "Network", + "properties": { + "name": { + "description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", + "type": "string" + } + }, + "type": "object" + }, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -14082,6 +14497,23 @@ }, "type": "object" }, + "PortRange": { + "description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", + "id": "PortRange", + "properties": { + "max": { + "description": "Maximum port value.", + "format": "int64", + "type": "string" + }, + "min": { + "description": "Minimum port value.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Position": { "description": "A position in the uploaded text version of a module.", "id": "Position", @@ -15040,6 +15472,13 @@ "$ref": "Cve", "description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" }, + "cwes": { + "description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", + "items": { + "$ref": "Cwe" + }, + "type": "array" + }, "fixedPackage": { "$ref": "Package", "description": "The fixed package is relevant to the finding." @@ -15048,6 +15487,15 @@ "$ref": "Package", "description": "The offending package is relevant to the finding." }, + "providerRiskScore": { + "description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", + "format": "int64", + "type": "string" + }, + "reachable": { + "description": "Represents whether the vulnerability is reachable (detected via static analysis)", + "type": "boolean" + }, "securityBulletin": { "$ref": "SecurityBulletin", "description": "The security bulletin is relevant to this finding." diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index 79ee4f46eb0..b3a582b0653 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -913,7 +913,7 @@ } } }, - "revision": "20250116", + "revision": "20250308", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1017,6 +1017,20 @@ }, "type": "object" }, + "Allowed": { + "description": "Allowed IP rule.", + "id": "Allowed", + "properties": { + "ipRules": { + "description": "Optional. Optional list of allowed IP rules.", + "items": { + "$ref": "IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "Application": { "description": "Represents an application associated with a finding.", "id": "Application", @@ -1961,6 +1975,24 @@ }, "type": "object" }, + "Cwe": { + "description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", + "id": "Cwe", + "properties": { + "id": { + "description": "The CWE identifier, e.g. CWE-94", + "type": "string" + }, + "references": { + "description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", + "items": { + "$ref": "Reference" + }, + "type": "array" + } + }, + "type": "object" + }, "DataAccessEvent": { "description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "DataAccessEvent", @@ -2064,7 +2096,7 @@ "type": "string" }, "maxRetentionAllowed": { - "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", + "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" } @@ -2105,6 +2137,20 @@ }, "type": "object" }, + "Denied": { + "description": "Denied IP rule.", + "id": "Denied", + "properties": { + "ipRules": { + "description": "Optional. Optional list of denied IP rules.", + "items": { + "$ref": "IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "Detection", @@ -2126,7 +2172,7 @@ "id": "Disk", "properties": { "name": { - "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id\".", + "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, @@ -2467,6 +2513,14 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, + "ipRules": { + "$ref": "IpRules", + "description": "IP rules associated with the finding." + }, + "job": { + "$ref": "Job", + "description": "Job associated with the finding." + }, "kernelRootkit": { "$ref": "KernelRootkit", "description": "Signature of the kernel rootkit." @@ -2532,6 +2586,13 @@ "description": "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}\".", "type": "string" }, + "networks": { + "description": "Represents the VPC networks that the resource is attached to.", + "items": { + "$ref": "Network" + }, + "type": "array" + }, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -3791,6 +3852,20 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Allowed": { + "description": "Allowed IP rule.", + "id": "GoogleCloudSecuritycenterV2Allowed", + "properties": { + "ipRules": { + "description": "Optional. Optional list of allowed IP rules.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Application": { "description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", @@ -4619,6 +4694,24 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Cwe": { + "description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", + "id": "GoogleCloudSecuritycenterV2Cwe", + "properties": { + "id": { + "description": "The CWE identifier, e.g. CWE-94", + "type": "string" + }, + "references": { + "description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Reference" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2DataAccessEvent": { "description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataAccessEvent", @@ -4722,7 +4815,7 @@ "type": "string" }, "maxRetentionAllowed": { - "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", + "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" } @@ -4763,6 +4856,20 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Denied": { + "description": "Denied IP rule.", + "id": "GoogleCloudSecuritycenterV2Denied", + "properties": { + "ipRules": { + "description": "Optional. Optional list of denied IP rules.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", @@ -4784,7 +4891,7 @@ "id": "GoogleCloudSecuritycenterV2Disk", "properties": { "name": { - "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id\".", + "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, @@ -5156,6 +5263,14 @@ "$ref": "GoogleCloudSecuritycenterV2Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, + "ipRules": { + "$ref": "GoogleCloudSecuritycenterV2IpRules", + "description": "IP rules associated with the finding." + }, + "job": { + "$ref": "GoogleCloudSecuritycenterV2Job", + "description": "Job associated with the finding." + }, "kernelRootkit": { "$ref": "GoogleCloudSecuritycenterV2KernelRootkit", "description": "Signature of the kernel rootkit." @@ -5221,6 +5336,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, + "networks": { + "description": "Represents the VPC networks that the resource is attached to.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Network" + }, + "type": "array" + }, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -5429,6 +5551,74 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IpRule": { + "description": "IP rule information.", + "id": "GoogleCloudSecuritycenterV2IpRule", + "properties": { + "portRanges": { + "description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2PortRange" + }, + "type": "array" + }, + "protocol": { + "description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IpRules": { + "description": "IP rules associated with the finding.", + "id": "GoogleCloudSecuritycenterV2IpRules", + "properties": { + "allowed": { + "$ref": "GoogleCloudSecuritycenterV2Allowed", + "description": "Tuple with allowed rules." + }, + "denied": { + "$ref": "GoogleCloudSecuritycenterV2Denied", + "description": "Tuple with denied rules." + }, + "destinationIpRanges": { + "description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + }, + "direction": { + "description": "The direction that the rule is applicable to, one of ingress or egress.", + "enum": [ + "DIRECTION_UNSPECIFIED", + "INGRESS", + "EGRESS" + ], + "enumDescriptions": [ + "Unspecified direction value.", + "Ingress direction value.", + "Egress direction value." + ], + "type": "string" + }, + "exposedServices": { + "description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceIpRanges": { + "description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Issue": { "description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", @@ -5826,6 +6016,45 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Job": { + "description": "Describes a job", + "id": "GoogleCloudSecuritycenterV2Job", + "properties": { + "errorCode": { + "description": "Optional. If the job did not complete successfully, this field describes why.", + "format": "int32", + "type": "integer" + }, + "location": { + "description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", + "type": "string" + }, + "name": { + "description": "The fully-qualified name for a job. e.g. `projects//jobs/`", + "type": "string" + }, + "state": { + "description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", + "enum": [ + "JOB_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified represents an unknown state and should not be used.", + "Job is scheduled and pending for run", + "Job in progress", + "Job has completed with success", + "Job has completed but with failure" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", @@ -6030,6 +6259,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -6055,6 +6285,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -6064,6 +6295,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -6099,6 +6331,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -6124,6 +6357,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -6133,6 +6367,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -6213,6 +6448,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -6238,6 +6474,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -6247,6 +6484,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -6282,6 +6520,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -6307,6 +6546,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -6316,6 +6556,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -6433,6 +6674,17 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Network": { + "description": "Contains information about a VPC network associated with the finding.", + "id": "GoogleCloudSecuritycenterV2Network", + "properties": { + "name": { + "description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -6540,7 +6792,7 @@ "id": "GoogleCloudSecuritycenterV2OrgPolicy", "properties": { "name": { - "description": "The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", + "description": "Identifier. The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, @@ -6617,6 +6869,23 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2PortRange": { + "description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", + "id": "GoogleCloudSecuritycenterV2PortRange", + "properties": { + "max": { + "description": "Maximum port value.", + "format": "int64", + "type": "string" + }, + "min": { + "description": "Minimum port value.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Process": { "description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", @@ -7261,6 +7530,13 @@ "$ref": "GoogleCloudSecuritycenterV2Cve", "description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" }, + "cwes": { + "description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Cwe" + }, + "type": "array" + }, "fixedPackage": { "$ref": "GoogleCloudSecuritycenterV2Package", "description": "The fixed package is relevant to the finding." @@ -7269,6 +7545,15 @@ "$ref": "GoogleCloudSecuritycenterV2Package", "description": "The offending package is relevant to the finding." }, + "providerRiskScore": { + "description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", + "format": "int64", + "type": "string" + }, + "reachable": { + "description": "Represents whether the vulnerability is reachable (detected via static analysis)", + "type": "boolean" + }, "securityBulletin": { "$ref": "GoogleCloudSecuritycenterV2SecurityBulletin", "description": "The security bulletin is relevant to this finding." @@ -7502,6 +7787,113 @@ }, "type": "object" }, + "IpRule": { + "description": "IP rule information.", + "id": "IpRule", + "properties": { + "portRanges": { + "description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", + "items": { + "$ref": "PortRange" + }, + "type": "array" + }, + "protocol": { + "description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", + "type": "string" + } + }, + "type": "object" + }, + "IpRules": { + "description": "IP rules associated with the finding.", + "id": "IpRules", + "properties": { + "allowed": { + "$ref": "Allowed", + "description": "Tuple with allowed rules." + }, + "denied": { + "$ref": "Denied", + "description": "Tuple with denied rules." + }, + "destinationIpRanges": { + "description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + }, + "direction": { + "description": "The direction that the rule is applicable to, one of ingress or egress.", + "enum": [ + "DIRECTION_UNSPECIFIED", + "INGRESS", + "EGRESS" + ], + "enumDescriptions": [ + "Unspecified direction value.", + "Ingress direction value.", + "Egress direction value." + ], + "type": "string" + }, + "exposedServices": { + "description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceIpRanges": { + "description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Job": { + "description": "Describes a job", + "id": "Job", + "properties": { + "errorCode": { + "description": "Optional. If the job did not complete successfully, this field describes why.", + "format": "int32", + "type": "integer" + }, + "location": { + "description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", + "type": "string" + }, + "name": { + "description": "The fully-qualified name for a job. e.g. `projects//jobs/`", + "type": "string" + }, + "state": { + "description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", + "enum": [ + "JOB_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified represents an unknown state and should not be used.", + "Job is scheduled and pending for run", + "Job in progress", + "Job has completed with success", + "Job has completed but with failure" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", @@ -7827,6 +8219,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -7852,6 +8245,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -7861,6 +8255,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -7896,6 +8291,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -7921,6 +8317,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -7930,6 +8327,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -8010,6 +8408,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -8035,6 +8434,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -8044,6 +8444,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -8079,6 +8480,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -8104,6 +8506,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -8113,6 +8516,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -8175,6 +8579,17 @@ }, "type": "object" }, + "Network": { + "description": "Contains information about a VPC network associated with the finding.", + "id": "Network", + "properties": { + "name": { + "description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", + "type": "string" + } + }, + "type": "object" + }, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -8425,6 +8840,23 @@ }, "type": "object" }, + "PortRange": { + "description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", + "id": "PortRange", + "properties": { + "max": { + "description": "Maximum port value.", + "format": "int64", + "type": "string" + }, + "min": { + "description": "Minimum port value.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Process": { "description": "Represents an operating system process.", "id": "Process", @@ -9028,6 +9460,13 @@ "$ref": "Cve", "description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" }, + "cwes": { + "description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", + "items": { + "$ref": "Cwe" + }, + "type": "array" + }, "fixedPackage": { "$ref": "Package", "description": "The fixed package is relevant to the finding." @@ -9036,6 +9475,15 @@ "$ref": "Package", "description": "The offending package is relevant to the finding." }, + "providerRiskScore": { + "description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", + "format": "int64", + "type": "string" + }, + "reachable": { + "description": "Represents whether the vulnerability is reachable (detected via static analysis)", + "type": "boolean" + }, "securityBulletin": { "$ref": "SecurityBulletin", "description": "The security bulletin is relevant to this finding." diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index d680ad94374..2503342b09e 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -2003,7 +2003,7 @@ } } }, - "revision": "20250116", + "revision": "20250308", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2107,6 +2107,20 @@ }, "type": "object" }, + "Allowed": { + "description": "Allowed IP rule.", + "id": "Allowed", + "properties": { + "ipRules": { + "description": "Optional. Optional list of allowed IP rules.", + "items": { + "$ref": "IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "Application": { "description": "Represents an application associated with a finding.", "id": "Application", @@ -2987,6 +3001,24 @@ }, "type": "object" }, + "Cwe": { + "description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", + "id": "Cwe", + "properties": { + "id": { + "description": "The CWE identifier, e.g. CWE-94", + "type": "string" + }, + "references": { + "description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", + "items": { + "$ref": "Reference" + }, + "type": "array" + } + }, + "type": "object" + }, "DataAccessEvent": { "description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "DataAccessEvent", @@ -3090,7 +3122,7 @@ "type": "string" }, "maxRetentionAllowed": { - "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", + "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" } @@ -3131,6 +3163,20 @@ }, "type": "object" }, + "Denied": { + "description": "Denied IP rule.", + "id": "Denied", + "properties": { + "ipRules": { + "description": "Optional. Optional list of denied IP rules.", + "items": { + "$ref": "IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "Details": { "description": "Details of a subscription.", "id": "Details", @@ -3189,7 +3235,7 @@ "id": "Disk", "properties": { "name": { - "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id\".", + "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, @@ -3564,6 +3610,14 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, + "ipRules": { + "$ref": "IpRules", + "description": "IP rules associated with the finding." + }, + "job": { + "$ref": "Job", + "description": "Job associated with the finding." + }, "kernelRootkit": { "$ref": "KernelRootkit", "description": "Signature of the kernel rootkit." @@ -3629,6 +3683,13 @@ "description": "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}\".", "type": "string" }, + "networks": { + "description": "Represents the VPC networks that the resource is attached to.", + "items": { + "$ref": "Network" + }, + "type": "array" + }, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -4784,6 +4845,20 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Allowed": { + "description": "Allowed IP rule.", + "id": "GoogleCloudSecuritycenterV2Allowed", + "properties": { + "ipRules": { + "description": "Optional. Optional list of allowed IP rules.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Application": { "description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", @@ -5612,6 +5687,24 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Cwe": { + "description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", + "id": "GoogleCloudSecuritycenterV2Cwe", + "properties": { + "id": { + "description": "The CWE identifier, e.g. CWE-94", + "type": "string" + }, + "references": { + "description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Reference" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2DataAccessEvent": { "description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataAccessEvent", @@ -5715,7 +5808,7 @@ "type": "string" }, "maxRetentionAllowed": { - "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", + "description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" } @@ -5756,6 +5849,20 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Denied": { + "description": "Denied IP rule.", + "id": "GoogleCloudSecuritycenterV2Denied", + "properties": { + "ipRules": { + "description": "Optional. Optional list of denied IP rules.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IpRule" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Detection": { "description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", @@ -5777,7 +5884,7 @@ "id": "GoogleCloudSecuritycenterV2Disk", "properties": { "name": { - "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id\".", + "description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, @@ -6149,6 +6256,14 @@ "$ref": "GoogleCloudSecuritycenterV2Indicator", "description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." }, + "ipRules": { + "$ref": "GoogleCloudSecuritycenterV2IpRules", + "description": "IP rules associated with the finding." + }, + "job": { + "$ref": "GoogleCloudSecuritycenterV2Job", + "description": "Job associated with the finding." + }, "kernelRootkit": { "$ref": "GoogleCloudSecuritycenterV2KernelRootkit", "description": "Signature of the kernel rootkit." @@ -6214,6 +6329,13 @@ "description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, + "networks": { + "description": "Represents the VPC networks that the resource is attached to.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Network" + }, + "type": "array" + }, "nextSteps": { "description": "Steps to address the finding.", "type": "string" @@ -6422,6 +6544,74 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IpRule": { + "description": "IP rule information.", + "id": "GoogleCloudSecuritycenterV2IpRule", + "properties": { + "portRanges": { + "description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2PortRange" + }, + "type": "array" + }, + "protocol": { + "description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IpRules": { + "description": "IP rules associated with the finding.", + "id": "GoogleCloudSecuritycenterV2IpRules", + "properties": { + "allowed": { + "$ref": "GoogleCloudSecuritycenterV2Allowed", + "description": "Tuple with allowed rules." + }, + "denied": { + "$ref": "GoogleCloudSecuritycenterV2Denied", + "description": "Tuple with denied rules." + }, + "destinationIpRanges": { + "description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + }, + "direction": { + "description": "The direction that the rule is applicable to, one of ingress or egress.", + "enum": [ + "DIRECTION_UNSPECIFIED", + "INGRESS", + "EGRESS" + ], + "enumDescriptions": [ + "Unspecified direction value.", + "Ingress direction value.", + "Egress direction value." + ], + "type": "string" + }, + "exposedServices": { + "description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceIpRanges": { + "description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Issue": { "description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", @@ -6819,6 +7009,45 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Job": { + "description": "Describes a job", + "id": "GoogleCloudSecuritycenterV2Job", + "properties": { + "errorCode": { + "description": "Optional. If the job did not complete successfully, this field describes why.", + "format": "int32", + "type": "integer" + }, + "location": { + "description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", + "type": "string" + }, + "name": { + "description": "The fully-qualified name for a job. e.g. `projects//jobs/`", + "type": "string" + }, + "state": { + "description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", + "enum": [ + "JOB_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified represents an unknown state and should not be used.", + "Job is scheduled and pending for run", + "Job in progress", + "Job has completed with success", + "Job has completed but with failure" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", @@ -7023,6 +7252,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -7048,6 +7278,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -7057,6 +7288,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -7092,6 +7324,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -7117,6 +7350,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -7126,6 +7360,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -7206,6 +7441,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -7231,6 +7467,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -7240,6 +7477,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -7275,6 +7513,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -7300,6 +7539,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -7309,6 +7549,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -7426,6 +7667,17 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2Network": { + "description": "Contains information about a VPC network associated with the finding.", + "id": "GoogleCloudSecuritycenterV2Network", + "properties": { + "name": { + "description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -7533,7 +7785,7 @@ "id": "GoogleCloudSecuritycenterV2OrgPolicy", "properties": { "name": { - "description": "The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", + "description": "Identifier. The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, @@ -7610,6 +7862,23 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2PortRange": { + "description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", + "id": "GoogleCloudSecuritycenterV2PortRange", + "properties": { + "max": { + "description": "Maximum port value.", + "format": "int64", + "type": "string" + }, + "min": { + "description": "Minimum port value.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Process": { "description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", @@ -8254,6 +8523,13 @@ "$ref": "GoogleCloudSecuritycenterV2Cve", "description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" }, + "cwes": { + "description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2Cwe" + }, + "type": "array" + }, "fixedPackage": { "$ref": "GoogleCloudSecuritycenterV2Package", "description": "The fixed package is relevant to the finding." @@ -8262,6 +8538,15 @@ "$ref": "GoogleCloudSecuritycenterV2Package", "description": "The offending package is relevant to the finding." }, + "providerRiskScore": { + "description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", + "format": "int64", + "type": "string" + }, + "reachable": { + "description": "Represents whether the vulnerability is reachable (detected via static analysis)", + "type": "boolean" + }, "securityBulletin": { "$ref": "GoogleCloudSecuritycenterV2SecurityBulletin", "description": "The security bulletin is relevant to this finding." @@ -8367,6 +8652,113 @@ }, "type": "object" }, + "IpRule": { + "description": "IP rule information.", + "id": "IpRule", + "properties": { + "portRanges": { + "description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", + "items": { + "$ref": "PortRange" + }, + "type": "array" + }, + "protocol": { + "description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", + "type": "string" + } + }, + "type": "object" + }, + "IpRules": { + "description": "IP rules associated with the finding.", + "id": "IpRules", + "properties": { + "allowed": { + "$ref": "Allowed", + "description": "Tuple with allowed rules." + }, + "denied": { + "$ref": "Denied", + "description": "Tuple with denied rules." + }, + "destinationIpRanges": { + "description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + }, + "direction": { + "description": "The direction that the rule is applicable to, one of ingress or egress.", + "enum": [ + "DIRECTION_UNSPECIFIED", + "INGRESS", + "EGRESS" + ], + "enumDescriptions": [ + "Unspecified direction value.", + "Ingress direction value.", + "Egress direction value." + ], + "type": "string" + }, + "exposedServices": { + "description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceIpRanges": { + "description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Job": { + "description": "Describes a job", + "id": "Job", + "properties": { + "errorCode": { + "description": "Optional. If the job did not complete successfully, this field describes why.", + "format": "int32", + "type": "integer" + }, + "location": { + "description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", + "type": "string" + }, + "name": { + "description": "The fully-qualified name for a job. e.g. `projects//jobs/`", + "type": "string" + }, + "state": { + "description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", + "enum": [ + "JOB_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified represents an unknown state and should not be used.", + "Job is scheduled and pending for run", + "Job in progress", + "Job has completed with success", + "Job has completed but with failure" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "KernelRootkit": { "description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", @@ -8571,6 +8963,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -8596,6 +8989,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -8605,6 +8999,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -8640,6 +9035,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -8665,6 +9061,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -8674,6 +9071,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -8754,6 +9152,7 @@ "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", + "AUTOMATED_EXFILTRATION", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", @@ -8779,6 +9178,7 @@ "MULTI_HOP_PROXY", "ACCOUNT_MANIPULATION", "ADDITIONAL_CLOUD_CREDENTIALS", + "ADDITIONAL_CLOUD_ROLES", "SSH_AUTHORIZED_KEYS", "ADDITIONAL_CONTAINER_CLUSTER_ROLES", "INGRESS_TOOL_TRANSFER", @@ -8788,6 +9188,7 @@ "ACCESS_TOKEN_MANIPULATION", "TOKEN_IMPERSONATION_OR_THEFT", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "SERVICE_STOP", @@ -8823,6 +9224,7 @@ ], "enumDescriptions": [ "Unspecified value.", + "T1020", "T1036", "T1036.005", "T1037", @@ -8848,6 +9250,7 @@ "T1090.003", "T1098", "T1098.001", + "T1098.003", "T1098.004", "T1098.006", "T1105", @@ -8857,6 +9260,7 @@ "T1134", "T1134.001", "T1190", + "T1204", "T1484", "T1485", "T1489", @@ -8919,6 +9323,17 @@ }, "type": "object" }, + "Network": { + "description": "Contains information about a VPC network associated with the finding.", + "id": "Network", + "properties": { + "name": { + "description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", + "type": "string" + } + }, + "type": "object" + }, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -9084,6 +9499,23 @@ }, "type": "object" }, + "PortRange": { + "description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", + "id": "PortRange", + "properties": { + "max": { + "description": "Maximum port value.", + "format": "int64", + "type": "string" + }, + "min": { + "description": "Minimum port value.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Process": { "description": "Represents an operating system process.", "id": "Process", @@ -9724,6 +10156,13 @@ "$ref": "Cve", "description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" }, + "cwes": { + "description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", + "items": { + "$ref": "Cwe" + }, + "type": "array" + }, "fixedPackage": { "$ref": "Package", "description": "The fixed package is relevant to the finding." @@ -9732,6 +10171,15 @@ "$ref": "Package", "description": "The offending package is relevant to the finding." }, + "providerRiskScore": { + "description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", + "format": "int64", + "type": "string" + }, + "reachable": { + "description": "Represents whether the vulnerability is reachable (detected via static analysis)", + "type": "boolean" + }, "securityBulletin": { "$ref": "SecurityBulletin", "description": "The security bulletin is relevant to this finding." diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 98a6f9e1329..e6abbacdd90 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -219,6 +219,15 @@ export namespace securitycenter_v1 { */ confidence?: number | null; } + /** + * Allowed IP rule. + */ + export interface Schema$Allowed { + /** + * Optional. Optional list of allowed IP rules. + */ + ipRules?: Schema$IpRule[]; + } /** * Represents an application associated with a finding. */ @@ -1008,6 +1017,19 @@ export namespace securitycenter_v1 { */ userInteraction?: string | null; } + /** + * CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). + */ + export interface Schema$Cwe { + /** + * The CWE identifier, e.g. CWE-94 + */ + id?: string | null; + /** + * Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html + */ + references?: Schema$Reference[]; + } /** * Details about a data access attempt made by a principal not authorized under applicable data security policy. */ @@ -1100,10 +1122,19 @@ export namespace securitycenter_v1 { */ eventType?: string | null; /** - * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. + * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. */ maxRetentionAllowed?: string | null; } + /** + * Denied IP rule. + */ + export interface Schema$Denied { + /** + * Optional. Optional list of denied IP rules. + */ + ipRules?: Schema$IpRule[]; + } /** * Memory hash detection contributing to the binary family match. */ @@ -1122,7 +1153,7 @@ export namespace securitycenter_v1 { */ export interface Schema$Disk { /** - * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id". + * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id\}/zones/{zone-id\}/disks/{disk-id\}". */ name?: string | null; } @@ -1453,6 +1484,14 @@ export namespace securitycenter_v1 { * Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). */ indicator?: Schema$Indicator; + /** + * IP rules associated with the finding. + */ + ipRules?: Schema$IpRules; + /** + * Job associated with the finding. + */ + job?: Schema$Job; /** * Signature of the kernel rootkit. */ @@ -1497,6 +1536,10 @@ export namespace securitycenter_v1 { * 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 | null; + /** + * Represents the VPC networks that the resource is attached to. + */ + networks?: Schema$Network[]; /** * Steps to address the finding. */ @@ -2304,6 +2347,15 @@ export namespace securitycenter_v1 { */ confidence?: number | null; } + /** + * Allowed IP rule. + */ + export interface Schema$GoogleCloudSecuritycenterV2Allowed { + /** + * Optional. Optional list of allowed IP rules. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRule[]; + } /** * Represents an application associated with a finding. */ @@ -2862,6 +2914,19 @@ export namespace securitycenter_v1 { */ userInteraction?: string | null; } + /** + * CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). + */ + export interface Schema$GoogleCloudSecuritycenterV2Cwe { + /** + * The CWE identifier, e.g. CWE-94 + */ + id?: string | null; + /** + * Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html + */ + references?: Schema$GoogleCloudSecuritycenterV2Reference[]; + } /** * Details about a data access attempt made by a principal not authorized under applicable data security policy. */ @@ -2954,10 +3019,19 @@ export namespace securitycenter_v1 { */ eventType?: string | null; /** - * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. + * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. */ maxRetentionAllowed?: string | null; } + /** + * Denied IP rule. + */ + export interface Schema$GoogleCloudSecuritycenterV2Denied { + /** + * Optional. Optional list of denied IP rules. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRule[]; + } /** * Memory hash detection contributing to the binary family match. */ @@ -2976,7 +3050,7 @@ export namespace securitycenter_v1 { */ export interface Schema$GoogleCloudSecuritycenterV2Disk { /** - * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id". + * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id\}/zones/{zone-id\}/disks/{disk-id\}". */ name?: string | null; } @@ -3255,6 +3329,14 @@ export namespace securitycenter_v1 { * Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). */ indicator?: Schema$GoogleCloudSecuritycenterV2Indicator; + /** + * IP rules associated with the finding. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRules; + /** + * Job associated with the finding. + */ + job?: Schema$GoogleCloudSecuritycenterV2Job; /** * Signature of the kernel rootkit. */ @@ -3299,6 +3381,10 @@ export namespace securitycenter_v1 { * The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}` + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` */ name?: string | null; + /** + * Represents the VPC networks that the resource is attached to. + */ + networks?: Schema$GoogleCloudSecuritycenterV2Network[]; /** * Steps to address the finding. */ @@ -3429,6 +3515,48 @@ export namespace securitycenter_v1 { */ uris?: string[] | null; } + /** + * IP rule information. + */ + export interface Schema$GoogleCloudSecuritycenterV2IpRule { + /** + * Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + */ + portRanges?: Schema$GoogleCloudSecuritycenterV2PortRange[]; + /** + * The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + */ + protocol?: string | null; + } + /** + * IP rules associated with the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2IpRules { + /** + * Tuple with allowed rules. + */ + allowed?: Schema$GoogleCloudSecuritycenterV2Allowed; + /** + * Tuple with denied rules. + */ + denied?: Schema$GoogleCloudSecuritycenterV2Denied; + /** + * If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + destinationIpRanges?: string[] | null; + /** + * The direction that the rule is applicable to, one of ingress or egress. + */ + direction?: string | null; + /** + * Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + */ + exposedServices?: string[] | null; + /** + * If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + sourceIpRanges?: string[] | null; + } /** * Security Command Center Issue. */ @@ -3692,6 +3820,27 @@ export namespace securitycenter_v1 { */ values?: string[] | null; } + /** + * Describes a job + */ + export interface Schema$GoogleCloudSecuritycenterV2Job { + /** + * Optional. If the job did not complete successfully, this field describes why. + */ + errorCode?: number | null; + /** + * Optional. Gives the location where the job ran, such as `US` or `europe-west1` + */ + location?: string | null; + /** + * The fully-qualified name for a job. e.g. `projects//jobs/` + */ + name?: string | null; + /** + * Output only. State of the job, such as `RUNNING` or `PENDING`. + */ + state?: string | null; + } /** * Kernel mode rootkit signatures. */ @@ -3885,6 +4034,15 @@ export namespace securitycenter_v1 { */ staticMute?: Schema$GoogleCloudSecuritycenterV2StaticMute; } + /** + * Contains information about a VPC network associated with the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2Network { + /** + * The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + */ + name?: string | null; + } /** * Kubernetes nodes associated with the finding. */ @@ -3975,7 +4133,7 @@ export namespace securitycenter_v1 { */ export interface Schema$GoogleCloudSecuritycenterV2OrgPolicy { /** - * The resource name of the org policy. Example: "organizations/{organization_id\}/policies/{constraint_name\}" + * Identifier. The resource name of the org policy. Example: "organizations/{organization_id\}/policies/{constraint_name\}" */ name?: string | null; } @@ -4038,6 +4196,19 @@ export namespace securitycenter_v1 { */ field?: string | null; } + /** + * A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + */ + export interface Schema$GoogleCloudSecuritycenterV2PortRange { + /** + * Maximum port value. + */ + max?: string | null; + /** + * Minimum port value. + */ + min?: string | null; + } /** * Represents an operating system process. */ @@ -4469,6 +4640,10 @@ export namespace securitycenter_v1 { * CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) */ cve?: Schema$GoogleCloudSecuritycenterV2Cve; + /** + * Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. + */ + cwes?: Schema$GoogleCloudSecuritycenterV2Cwe[]; /** * The fixed package is relevant to the finding. */ @@ -4477,6 +4652,14 @@ export namespace securitycenter_v1 { * The offending package is relevant to the finding. */ offendingPackage?: Schema$GoogleCloudSecuritycenterV2Package; + /** + * Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. + */ + providerRiskScore?: string | null; + /** + * Represents whether the vulnerability is reachable (detected via static analysis) + */ + reachable?: boolean | null; /** * The security bulletin is relevant to this finding. */ @@ -4664,6 +4847,69 @@ export namespace securitycenter_v1 { */ uris?: string[] | null; } + /** + * IP rule information. + */ + export interface Schema$IpRule { + /** + * Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + */ + portRanges?: Schema$PortRange[]; + /** + * The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + */ + protocol?: string | null; + } + /** + * IP rules associated with the finding. + */ + export interface Schema$IpRules { + /** + * Tuple with allowed rules. + */ + allowed?: Schema$Allowed; + /** + * Tuple with denied rules. + */ + denied?: Schema$Denied; + /** + * If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + destinationIpRanges?: string[] | null; + /** + * The direction that the rule is applicable to, one of ingress or egress. + */ + direction?: string | null; + /** + * Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + */ + exposedServices?: string[] | null; + /** + * If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + sourceIpRanges?: string[] | null; + } + /** + * Describes a job + */ + export interface Schema$Job { + /** + * Optional. If the job did not complete successfully, this field describes why. + */ + errorCode?: number | null; + /** + * Optional. Gives the location where the job ran, such as `US` or `europe-west1` + */ + location?: string | null; + /** + * The fully-qualified name for a job. e.g. `projects//jobs/` + */ + name?: string | null; + /** + * Output only. State of the job, such as `RUNNING` or `PENDING`. + */ + state?: string | null; + } /** * Kernel mode rootkit signatures. */ @@ -5078,6 +5324,15 @@ export namespace securitycenter_v1 { */ staticMute?: Schema$StaticMute; } + /** + * Contains information about a VPC network associated with the finding. + */ + export interface Schema$Network { + /** + * The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + */ + name?: string | null; + } /** * Kubernetes nodes associated with the finding. */ @@ -5319,6 +5574,19 @@ export namespace securitycenter_v1 { */ field?: string | null; } + /** + * A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + */ + export interface Schema$PortRange { + /** + * Maximum port value. + */ + max?: string | null; + /** + * Minimum port value. + */ + min?: string | null; + } /** * A position in the uploaded text version of a module. */ @@ -6001,6 +6269,10 @@ export namespace securitycenter_v1 { * CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) */ cve?: Schema$Cve; + /** + * Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. + */ + cwes?: Schema$Cwe[]; /** * The fixed package is relevant to the finding. */ @@ -6009,6 +6281,14 @@ export namespace securitycenter_v1 { * The offending package is relevant to the finding. */ offendingPackage?: Schema$Package; + /** + * Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. + */ + providerRiskScore?: string | null; + /** + * Represents whether the vulnerability is reachable (detected via static analysis) + */ + reachable?: boolean | null; /** * The security bulletin is relevant to this finding. */ diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index d0eee460e61..757eac361e3 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -215,6 +215,15 @@ export namespace securitycenter_v1beta1 { */ confidence?: number | null; } + /** + * Allowed IP rule. + */ + export interface Schema$Allowed { + /** + * Optional. Optional list of allowed IP rules. + */ + ipRules?: Schema$IpRule[]; + } /** * Represents an application associated with a finding. */ @@ -837,6 +846,19 @@ export namespace securitycenter_v1beta1 { */ userInteraction?: string | null; } + /** + * CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). + */ + export interface Schema$Cwe { + /** + * The CWE identifier, e.g. CWE-94 + */ + id?: string | null; + /** + * Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html + */ + references?: Schema$Reference[]; + } /** * Details about a data access attempt made by a principal not authorized under applicable data security policy. */ @@ -929,10 +951,19 @@ export namespace securitycenter_v1beta1 { */ eventType?: string | null; /** - * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. + * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. */ maxRetentionAllowed?: string | null; } + /** + * Denied IP rule. + */ + export interface Schema$Denied { + /** + * Optional. Optional list of denied IP rules. + */ + ipRules?: Schema$IpRule[]; + } /** * Memory hash detection contributing to the binary family match. */ @@ -951,7 +982,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$Disk { /** - * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id". + * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id\}/zones/{zone-id\}/disks/{disk-id\}". */ name?: string | null; } @@ -1204,6 +1235,14 @@ export namespace securitycenter_v1beta1 { * Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). */ indicator?: Schema$Indicator; + /** + * IP rules associated with the finding. + */ + ipRules?: Schema$IpRules; + /** + * Job associated with the finding. + */ + job?: Schema$Job; /** * Signature of the kernel rootkit. */ @@ -1248,6 +1287,10 @@ export namespace securitycenter_v1beta1 { * 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 | null; + /** + * Represents the VPC networks that the resource is attached to. + */ + networks?: Schema$Network[]; /** * Steps to address the finding. */ @@ -2113,6 +2156,15 @@ export namespace securitycenter_v1beta1 { */ confidence?: number | null; } + /** + * Allowed IP rule. + */ + export interface Schema$GoogleCloudSecuritycenterV2Allowed { + /** + * Optional. Optional list of allowed IP rules. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRule[]; + } /** * Represents an application associated with a finding. */ @@ -2671,6 +2723,19 @@ export namespace securitycenter_v1beta1 { */ userInteraction?: string | null; } + /** + * CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). + */ + export interface Schema$GoogleCloudSecuritycenterV2Cwe { + /** + * The CWE identifier, e.g. CWE-94 + */ + id?: string | null; + /** + * Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html + */ + references?: Schema$GoogleCloudSecuritycenterV2Reference[]; + } /** * Details about a data access attempt made by a principal not authorized under applicable data security policy. */ @@ -2763,10 +2828,19 @@ export namespace securitycenter_v1beta1 { */ eventType?: string | null; /** - * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. + * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. */ maxRetentionAllowed?: string | null; } + /** + * Denied IP rule. + */ + export interface Schema$GoogleCloudSecuritycenterV2Denied { + /** + * Optional. Optional list of denied IP rules. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRule[]; + } /** * Memory hash detection contributing to the binary family match. */ @@ -2785,7 +2859,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GoogleCloudSecuritycenterV2Disk { /** - * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id". + * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id\}/zones/{zone-id\}/disks/{disk-id\}". */ name?: string | null; } @@ -3064,6 +3138,14 @@ export namespace securitycenter_v1beta1 { * Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). */ indicator?: Schema$GoogleCloudSecuritycenterV2Indicator; + /** + * IP rules associated with the finding. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRules; + /** + * Job associated with the finding. + */ + job?: Schema$GoogleCloudSecuritycenterV2Job; /** * Signature of the kernel rootkit. */ @@ -3108,6 +3190,10 @@ export namespace securitycenter_v1beta1 { * The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}` + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` */ name?: string | null; + /** + * Represents the VPC networks that the resource is attached to. + */ + networks?: Schema$GoogleCloudSecuritycenterV2Network[]; /** * Steps to address the finding. */ @@ -3238,6 +3324,48 @@ export namespace securitycenter_v1beta1 { */ uris?: string[] | null; } + /** + * IP rule information. + */ + export interface Schema$GoogleCloudSecuritycenterV2IpRule { + /** + * Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + */ + portRanges?: Schema$GoogleCloudSecuritycenterV2PortRange[]; + /** + * The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + */ + protocol?: string | null; + } + /** + * IP rules associated with the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2IpRules { + /** + * Tuple with allowed rules. + */ + allowed?: Schema$GoogleCloudSecuritycenterV2Allowed; + /** + * Tuple with denied rules. + */ + denied?: Schema$GoogleCloudSecuritycenterV2Denied; + /** + * If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + destinationIpRanges?: string[] | null; + /** + * The direction that the rule is applicable to, one of ingress or egress. + */ + direction?: string | null; + /** + * Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + */ + exposedServices?: string[] | null; + /** + * If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + sourceIpRanges?: string[] | null; + } /** * Security Command Center Issue. */ @@ -3501,6 +3629,27 @@ export namespace securitycenter_v1beta1 { */ values?: string[] | null; } + /** + * Describes a job + */ + export interface Schema$GoogleCloudSecuritycenterV2Job { + /** + * Optional. If the job did not complete successfully, this field describes why. + */ + errorCode?: number | null; + /** + * Optional. Gives the location where the job ran, such as `US` or `europe-west1` + */ + location?: string | null; + /** + * The fully-qualified name for a job. e.g. `projects//jobs/` + */ + name?: string | null; + /** + * Output only. State of the job, such as `RUNNING` or `PENDING`. + */ + state?: string | null; + } /** * Kernel mode rootkit signatures. */ @@ -3694,6 +3843,15 @@ export namespace securitycenter_v1beta1 { */ staticMute?: Schema$GoogleCloudSecuritycenterV2StaticMute; } + /** + * Contains information about a VPC network associated with the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2Network { + /** + * The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + */ + name?: string | null; + } /** * Kubernetes nodes associated with the finding. */ @@ -3784,7 +3942,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GoogleCloudSecuritycenterV2OrgPolicy { /** - * The resource name of the org policy. Example: "organizations/{organization_id\}/policies/{constraint_name\}" + * Identifier. The resource name of the org policy. Example: "organizations/{organization_id\}/policies/{constraint_name\}" */ name?: string | null; } @@ -3847,6 +4005,19 @@ export namespace securitycenter_v1beta1 { */ field?: string | null; } + /** + * A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + */ + export interface Schema$GoogleCloudSecuritycenterV2PortRange { + /** + * Maximum port value. + */ + max?: string | null; + /** + * Minimum port value. + */ + min?: string | null; + } /** * Represents an operating system process. */ @@ -4278,6 +4449,10 @@ export namespace securitycenter_v1beta1 { * CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) */ cve?: Schema$GoogleCloudSecuritycenterV2Cve; + /** + * Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. + */ + cwes?: Schema$GoogleCloudSecuritycenterV2Cwe[]; /** * The fixed package is relevant to the finding. */ @@ -4286,6 +4461,14 @@ export namespace securitycenter_v1beta1 { * The offending package is relevant to the finding. */ offendingPackage?: Schema$GoogleCloudSecuritycenterV2Package; + /** + * Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. + */ + providerRiskScore?: string | null; + /** + * Represents whether the vulnerability is reachable (detected via static analysis) + */ + reachable?: boolean | null; /** * The security bulletin is relevant to this finding. */ @@ -4452,6 +4635,69 @@ export namespace securitycenter_v1beta1 { */ uris?: string[] | null; } + /** + * IP rule information. + */ + export interface Schema$IpRule { + /** + * Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + */ + portRanges?: Schema$PortRange[]; + /** + * The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + */ + protocol?: string | null; + } + /** + * IP rules associated with the finding. + */ + export interface Schema$IpRules { + /** + * Tuple with allowed rules. + */ + allowed?: Schema$Allowed; + /** + * Tuple with denied rules. + */ + denied?: Schema$Denied; + /** + * If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + destinationIpRanges?: string[] | null; + /** + * The direction that the rule is applicable to, one of ingress or egress. + */ + direction?: string | null; + /** + * Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + */ + exposedServices?: string[] | null; + /** + * If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + sourceIpRanges?: string[] | null; + } + /** + * Describes a job + */ + export interface Schema$Job { + /** + * Optional. If the job did not complete successfully, this field describes why. + */ + errorCode?: number | null; + /** + * Optional. Gives the location where the job ran, such as `US` or `europe-west1` + */ + location?: string | null; + /** + * The fully-qualified name for a job. e.g. `projects//jobs/` + */ + name?: string | null; + /** + * Output only. State of the job, such as `RUNNING` or `PENDING`. + */ + state?: string | null; + } /** * Kernel mode rootkit signatures. */ @@ -4689,6 +4935,15 @@ export namespace securitycenter_v1beta1 { */ staticMute?: Schema$StaticMute; } + /** + * Contains information about a VPC network associated with the finding. + */ + export interface Schema$Network { + /** + * The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + */ + name?: string | null; + } /** * Kubernetes nodes associated with the finding. */ @@ -4888,6 +5143,19 @@ export namespace securitycenter_v1beta1 { */ field?: string | null; } + /** + * A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + */ + export interface Schema$PortRange { + /** + * Maximum port value. + */ + max?: string | null; + /** + * Minimum port value. + */ + min?: string | null; + } /** * Represents an operating system process. */ @@ -5315,6 +5583,10 @@ export namespace securitycenter_v1beta1 { * CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) */ cve?: Schema$Cve; + /** + * Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. + */ + cwes?: Schema$Cwe[]; /** * The fixed package is relevant to the finding. */ @@ -5323,6 +5595,14 @@ export namespace securitycenter_v1beta1 { * The offending package is relevant to the finding. */ offendingPackage?: Schema$Package; + /** + * Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. + */ + providerRiskScore?: string | null; + /** + * Represents whether the vulnerability is reachable (detected via static analysis) + */ + reachable?: boolean | null; /** * The security bulletin is relevant to this finding. */ diff --git a/src/apis/securitycenter/v1beta2.ts b/src/apis/securitycenter/v1beta2.ts index fcf083b3553..f553cddaadb 100644 --- a/src/apis/securitycenter/v1beta2.ts +++ b/src/apis/securitycenter/v1beta2.ts @@ -219,6 +219,15 @@ export namespace securitycenter_v1beta2 { */ confidence?: number | null; } + /** + * Allowed IP rule. + */ + export interface Schema$Allowed { + /** + * Optional. Optional list of allowed IP rules. + */ + ipRules?: Schema$IpRule[]; + } /** * Represents an application associated with a finding. */ @@ -790,6 +799,19 @@ export namespace securitycenter_v1beta2 { */ userInteraction?: string | null; } + /** + * CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). + */ + export interface Schema$Cwe { + /** + * The CWE identifier, e.g. CWE-94 + */ + id?: string | null; + /** + * Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html + */ + references?: Schema$Reference[]; + } /** * Details about a data access attempt made by a principal not authorized under applicable data security policy. */ @@ -882,10 +904,19 @@ export namespace securitycenter_v1beta2 { */ eventType?: string | null; /** - * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. + * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. */ maxRetentionAllowed?: string | null; } + /** + * Denied IP rule. + */ + export interface Schema$Denied { + /** + * Optional. Optional list of denied IP rules. + */ + ipRules?: Schema$IpRule[]; + } /** * Details of a subscription. */ @@ -921,7 +952,7 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$Disk { /** - * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id". + * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id\}/zones/{zone-id\}/disks/{disk-id\}". */ name?: string | null; } @@ -1191,6 +1222,14 @@ export namespace securitycenter_v1beta2 { * Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). */ indicator?: Schema$Indicator; + /** + * IP rules associated with the finding. + */ + ipRules?: Schema$IpRules; + /** + * Job associated with the finding. + */ + job?: Schema$Job; /** * Signature of the kernel rootkit. */ @@ -1235,6 +1274,10 @@ export namespace securitycenter_v1beta2 { * 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 | null; + /** + * Represents the VPC networks that the resource is attached to. + */ + networks?: Schema$Network[]; /** * Steps to address the finding. */ @@ -2024,6 +2067,15 @@ export namespace securitycenter_v1beta2 { */ confidence?: number | null; } + /** + * Allowed IP rule. + */ + export interface Schema$GoogleCloudSecuritycenterV2Allowed { + /** + * Optional. Optional list of allowed IP rules. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRule[]; + } /** * Represents an application associated with a finding. */ @@ -2582,6 +2634,19 @@ export namespace securitycenter_v1beta2 { */ userInteraction?: string | null; } + /** + * CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). + */ + export interface Schema$GoogleCloudSecuritycenterV2Cwe { + /** + * The CWE identifier, e.g. CWE-94 + */ + id?: string | null; + /** + * Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html + */ + references?: Schema$GoogleCloudSecuritycenterV2Reference[]; + } /** * Details about a data access attempt made by a principal not authorized under applicable data security policy. */ @@ -2674,10 +2739,19 @@ export namespace securitycenter_v1beta2 { */ eventType?: string | null; /** - * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user set the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. + * Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. */ maxRetentionAllowed?: string | null; } + /** + * Denied IP rule. + */ + export interface Schema$GoogleCloudSecuritycenterV2Denied { + /** + * Optional. Optional list of denied IP rules. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRule[]; + } /** * Memory hash detection contributing to the binary family match. */ @@ -2696,7 +2770,7 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$GoogleCloudSecuritycenterV2Disk { /** - * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/project-id/zones/zone-id/disks/disk-id". + * The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id\}/zones/{zone-id\}/disks/{disk-id\}". */ name?: string | null; } @@ -2975,6 +3049,14 @@ export namespace securitycenter_v1beta2 { * Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). */ indicator?: Schema$GoogleCloudSecuritycenterV2Indicator; + /** + * IP rules associated with the finding. + */ + ipRules?: Schema$GoogleCloudSecuritycenterV2IpRules; + /** + * Job associated with the finding. + */ + job?: Schema$GoogleCloudSecuritycenterV2Job; /** * Signature of the kernel rootkit. */ @@ -3019,6 +3101,10 @@ export namespace securitycenter_v1beta2 { * The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}` + `organizations/{organization_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}` + `folders/{folder_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}` + `projects/{project_id\}/sources/{source_id\}/locations/{location_id\}/findings/{finding_id\}` */ name?: string | null; + /** + * Represents the VPC networks that the resource is attached to. + */ + networks?: Schema$GoogleCloudSecuritycenterV2Network[]; /** * Steps to address the finding. */ @@ -3149,6 +3235,48 @@ export namespace securitycenter_v1beta2 { */ uris?: string[] | null; } + /** + * IP rule information. + */ + export interface Schema$GoogleCloudSecuritycenterV2IpRule { + /** + * Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + */ + portRanges?: Schema$GoogleCloudSecuritycenterV2PortRange[]; + /** + * The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + */ + protocol?: string | null; + } + /** + * IP rules associated with the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2IpRules { + /** + * Tuple with allowed rules. + */ + allowed?: Schema$GoogleCloudSecuritycenterV2Allowed; + /** + * Tuple with denied rules. + */ + denied?: Schema$GoogleCloudSecuritycenterV2Denied; + /** + * If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + destinationIpRanges?: string[] | null; + /** + * The direction that the rule is applicable to, one of ingress or egress. + */ + direction?: string | null; + /** + * Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + */ + exposedServices?: string[] | null; + /** + * If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + sourceIpRanges?: string[] | null; + } /** * Security Command Center Issue. */ @@ -3412,6 +3540,27 @@ export namespace securitycenter_v1beta2 { */ values?: string[] | null; } + /** + * Describes a job + */ + export interface Schema$GoogleCloudSecuritycenterV2Job { + /** + * Optional. If the job did not complete successfully, this field describes why. + */ + errorCode?: number | null; + /** + * Optional. Gives the location where the job ran, such as `US` or `europe-west1` + */ + location?: string | null; + /** + * The fully-qualified name for a job. e.g. `projects//jobs/` + */ + name?: string | null; + /** + * Output only. State of the job, such as `RUNNING` or `PENDING`. + */ + state?: string | null; + } /** * Kernel mode rootkit signatures. */ @@ -3605,6 +3754,15 @@ export namespace securitycenter_v1beta2 { */ staticMute?: Schema$GoogleCloudSecuritycenterV2StaticMute; } + /** + * Contains information about a VPC network associated with the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2Network { + /** + * The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + */ + name?: string | null; + } /** * Kubernetes nodes associated with the finding. */ @@ -3695,7 +3853,7 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$GoogleCloudSecuritycenterV2OrgPolicy { /** - * The resource name of the org policy. Example: "organizations/{organization_id\}/policies/{constraint_name\}" + * Identifier. The resource name of the org policy. Example: "organizations/{organization_id\}/policies/{constraint_name\}" */ name?: string | null; } @@ -3758,6 +3916,19 @@ export namespace securitycenter_v1beta2 { */ field?: string | null; } + /** + * A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + */ + export interface Schema$GoogleCloudSecuritycenterV2PortRange { + /** + * Maximum port value. + */ + max?: string | null; + /** + * Minimum port value. + */ + min?: string | null; + } /** * Represents an operating system process. */ @@ -4189,6 +4360,10 @@ export namespace securitycenter_v1beta2 { * CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) */ cve?: Schema$GoogleCloudSecuritycenterV2Cve; + /** + * Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. + */ + cwes?: Schema$GoogleCloudSecuritycenterV2Cwe[]; /** * The fixed package is relevant to the finding. */ @@ -4197,6 +4372,14 @@ export namespace securitycenter_v1beta2 { * The offending package is relevant to the finding. */ offendingPackage?: Schema$GoogleCloudSecuritycenterV2Package; + /** + * Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. + */ + providerRiskScore?: string | null; + /** + * Represents whether the vulnerability is reachable (detected via static analysis) + */ + reachable?: boolean | null; /** * The security bulletin is relevant to this finding. */ @@ -4262,6 +4445,69 @@ export namespace securitycenter_v1beta2 { */ uris?: string[] | null; } + /** + * IP rule information. + */ + export interface Schema$IpRule { + /** + * Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. + */ + portRanges?: Schema$PortRange[]; + /** + * The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + */ + protocol?: string | null; + } + /** + * IP rules associated with the finding. + */ + export interface Schema$IpRules { + /** + * Tuple with allowed rules. + */ + allowed?: Schema$Allowed; + /** + * Tuple with denied rules. + */ + denied?: Schema$Denied; + /** + * If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + destinationIpRanges?: string[] | null; + /** + * The direction that the rule is applicable to, one of ingress or egress. + */ + direction?: string | null; + /** + * Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + */ + exposedServices?: string[] | null; + /** + * If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + */ + sourceIpRanges?: string[] | null; + } + /** + * Describes a job + */ + export interface Schema$Job { + /** + * Optional. If the job did not complete successfully, this field describes why. + */ + errorCode?: number | null; + /** + * Optional. Gives the location where the job ran, such as `US` or `europe-west1` + */ + location?: string | null; + /** + * The fully-qualified name for a job. e.g. `projects//jobs/` + */ + name?: string | null; + /** + * Output only. State of the job, such as `RUNNING` or `PENDING`. + */ + state?: string | null; + } /** * Kernel mode rootkit signatures. */ @@ -4418,6 +4664,15 @@ export namespace securitycenter_v1beta2 { */ staticMute?: Schema$StaticMute; } + /** + * Contains information about a VPC network associated with the finding. + */ + export interface Schema$Network { + /** + * The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + */ + name?: string | null; + } /** * Kubernetes nodes associated with the finding. */ @@ -4554,6 +4809,19 @@ export namespace securitycenter_v1beta2 { */ field?: string | null; } + /** + * A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. + */ + export interface Schema$PortRange { + /** + * Maximum port value. + */ + max?: string | null; + /** + * Minimum port value. + */ + min?: string | null; + } /** * Represents an operating system process. */ @@ -4983,6 +5251,10 @@ export namespace securitycenter_v1beta2 { * CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) */ cve?: Schema$Cve; + /** + * Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. + */ + cwes?: Schema$Cwe[]; /** * The fixed package is relevant to the finding. */ @@ -4991,6 +5263,14 @@ export namespace securitycenter_v1beta2 { * The offending package is relevant to the finding. */ offendingPackage?: Schema$Package; + /** + * Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. + */ + providerRiskScore?: string | null; + /** + * Represents whether the vulnerability is reachable (detected via static analysis) + */ + reachable?: boolean | null; /** * The security bulletin is relevant to this finding. */ From dae1c47f6e0ae13a0d456ab61cb474126d684cfd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 112/144] fix(securityposture): update the API #### securityposture:v1 The following keys were changed: - schemas.GoogleCloudSecuritypostureV1PolicyRule.properties.parameters.description - schemas.GoogleCloudSecuritypostureV1PolicyRule.properties.resourceTypes.description - schemas.ResourceTypes.description - schemas.ResourceTypes.properties.included.description --- discovery/securityposture-v1.json | 10 +++++----- src/apis/securityposture/v1.ts | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/securityposture-v1.json b/discovery/securityposture-v1.json index 97e273fdb2b..bafe84377b0 100644 --- a/discovery/securityposture-v1.json +++ b/discovery/securityposture-v1.json @@ -892,7 +892,7 @@ } } }, - "revision": "20241212", + "revision": "20250226", "rootUrl": "https://securityposture.googleapis.com/", "schemas": { "AssetDetails": { @@ -1162,12 +1162,12 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. Required for GMCs if parameters defined in constraints. Pass parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { \"allowedLocations\" : [\"us-east1\", \"us-west1\"], \"allowAll\" : true }", + "description": "Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { \"allowedLocations\" : [\"us-east1\", \"us-west1\"], \"allowAll\" : true }", "type": "object" }, "resourceTypes": { "$ref": "ResourceTypes", - "description": "Optional. The resource types policy can support, only used for Google managed constraint and method type is GOVERN_TAGS." + "description": "Optional. The resource types policies can support, only used for managed constraints. Method type is `GOVERN_TAGS`." }, "values": { "$ref": "GoogleCloudSecuritypostureV1PolicyRuleStringValues", @@ -1980,11 +1980,11 @@ "type": "object" }, "ResourceTypes": { - "description": "Set multiple resource types for one policy, eg: resourceTypes: included: - compute.googleapis.com/Instance - compute.googleapis.com/Disk Constraint definition contains an empty resource type in order to support multiple resource types in the policy. Only support Google managed constriaint and method type is GOVERN_TAGS Refer go/multi-resource-support-force-tags-gmc to get more details.", + "description": "Set multiple resource types for one policy, for example: resourceTypes: included: - compute.googleapis.com/Instance - compute.googleapis.com/Disk Constraint definition contains an empty resource type in order to support multiple resource types in the policy. Only supports managed constraints. Method type is `GOVERN_TAGS`. Refer go/multi-resource-support-force-tags-gmc to get more details.", "id": "ResourceTypes", "properties": { "included": { - "description": "Optional. The resource type we currently support. cloud/orgpolicy/customconstraintconfig/prod/resource_types.prototext", + "description": "Optional. The resource types we currently support. cloud/orgpolicy/customconstraintconfig/prod/resource_types.prototext", "items": { "type": "string" }, diff --git a/src/apis/securityposture/v1.ts b/src/apis/securityposture/v1.ts index ed204646d9c..9f3e6f7a3bb 100644 --- a/src/apis/securityposture/v1.ts +++ b/src/apis/securityposture/v1.ts @@ -320,11 +320,11 @@ export namespace securityposture_v1 { */ enforce?: boolean | null; /** - * Optional. Required for GMCs if parameters defined in constraints. Pass parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true \} + * Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true \} */ parameters?: {[key: string]: any} | null; /** - * Optional. The resource types policy can support, only used for Google managed constraint and method type is GOVERN_TAGS. + * Optional. The resource types policies can support, only used for managed constraints. Method type is `GOVERN_TAGS`. */ resourceTypes?: Schema$ResourceTypes; /** @@ -854,11 +854,11 @@ export namespace securityposture_v1 { resourceTypes?: string[] | null; } /** - * Set multiple resource types for one policy, eg: resourceTypes: included: - compute.googleapis.com/Instance - compute.googleapis.com/Disk Constraint definition contains an empty resource type in order to support multiple resource types in the policy. Only support Google managed constriaint and method type is GOVERN_TAGS Refer go/multi-resource-support-force-tags-gmc to get more details. + * Set multiple resource types for one policy, for example: resourceTypes: included: - compute.googleapis.com/Instance - compute.googleapis.com/Disk Constraint definition contains an empty resource type in order to support multiple resource types in the policy. Only supports managed constraints. Method type is `GOVERN_TAGS`. Refer go/multi-resource-support-force-tags-gmc to get more details. */ export interface Schema$ResourceTypes { /** - * Optional. The resource type we currently support. cloud/orgpolicy/customconstraintconfig/prod/resource_types.prototext + * Optional. The resource types we currently support. cloud/orgpolicy/customconstraintconfig/prod/resource_types.prototext */ included?: string[] | null; } From b1956efd6d92db0b93b2849809268433b8d05b21 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 113/144] feat(serviceconsumermanagement): update the API #### serviceconsumermanagement:v1beta1 The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type - schemas.Service.properties.aspects.description - schemas.Service.properties.aspects.items.$ref - schemas.Service.properties.aspects.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description #### serviceconsumermanagement:v1 The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type - schemas.Service.properties.aspects.description - schemas.Service.properties.aspects.items.$ref - schemas.Service.properties.aspects.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description --- discovery/serviceconsumermanagement-v1.json | 50 ++++++++++++++++--- .../serviceconsumermanagement-v1beta1.json | 50 ++++++++++++++++--- src/apis/serviceconsumermanagement/v1.ts | 39 +++++++++++++-- src/apis/serviceconsumermanagement/v1beta1.ts | 39 +++++++++++++-- 4 files changed, 156 insertions(+), 22 deletions(-) diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index dc718bbc20a..53e6036d45d 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20241210", + "revision": "20250227", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -629,6 +629,25 @@ }, "type": "object" }, + "Aspect": { + "description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", + "id": "Aspect", + "properties": { + "kind": { + "description": "The type of this aspect configuration.", + "type": "string" + }, + "spec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "type": "object" + } + }, + "type": "object" + }, "AttachTenantProjectRequest": { "description": "Request to attach an existing project to the tenancy unit as a new tenant resource.", "id": "AttachTenantProjectRequest", @@ -779,6 +798,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, + "loadBalancingPolicy": { + "description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", + "type": "string" + }, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1160,7 +1183,7 @@ "type": "array" }, "sectionOverrides": { - "description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", + "description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1190,7 +1213,7 @@ "type": "string" }, "disableReplacementWords": { - "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", + "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -1359,6 +1382,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" + }, + "unversionedPackageDisabled": { + "description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", + "type": "boolean" } }, "type": "object" @@ -2240,7 +2267,7 @@ "id": "Page", "properties": { "content": { - "description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", + "description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -2500,6 +2527,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { + "generateOmittedAsInternal": { + "description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", + "type": "boolean" + }, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -2521,6 +2552,13 @@ }, "type": "array" }, + "aspects": { + "description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", + "items": { + "$ref": "Aspect" + }, + "type": "array" + }, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -2991,11 +3029,11 @@ "type": "object" }, "UsageRule": { - "description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true", + "description": "Usage configuration rules for the service.", "id": "UsageRule", "properties": { "allowUnregisteredCalls": { - "description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.", + "description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index 3ba9f6bfc3d..af30d71913a 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -715,7 +715,7 @@ } } }, - "revision": "20241205", + "revision": "20250227", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -772,6 +772,25 @@ }, "type": "object" }, + "Aspect": { + "description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", + "id": "Aspect", + "properties": { + "kind": { + "description": "The type of this aspect configuration.", + "type": "string" + }, + "spec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "type": "object" + } + }, + "type": "object" + }, "AuthProvider": { "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "id": "AuthProvider", @@ -903,6 +922,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, + "loadBalancingPolicy": { + "description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", + "type": "string" + }, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1245,7 +1268,7 @@ "type": "array" }, "sectionOverrides": { - "description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", + "description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1275,7 +1298,7 @@ "type": "string" }, "disableReplacementWords": { - "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", + "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -1444,6 +1467,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" + }, + "unversionedPackageDisabled": { + "description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", + "type": "boolean" } }, "type": "object" @@ -2289,7 +2316,7 @@ "id": "Page", "properties": { "content": { - "description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", + "description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -2502,6 +2529,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { + "generateOmittedAsInternal": { + "description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", + "type": "boolean" + }, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -2523,6 +2554,13 @@ }, "type": "array" }, + "aspects": { + "description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", + "items": { + "$ref": "Aspect" + }, + "type": "array" + }, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -2843,11 +2881,11 @@ "type": "object" }, "UsageRule": { - "description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true", + "description": "Usage configuration rules for the service.", "id": "UsageRule", "properties": { "allowUnregisteredCalls": { - "description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.", + "description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index eba90889ab0..121b47ca682 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -185,6 +185,19 @@ export namespace serviceconsumermanagement_v1 { */ tag?: string | null; } + /** + * Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto + */ + export interface Schema$Aspect { + /** + * The type of this aspect configuration. + */ + kind?: string | null; + /** + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + */ + spec?: {[key: string]: any} | null; + } /** * Request to attach an existing project to the tenancy unit as a new tenant resource. */ @@ -307,6 +320,10 @@ export namespace serviceconsumermanagement_v1 { * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; + /** + * The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". + */ + loadBalancingPolicy?: string | null; /** * Deprecated, do not use. */ @@ -568,7 +585,7 @@ export namespace serviceconsumermanagement_v1 { */ rules?: Schema$DocumentationRule[]; /** - * Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + * Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries */ sectionOverrides?: Schema$Page[]; /** @@ -593,7 +610,7 @@ export namespace serviceconsumermanagement_v1 { */ description?: string | null; /** - * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. */ disableReplacementWords?: string | null; /** @@ -713,6 +730,10 @@ export namespace serviceconsumermanagement_v1 { * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. */ restAsyncIoEnabled?: boolean | null; + /** + * Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. + */ + unversionedPackageDisabled?: boolean | null; } /** * A single field of a message type. @@ -1271,7 +1292,7 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$Page { /** - * The Markdown content of the page. You can use (== include {path\} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + * The Markdown content of the page. You can use ```(== include {path\} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. */ content?: string | null; /** @@ -1460,6 +1481,10 @@ export namespace serviceconsumermanagement_v1 { * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. */ export interface Schema$SelectiveGapicGeneration { + /** + * Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. + */ + generateOmittedAsInternal?: boolean | null; /** * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. */ @@ -1473,6 +1498,10 @@ export namespace serviceconsumermanagement_v1 { * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; + /** + * Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners. + */ + aspects?: Schema$Aspect[]; /** * Auth configuration. */ @@ -1809,11 +1838,11 @@ export namespace serviceconsumermanagement_v1 { rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true + * Usage configuration rules for the service. */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. + * Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. */ allowUnregisteredCalls?: boolean | null; /** diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index bccf403322d..89c6b602917 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -159,6 +159,19 @@ export namespace serviceconsumermanagement_v1beta1 { */ version?: string | null; } + /** + * Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto + */ + export interface Schema$Aspect { + /** + * The type of this aspect configuration. + */ + kind?: string | null; + /** + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + */ + spec?: {[key: string]: any} | null; + } /** * `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read */ @@ -264,6 +277,10 @@ export namespace serviceconsumermanagement_v1beta1 { * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; + /** + * The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". + */ + loadBalancingPolicy?: string | null; /** * Deprecated, do not use. */ @@ -494,7 +511,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ rules?: Schema$DocumentationRule[]; /** - * Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + * Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries */ sectionOverrides?: Schema$Page[]; /** @@ -519,7 +536,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ description?: string | null; /** - * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. */ disableReplacementWords?: string | null; /** @@ -639,6 +656,10 @@ export namespace serviceconsumermanagement_v1beta1 { * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. */ restAsyncIoEnabled?: boolean | null; + /** + * Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. + */ + unversionedPackageDisabled?: boolean | null; } /** * A single field of a message type. @@ -1171,7 +1192,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ export interface Schema$Page { /** - * The Markdown content of the page. You can use (== include {path\} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + * The Markdown content of the page. You can use ```(== include {path\} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. */ content?: string | null; /** @@ -1325,6 +1346,10 @@ export namespace serviceconsumermanagement_v1beta1 { * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. */ export interface Schema$SelectiveGapicGeneration { + /** + * Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. + */ + generateOmittedAsInternal?: boolean | null; /** * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. */ @@ -1338,6 +1363,10 @@ export namespace serviceconsumermanagement_v1beta1 { * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; + /** + * Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners. + */ + aspects?: Schema$Aspect[]; /** * Auth configuration. */ @@ -1572,11 +1601,11 @@ export namespace serviceconsumermanagement_v1beta1 { rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true + * Usage configuration rules for the service. */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. + * Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. */ allowUnregisteredCalls?: boolean | null; /** From cd71b24ff78831fb8da3cf9639416aa479348318 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 114/144] feat(servicecontrol): update the API #### servicecontrol:v1 The following keys were added: - schemas.Request.properties.origin.description - schemas.Request.properties.origin.type #### servicecontrol:v2 The following keys were added: - schemas.Request.properties.origin.description - schemas.Request.properties.origin.type --- discovery/servicecontrol-v1.json | 6 +++++- discovery/servicecontrol-v2.json | 6 +++++- src/apis/servicecontrol/v1.ts | 4 ++++ src/apis/servicecontrol/v2.ts | 4 ++++ 4 files changed, 18 insertions(+), 2 deletions(-) diff --git a/discovery/servicecontrol-v1.json b/discovery/servicecontrol-v1.json index 4ac7c7d6c35..486a519b98d 100644 --- a/discovery/servicecontrol-v1.json +++ b/discovery/servicecontrol-v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20250117", + "revision": "20250124", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -1592,6 +1592,10 @@ "description": "The HTTP request method, such as `GET`, `POST`.", "type": "string" }, + "origin": { + "description": "The values from Origin header from the HTTP request, such as \"https://console.cloud.google.com\". Modern browsers can only have one origin. Special browsers and/or HTTP clients may require multiple origins.", + "type": "string" + }, "path": { "description": "The HTTP URL path, excluding the query parameters.", "type": "string" diff --git a/discovery/servicecontrol-v2.json b/discovery/servicecontrol-v2.json index 0d11fb54453..9449aee6ab7 100644 --- a/discovery/servicecontrol-v2.json +++ b/discovery/servicecontrol-v2.json @@ -169,7 +169,7 @@ } } }, - "revision": "20250103", + "revision": "20250124", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { @@ -661,6 +661,10 @@ "description": "The HTTP request method, such as `GET`, `POST`.", "type": "string" }, + "origin": { + "description": "The values from Origin header from the HTTP request, such as \"https://console.cloud.google.com\". Modern browsers can only have one origin. Special browsers and/or HTTP clients may require multiple origins.", + "type": "string" + }, "path": { "description": "The HTTP URL path, excluding the query parameters.", "type": "string" diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 70784f789cb..e03f3ac5903 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -1051,6 +1051,10 @@ export namespace servicecontrol_v1 { * The HTTP request method, such as `GET`, `POST`. */ method?: string | null; + /** + * The values from Origin header from the HTTP request, such as "https://console.cloud.google.com". Modern browsers can only have one origin. Special browsers and/or HTTP clients may require multiple origins. + */ + origin?: string | null; /** * The HTTP URL path, excluding the query parameters. */ diff --git a/src/apis/servicecontrol/v2.ts b/src/apis/servicecontrol/v2.ts index bbf134bac27..b11a304239b 100644 --- a/src/apis/servicecontrol/v2.ts +++ b/src/apis/servicecontrol/v2.ts @@ -482,6 +482,10 @@ export namespace servicecontrol_v2 { * The HTTP request method, such as `GET`, `POST`. */ method?: string | null; + /** + * The values from Origin header from the HTTP request, such as "https://console.cloud.google.com". Modern browsers can only have one origin. Special browsers and/or HTTP clients may require multiple origins. + */ + origin?: string | null; /** * The HTTP URL path, excluding the query parameters. */ From 48814ae5ff4b64c9612cf1d87abf20a381279ca9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 115/144] feat(servicemanagement): update the API #### servicemanagement:v1 The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type - schemas.Service.properties.aspects.description - schemas.Service.properties.aspects.items.$ref - schemas.Service.properties.aspects.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description --- discovery/servicemanagement-v1.json | 50 +++++++++++++++++++++++++---- src/apis/servicemanagement/v1.ts | 39 +++++++++++++++++++--- 2 files changed, 78 insertions(+), 11 deletions(-) diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index fb75d374e74..bd154d91cc8 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -830,7 +830,7 @@ } } }, - "revision": "20241202", + "revision": "20250228", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -898,6 +898,25 @@ }, "type": "object" }, + "Aspect": { + "description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", + "id": "Aspect", + "properties": { + "kind": { + "description": "The type of this aspect configuration.", + "type": "string" + }, + "spec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "type": "object" + } + }, + "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", @@ -1077,6 +1096,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, + "loadBalancingPolicy": { + "description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", + "type": "string" + }, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1595,7 +1618,7 @@ "type": "array" }, "sectionOverrides": { - "description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", + "description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1625,7 +1648,7 @@ "type": "string" }, "disableReplacementWords": { - "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", + "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -1794,6 +1817,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" + }, + "unversionedPackageDisabled": { + "description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", + "type": "boolean" } }, "type": "object" @@ -2885,7 +2912,7 @@ "id": "Page", "properties": { "content": { - "description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", + "description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -3198,6 +3225,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { + "generateOmittedAsInternal": { + "description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", + "type": "boolean" + }, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -3219,6 +3250,13 @@ }, "type": "array" }, + "aspects": { + "description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", + "items": { + "$ref": "Aspect" + }, + "type": "array" + }, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -3666,11 +3704,11 @@ "type": "object" }, "UsageRule": { - "description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true", + "description": "Usage configuration rules for the service.", "id": "UsageRule", "properties": { "allowUnregisteredCalls": { - "description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.", + "description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 3a88f564dbc..40bdc260961 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -168,6 +168,19 @@ export namespace servicemanagement_v1 { */ version?: string | null; } + /** + * Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto + */ + export interface Schema$Aspect { + /** + * The type of this aspect configuration. + */ + kind?: string | null; + /** + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + */ + spec?: {[key: string]: any} | null; + } /** * 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. */ @@ -299,6 +312,10 @@ export namespace servicemanagement_v1 { * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; + /** + * The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". + */ + loadBalancingPolicy?: string | null; /** * Deprecated, do not use. */ @@ -640,7 +657,7 @@ export namespace servicemanagement_v1 { */ rules?: Schema$DocumentationRule[]; /** - * Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + * Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries */ sectionOverrides?: Schema$Page[]; /** @@ -665,7 +682,7 @@ export namespace servicemanagement_v1 { */ description?: string | null; /** - * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. */ disableReplacementWords?: string | null; /** @@ -785,6 +802,10 @@ export namespace servicemanagement_v1 { * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. */ restAsyncIoEnabled?: boolean | null; + /** + * Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. + */ + unversionedPackageDisabled?: boolean | 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. @@ -1502,7 +1523,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$Page { /** - * The Markdown content of the page. You can use (== include {path\} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + * The Markdown content of the page. You can use ```(== include {path\} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. */ content?: string | null; /** @@ -1723,6 +1744,10 @@ export namespace servicemanagement_v1 { * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. */ export interface Schema$SelectiveGapicGeneration { + /** + * Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. + */ + generateOmittedAsInternal?: boolean | null; /** * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. */ @@ -1736,6 +1761,10 @@ export namespace servicemanagement_v1 { * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; + /** + * Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners. + */ + aspects?: Schema$Aspect[]; /** * Auth configuration. */ @@ -2054,11 +2083,11 @@ export namespace servicemanagement_v1 { rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true + * Usage configuration rules for the service. */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. + * Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. */ allowUnregisteredCalls?: boolean | null; /** From 82325f1c3df88c75d384793b60fbc72039c452b0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 116/144] feat(servicenetworking): update the API #### servicenetworking:v1beta The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type - schemas.Service.properties.aspects.description - schemas.Service.properties.aspects.items.$ref - schemas.Service.properties.aspects.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.JavaSettings.properties.libraryPackage.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description #### servicenetworking:v1 The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type - schemas.Service.properties.aspects.description - schemas.Service.properties.aspects.items.$ref - schemas.Service.properties.aspects.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.JavaSettings.properties.libraryPackage.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description - schemas.ValidateConsumerConfigResponse.properties.validationError.enum - schemas.ValidateConsumerConfigResponse.properties.validationError.enumDescriptions --- discovery/servicenetworking-v1.json | 58 +++++++++++++++++++++---- discovery/servicenetworking-v1beta.json | 52 +++++++++++++++++++--- src/apis/servicenetworking/v1.ts | 41 ++++++++++++++--- src/apis/servicenetworking/v1beta.ts | 41 ++++++++++++++--- 4 files changed, 164 insertions(+), 28 deletions(-) diff --git a/discovery/servicenetworking-v1.json b/discovery/servicenetworking-v1.json index 476bb0b2fa7..57fbb0e22c6 100644 --- a/discovery/servicenetworking-v1.json +++ b/discovery/servicenetworking-v1.json @@ -1029,7 +1029,7 @@ } } }, - "revision": "20250107", + "revision": "20250312", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1287,6 +1287,25 @@ }, "type": "object" }, + "Aspect": { + "description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", + "id": "Aspect", + "properties": { + "kind": { + "description": "The type of this aspect configuration.", + "type": "string" + }, + "spec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "type": "object" + } + }, + "type": "object" + }, "AuthProvider": { "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "id": "AuthProvider", @@ -1418,6 +1437,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, + "loadBalancingPolicy": { + "description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", + "type": "string" + }, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1995,7 +2018,7 @@ "type": "array" }, "sectionOverrides": { - "description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", + "description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -2025,7 +2048,7 @@ "type": "string" }, "disableReplacementWords": { - "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", + "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -2205,6 +2228,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" + }, + "unversionedPackageDisabled": { + "description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", + "type": "boolean" } }, "type": "object" @@ -2513,7 +2540,7 @@ "description": "Some settings." }, "libraryPackage": { - "description": "The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name\" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1", + "description": "The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name\" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: library_settings: java_settings: library_package: com.google.cloud.pubsub.v1", "type": "string" }, "serviceClassNames": { @@ -3208,7 +3235,7 @@ "id": "Page", "properties": { "content": { - "description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", + "description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -3646,6 +3673,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { + "generateOmittedAsInternal": { + "description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", + "type": "boolean" + }, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -3667,6 +3698,13 @@ }, "type": "array" }, + "aspects": { + "description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", + "items": { + "$ref": "Aspect" + }, + "type": "array" + }, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -4061,11 +4099,11 @@ "type": "object" }, "UsageRule": { - "description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true", + "description": "Usage configuration rules for the service.", "id": "UsageRule", "properties": { "allowUnregisteredCalls": { - "description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.", + "description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { @@ -4136,7 +4174,8 @@ "RANGES_NOT_RESERVED", "RANGES_DELETED_LATER", "COMPUTE_API_NOT_ENABLED", - "USE_PERMISSION_NOT_FOUND" + "USE_PERMISSION_NOT_FOUND", + "SN_SERVICE_AGENT_PERMISSION_DENIED_ON_CONSUMER_PROJECT" ], "enumDescriptions": [ "", @@ -4153,7 +4192,8 @@ "The IP ranges were not reserved.", "The IP ranges were reserved but deleted later.", "The consumer project does not have the compute api enabled.", - "The consumer project does not have the permission from the host project." + "The consumer project does not have the permission from the host project.", + "The SN service agent {service-@service-networking.iam.gserviceaccount.com} does not have the SN service agent role on the consumer project." ], "type": "string" } diff --git a/discovery/servicenetworking-v1beta.json b/discovery/servicenetworking-v1beta.json index a0ce0098a86..8d7c2e8a088 100644 --- a/discovery/servicenetworking-v1beta.json +++ b/discovery/servicenetworking-v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20241212", + "revision": "20250312", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -454,6 +454,25 @@ }, "type": "object" }, + "Aspect": { + "description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", + "id": "Aspect", + "properties": { + "kind": { + "description": "The type of this aspect configuration.", + "type": "string" + }, + "spec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "type": "object" + } + }, + "type": "object" + }, "AuthProvider": { "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "id": "AuthProvider", @@ -585,6 +604,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, + "loadBalancingPolicy": { + "description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", + "type": "string" + }, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1107,7 +1130,7 @@ "type": "array" }, "sectionOverrides": { - "description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", + "description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1137,7 +1160,7 @@ "type": "string" }, "disableReplacementWords": { - "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", + "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -1300,6 +1323,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" + }, + "unversionedPackageDisabled": { + "description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", + "type": "boolean" } }, "type": "object" @@ -1593,7 +1620,7 @@ "description": "Some settings." }, "libraryPackage": { - "description": "The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name\" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1", + "description": "The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name\" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: library_settings: java_settings: library_package: com.google.cloud.pubsub.v1", "type": "string" }, "serviceClassNames": { @@ -2228,7 +2255,7 @@ "id": "Page", "properties": { "content": { - "description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", + "description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -2575,6 +2602,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { + "generateOmittedAsInternal": { + "description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", + "type": "boolean" + }, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -2596,6 +2627,13 @@ }, "type": "array" }, + "aspects": { + "description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", + "items": { + "$ref": "Aspect" + }, + "type": "array" + }, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -2956,11 +2994,11 @@ "type": "object" }, "UsageRule": { - "description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true", + "description": "Usage configuration rules for the service.", "id": "UsageRule", "properties": { "allowUnregisteredCalls": { - "description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.", + "description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index b8186dd47f3..21e69175f02 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -325,6 +325,19 @@ export namespace servicenetworking_v1 { */ version?: string | null; } + /** + * Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto + */ + export interface Schema$Aspect { + /** + * The type of this aspect configuration. + */ + kind?: string | null; + /** + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + */ + spec?: {[key: string]: any} | null; + } /** * `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read */ @@ -430,6 +443,10 @@ export namespace servicenetworking_v1 { * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; + /** + * The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". + */ + loadBalancingPolicy?: string | null; /** * Deprecated, do not use. */ @@ -845,7 +862,7 @@ export namespace servicenetworking_v1 { */ rules?: Schema$DocumentationRule[]; /** - * Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + * Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries */ sectionOverrides?: Schema$Page[]; /** @@ -870,7 +887,7 @@ export namespace servicenetworking_v1 { */ description?: string | null; /** - * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. */ disableReplacementWords?: string | null; /** @@ -999,6 +1016,10 @@ export namespace servicenetworking_v1 { * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. */ restAsyncIoEnabled?: boolean | null; + /** + * Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. + */ + unversionedPackageDisabled?: boolean | null; } /** * A single field of a message type. @@ -1214,7 +1235,7 @@ export namespace servicenetworking_v1 { */ common?: Schema$CommonLanguageSettings; /** - * The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1 + * The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: library_settings: java_settings: library_package: com.google.cloud.pubsub.v1 */ libraryPackage?: string | null; /** @@ -1652,7 +1673,7 @@ export namespace servicenetworking_v1 { */ export interface Schema$Page { /** - * The Markdown content of the page. You can use (== include {path\} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + * The Markdown content of the page. You can use ```(== include {path\} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. */ content?: string | null; /** @@ -1982,6 +2003,10 @@ export namespace servicenetworking_v1 { * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. */ export interface Schema$SelectiveGapicGeneration { + /** + * Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. + */ + generateOmittedAsInternal?: boolean | null; /** * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. */ @@ -1995,6 +2020,10 @@ export namespace servicenetworking_v1 { * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; + /** + * Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners. + */ + aspects?: Schema$Aspect[]; /** * Auth configuration. */ @@ -2292,11 +2321,11 @@ export namespace servicenetworking_v1 { rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true + * Usage configuration rules for the service. */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. + * Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. */ allowUnregisteredCalls?: boolean | null; /** diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 1f643bd6a4b..f6985db0aa5 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -230,6 +230,19 @@ export namespace servicenetworking_v1beta { */ version?: string | null; } + /** + * Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto + */ + export interface Schema$Aspect { + /** + * The type of this aspect configuration. + */ + kind?: string | null; + /** + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + */ + spec?: {[key: string]: any} | null; + } /** * `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read */ @@ -335,6 +348,10 @@ export namespace servicenetworking_v1beta { * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; + /** + * The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". + */ + loadBalancingPolicy?: string | null; /** * Deprecated, do not use. */ @@ -706,7 +723,7 @@ export namespace servicenetworking_v1beta { */ rules?: Schema$DocumentationRule[]; /** - * Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + * Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries */ sectionOverrides?: Schema$Page[]; /** @@ -731,7 +748,7 @@ export namespace servicenetworking_v1beta { */ description?: string | null; /** - * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. */ disableReplacementWords?: string | null; /** @@ -847,6 +864,10 @@ export namespace servicenetworking_v1beta { * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. */ restAsyncIoEnabled?: boolean | null; + /** + * Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. + */ + unversionedPackageDisabled?: boolean | null; } /** * A single field of a message type. @@ -1049,7 +1070,7 @@ export namespace servicenetworking_v1beta { */ common?: Schema$CommonLanguageSettings; /** - * The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1 + * The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: library_settings: java_settings: library_package: com.google.cloud.pubsub.v1 */ libraryPackage?: string | null; /** @@ -1447,7 +1468,7 @@ export namespace servicenetworking_v1beta { */ export interface Schema$Page { /** - * The Markdown content of the page. You can use (== include {path\} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + * The Markdown content of the page. You can use ```(== include {path\} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. */ content?: string | null; /** @@ -1708,6 +1729,10 @@ export namespace servicenetworking_v1beta { * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. */ export interface Schema$SelectiveGapicGeneration { + /** + * Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. + */ + generateOmittedAsInternal?: boolean | null; /** * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. */ @@ -1721,6 +1746,10 @@ export namespace servicenetworking_v1beta { * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; + /** + * Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners. + */ + aspects?: Schema$Aspect[]; /** * Auth configuration. */ @@ -1988,11 +2017,11 @@ export namespace servicenetworking_v1beta { rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true + * Usage configuration rules for the service. */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. + * Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. */ allowUnregisteredCalls?: boolean | null; /** From c4dc7f9b88e7b1df1d4eb46302661751174d4fc6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 117/144] feat(serviceusage)!: update the API BREAKING CHANGE: This release has breaking changes. #### serviceusage:v1beta1 The following keys were deleted: - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.$ref - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.description - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.readOnly The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.GoogleApiService.properties.aspects.description - schemas.GoogleApiService.properties.aspects.items.$ref - schemas.GoogleApiService.properties.aspects.type - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.$ref - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.description - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.readOnly - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description #### serviceusage:v1 The following keys were deleted: - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.$ref - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.description - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.readOnly The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.GoogleApiService.properties.aspects.description - schemas.GoogleApiService.properties.aspects.items.$ref - schemas.GoogleApiService.properties.aspects.type - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.$ref - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.description - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.readOnly - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description --- discovery/serviceusage-v1.json | 52 +++++++++++++++++++++++++---- discovery/serviceusage-v1beta1.json | 52 +++++++++++++++++++++++++---- src/apis/serviceusage/v1.ts | 41 +++++++++++++++++++---- src/apis/serviceusage/v1beta1.ts | 41 +++++++++++++++++++---- 4 files changed, 160 insertions(+), 26 deletions(-) diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index 0d68f05689a..bbfd8e77699 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20241219", + "revision": "20250227", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -621,6 +621,25 @@ }, "type": "object" }, + "Aspect": { + "description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", + "id": "Aspect", + "properties": { + "kind": { + "description": "The type of this aspect configuration.", + "type": "string" + }, + "spec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "type": "object" + } + }, + "type": "object" + }, "AuthProvider": { "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "id": "AuthProvider", @@ -752,6 +771,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, + "loadBalancingPolicy": { + "description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", + "type": "string" + }, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1260,7 +1283,7 @@ "type": "array" }, "sectionOverrides": { - "description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", + "description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1290,7 +1313,7 @@ "type": "string" }, "disableReplacementWords": { - "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", + "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -1537,6 +1560,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" + }, + "unversionedPackageDisabled": { + "description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", + "type": "boolean" } }, "type": "object" @@ -1724,6 +1751,13 @@ }, "type": "array" }, + "aspects": { + "description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", + "items": { + "$ref": "Aspect" + }, + "type": "array" + }, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -2065,7 +2099,7 @@ "description": "A message to group the analysis information.", "id": "GoogleApiServiceusageV2betaAnalysis", "properties": { - "analysis": { + "analysisResult": { "$ref": "GoogleApiServiceusageV2betaAnalysisResult", "description": "Output only. Analysis result of updating a policy.", "readOnly": true @@ -3065,7 +3099,7 @@ "id": "Page", "properties": { "content": { - "description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", + "description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -3338,6 +3372,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { + "generateOmittedAsInternal": { + "description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", + "type": "boolean" + }, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -3562,11 +3600,11 @@ "type": "object" }, "UsageRule": { - "description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true", + "description": "Usage configuration rules for the service.", "id": "UsageRule", "properties": { "allowUnregisteredCalls": { - "description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.", + "description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index e90b50208b3..6fbe9639bd8 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20241219", + "revision": "20250227", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1159,6 +1159,25 @@ }, "type": "object" }, + "Aspect": { + "description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto", + "id": "Aspect", + "properties": { + "kind": { + "description": "The type of this aspect configuration.", + "type": "string" + }, + "spec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "type": "object" + } + }, + "type": "object" + }, "AuthProvider": { "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "id": "AuthProvider", @@ -1290,6 +1309,10 @@ "description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.", "type": "string" }, + "loadBalancingPolicy": { + "description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".", + "type": "string" + }, "minDeadline": { "deprecated": true, "description": "Deprecated, do not use.", @@ -1837,7 +1860,7 @@ "type": "array" }, "sectionOverrides": { - "description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries", + "description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries", "items": { "$ref": "Page" }, @@ -1867,7 +1890,7 @@ "type": "string" }, "disableReplacementWords": { - "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.", + "description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.", "type": "string" }, "selector": { @@ -2114,6 +2137,10 @@ "restAsyncIoEnabled": { "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", "type": "boolean" + }, + "unversionedPackageDisabled": { + "description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.", + "type": "boolean" } }, "type": "object" @@ -2301,6 +2328,13 @@ }, "type": "array" }, + "aspects": { + "description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.", + "items": { + "$ref": "Aspect" + }, + "type": "array" + }, "authentication": { "$ref": "Authentication", "description": "Auth configuration." @@ -2642,7 +2676,7 @@ "description": "A message to group the analysis information.", "id": "GoogleApiServiceusageV2betaAnalysis", "properties": { - "analysis": { + "analysisResult": { "$ref": "GoogleApiServiceusageV2betaAnalysisResult", "description": "Output only. Analysis result of updating a policy.", "readOnly": true @@ -3774,7 +3808,7 @@ "id": "Page", "properties": { "content": { - "description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", + "description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.", "type": "string" }, "name": { @@ -4137,6 +4171,10 @@ "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", "id": "SelectiveGapicGeneration", "properties": { + "generateOmittedAsInternal": { + "description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.", + "type": "boolean" + }, "methods": { "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", "items": { @@ -4450,11 +4488,11 @@ "type": "object" }, "UsageRule": { - "description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true", + "description": "Usage configuration rules for the service.", "id": "UsageRule", "properties": { "allowUnregisteredCalls": { - "description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.", + "description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index cab73299b69..dd000fc4a79 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -252,6 +252,19 @@ export namespace serviceusage_v1 { */ version?: string | null; } + /** + * Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto + */ + export interface Schema$Aspect { + /** + * The type of this aspect configuration. + */ + kind?: string | null; + /** + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + */ + spec?: {[key: string]: any} | null; + } /** * `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read */ @@ -357,6 +370,10 @@ export namespace serviceusage_v1 { * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; + /** + * The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". + */ + loadBalancingPolicy?: string | null; /** * Deprecated, do not use. */ @@ -695,7 +712,7 @@ export namespace serviceusage_v1 { */ rules?: Schema$DocumentationRule[]; /** - * Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + * Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries */ sectionOverrides?: Schema$Page[]; /** @@ -720,7 +737,7 @@ export namespace serviceusage_v1 { */ description?: string | null; /** - * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. */ disableReplacementWords?: string | null; /** @@ -887,6 +904,10 @@ export namespace serviceusage_v1 { * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. */ restAsyncIoEnabled?: boolean | null; + /** + * Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. + */ + unversionedPackageDisabled?: boolean | null; } /** * A single field of a message type. @@ -975,6 +996,10 @@ export namespace serviceusage_v1 { * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; + /** + * Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners. + */ + aspects?: Schema$Aspect[]; /** * Auth configuration. */ @@ -1234,7 +1259,7 @@ export namespace serviceusage_v1 { /** * Output only. Analysis result of updating a policy. */ - analysis?: Schema$GoogleApiServiceusageV2betaAnalysisResult; + analysisResult?: Schema$GoogleApiServiceusageV2betaAnalysisResult; /** * Output only. The type of analysis. */ @@ -1889,7 +1914,7 @@ export namespace serviceusage_v1 { */ export interface Schema$Page { /** - * The Markdown content of the page. You can use (== include {path\} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + * The Markdown content of the page. You can use ```(== include {path\} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. */ content?: string | null; /** @@ -2089,6 +2114,10 @@ export namespace serviceusage_v1 { * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. */ export interface Schema$SelectiveGapicGeneration { + /** + * Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. + */ + generateOmittedAsInternal?: boolean | null; /** * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. */ @@ -2240,11 +2269,11 @@ export namespace serviceusage_v1 { rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true + * Usage configuration rules for the service. */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. + * Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. */ allowUnregisteredCalls?: boolean | null; /** diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index a06af2e9201..3b938e5ca16 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -252,6 +252,19 @@ export namespace serviceusage_v1beta1 { */ version?: string | null; } + /** + * Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto + */ + export interface Schema$Aspect { + /** + * The type of this aspect configuration. + */ + kind?: string | null; + /** + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + */ + spec?: {[key: string]: any} | null; + } /** * `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read */ @@ -357,6 +370,10 @@ export namespace serviceusage_v1beta1 { * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; + /** + * The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". + */ + loadBalancingPolicy?: string | null; /** * Deprecated, do not use. */ @@ -735,7 +752,7 @@ export namespace serviceusage_v1beta1 { */ rules?: Schema$DocumentationRule[]; /** - * Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries + * Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries */ sectionOverrides?: Schema$Page[]; /** @@ -760,7 +777,7 @@ export namespace serviceusage_v1beta1 { */ description?: string | null; /** - * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. + * String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. */ disableReplacementWords?: string | null; /** @@ -927,6 +944,10 @@ export namespace serviceusage_v1beta1 { * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. */ restAsyncIoEnabled?: boolean | null; + /** + * Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. + */ + unversionedPackageDisabled?: boolean | null; } /** * A single field of a message type. @@ -1015,6 +1036,10 @@ export namespace serviceusage_v1beta1 { * A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. */ apis?: Schema$Api[]; + /** + * Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners. + */ + aspects?: Schema$Aspect[]; /** * Auth configuration. */ @@ -1274,7 +1299,7 @@ export namespace serviceusage_v1beta1 { /** * Output only. Analysis result of updating a policy. */ - analysis?: Schema$GoogleApiServiceusageV2betaAnalysisResult; + analysisResult?: Schema$GoogleApiServiceusageV2betaAnalysisResult; /** * Output only. The type of analysis. */ @@ -2011,7 +2036,7 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$Page { /** - * The Markdown content of the page. You can use (== include {path\} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. + * The Markdown content of the page. You can use ```(== include {path\} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. */ content?: string | null; /** @@ -2286,6 +2311,10 @@ export namespace serviceusage_v1beta1 { * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. */ export interface Schema$SelectiveGapicGeneration { + /** + * Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. + */ + generateOmittedAsInternal?: boolean | null; /** * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. */ @@ -2503,11 +2532,11 @@ export namespace serviceusage_v1beta1 { rules?: Schema$UsageRule[]; } /** - * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true + * Usage configuration rules for the service. */ export interface Schema$UsageRule { /** - * If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. + * Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. */ allowUnregisteredCalls?: boolean | null; /** From 67f8e9822d0f8219d042f5a3f1e678db8fa65792 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 118/144] fix(sheets): update the API #### sheets:v4 The following keys were changed: - schemas.InsertRangeRequest.properties.range.description --- discovery/sheets-v4.json | 4 ++-- src/apis/sheets/v4.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json index 1f5062e18f0..88ad3181630 100644 --- a/discovery/sheets-v4.json +++ b/discovery/sheets-v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20250106", + "revision": "20250211", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -4970,7 +4970,7 @@ "properties": { "range": { "$ref": "GridRange", - "description": "The range to insert new cells into." + "description": "The range to insert new cells into. The range is constrained to the current sheet boundaries." }, "shiftDimension": { "description": "The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right.", diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 73f7235b6e4..3c5039f3f16 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -2793,7 +2793,7 @@ export namespace sheets_v4 { */ export interface Schema$InsertRangeRequest { /** - * The range to insert new cells into. + * The range to insert new cells into. The range is constrained to the current sheet boundaries. */ range?: Schema$GridRange; /** From bc962690f53428aa6c43d5cd80ed597cecf01045 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 119/144] fix(slides): update the API #### slides:v1 The following keys were changed: - schemas.Autofit.description - schemas.Autofit.properties.autofitType.description - schemas.Autofit.properties.fontScale.description - schemas.Autofit.properties.lineSpacingReduction.description - schemas.CreateShapeRequest.properties.shapeType.enumDescriptions - schemas.LineConnection.properties.connectionSiteIndex.description - schemas.Recolor.properties.name.enumDescriptions - schemas.Shape.description - schemas.Shape.properties.shapeType.enumDescriptions --- discovery/slides-v1.json | 24 ++++++++++++------------ src/apis/slides/v1.ts | 12 ++++++------ 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/discovery/slides-v1.json b/discovery/slides-v1.json index ced20e9f96a..ec7b82d7e72 100644 --- a/discovery/slides-v1.json +++ b/discovery/slides-v1.json @@ -313,7 +313,7 @@ } } }, - "revision": "20240305", + "revision": "20250218", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { @@ -395,11 +395,11 @@ "type": "object" }, "Autofit": { - "description": "The autofit properties of a Shape.", + "description": "The autofit properties of a Shape. This property is only set for shapes that allow text.", "id": "Autofit", "properties": { "autofitType": { - "description": "The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values.", + "description": "The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case, the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values.", "enum": [ "AUTOFIT_TYPE_UNSPECIFIED", "NONE", @@ -415,12 +415,12 @@ "type": "string" }, "fontScale": { - "description": "The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that is rendered in the editor. This property is read-only.", + "description": "The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that's rendered in the editor. This property is read-only.", "format": "float", "type": "number" }, "lineSpacingReduction": { - "description": "The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that is rendered in the editor. This property is read-only.", + "description": "The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that's rendered in the editor. This property is read-only.", "format": "float", "type": "number" } @@ -830,9 +830,9 @@ "CUSTOM" ], "enumDescriptions": [ - "The shape type that is not predefined.", + "Default value. This value is unused.", "Text box shape.", - "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.", + "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'", "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'roundRect'", "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'", "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'", @@ -1648,7 +1648,7 @@ "type": "string" }, "connectionSiteIndex": { - "description": "The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the \"cnx\" attribute in section 20.1.9.9 and Annex H. \"Predefined DrawingML Shape and Text Geometries\" of \"Office Open XML File Formats-Fundamentals and Markup Language Reference\", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor.", + "description": "The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in both the description of the \"cxn\" attribute in section 20.1.9.9 and \"Annex H. Example Predefined DrawingML Shape and Text Geometries\" of \"Office Open XML File Formats - Fundamentals and Markup Language Reference\", part 1 of [ECMA-376 5th edition](https://ecma-international.org/publications-and-standards/standards/ecma-376/). The position of each connection site can also be viewed from Slides editor.", "format": "int32", "type": "integer" } @@ -2465,7 +2465,7 @@ "A recolor effect that lightens the image using the page's first available color from its color scheme.", "A recolor effect that lightens the image using the page's second available color from its color scheme.", "A recolor effect that lightens the image using the page's third available color from its color scheme.", - "A recolor effect that lightens the image using the page's forth available color from its color scheme.", + "A recolor effect that lightens the image using the page's fourth available color from its color scheme.", "A recolor effect that lightens the image using the page's fifth available color from its color scheme.", "A recolor effect that lightens the image using the page's sixth available color from its color scheme.", "A recolor effect that lightens the image using the page's seventh available color from its color scheme.", @@ -3039,7 +3039,7 @@ "type": "object" }, "Shape": { - "description": "A PageElement kind representing a generic shape that does not have a more specific classification.", + "description": "A PageElement kind representing a generic shape that doesn't have a more specific classification. For more information, see [Size and position page elements](https://developers.google.com/slides/api/guides/transform).", "id": "Shape", "properties": { "placeholder": { @@ -3198,9 +3198,9 @@ "CUSTOM" ], "enumDescriptions": [ - "The shape type that is not predefined.", + "Default value. This value is unused.", "Text box shape.", - "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.", + "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'", "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'roundRect'", "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'", "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'", diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index 8c9b29349a6..e479dae0927 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -158,19 +158,19 @@ export namespace slides_v1 { unit?: string | null; } /** - * The autofit properties of a Shape. + * The autofit properties of a Shape. This property is only set for shapes that allow text. */ export interface Schema$Autofit { /** - * The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values. + * The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case, the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values. */ autofitType?: string | null; /** - * The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that is rendered in the editor. This property is read-only. + * The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that's rendered in the editor. This property is read-only. */ fontScale?: number | null; /** - * The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that is rendered in the editor. This property is read-only. + * The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that's rendered in the editor. This property is read-only. */ lineSpacingReduction?: number | null; } @@ -849,7 +849,7 @@ export namespace slides_v1 { */ connectedObjectId?: string | null; /** - * The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. + * The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in both the description of the "cxn" attribute in section 20.1.9.9 and "Annex H. Example Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition](https://ecma-international.org/publications-and-standards/standards/ecma-376/). The position of each connection site can also be viewed from Slides editor. */ connectionSiteIndex?: number | null; } @@ -1734,7 +1734,7 @@ export namespace slides_v1 { type?: string | null; } /** - * A PageElement kind representing a generic shape that does not have a more specific classification. + * A PageElement kind representing a generic shape that doesn't have a more specific classification. For more information, see [Size and position page elements](https://developers.google.com/slides/api/guides/transform). */ export interface Schema$Shape { /** From 4d718f85abc0dfa13a894c8b10c31a34b64bbaa6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:49 +0000 Subject: [PATCH 120/144] fix(solar): update the API #### solar:v1 The following keys were changed: - resources.buildingInsights.methods.findClosest.description --- discovery/solar-v1.json | 4 ++-- src/apis/solar/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/solar-v1.json b/discovery/solar-v1.json index 5ec92f4ac5f..eac42ca5568 100644 --- a/discovery/solar-v1.json +++ b/discovery/solar-v1.json @@ -108,7 +108,7 @@ "buildingInsights": { "methods": { "findClosest": { - "description": "Locates the closest building to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point.", + "description": "Locates the building whose centroid is closest to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point.", "flatPath": "v1/buildingInsights:findClosest", "httpMethod": "GET", "id": "solar.buildingInsights.findClosest", @@ -299,7 +299,7 @@ } } }, - "revision": "20241211", + "revision": "20250302", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { diff --git a/src/apis/solar/v1.ts b/src/apis/solar/v1.ts index 47a5cc97605..6ae9acff257 100644 --- a/src/apis/solar/v1.ts +++ b/src/apis/solar/v1.ts @@ -651,7 +651,7 @@ export namespace solar_v1 { } /** - * Locates the closest building to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point. + * Locates the building whose centroid is closest to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From 8cfc9a0cc01ab890038144803d3188754dd70863 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 121/144] feat(spanner): update the API #### spanner:v1 The following keys were added: - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.flatPath - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.httpMethod - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.id - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.parameterOrder - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.parameters.name.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.parameters.name.location - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.parameters.name.pattern - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.parameters.name.required - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.parameters.name.type - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.path - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.request.$ref - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.response.$ref - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage.scopes - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.flatPath - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.httpMethod - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.id - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.parameterOrder - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.parameters.parent.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.parameters.parent.location - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.parameters.parent.pattern - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.parameters.parent.required - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.parameters.parent.type - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.path - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.request.$ref - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.response.$ref - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter.scopes - schemas.AdaptMessageRequest.description - schemas.AdaptMessageRequest.id - schemas.AdaptMessageRequest.properties.attachments.additionalProperties.type - schemas.AdaptMessageRequest.properties.attachments.description - schemas.AdaptMessageRequest.properties.attachments.type - schemas.AdaptMessageRequest.properties.payload.description - schemas.AdaptMessageRequest.properties.payload.format - schemas.AdaptMessageRequest.properties.payload.type - schemas.AdaptMessageRequest.properties.protocol.description - schemas.AdaptMessageRequest.properties.protocol.type - schemas.AdaptMessageRequest.type - schemas.AdaptMessageResponse.description - schemas.AdaptMessageResponse.id - schemas.AdaptMessageResponse.properties.payload.description - schemas.AdaptMessageResponse.properties.payload.format - schemas.AdaptMessageResponse.properties.payload.type - schemas.AdaptMessageResponse.properties.stateUpdates.additionalProperties.type - schemas.AdaptMessageResponse.properties.stateUpdates.description - schemas.AdaptMessageResponse.properties.stateUpdates.type - schemas.AdaptMessageResponse.type - schemas.AdapterSession.description - schemas.AdapterSession.id - schemas.AdapterSession.properties.name.description - schemas.AdapterSession.properties.name.type - schemas.AdapterSession.type - schemas.Backup.properties.instancePartitions.description - schemas.Backup.properties.instancePartitions.items.$ref - schemas.Backup.properties.instancePartitions.readOnly - schemas.Backup.properties.instancePartitions.type - schemas.BackupInstancePartition.description - schemas.BackupInstancePartition.id - schemas.BackupInstancePartition.properties.instancePartition.description - schemas.BackupInstancePartition.properties.instancePartition.type - schemas.BackupInstancePartition.type - schemas.PartialResultSet.properties.last.description - schemas.PartialResultSet.properties.last.type - schemas.TransactionOptions.properties.isolationLevel.description - schemas.TransactionOptions.properties.isolationLevel.enum - schemas.TransactionOptions.properties.isolationLevel.enumDescriptions - schemas.TransactionOptions.properties.isolationLevel.type The following keys were changed: - resources.projects.resources.instances.resources.databases.resources.sessions.methods.batchWrite.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.commit.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.create.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.delete.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.executeSql.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.get.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.partitionQuery.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.partitionRead.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.read.description - resources.projects.resources.instances.resources.databases.resources.sessions.methods.rollback.description - schemas.AddSplitPointsRequest.properties.initiator.description - schemas.BackupSchedule.properties.encryptionConfig.description - schemas.BatchCreateSessionsRequest.properties.sessionCount.description - schemas.BatchCreateSessionsRequest.properties.sessionTemplate.description - schemas.BatchWriteRequest.properties.excludeTxnFromChangeStreams.description - schemas.BeginTransactionRequest.properties.mutationKey.description - schemas.BeginTransactionRequest.properties.requestOptions.description - schemas.CommitRequest.properties.maxCommitDelay.description - schemas.CommitRequest.properties.precommitToken.description - schemas.CommitRequest.properties.returnCommitStats.description - schemas.CommitRequest.properties.singleUseTransaction.description - schemas.CommitResponse.properties.commitStats.description - schemas.CommitResponse.properties.precommitToken.description - schemas.CrontabSpec.description - schemas.CrontabSpec.properties.creationWindow.description - schemas.CrontabSpec.properties.text.description - schemas.CrontabSpec.properties.timeZone.description - schemas.DirectedReadOptions.description - schemas.DirectedReadOptions.properties.excludeReplicas.description - schemas.DirectedReadOptions.properties.includeReplicas.description - schemas.ExecuteBatchDmlRequest.properties.lastStatements.description - schemas.ExecuteBatchDmlRequest.properties.seqno.description - schemas.ExecuteBatchDmlResponse.properties.precommitToken.description - schemas.ExecuteSqlRequest.properties.dataBoostEnabled.description - schemas.ExecuteSqlRequest.properties.lastStatement.description - schemas.ExecuteSqlRequest.properties.paramTypes.description - schemas.ExecuteSqlRequest.properties.params.description - schemas.ExecuteSqlRequest.properties.partitionToken.description - schemas.ExecuteSqlRequest.properties.queryMode.enumDescriptions - schemas.ExecuteSqlRequest.properties.seqno.description - schemas.IncludeReplicas.description - schemas.IncludeReplicas.properties.autoFailoverDisabled.description - schemas.Instance.properties.nodeCount.description - schemas.Instance.properties.processingUnits.description - schemas.MultiplexedSessionPrecommitToken.description - schemas.PartialResultSet.properties.precommitToken.description - schemas.PartialResultSet.properties.stats.description - schemas.PartialResultSet.properties.values.description - schemas.Partition.properties.partitionToken.description - schemas.PartitionOptions.description - schemas.PartitionOptions.properties.maxPartitions.description - schemas.PartitionOptions.properties.partitionSizeBytes.description - schemas.PartitionQueryRequest.properties.paramTypes.description - schemas.PartitionQueryRequest.properties.params.description - schemas.PartitionQueryRequest.properties.sql.description - schemas.PartitionQueryRequest.properties.transaction.description - schemas.PartitionReadRequest.properties.keySet.description - schemas.QueryOptions.properties.optimizerStatisticsPackage.description - schemas.QueryOptions.properties.optimizerVersion.description - schemas.ReadRequest.properties.dataBoostEnabled.description - schemas.ReadRequest.properties.keySet.description - schemas.ReadRequest.properties.limit.description - schemas.ReadRequest.properties.lockHint.enumDescriptions - schemas.ReadRequest.properties.orderBy.description - schemas.ReadRequest.properties.orderBy.enumDescriptions - schemas.ReadRequest.properties.partitionToken.description - schemas.ReadWrite.properties.readLockMode.enumDescriptions - schemas.ReplicaSelection.description - schemas.ReplicaSelection.properties.location.description - schemas.RequestOptions.properties.requestTag.description - schemas.RequestOptions.properties.transactionTag.description - schemas.ResultSet.properties.precommitToken.description - schemas.ResultSet.properties.stats.description - schemas.ResultSetStats.properties.rowCountLowerBound.description - schemas.Session.properties.approximateLastUseTime.description - schemas.Session.properties.multiplexed.description - schemas.Statement.properties.paramTypes.description - schemas.Statement.properties.params.description --- discovery/spanner-v1.json | 314 ++++++++++++++++++++-------- src/apis/spanner/v1.ts | 417 +++++++++++++++++++++++++++++++------- 2 files changed, 574 insertions(+), 157 deletions(-) diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index 32b80340c91..20c0b9719d2 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -2343,6 +2343,64 @@ }, "sessions": { "methods": { + "adaptMessage": { + "description": "Handles a single message from the client and returns the result as a stream. The server will interpret the message frame and respond with message frames to the client.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:adaptMessage", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.sessions.adaptMessage", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The database session in which the adapter request is processed.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:adaptMessage", + "request": { + "$ref": "AdaptMessageRequest" + }, + "response": { + "$ref": "AdaptMessageResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ] + }, + "adapter": { + "description": "Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many `AdaptMessage` calls.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:adapter", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.sessions.adapter", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The database in which the new session is created.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions:adapter", + "request": { + "$ref": "AdapterSession" + }, + "response": { + "$ref": "AdapterSession" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ] + }, "batchCreate": { "description": "Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:batchCreate", @@ -2373,7 +2431,7 @@ ] }, "batchWrite": { - "description": "Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.", + "description": "Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, that is, some groups might have been committed successfully, while some might have failed. The results of individual batches are streamed into the response as the batches are applied. `BatchWrite` requests are not replay protected, meaning that each mutation group can be applied more than once. Replays of non-idempotent mutations can have undesirable effects. For example, replays of an insert mutation can produce an already exists error or if you use generated or commit timestamp-based keys, it can result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:batchWrite", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.batchWrite", @@ -2431,7 +2489,7 @@ ] }, "commit": { - "description": "Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.", + "description": "Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should retry the transaction from the beginning, reusing the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.commit", @@ -2460,7 +2518,7 @@ ] }, "create": { - "description": "Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `\"SELECT 1\"`.", + "description": "Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it's a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions when no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, for example, `\"SELECT 1\"`.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.create", @@ -2489,7 +2547,7 @@ ] }, "delete": { - "description": "Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.", + "description": "Ends a session, releasing server resources associated with it. This asynchronously triggers the cancellation of any operations that are running with this session.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}", "httpMethod": "DELETE", "id": "spanner.projects.instances.databases.sessions.delete", @@ -2544,7 +2602,7 @@ ] }, "executeSql": { - "description": "Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).", + "description": "Executes an SQL statement, returning all results in a single reply. This method can't be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.executeSql", @@ -2602,7 +2660,7 @@ ] }, "get": { - "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive.", + "description": "Gets a session. Returns `NOT_FOUND` if the session doesn't exist. This is mainly useful for determining whether a session is still alive.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}", "httpMethod": "GET", "id": "spanner.projects.instances.databases.sessions.get", @@ -2670,7 +2728,7 @@ ] }, "partitionQuery": { - "description": "Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.", + "description": "Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the `PartitionQueryRequest` used to create the partition tokens and the `ExecuteSqlRequests` that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the query, and the whole operation must be restarted from the beginning.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionQuery", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.partitionQuery", @@ -2699,7 +2757,7 @@ ] }, "partitionRead": { - "description": "Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.", + "description": "Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the `PartitionReadRequest` used to create the partition tokens and the `ReadRequests` that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual `StreamingRead` call issued with a `partition_token`. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the read, and the whole operation must be restarted from the beginning.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionRead", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.partitionRead", @@ -2728,7 +2786,7 @@ ] }, "read": { - "description": "Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.", + "description": "Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method can't be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.read", @@ -2757,7 +2815,7 @@ ] }, "rollback": { - "description": "Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.", + "description": "Rolls back a transaction, releasing any locks it holds. It's a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction isn't found. `Rollback` never returns `ABORTED`.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.rollback", @@ -3348,15 +3406,68 @@ } } }, - "revision": "20250113", + "revision": "20250304", "rootUrl": "https://spanner.googleapis.com/", "schemas": { + "AdaptMessageRequest": { + "description": "Message sent by the client to the adapter.", + "id": "AdaptMessageRequest", + "properties": { + "attachments": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Opaque request state passed by the client to the server.", + "type": "object" + }, + "payload": { + "description": "Optional. Uninterpreted bytes from the underlying wire protocol.", + "format": "byte", + "type": "string" + }, + "protocol": { + "description": "Required. Identifier for the underlying wire protocol.", + "type": "string" + } + }, + "type": "object" + }, + "AdaptMessageResponse": { + "description": "Message sent by the adapter to the client.", + "id": "AdaptMessageResponse", + "properties": { + "payload": { + "description": "Optional. Uninterpreted bytes from the underlying wire protocol.", + "format": "byte", + "type": "string" + }, + "stateUpdates": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Opaque state updates to be applied by the client.", + "type": "object" + } + }, + "type": "object" + }, + "AdapterSession": { + "description": "A session in the Cloud Spanner Adapter API.", + "id": "AdapterSession", + "properties": { + "name": { + "description": "Identifier. The name of the session. This is always system-assigned.", + "type": "string" + } + }, + "type": "object" + }, "AddSplitPointsRequest": { "description": "The request for AddSplitPoints.", "id": "AddSplitPointsRequest", "properties": { "initiator": { - "description": "Optional. A user-supplied tag associated with the split points. For example, \"intital_data_load\", \"special_event_1\". Defaults to \"CloudAddSplitPointsAPI\" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.", + "description": "Optional. A user-supplied tag associated with the split points. For example, \"initial_data_load\", \"special_event_1\". Defaults to \"CloudAddSplitPointsAPI\" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.", "type": "string" }, "splitPoints": { @@ -3544,6 +3655,14 @@ "readOnly": true, "type": "string" }, + "instancePartitions": { + "description": "Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`.", + "items": { + "$ref": "BackupInstancePartition" + }, + "readOnly": true, + "type": "array" + }, "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", @@ -3630,13 +3749,24 @@ }, "type": "object" }, + "BackupInstancePartition": { + "description": "Instance partition information for the backup.", + "id": "BackupInstancePartition", + "properties": { + "instancePartition": { + "description": "A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/`", + "type": "string" + } + }, + "type": "object" + }, "BackupSchedule": { "description": "BackupSchedule expresses the automated backup creation specification for a Spanner database.", "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." + "description": "Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database." }, "fullBackupSpec": { "$ref": "FullBackupSpec", @@ -3684,13 +3814,13 @@ "id": "BatchCreateSessionsRequest", "properties": { "sessionCount": { - "description": "Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).", + "description": "Required. The number of sessions to be created in this batch call. The API can return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to `BatchCreateSessions` (adjusting session_count as necessary).", "format": "int32", "type": "integer" }, "sessionTemplate": { "$ref": "Session", - "description": "Parameters to be applied to each created session." + "description": "Parameters to apply to each created session." } }, "type": "object" @@ -3714,7 +3844,7 @@ "id": "BatchWriteRequest", "properties": { "excludeTxnFromChangeStreams": { - "description": "Optional. When `exclude_txn_from_change_streams` is set to `true`: * Modifications from all transactions in this batch write operation will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from all transactions in this batch write operation will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions.", + "description": "Optional. When `exclude_txn_from_change_streams` is set to `true`: * Modifications from all transactions in this batch write operation are not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from all transactions in this batch write operation are recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from all transactions in this batch write operation are recorded in all change streams that are tracking columns modified by these transactions.", "type": "boolean" }, "mutationGroups": { @@ -3761,7 +3891,7 @@ "properties": { "mutationKey": { "$ref": "Mutation", - "description": "Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request." + "description": "Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request." }, "options": { "$ref": "TransactionOptions", @@ -3769,7 +3899,7 @@ }, "requestOptions": { "$ref": "RequestOptions", - "description": "Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead." + "description": "Common options for this request. Priority is ignored for this request. Setting the priority in this `request_options` struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead." } }, "type": "object" @@ -3861,7 +3991,7 @@ "id": "CommitRequest", "properties": { "maxCommitDelay": { - "description": "Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms.", + "description": "Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field isn't set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms.", "format": "google-duration", "type": "string" }, @@ -3874,19 +4004,19 @@ }, "precommitToken": { "$ref": "MultiplexedSessionPrecommitToken", - "description": "Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error." + "description": "Optional. If the read-write transaction was executed on a multiplexed session, then you must include the precommit token with the highest sequence number received in this transaction attempt. Failing to do so results in a `FailedPrecondition` error." }, "requestOptions": { "$ref": "RequestOptions", "description": "Common options for this request." }, "returnCommitStats": { - "description": "If `true`, then statistics related to the transaction will be included in the CommitResponse. Default value is `false`.", + "description": "If `true`, then statistics related to the transaction is included in the CommitResponse. Default value is `false`.", "type": "boolean" }, "singleUseTransaction": { "$ref": "TransactionOptions", - "description": "Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead." + "description": "Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it's possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead." }, "transactionId": { "description": "Commit a previously-started transaction.", @@ -3902,7 +4032,7 @@ "properties": { "commitStats": { "$ref": "CommitStats", - "description": "The statistics about this Commit. Not returned by default. For more information, see CommitRequest.return_commit_stats." + "description": "The statistics about this `Commit`. Not returned by default. For more information, see CommitRequest.return_commit_stats." }, "commitTimestamp": { "description": "The Cloud Spanner timestamp at which the transaction committed.", @@ -3911,7 +4041,7 @@ }, "precommitToken": { "$ref": "MultiplexedSessionPrecommitToken", - "description": "If specified, transaction has not committed yet. Clients must retry the commit with the new precommit token." + "description": "If specified, transaction has not committed yet. You must retry the commit with the new precommit token." } }, "type": "object" @@ -4305,21 +4435,21 @@ "type": "object" }, "CrontabSpec": { - "description": "CrontabSpec can be used to specify the version time and frequency at which the backup should be created.", + "description": "CrontabSpec can be used to specify the version time and frequency at which the backup is 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`.", + "description": "Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates 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 timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. 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 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) 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.", + "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 timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. 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 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) 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.", + "description": "Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported.", "readOnly": true, "type": "string" } @@ -4528,16 +4658,16 @@ "type": "object" }, "DirectedReadOptions": { - "description": "The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries. DirectedReadOptions may only be specified for a read-only transaction, otherwise the API will return an `INVALID_ARGUMENT` error.", + "description": "The `DirectedReadOptions` can be used to indicate which replicas or regions should be used for non-transactional reads or queries. `DirectedReadOptions` can only be specified for a read-only transaction, otherwise the API returns an `INVALID_ARGUMENT` error.", "id": "DirectedReadOptions", "properties": { "excludeReplicas": { "$ref": "ExcludeReplicas", - "description": "Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list." + "description": "`Exclude_replicas` indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list." }, "includeReplicas": { "$ref": "IncludeReplicas", - "description": "Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to `DEADLINE_EXCEEDED` errors." + "description": "`Include_replicas` indicates the order of replicas (as they appear in this list) to process the request. If `auto_failover_disabled` is set to `true` and all replicas are exhausted without finding a healthy replica, Spanner waits for a replica in the list to become available, requests might fail due to `DEADLINE_EXCEEDED` errors." } }, "type": "object" @@ -4623,7 +4753,7 @@ "id": "ExecuteBatchDmlRequest", "properties": { "lastStatements": { - "description": "Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully.", + "description": "Optional. If set to `true`, this request marks the end of the transaction. After these statements execute, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. Setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of statements shouldn't be assumed until a subsequent `Commit` call completes successfully.", "type": "boolean" }, "requestOptions": { @@ -4631,7 +4761,7 @@ "description": "Common options for this request." }, "seqno": { - "description": "Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.", + "description": "Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction might be aborted. Replays of previously handled requests yield the same response as the first execution.", "format": "int64", "type": "string" }, @@ -4655,7 +4785,7 @@ "properties": { "precommitToken": { "$ref": "MultiplexedSessionPrecommitToken", - "description": "Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction." + "description": "Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction." }, "resultSets": { "description": "One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata.", @@ -4676,7 +4806,7 @@ "id": "ExecuteSqlRequest", "properties": { "dataBoostEnabled": { - "description": "If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error.", + "description": "If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error.", "type": "boolean" }, "directedReadOptions": { @@ -4684,14 +4814,14 @@ "description": "Directed read options for this request." }, "lastStatement": { - "description": "Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully.", + "description": "Optional. If set to `true`, this statement marks the end of the transaction. After this statement executes, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. For DML statements, setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of a DML statement shouldn't be assumed until a subsequent `Commit` call completes successfully.", "type": "boolean" }, "paramTypes": { "additionalProperties": { "$ref": "Type" }, - "description": "It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.", + "description": "It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, you can use `param_types` to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.", "type": "object" }, "params": { @@ -4699,11 +4829,11 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `\"WHERE id > @msg_id AND id < @msg_id + 100\"` It is an error to execute a SQL statement with unbound parameters.", + "description": "Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `\"WHERE id > @msg_id AND id < @msg_id + 100\"` It's an error to execute a SQL statement with unbound parameters.", "type": "object" }, "partitionToken": { - "description": "If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.", + "description": "If present, results are restricted to the specified partition previously created using `PartitionQuery`. There must be an exact match for the values of fields common to this message and the `PartitionQueryRequest` message used to create this `partition_token`.", "format": "byte", "type": "string" }, @@ -4719,7 +4849,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 the query plan, overall execution statistics, operator level execution statistics along with the results. This has a performance overhead compared to the other modes. It is not recommended to use this mode for production traffic.", + "This mode returns the query plan, overall execution statistics, operator level execution statistics along with the results. This has a performance overhead compared to the other modes. It isn't recommended to use this mode for production traffic.", "This mode returns the overall (but not operator-level) execution statistics along with the results.", "This mode returns the query plan, overall (but not operator-level) execution statistics along with the results." ], @@ -4739,7 +4869,7 @@ "type": "string" }, "seqno": { - "description": "A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries.", + "description": "A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution. Required for DML statements. Ignored for queries.", "format": "int64", "type": "string" }, @@ -4874,11 +5004,11 @@ "type": "object" }, "IncludeReplicas": { - "description": "An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.", + "description": "An `IncludeReplicas` contains a repeated set of `ReplicaSelection` which indicates the order in which replicas should be considered.", "id": "IncludeReplicas", "properties": { "autoFailoverDisabled": { - "description": "If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is `false`.", + "description": "If `true`, Spanner doesn't route requests to a replica outside the <`include_replicas` list when all of the specified replicas are unavailable or unhealthy. Default value is `false`.", "type": "boolean" }, "replicaSelections": { @@ -5034,12 +5164,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 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).", + "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. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. 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 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).", + "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. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, @@ -5869,7 +5999,7 @@ "type": "object" }, "MultiplexedSessionPrecommitToken": { - "description": "When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the [Transaction] message in the BeginTransaction response and also as a part of the [ResultSet] and [PartialResultSet] responses.", + "description": "When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the Transaction message in the BeginTransaction response and also as a part of the ResultSet and PartialResultSet responses.", "id": "MultiplexedSessionPrecommitToken", "properties": { "precommitToken": { @@ -6006,13 +6136,17 @@ "description": "If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value.", "type": "boolean" }, + "last": { + "description": "Optional. Indicates whether this is the last `PartialResultSet` in the stream. The server might optionally set this field. Clients shouldn't rely on this field being set in all cases.", + "type": "boolean" + }, "metadata": { "$ref": "ResultSetMetadata", "description": "Metadata about the result set, such as row type information. Only present in the first response." }, "precommitToken": { "$ref": "MultiplexedSessionPrecommitToken", - "description": "Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction." + "description": "Optional. A precommit token is included if the read-write transaction has multiplexed sessions enabled. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction." }, "resumeToken": { "description": "Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token.", @@ -6021,10 +6155,10 @@ }, "stats": { "$ref": "ResultSetStats", - "description": "Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements." + "description": "Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field is also present in the last response for DML statements." }, "values": { - "description": "A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It is possible that the last value in values is \"chunked\", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: cannot be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: # Strings are concatenated. \"foo\", \"bar\" => \"foobar\" # Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are concatenated, but the last and first elements are merged # because they are strings. [\"a\", \"b\"], [\"c\", \"d\"] => [\"a\", \"bc\", \"d\"] # Lists are concatenated, but the last and first elements are merged # because they are lists. Recursively, the last and first elements # of the inner lists are merged because they are strings. [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] => [\"a\", [\"b\", \"cd\"], \"e\"] # Non-overlapping object fields are combined. {\"a\": \"1\"}, {\"b\": \"2\"} => {\"a\": \"1\", \"b\": 2\"} # Overlapping object fields are merged. {\"a\": \"1\"}, {\"a\": \"2\"} => {\"a\": \"12\"} # Examples of merging objects containing lists of strings. {\"a\": [\"1\"]}, {\"a\": [\"2\"]} => {\"a\": [\"12\"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { \"metadata\": { ... } \"values\": [\"Hello\", \"W\"] \"chunked_value\": true \"resume_token\": \"Af65...\" } { \"values\": [\"orl\"] \"chunked_value\": true } { \"values\": [\"d\"] \"resume_token\": \"Zx1B...\" } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `\"Hello\"`, and a second containing the field value `\"World\" = \"W\" + \"orl\" + \"d\"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, resuming the query with `\"resume_token\": \"Af65...\"` will yield results from the `PartialResultSet` with value `[\"orl\"]`.", + "description": "A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It's possible that the last value in values is \"chunked\", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: can't be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: Strings are concatenated. \"foo\", \"bar\" => \"foobar\" Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] Lists are concatenated, but the last and first elements are merged because they are strings. [\"a\", \"b\"], [\"c\", \"d\"] => [\"a\", \"bc\", \"d\"] Lists are concatenated, but the last and first elements are merged because they are lists. Recursively, the last and first elements of the inner lists are merged because they are strings. [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] => [\"a\", [\"b\", \"cd\"], \"e\"] Non-overlapping object fields are combined. {\"a\": \"1\"}, {\"b\": \"2\"} => {\"a\": \"1\", \"b\": 2\"} Overlapping object fields are merged. {\"a\": \"1\"}, {\"a\": \"2\"} => {\"a\": \"12\"} Examples of merging objects containing lists of strings. {\"a\": [\"1\"]}, {\"a\": [\"2\"]} => {\"a\": [\"12\"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { \"metadata\": { ... } \"values\": [\"Hello\", \"W\"] \"chunked_value\": true \"resume_token\": \"Af65...\" } { \"values\": [\"orl\"] \"chunked_value\": true } { \"values\": [\"d\"] \"resume_token\": \"Zx1B...\" } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `\"Hello\"`, and a second containing the field value `\"World\" = \"W\" + \"orl\" + \"d\"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, resuming the query with `\"resume_token\": \"Af65...\"` yields results from the `PartialResultSet` with value \"orl\".", "items": { "type": "any" }, @@ -6038,7 +6172,7 @@ "id": "Partition", "properties": { "partitionToken": { - "description": "This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token.", + "description": "This token can be passed to `Read`, `StreamingRead`, `ExecuteSql`, or `ExecuteStreamingSql` requests to restrict the results to those identified by this partition token.", "format": "byte", "type": "string" } @@ -6046,16 +6180,16 @@ "type": "object" }, "PartitionOptions": { - "description": "Options for a PartitionQueryRequest and PartitionReadRequest.", + "description": "Options for a `PartitionQueryRequest` and `PartitionReadRequest`.", "id": "PartitionOptions", "properties": { "maxPartitions": { - "description": "**Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request.", + "description": "**Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests. The desired maximum number of partitions to return. For example, this might be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned can be smaller or larger than this maximum count request.", "format": "int64", "type": "string" }, "partitionSizeBytes": { - "description": "**Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request.", + "description": "**Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition can be smaller or larger than this size request.", "format": "int64", "type": "string" } @@ -6070,7 +6204,7 @@ "additionalProperties": { "$ref": "Type" }, - "description": "It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.", + "description": "It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.", "type": "object" }, "params": { @@ -6078,7 +6212,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `\"WHERE id > @msg_id AND id < @msg_id + 100\"` It is an error to execute a SQL statement with unbound parameters.", + "description": "Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `\"WHERE id > @msg_id AND id < @msg_id + 100\"` It's an error to execute a SQL statement with unbound parameters.", "type": "object" }, "partitionOptions": { @@ -6086,12 +6220,12 @@ "description": "Additional options that affect how many partitions are created." }, "sql": { - "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.", + "description": "Required. The query request to generate partitions for. The request fails if the query isn't 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": { "$ref": "TransactionSelector", - "description": "Read only snapshot transactions are supported, read/write and single use transactions are not." + "description": "Read-only snapshot transactions are supported, read and write and single-use transactions are not." } }, "type": "object" @@ -6113,7 +6247,7 @@ }, "keySet": { "$ref": "KeySet", - "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows." + "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It isn't an error for the `key_set` to name rows that don't exist in the database. Read yields nothing for nonexistent rows." }, "partitionOptions": { "$ref": "PartitionOptions", @@ -6284,11 +6418,11 @@ "id": "QueryOptions", "properties": { "optimizerStatisticsPackage": { - "description": "An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying `latest` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option is not set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement: ``` ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails with an `INVALID_ARGUMENT` error.", + "description": "An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying `latest` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option isn't set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement: ```sql ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails with an `INVALID_ARGUMENT` error.", "type": "string" }, "optimizerVersion": { - "description": "An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying `latest` as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an invalid optimizer version fails with an `INVALID_ARGUMENT` error. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The `optimizer_version` statement hint has precedence over this setting.", + "description": "An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying `latest` as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from `SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS`. Executing a SQL statement with an invalid optimizer version fails with an `INVALID_ARGUMENT` error. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The `optimizer_version` statement hint has precedence over this setting.", "type": "string" } }, @@ -6412,7 +6546,7 @@ "type": "array" }, "dataBoostEnabled": { - "description": "If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error.", + "description": "If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error.", "type": "boolean" }, "directedReadOptions": { @@ -6425,10 +6559,10 @@ }, "keySet": { "$ref": "KeySet", - "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows." + "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field isn't empty, rows are yielded in an unspecified order. It isn't an error for the `key_set` to name rows that don't exist in the database. Read yields nothing for nonexistent rows." }, "limit": { - "description": "If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit cannot be specified if `partition_token` is set.", + "description": "If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit can't be specified if `partition_token` is set.", "format": "int64", "type": "string" }, @@ -6440,28 +6574,28 @@ "LOCK_HINT_EXCLUSIVE" ], "enumDescriptions": [ - "Default value. LOCK_HINT_UNSPECIFIED is equivalent to LOCK_HINT_SHARED.", + "Default value. `LOCK_HINT_UNSPECIFIED` is equivalent to `LOCK_HINT_SHARED`.", "Acquire shared locks. By default when you perform a read as part of a read-write transaction, Spanner acquires shared read locks, which allows other reads to still access the data until your transaction is ready to commit. When your transaction is committing and writes are being applied, the transaction attempts to upgrade to an exclusive lock for any data you are writing. For more information about locks, see [Lock modes](https://cloud.google.com/spanner/docs/introspection/lock-statistics#explain-lock-modes).", - "Acquire exclusive locks. Requesting exclusive locks is beneficial if you observe high write contention, which means you notice that multiple transactions are concurrently trying to read and write to the same data, resulting in a large number of aborts. This problem occurs when two transactions initially acquire shared locks and then both try to upgrade to exclusive locks at the same time. In this situation both transactions are waiting for the other to give up their lock, resulting in a deadlocked situation. Spanner is able to detect this occurring and force one of the transactions to abort. However, this is a slow and expensive operation and results in lower performance. In this case it makes sense to acquire exclusive locks at the start of the transaction because then when multiple transactions try to act on the same data, they automatically get serialized. Each transaction waits its turn to acquire the lock and avoids getting into deadlock situations. Because the exclusive lock hint is just a hint, it should not be considered equivalent to a mutex. In other words, you should not use Spanner exclusive locks as a mutual exclusion mechanism for the execution of code outside of Spanner. **Note:** Request exclusive locks judiciously because they block others from reading that data for the entire transaction, rather than just when the writes are being performed. Unless you observe high write contention, you should use the default of shared read locks so you don't prematurely block other clients from reading the data that you're writing to." + "Acquire exclusive locks. Requesting exclusive locks is beneficial if you observe high write contention, which means you notice that multiple transactions are concurrently trying to read and write to the same data, resulting in a large number of aborts. This problem occurs when two transactions initially acquire shared locks and then both try to upgrade to exclusive locks at the same time. In this situation both transactions are waiting for the other to give up their lock, resulting in a deadlocked situation. Spanner is able to detect this occurring and force one of the transactions to abort. However, this is a slow and expensive operation and results in lower performance. In this case it makes sense to acquire exclusive locks at the start of the transaction because then when multiple transactions try to act on the same data, they automatically get serialized. Each transaction waits its turn to acquire the lock and avoids getting into deadlock situations. Because the exclusive lock hint is just a hint, it shouldn't be considered equivalent to a mutex. In other words, you shouldn't use Spanner exclusive locks as a mutual exclusion mechanism for the execution of code outside of Spanner. **Note:** Request exclusive locks judiciously because they block others from reading that data for the entire transaction, rather than just when the writes are being performed. Unless you observe high write contention, you should use the default of shared read locks so you don't prematurely block other clients from reading the data that you're writing to." ], "type": "string" }, "orderBy": { - "description": "Optional. Order for the returned rows. By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups).", + "description": "Optional. Order for the returned rows. By default, Spanner returns result rows in primary key order except for PartitionRead requests. For applications that don't require rows to be returned in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (for example, bulk point lookups).", "enum": [ "ORDER_BY_UNSPECIFIED", "ORDER_BY_PRIMARY_KEY", "ORDER_BY_NO_ORDER" ], "enumDescriptions": [ - "Default value. ORDER_BY_UNSPECIFIED is equivalent to ORDER_BY_PRIMARY_KEY.", - "Read rows are returned in primary key order. In the event that this option is used in conjunction with the `partition_token` field, the API will return an `INVALID_ARGUMENT` error.", + "Default value. `ORDER_BY_UNSPECIFIED` is equivalent to `ORDER_BY_PRIMARY_KEY`.", + "Read rows are returned in primary key order. In the event that this option is used in conjunction with the `partition_token` field, the API returns an `INVALID_ARGUMENT` error.", "Read rows are returned in any order." ], "type": "string" }, "partitionToken": { - "description": "If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.", + "description": "If present, results are restricted to the specified partition previously created using `PartitionRead`. There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.", "format": "byte", "type": "string" }, @@ -6502,9 +6636,9 @@ "OPTIMISTIC" ], "enumDescriptions": [ - "Default value. If the value is not specified, the pessimistic read lock is used.", - "Pessimistic lock mode. Read locks are acquired immediately on read.", - "Optimistic lock mode. Locks for reads within the transaction are not acquired on read. Instead the locks are acquired on a commit to validate that read/queried data has not changed since the transaction started." + "Default value. * If isolation level is REPEATABLE_READ, then it is an error to specify `read_lock_mode`. Locking semantics default to `OPTIMISTIC`. No validation checks are done for reads, except to validate that the data that was served at the snapshot time is unchanged at commit time in the following cases: 1. reads done as part of queries that use `SELECT FOR UPDATE` 2. reads done as part of statements with a `LOCK_SCANNED_RANGES` hint 3. reads done as part of DML statements * At all other isolation levels, if `read_lock_mode` is the default value, then pessimistic read locks are used.", + "Pessimistic lock mode. Read locks are acquired immediately on read. Semantics described only applies to SERIALIZABLE isolation.", + "Optimistic lock mode. Locks for reads within the transaction are not acquired on read. Instead the locks are acquired on a commit to validate that read/queried data has not changed since the transaction started. Semantics described only applies to SERIALIZABLE isolation." ], "type": "string" } @@ -6563,11 +6697,11 @@ "type": "object" }, "ReplicaSelection": { - "description": "The directed read replica selector. Callers must provide one or more of the following fields for replica selection: * `location` - The location must be one of the regions within the multi-region configuration of your database. * `type` - The type of the replica. Some examples of using replica_selectors are: * `location:us-east1` --> The \"us-east1\" replica(s) of any available type will be used to process the request. * `type:READ_ONLY` --> The \"READ_ONLY\" type replica(s) in nearest available location will be used to process the request. * `location:us-east1 type:READ_ONLY` --> The \"READ_ONLY\" type replica(s) in location \"us-east1\" will be used to process the request.", + "description": "The directed read replica selector. Callers must provide one or more of the following fields for replica selection: * `location` - The location must be one of the regions within the multi-region configuration of your database. * `type` - The type of the replica. Some examples of using replica_selectors are: * `location:us-east1` --> The \"us-east1\" replica(s) of any available type is used to process the request. * `type:READ_ONLY` --> The \"READ_ONLY\" type replica(s) in the nearest available location are used to process the request. * `location:us-east1 type:READ_ONLY` --> The \"READ_ONLY\" type replica(s) in location \"us-east1\" is used to process the request.", "id": "ReplicaSelection", "properties": { "location": { - "description": "The location or region of the serving requests, e.g. \"us-east1\".", + "description": "The location or region of the serving requests, for example, \"us-east1\".", "type": "string" }, "type": { @@ -6608,11 +6742,11 @@ "type": "string" }, "requestTag": { - "description": "A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.", + "description": "A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.", "type": "string" }, "transactionTag": { - "description": "A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.", + "description": "A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.", "type": "string" } }, @@ -6744,7 +6878,7 @@ }, "precommitToken": { "$ref": "MultiplexedSessionPrecommitToken", - "description": "Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction." + "description": "Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction." }, "rows": { "description": "Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.", @@ -6758,7 +6892,7 @@ }, "stats": { "$ref": "ResultSetStats", - "description": "Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode." + "description": "Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode." } }, "type": "object" @@ -6804,7 +6938,7 @@ "type": "string" }, "rowCountLowerBound": { - "description": "Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified.", + "description": "Partitioned DML doesn't offer exactly-once semantics, so it returns a lower bound of the rows modified.", "format": "int64", "type": "string" } @@ -6883,7 +7017,7 @@ "id": "Session", "properties": { "approximateLastUseTime": { - "description": "Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time.", + "description": "Output only. The approximate timestamp when the session is last used. It's typically earlier than the actual last use time.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6906,7 +7040,7 @@ "type": "object" }, "multiplexed": { - "description": "Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions.", + "description": "Optional. If `true`, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions.", "type": "boolean" }, "name": { @@ -6993,7 +7127,7 @@ "additionalProperties": { "$ref": "Type" }, - "description": "It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.", + "description": "It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.", "type": "object" }, "params": { @@ -7001,7 +7135,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `\"WHERE id > @msg_id AND id < @msg_id + 100\"` It is an error to execute a SQL statement with unbound parameters.", + "description": "Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `\"WHERE id > @msg_id AND id < @msg_id + 100\"` It's an error to execute a SQL statement with unbound parameters.", "type": "object" }, "sql": { @@ -7109,6 +7243,20 @@ "description": "When `exclude_txn_from_change_streams` is set to `true`: * Modifications from this transaction will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from this transaction will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. `exclude_txn_from_change_streams` may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an `INVALID_ARGUMENT` error.", "type": "boolean" }, + "isolationLevel": { + "description": "Isolation level for the transaction.", + "enum": [ + "ISOLATION_LEVEL_UNSPECIFIED", + "SERIALIZABLE", + "REPEATABLE_READ" + ], + "enumDescriptions": [ + "Default value. If the value is not specified, the `SERIALIZABLE` isolation level is used.", + "All transactions appear as if they executed in a serial order, even if some of the reads, writes, and other operations of distinct transactions actually occurred in parallel. Spanner assigns commit timestamps that reflect the order of committed transactions to implement this property. Spanner offers a stronger guarantee than serializability called external consistency. For further details, please refer to https://cloud.google.com/spanner/docs/true-time-external-consistency#serializability.", + "All reads performed during the transaction observe a consistent snapshot of the database, and the transaction will only successfully commit in the absence of conflicts between its updates and any concurrent updates that have occurred since that snapshot. Consequently, in contrast to `SERIALIZABLE` transactions, only write-write conflicts are detected in snapshot transactions. This isolation level does not support Read-only and Partitioned DML transactions. When `REPEATABLE_READ` is specified on a read-write transaction, the locking semantics default to `OPTIMISTIC`." + ], + "type": "string" + }, "partitionedDml": { "$ref": "PartitionedDml", "description": "Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource." diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 940f918504f..a0700b9f13e 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -126,12 +126,51 @@ export namespace spanner_v1 { } } + /** + * A session in the Cloud Spanner Adapter API. + */ + export interface Schema$AdapterSession { + /** + * Identifier. The name of the session. This is always system-assigned. + */ + name?: string | null; + } + /** + * Message sent by the client to the adapter. + */ + export interface Schema$AdaptMessageRequest { + /** + * Optional. Opaque request state passed by the client to the server. + */ + attachments?: {[key: string]: string} | null; + /** + * Optional. Uninterpreted bytes from the underlying wire protocol. + */ + payload?: string | null; + /** + * Required. Identifier for the underlying wire protocol. + */ + protocol?: string | null; + } + /** + * Message sent by the adapter to the client. + */ + export interface Schema$AdaptMessageResponse { + /** + * Optional. Uninterpreted bytes from the underlying wire protocol. + */ + payload?: string | null; + /** + * Optional. Opaque state updates to be applied by the client. + */ + stateUpdates?: {[key: string]: string} | null; + } /** * The request for AddSplitPoints. */ export interface Schema$AddSplitPointsRequest { /** - * Optional. A user-supplied tag associated with the split points. For example, "intital_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed. + * Optional. A user-supplied tag associated with the split points. For example, "initial_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed. */ initiator?: string | null; /** @@ -264,6 +303,10 @@ export namespace spanner_v1 { * 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 instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`. + */ + instancePartitions?: Schema$BackupInstancePartition[]; /** * 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`. */ @@ -318,12 +361,21 @@ export namespace spanner_v1 { */ versionTime?: string | null; } + /** + * Instance partition information for the backup. + */ + export interface Schema$BackupInstancePartition { + /** + * A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/` + */ + instancePartition?: string | null; + } /** * BackupSchedule expresses the automated backup creation specification for a Spanner database. */ 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. + * Optional. The encryption configuration that is used to encrypt the backup. If this field is not specified, the backup uses the same encryption configuration as the database. */ encryptionConfig?: Schema$CreateBackupEncryptionConfig; /** @@ -365,11 +417,11 @@ export namespace spanner_v1 { */ export interface Schema$BatchCreateSessionsRequest { /** - * Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary). + * Required. The number of sessions to be created in this batch call. The API can return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to `BatchCreateSessions` (adjusting session_count as necessary). */ sessionCount?: number | null; /** - * Parameters to be applied to each created session. + * Parameters to apply to each created session. */ sessionTemplate?: Schema$Session; } @@ -387,7 +439,7 @@ export namespace spanner_v1 { */ export interface Schema$BatchWriteRequest { /** - * Optional. When `exclude_txn_from_change_streams` is set to `true`: * Modifications from all transactions in this batch write operation will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from all transactions in this batch write operation will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions. + * Optional. When `exclude_txn_from_change_streams` is set to `true`: * Modifications from all transactions in this batch write operation are not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from all transactions in this batch write operation are recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from all transactions in this batch write operation are recorded in all change streams that are tracking columns modified by these transactions. */ excludeTxnFromChangeStreams?: boolean | null; /** @@ -421,7 +473,7 @@ export namespace spanner_v1 { */ export interface Schema$BeginTransactionRequest { /** - * Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. + * Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request. */ mutationKey?: Schema$Mutation; /** @@ -429,7 +481,7 @@ export namespace spanner_v1 { */ options?: Schema$TransactionOptions; /** - * Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. + * Common options for this request. Priority is ignored for this request. Setting the priority in this `request_options` struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. */ requestOptions?: Schema$RequestOptions; } @@ -506,7 +558,7 @@ export namespace spanner_v1 { */ export interface Schema$CommitRequest { /** - * Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms. + * Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field isn't set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms. */ maxCommitDelay?: string | null; /** @@ -514,7 +566,7 @@ export namespace spanner_v1 { */ mutations?: Schema$Mutation[]; /** - * Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. + * Optional. If the read-write transaction was executed on a multiplexed session, then you must include the precommit token with the highest sequence number received in this transaction attempt. Failing to do so results in a `FailedPrecondition` error. */ precommitToken?: Schema$MultiplexedSessionPrecommitToken; /** @@ -522,11 +574,11 @@ export namespace spanner_v1 { */ requestOptions?: Schema$RequestOptions; /** - * If `true`, then statistics related to the transaction will be included in the CommitResponse. Default value is `false`. + * If `true`, then statistics related to the transaction is included in the CommitResponse. Default value is `false`. */ returnCommitStats?: boolean | null; /** - * Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead. + * Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it's possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead. */ singleUseTransaction?: Schema$TransactionOptions; /** @@ -539,7 +591,7 @@ export namespace spanner_v1 { */ export interface Schema$CommitResponse { /** - * The statistics about this Commit. Not returned by default. For more information, see CommitRequest.return_commit_stats. + * The statistics about this `Commit`. Not returned by default. For more information, see CommitRequest.return_commit_stats. */ commitStats?: Schema$CommitStats; /** @@ -547,7 +599,7 @@ export namespace spanner_v1 { */ commitTimestamp?: string | null; /** - * If specified, transaction has not committed yet. Clients must retry the commit with the new precommit token. + * If specified, transaction has not committed yet. You must retry the commit with the new precommit token. */ precommitToken?: Schema$MultiplexedSessionPrecommitToken; } @@ -828,19 +880,19 @@ 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. + * CrontabSpec can be used to specify the version time and frequency at which the backup is 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`. + * Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates 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 timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. 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 x/4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) 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. + * 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 timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. 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 x/4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) 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. + * Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported. */ timeZone?: string | null; } @@ -979,15 +1031,15 @@ export namespace spanner_v1 { shortMessage?: Schema$LocalizedString; } /** - * The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries. DirectedReadOptions may only be specified for a read-only transaction, otherwise the API will return an `INVALID_ARGUMENT` error. + * The `DirectedReadOptions` can be used to indicate which replicas or regions should be used for non-transactional reads or queries. `DirectedReadOptions` can only be specified for a read-only transaction, otherwise the API returns an `INVALID_ARGUMENT` error. */ export interface Schema$DirectedReadOptions { /** - * Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list. + * `Exclude_replicas` indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list. */ excludeReplicas?: Schema$ExcludeReplicas; /** - * Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to `DEADLINE_EXCEEDED` errors. + * `Include_replicas` indicates the order of replicas (as they appear in this list) to process the request. If `auto_failover_disabled` is set to `true` and all replicas are exhausted without finding a healthy replica, Spanner waits for a replica in the list to become available, requests might fail due to `DEADLINE_EXCEEDED` errors. */ includeReplicas?: Schema$IncludeReplicas; } @@ -1043,7 +1095,7 @@ export namespace spanner_v1 { */ export interface Schema$ExecuteBatchDmlRequest { /** - * Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully. + * Optional. If set to `true`, this request marks the end of the transaction. After these statements execute, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. Setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of statements shouldn't be assumed until a subsequent `Commit` call completes successfully. */ lastStatements?: boolean | null; /** @@ -1051,7 +1103,7 @@ export namespace spanner_v1 { */ requestOptions?: Schema$RequestOptions; /** - * Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. + * Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction might be aborted. Replays of previously handled requests yield the same response as the first execution. */ seqno?: string | null; /** @@ -1068,7 +1120,7 @@ export namespace spanner_v1 { */ export interface Schema$ExecuteBatchDmlResponse { /** - * Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. + * Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. */ precommitToken?: Schema$MultiplexedSessionPrecommitToken; /** @@ -1085,7 +1137,7 @@ export namespace spanner_v1 { */ export interface Schema$ExecuteSqlRequest { /** - * If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error. + * If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error. */ dataBoostEnabled?: boolean | null; /** @@ -1093,19 +1145,19 @@ export namespace spanner_v1 { */ directedReadOptions?: Schema$DirectedReadOptions; /** - * Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully. + * Optional. If set to `true`, this statement marks the end of the transaction. After this statement executes, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. For DML statements, setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of a DML statement shouldn't be assumed until a subsequent `Commit` call completes successfully. */ lastStatement?: boolean | null; /** - * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. + * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL statement with unbound parameters. */ params?: {[key: string]: any} | null; /** - * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. + * It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, you can use `param_types` to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */ paramTypes?: {[key: string]: Schema$Type} | null; /** - * If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token. + * If present, results are restricted to the specified partition previously created using `PartitionQuery`. There must be an exact match for the values of fields common to this message and the `PartitionQueryRequest` message used to create this `partition_token`. */ partitionToken?: string | null; /** @@ -1125,7 +1177,7 @@ export namespace spanner_v1 { */ resumeToken?: string | null; /** - * A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. + * A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution. Required for DML statements. Ignored for queries. */ seqno?: string | null; /** @@ -1224,11 +1276,11 @@ export namespace spanner_v1 { requestedPolicyVersion?: number | null; } /** - * An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered. + * An `IncludeReplicas` contains a repeated set of `ReplicaSelection` which indicates the order in which replicas should be considered. */ export interface Schema$IncludeReplicas { /** - * If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is `false`. + * If `true`, Spanner doesn't route requests to a replica outside the <`include_replicas` list when all of the specified replicas are unavailable or unhealthy. Default value is `false`. */ autoFailoverDisabled?: boolean | null; /** @@ -1320,11 +1372,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 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). + * 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. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. 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 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). + * 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. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). */ processingUnits?: number | null; /** @@ -1869,7 +1921,7 @@ export namespace spanner_v1 { targetConfig?: string | null; } /** - * When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the [Transaction] message in the BeginTransaction response and also as a part of the [ResultSet] and [PartialResultSet] responses. + * When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the Transaction message in the BeginTransaction response and also as a part of the ResultSet and PartialResultSet responses. */ export interface Schema$MultiplexedSessionPrecommitToken { /** @@ -1978,12 +2030,16 @@ export namespace spanner_v1 { * If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value. */ chunkedValue?: boolean | null; + /** + * Optional. Indicates whether this is the last `PartialResultSet` in the stream. The server might optionally set this field. Clients shouldn't rely on this field being set in all cases. + */ + last?: boolean | null; /** * Metadata about the result set, such as row type information. Only present in the first response. */ metadata?: Schema$ResultSetMetadata; /** - * Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. + * Optional. A precommit token is included if the read-write transaction has multiplexed sessions enabled. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction. */ precommitToken?: Schema$MultiplexedSessionPrecommitToken; /** @@ -1991,11 +2047,11 @@ export namespace spanner_v1 { */ resumeToken?: string | null; /** - * Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements. + * Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field is also present in the last response for DML statements. */ stats?: Schema$ResultSetStats; /** - * A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: cannot be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: # Strings are concatenated. "foo", "bar" =\> "foobar" # Lists of non-strings are concatenated. [2, 3], [4] =\> [2, 3, 4] # Lists are concatenated, but the last and first elements are merged # because they are strings. ["a", "b"], ["c", "d"] =\> ["a", "bc", "d"] # Lists are concatenated, but the last and first elements are merged # because they are lists. Recursively, the last and first elements # of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] =\> ["a", ["b", "cd"], "e"] # Non-overlapping object fields are combined. {"a": "1"\}, {"b": "2"\} =\> {"a": "1", "b": 2"\} # Overlapping object fields are merged. {"a": "1"\}, {"a": "2"\} =\> {"a": "12"\} # Examples of merging objects containing lists of strings. {"a": ["1"]\}, {"a": ["2"]\} =\> {"a": ["12"]\} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... \} "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." \} { "values": ["orl"] "chunked_value": true \} { "values": ["d"] "resume_token": "Zx1B..." \} This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, resuming the query with `"resume_token": "Af65..."` will yield results from the `PartialResultSet` with value `["orl"]`. + * A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It's possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: can't be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: Strings are concatenated. "foo", "bar" =\> "foobar" Lists of non-strings are concatenated. [2, 3], [4] =\> [2, 3, 4] Lists are concatenated, but the last and first elements are merged because they are strings. ["a", "b"], ["c", "d"] =\> ["a", "bc", "d"] Lists are concatenated, but the last and first elements are merged because they are lists. Recursively, the last and first elements of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] =\> ["a", ["b", "cd"], "e"] Non-overlapping object fields are combined. {"a": "1"\}, {"b": "2"\} =\> {"a": "1", "b": 2"\} Overlapping object fields are merged. {"a": "1"\}, {"a": "2"\} =\> {"a": "12"\} Examples of merging objects containing lists of strings. {"a": ["1"]\}, {"a": ["2"]\} =\> {"a": ["12"]\} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... \} "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." \} { "values": ["orl"] "chunked_value": true \} { "values": ["d"] "resume_token": "Zx1B..." \} This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, resuming the query with `"resume_token": "Af65..."` yields results from the `PartialResultSet` with value "orl". */ values?: any[] | null; } @@ -2004,7 +2060,7 @@ export namespace spanner_v1 { */ export interface Schema$Partition { /** - * This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token. + * This token can be passed to `Read`, `StreamingRead`, `ExecuteSql`, or `ExecuteStreamingSql` requests to restrict the results to those identified by this partition token. */ partitionToken?: string | null; } @@ -2013,15 +2069,15 @@ export namespace spanner_v1 { */ export interface Schema$PartitionedDml {} /** - * Options for a PartitionQueryRequest and PartitionReadRequest. + * Options for a `PartitionQueryRequest` and `PartitionReadRequest`. */ export interface Schema$PartitionOptions { /** - * **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request. + * **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests. The desired maximum number of partitions to return. For example, this might be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned can be smaller or larger than this maximum count request. */ maxPartitions?: string | null; /** - * **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request. + * **Note:** This hint is currently ignored by `PartitionQuery` and `PartitionRead` requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition can be smaller or larger than this size request. */ partitionSizeBytes?: string | null; } @@ -2030,11 +2086,11 @@ export namespace spanner_v1 { */ export interface Schema$PartitionQueryRequest { /** - * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. + * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL statement with unbound parameters. */ params?: {[key: string]: any} | null; /** - * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types. + * It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types. */ paramTypes?: {[key: string]: Schema$Type} | null; /** @@ -2042,11 +2098,11 @@ export namespace spanner_v1 { */ partitionOptions?: Schema$PartitionOptions; /** - * 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. + * Required. The query request to generate partitions for. The request fails if the query isn't 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; /** - * Read only snapshot transactions are supported, read/write and single use transactions are not. + * Read-only snapshot transactions are supported, read and write and single-use transactions are not. */ transaction?: Schema$TransactionSelector; } @@ -2063,7 +2119,7 @@ export namespace spanner_v1 { */ index?: string | null; /** - * Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows. + * Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It isn't an error for the `key_set` to name rows that don't exist in the database. Read yields nothing for nonexistent rows. */ keySet?: Schema$KeySet; /** @@ -2181,11 +2237,11 @@ export namespace spanner_v1 { */ export interface Schema$QueryOptions { /** - * An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying `latest` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option is not set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement: ``` ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails with an `INVALID_ARGUMENT` error. + * An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying `latest` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option isn't set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement: ```sql ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails with an `INVALID_ARGUMENT` error. */ optimizerStatisticsPackage?: string | null; /** - * An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying `latest` as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an invalid optimizer version fails with an `INVALID_ARGUMENT` error. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The `optimizer_version` statement hint has precedence over this setting. + * An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying `latest` as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from `SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS`. Executing a SQL statement with an invalid optimizer version fails with an `INVALID_ARGUMENT` error. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The `optimizer_version` statement hint has precedence over this setting. */ optimizerVersion?: string | null; } @@ -2274,7 +2330,7 @@ export namespace spanner_v1 { */ columns?: string[] | null; /** - * If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error. + * If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error. */ dataBoostEnabled?: boolean | null; /** @@ -2286,11 +2342,11 @@ export namespace spanner_v1 { */ index?: string | null; /** - * Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the `key_set` to name rows that do not exist in the database. Read yields nothing for nonexistent rows. + * Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field isn't empty, rows are yielded in an unspecified order. It isn't an error for the `key_set` to name rows that don't exist in the database. Read yields nothing for nonexistent rows. */ keySet?: Schema$KeySet; /** - * If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit cannot be specified if `partition_token` is set. + * If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit can't be specified if `partition_token` is set. */ limit?: string | null; /** @@ -2298,11 +2354,11 @@ export namespace spanner_v1 { */ lockHint?: string | null; /** - * Optional. Order for the returned rows. By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups). + * Optional. Order for the returned rows. By default, Spanner returns result rows in primary key order except for PartitionRead requests. For applications that don't require rows to be returned in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (for example, bulk point lookups). */ orderBy?: string | null; /** - * If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. + * If present, results are restricted to the specified partition previously created using `PartitionRead`. There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. */ partitionToken?: string | null; /** @@ -2367,11 +2423,11 @@ export namespace spanner_v1 { type?: string | null; } /** - * The directed read replica selector. Callers must provide one or more of the following fields for replica selection: * `location` - The location must be one of the regions within the multi-region configuration of your database. * `type` - The type of the replica. Some examples of using replica_selectors are: * `location:us-east1` --\> The "us-east1" replica(s) of any available type will be used to process the request. * `type:READ_ONLY` --\> The "READ_ONLY" type replica(s) in nearest available location will be used to process the request. * `location:us-east1 type:READ_ONLY` --\> The "READ_ONLY" type replica(s) in location "us-east1" will be used to process the request. + * The directed read replica selector. Callers must provide one or more of the following fields for replica selection: * `location` - The location must be one of the regions within the multi-region configuration of your database. * `type` - The type of the replica. Some examples of using replica_selectors are: * `location:us-east1` --\> The "us-east1" replica(s) of any available type is used to process the request. * `type:READ_ONLY` --\> The "READ_ONLY" type replica(s) in the nearest available location are used to process the request. * `location:us-east1 type:READ_ONLY` --\> The "READ_ONLY" type replica(s) in location "us-east1" is used to process the request. */ export interface Schema$ReplicaSelection { /** - * The location or region of the serving requests, e.g. "us-east1". + * The location or region of the serving requests, for example, "us-east1". */ location?: string | null; /** @@ -2388,11 +2444,11 @@ export namespace spanner_v1 { */ priority?: string | null; /** - * A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string. + * A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. */ requestTag?: string | null; /** - * A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag will be ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string. + * A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. */ transactionTag?: string | null; } @@ -2481,7 +2537,7 @@ export namespace spanner_v1 { */ metadata?: Schema$ResultSetMetadata; /** - * Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. + * Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction. */ precommitToken?: Schema$MultiplexedSessionPrecommitToken; /** @@ -2489,7 +2545,7 @@ export namespace spanner_v1 { */ rows?: any[][] | null; /** - * Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode. + * Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode. */ stats?: Schema$ResultSetStats; } @@ -2527,7 +2583,7 @@ export namespace spanner_v1 { */ rowCountExact?: string | null; /** - * Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified. + * Partitioned DML doesn't offer exactly-once semantics, so it returns a lower bound of the rows modified. */ rowCountLowerBound?: string | null; } @@ -2587,7 +2643,7 @@ export namespace spanner_v1 { */ export interface Schema$Session { /** - * Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time. + * Output only. The approximate timestamp when the session is last used. It's typically earlier than the actual last use time. */ approximateLastUseTime?: string | null; /** @@ -2603,7 +2659,7 @@ export namespace spanner_v1 { */ labels?: {[key: string]: string} | null; /** - * Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. + * Optional. If `true`, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. */ multiplexed?: boolean | null; /** @@ -2668,11 +2724,11 @@ export namespace spanner_v1 { */ export interface Schema$Statement { /** - * Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. + * Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL statement with unbound parameters. */ params?: {[key: string]: any} | null; /** - * It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. + * It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */ paramTypes?: {[key: string]: Schema$Type} | null; /** @@ -2749,6 +2805,10 @@ export namespace spanner_v1 { * When `exclude_txn_from_change_streams` is set to `true`: * Modifications from this transaction will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from this transaction will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. `exclude_txn_from_change_streams` may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an `INVALID_ARGUMENT` error. */ excludeTxnFromChangeStreams?: boolean | null; + /** + * Isolation level for the transaction. + */ + isolationLevel?: string | null; /** * Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource. */ @@ -9909,6 +9969,191 @@ export namespace spanner_v1 { this.context = context; } + /** + * Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many `AdaptMessage` calls. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + adapter( + params: Params$Resource$Projects$Instances$Databases$Sessions$Adapter, + options: StreamMethodOptions + ): GaxiosPromise; + adapter( + params?: Params$Resource$Projects$Instances$Databases$Sessions$Adapter, + options?: MethodOptions + ): GaxiosPromise; + adapter( + params: Params$Resource$Projects$Instances$Databases$Sessions$Adapter, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + adapter( + params: Params$Resource$Projects$Instances$Databases$Sessions$Adapter, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + adapter( + params: Params$Resource$Projects$Instances$Databases$Sessions$Adapter, + callback: BodyResponseCallback + ): void; + adapter(callback: BodyResponseCallback): void; + adapter( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Sessions$Adapter + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Sessions$Adapter; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Sessions$Adapter; + 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}/sessions:adapter').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); + } + } + + /** + * Handles a single message from the client and returns the result as a stream. The server will interpret the message frame and respond with message frames to the 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. + */ + adaptMessage( + params: Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage, + options: StreamMethodOptions + ): GaxiosPromise; + adaptMessage( + params?: Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage, + options?: MethodOptions + ): GaxiosPromise; + adaptMessage( + params: Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + adaptMessage( + params: Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + adaptMessage( + params: Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage, + callback: BodyResponseCallback + ): void; + adaptMessage( + callback: BodyResponseCallback + ): void; + adaptMessage( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage; + 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}:adaptMessage').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 multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. * @@ -10006,7 +10251,7 @@ export namespace spanner_v1 { } /** - * Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue. + * Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, that is, some groups might have been committed successfully, while some might have failed. The results of individual batches are streamed into the response as the batches are applied. `BatchWrite` requests are not replay protected, meaning that each mutation group can be applied more than once. Replays of non-idempotent mutations can have undesirable effects. For example, replays of an insert mutation can produce an already exists error or if you use generated or commit timestamp-based keys, it can result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10187,7 +10432,7 @@ export namespace spanner_v1 { } /** - * Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now. + * Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should retry the transaction from the beginning, reusing the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10276,7 +10521,7 @@ export namespace spanner_v1 { } /** - * Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. + * Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it's a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions when no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, for example, `"SELECT 1"`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10365,7 +10610,7 @@ export namespace spanner_v1 { } /** - * Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. + * Ends a session, releasing server resources associated with it. This asynchronously triggers the cancellation of any operations that are running with this session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10547,7 +10792,7 @@ export namespace spanner_v1 { } /** - * Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). + * Executes an SQL statement, returning all results in a single reply. This method can't be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10727,7 +10972,7 @@ export namespace spanner_v1 { } /** - * Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive. + * Gets a session. Returns `NOT_FOUND` if the session doesn't exist. This is mainly useful for determining whether a session is still alive. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10907,7 +11152,7 @@ export namespace spanner_v1 { } /** - * Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning. + * Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the `PartitionQueryRequest` used to create the partition tokens and the `ExecuteSqlRequests` that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the query, and the whole operation must be restarted from the beginning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11001,7 +11246,7 @@ export namespace spanner_v1 { } /** - * Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning. + * Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the `PartitionReadRequest` used to create the partition tokens and the `ReadRequests` that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual `StreamingRead` call issued with a `partition_token`. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the read, and the whole operation must be restarted from the beginning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11095,7 +11340,7 @@ export namespace spanner_v1 { } /** - * Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. + * Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method can't be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11184,7 +11429,7 @@ export namespace spanner_v1 { } /** - * Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`. + * Rolls back a transaction, releasing any locks it holds. It's a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction isn't found. `Rollback` never returns `ABORTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11364,6 +11609,30 @@ export namespace spanner_v1 { } } + export interface Params$Resource$Projects$Instances$Databases$Sessions$Adapter + extends StandardParameters { + /** + * Required. The database in which the new session is created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdapterSession; + } + export interface Params$Resource$Projects$Instances$Databases$Sessions$Adaptmessage + extends StandardParameters { + /** + * Required. The database session in which the adapter request is processed. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdaptMessageRequest; + } export interface Params$Resource$Projects$Instances$Databases$Sessions$Batchcreate extends StandardParameters { /** From a5c472d33158f8459df7ae5e38d992a84936b328 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 122/144] feat(sqladmin): update the API #### sqladmin:v1beta4 The following keys were added: - resources.backups.methods.createBackup.description - resources.backups.methods.createBackup.flatPath - resources.backups.methods.createBackup.httpMethod - resources.backups.methods.createBackup.id - resources.backups.methods.createBackup.parameterOrder - resources.backups.methods.createBackup.parameters.parent.description - resources.backups.methods.createBackup.parameters.parent.location - resources.backups.methods.createBackup.parameters.parent.pattern - resources.backups.methods.createBackup.parameters.parent.required - resources.backups.methods.createBackup.parameters.parent.type - resources.backups.methods.createBackup.path - resources.backups.methods.createBackup.request.$ref - resources.backups.methods.createBackup.response.$ref - resources.backups.methods.createBackup.scopes - resources.backups.methods.deleteBackup.description - resources.backups.methods.deleteBackup.flatPath - resources.backups.methods.deleteBackup.httpMethod - resources.backups.methods.deleteBackup.id - resources.backups.methods.deleteBackup.parameterOrder - resources.backups.methods.deleteBackup.parameters.name.description - resources.backups.methods.deleteBackup.parameters.name.location - resources.backups.methods.deleteBackup.parameters.name.pattern - resources.backups.methods.deleteBackup.parameters.name.required - resources.backups.methods.deleteBackup.parameters.name.type - resources.backups.methods.deleteBackup.path - resources.backups.methods.deleteBackup.response.$ref - resources.backups.methods.deleteBackup.scopes - resources.backups.methods.getBackup.description - resources.backups.methods.getBackup.flatPath - resources.backups.methods.getBackup.httpMethod - resources.backups.methods.getBackup.id - resources.backups.methods.getBackup.parameterOrder - resources.backups.methods.getBackup.parameters.name.description - resources.backups.methods.getBackup.parameters.name.location - resources.backups.methods.getBackup.parameters.name.pattern - resources.backups.methods.getBackup.parameters.name.required - resources.backups.methods.getBackup.parameters.name.type - resources.backups.methods.getBackup.path - resources.backups.methods.getBackup.response.$ref - resources.backups.methods.getBackup.scopes - resources.backups.methods.listBackups.description - resources.backups.methods.listBackups.flatPath - resources.backups.methods.listBackups.httpMethod - resources.backups.methods.listBackups.id - resources.backups.methods.listBackups.parameterOrder - resources.backups.methods.listBackups.parameters.filter.description - resources.backups.methods.listBackups.parameters.filter.location - resources.backups.methods.listBackups.parameters.filter.type - resources.backups.methods.listBackups.parameters.pageSize.description - resources.backups.methods.listBackups.parameters.pageSize.format - resources.backups.methods.listBackups.parameters.pageSize.location - resources.backups.methods.listBackups.parameters.pageSize.type - resources.backups.methods.listBackups.parameters.pageToken.description - resources.backups.methods.listBackups.parameters.pageToken.location - resources.backups.methods.listBackups.parameters.pageToken.type - resources.backups.methods.listBackups.parameters.parent.description - resources.backups.methods.listBackups.parameters.parent.location - resources.backups.methods.listBackups.parameters.parent.pattern - resources.backups.methods.listBackups.parameters.parent.required - resources.backups.methods.listBackups.parameters.parent.type - resources.backups.methods.listBackups.path - resources.backups.methods.listBackups.response.$ref - resources.backups.methods.listBackups.scopes - resources.backups.methods.updateBackup.description - resources.backups.methods.updateBackup.flatPath - resources.backups.methods.updateBackup.httpMethod - resources.backups.methods.updateBackup.id - resources.backups.methods.updateBackup.parameterOrder - resources.backups.methods.updateBackup.parameters.name.description - resources.backups.methods.updateBackup.parameters.name.location - resources.backups.methods.updateBackup.parameters.name.pattern - resources.backups.methods.updateBackup.parameters.name.required - resources.backups.methods.updateBackup.parameters.name.type - resources.backups.methods.updateBackup.parameters.updateMask.description - resources.backups.methods.updateBackup.parameters.updateMask.format - resources.backups.methods.updateBackup.parameters.updateMask.location - resources.backups.methods.updateBackup.parameters.updateMask.type - resources.backups.methods.updateBackup.path - resources.backups.methods.updateBackup.request.$ref - resources.backups.methods.updateBackup.response.$ref - resources.backups.methods.updateBackup.scopes - resources.flags.methods.list.parameters.flagScope.description - resources.flags.methods.list.parameters.flagScope.enum - resources.flags.methods.list.parameters.flagScope.enumDescriptions - resources.flags.methods.list.parameters.flagScope.location - resources.flags.methods.list.parameters.flagScope.type - resources.instances.methods.delete.parameters.enableFinalBackup.description - resources.instances.methods.delete.parameters.enableFinalBackup.location - resources.instances.methods.delete.parameters.enableFinalBackup.type - resources.instances.methods.delete.parameters.finalBackupDescription.description - resources.instances.methods.delete.parameters.finalBackupDescription.location - resources.instances.methods.delete.parameters.finalBackupDescription.type - resources.instances.methods.delete.parameters.finalBackupExpiryTime.description - resources.instances.methods.delete.parameters.finalBackupExpiryTime.format - resources.instances.methods.delete.parameters.finalBackupExpiryTime.location - resources.instances.methods.delete.parameters.finalBackupExpiryTime.type - resources.instances.methods.delete.parameters.finalBackupTtlDays.description - resources.instances.methods.delete.parameters.finalBackupTtlDays.format - resources.instances.methods.delete.parameters.finalBackupTtlDays.location - resources.instances.methods.delete.parameters.finalBackupTtlDays.type - schemas.Backup.description - schemas.Backup.id - schemas.Backup.properties.backupInterval.$ref - schemas.Backup.properties.backupInterval.description - schemas.Backup.properties.backupInterval.readOnly - schemas.Backup.properties.backupKind.description - schemas.Backup.properties.backupKind.enum - schemas.Backup.properties.backupKind.enumDescriptions - schemas.Backup.properties.backupKind.readOnly - schemas.Backup.properties.backupKind.type - schemas.Backup.properties.backupRun.description - schemas.Backup.properties.backupRun.readOnly - schemas.Backup.properties.backupRun.type - schemas.Backup.properties.databaseVersion.description - schemas.Backup.properties.databaseVersion.enum - schemas.Backup.properties.databaseVersion.enumDeprecated - schemas.Backup.properties.databaseVersion.enumDescriptions - schemas.Backup.properties.databaseVersion.readOnly - schemas.Backup.properties.databaseVersion.type - schemas.Backup.properties.description.description - schemas.Backup.properties.description.type - schemas.Backup.properties.error.$ref - schemas.Backup.properties.error.description - schemas.Backup.properties.error.readOnly - schemas.Backup.properties.expiryTime.description - schemas.Backup.properties.expiryTime.format - schemas.Backup.properties.expiryTime.type - schemas.Backup.properties.instance.description - schemas.Backup.properties.instance.type - schemas.Backup.properties.instanceDeletionTime.description - schemas.Backup.properties.instanceDeletionTime.format - schemas.Backup.properties.instanceDeletionTime.readOnly - schemas.Backup.properties.instanceDeletionTime.type - schemas.Backup.properties.instanceSettings.$ref - schemas.Backup.properties.instanceSettings.description - schemas.Backup.properties.instanceSettings.readOnly - schemas.Backup.properties.kind.description - schemas.Backup.properties.kind.readOnly - schemas.Backup.properties.kind.type - schemas.Backup.properties.kmsKey.description - schemas.Backup.properties.kmsKey.readOnly - schemas.Backup.properties.kmsKey.type - schemas.Backup.properties.kmsKeyVersion.description - schemas.Backup.properties.kmsKeyVersion.readOnly - schemas.Backup.properties.kmsKeyVersion.type - schemas.Backup.properties.location.description - schemas.Backup.properties.location.type - schemas.Backup.properties.maxChargeableBytes.description - schemas.Backup.properties.maxChargeableBytes.format - schemas.Backup.properties.maxChargeableBytes.readOnly - schemas.Backup.properties.maxChargeableBytes.type - schemas.Backup.properties.name.description - schemas.Backup.properties.name.readOnly - schemas.Backup.properties.name.type - schemas.Backup.properties.satisfiesPzi.description - schemas.Backup.properties.satisfiesPzi.readOnly - schemas.Backup.properties.satisfiesPzi.type - schemas.Backup.properties.satisfiesPzs.description - schemas.Backup.properties.satisfiesPzs.readOnly - schemas.Backup.properties.satisfiesPzs.type - schemas.Backup.properties.selfLink.description - schemas.Backup.properties.selfLink.readOnly - schemas.Backup.properties.selfLink.type - schemas.Backup.properties.state.description - schemas.Backup.properties.state.enum - schemas.Backup.properties.state.enumDescriptions - schemas.Backup.properties.state.readOnly - schemas.Backup.properties.state.type - schemas.Backup.properties.timeZone.description - schemas.Backup.properties.timeZone.readOnly - schemas.Backup.properties.timeZone.type - schemas.Backup.properties.ttlDays.description - schemas.Backup.properties.ttlDays.format - schemas.Backup.properties.ttlDays.type - schemas.Backup.properties.type.description - schemas.Backup.properties.type.enum - schemas.Backup.properties.type.enumDescriptions - schemas.Backup.properties.type.readOnly - schemas.Backup.properties.type.type - schemas.Backup.type - schemas.BackupContext.properties.name.description - schemas.BackupContext.properties.name.type - schemas.BackupRun.properties.databaseVersion.description - schemas.BackupRun.properties.databaseVersion.enum - schemas.BackupRun.properties.databaseVersion.enumDeprecated - schemas.BackupRun.properties.databaseVersion.enumDescriptions - schemas.BackupRun.properties.databaseVersion.readOnly - schemas.BackupRun.properties.databaseVersion.type - schemas.ConnectPoolNodeConfig.description - schemas.ConnectPoolNodeConfig.id - schemas.ConnectPoolNodeConfig.properties.dnsName.description - schemas.ConnectPoolNodeConfig.properties.dnsName.readOnly - schemas.ConnectPoolNodeConfig.properties.dnsName.type - schemas.ConnectPoolNodeConfig.properties.dnsNames.description - schemas.ConnectPoolNodeConfig.properties.dnsNames.items.$ref - schemas.ConnectPoolNodeConfig.properties.dnsNames.readOnly - schemas.ConnectPoolNodeConfig.properties.dnsNames.type - schemas.ConnectPoolNodeConfig.properties.ipAddresses.description - schemas.ConnectPoolNodeConfig.properties.ipAddresses.items.$ref - schemas.ConnectPoolNodeConfig.properties.ipAddresses.readOnly - schemas.ConnectPoolNodeConfig.properties.ipAddresses.type - schemas.ConnectPoolNodeConfig.properties.name.description - schemas.ConnectPoolNodeConfig.properties.name.readOnly - schemas.ConnectPoolNodeConfig.properties.name.type - schemas.ConnectPoolNodeConfig.type - schemas.ConnectSettings.properties.dnsNames.description - schemas.ConnectSettings.properties.dnsNames.items.$ref - schemas.ConnectSettings.properties.dnsNames.readOnly - schemas.ConnectSettings.properties.dnsNames.type - schemas.ConnectSettings.properties.nodeCount.description - schemas.ConnectSettings.properties.nodeCount.format - schemas.ConnectSettings.properties.nodeCount.type - schemas.ConnectSettings.properties.nodes.description - schemas.ConnectSettings.properties.nodes.items.$ref - schemas.ConnectSettings.properties.nodes.readOnly - schemas.ConnectSettings.properties.nodes.type - schemas.ConnectionPoolConfig.description - schemas.ConnectionPoolConfig.id - schemas.ConnectionPoolConfig.properties.clientConnectionIdleTimeout.deprecated - schemas.ConnectionPoolConfig.properties.clientConnectionIdleTimeout.description - schemas.ConnectionPoolConfig.properties.clientConnectionIdleTimeout.format - schemas.ConnectionPoolConfig.properties.clientConnectionIdleTimeout.type - schemas.ConnectionPoolConfig.properties.connPoolSize.deprecated - schemas.ConnectionPoolConfig.properties.connPoolSize.description - schemas.ConnectionPoolConfig.properties.connPoolSize.format - schemas.ConnectionPoolConfig.properties.connPoolSize.type - schemas.ConnectionPoolConfig.properties.connectionPoolingEnabled.description - schemas.ConnectionPoolConfig.properties.connectionPoolingEnabled.type - schemas.ConnectionPoolConfig.properties.flags.description - schemas.ConnectionPoolConfig.properties.flags.items.$ref - schemas.ConnectionPoolConfig.properties.flags.type - schemas.ConnectionPoolConfig.properties.maxClientConnections.deprecated - schemas.ConnectionPoolConfig.properties.maxClientConnections.description - schemas.ConnectionPoolConfig.properties.maxClientConnections.format - schemas.ConnectionPoolConfig.properties.maxClientConnections.type - schemas.ConnectionPoolConfig.properties.poolMode.deprecated - schemas.ConnectionPoolConfig.properties.poolMode.description - schemas.ConnectionPoolConfig.properties.poolMode.enum - schemas.ConnectionPoolConfig.properties.poolMode.enumDescriptions - schemas.ConnectionPoolConfig.properties.poolMode.type - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.deprecated - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.description - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.format - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.type - schemas.ConnectionPoolConfig.properties.serverConnectionIdleTimeout.deprecated - schemas.ConnectionPoolConfig.properties.serverConnectionIdleTimeout.description - schemas.ConnectionPoolConfig.properties.serverConnectionIdleTimeout.format - schemas.ConnectionPoolConfig.properties.serverConnectionIdleTimeout.type - schemas.ConnectionPoolConfig.type - schemas.ConnectionPoolFlags.description - schemas.ConnectionPoolFlags.id - schemas.ConnectionPoolFlags.properties.name.description - schemas.ConnectionPoolFlags.properties.name.type - schemas.ConnectionPoolFlags.properties.value.description - schemas.ConnectionPoolFlags.properties.value.type - schemas.ConnectionPoolFlags.type - schemas.DatabaseInstance.properties.dnsNames.description - schemas.DatabaseInstance.properties.dnsNames.items.$ref - schemas.DatabaseInstance.properties.dnsNames.readOnly - schemas.DatabaseInstance.properties.dnsNames.type - schemas.DatabaseInstance.properties.includeReplicasForMajorVersionUpgrade.description - schemas.DatabaseInstance.properties.includeReplicasForMajorVersionUpgrade.type - schemas.DatabaseInstance.properties.nodeCount.description - schemas.DatabaseInstance.properties.nodeCount.format - schemas.DatabaseInstance.properties.nodeCount.type - schemas.DatabaseInstance.properties.nodes.description - schemas.DatabaseInstance.properties.nodes.items.$ref - schemas.DatabaseInstance.properties.nodes.readOnly - schemas.DatabaseInstance.properties.nodes.type - schemas.DnsNameMapping.description - schemas.DnsNameMapping.id - schemas.DnsNameMapping.properties.connectionType.description - schemas.DnsNameMapping.properties.connectionType.enum - schemas.DnsNameMapping.properties.connectionType.enumDescriptions - schemas.DnsNameMapping.properties.connectionType.readOnly - schemas.DnsNameMapping.properties.connectionType.type - schemas.DnsNameMapping.properties.dnsScope.description - schemas.DnsNameMapping.properties.dnsScope.enum - schemas.DnsNameMapping.properties.dnsScope.enumDescriptions - schemas.DnsNameMapping.properties.dnsScope.readOnly - schemas.DnsNameMapping.properties.dnsScope.type - schemas.DnsNameMapping.properties.name.description - schemas.DnsNameMapping.properties.name.type - schemas.DnsNameMapping.type - schemas.ExportContext.properties.tdeExportOptions.description - schemas.ExportContext.properties.tdeExportOptions.properties.certificatePath.description - schemas.ExportContext.properties.tdeExportOptions.properties.certificatePath.type - schemas.ExportContext.properties.tdeExportOptions.properties.name.description - schemas.ExportContext.properties.tdeExportOptions.properties.name.type - schemas.ExportContext.properties.tdeExportOptions.properties.privateKeyPassword.description - schemas.ExportContext.properties.tdeExportOptions.properties.privateKeyPassword.type - schemas.ExportContext.properties.tdeExportOptions.properties.privateKeyPath.description - schemas.ExportContext.properties.tdeExportOptions.properties.privateKeyPath.type - schemas.ExportContext.properties.tdeExportOptions.type - schemas.Flag.properties.flagScope.description - schemas.Flag.properties.flagScope.enum - schemas.Flag.properties.flagScope.enumDescriptions - schemas.Flag.properties.flagScope.type - schemas.Flag.properties.recommendedIntValue.description - schemas.Flag.properties.recommendedIntValue.format - schemas.Flag.properties.recommendedIntValue.type - schemas.Flag.properties.recommendedStringValue.description - schemas.Flag.properties.recommendedStringValue.type - schemas.ImportContext.properties.bakImportOptions.properties.encryptionOptions.properties.keepEncrypted.description - schemas.ImportContext.properties.bakImportOptions.properties.encryptionOptions.properties.keepEncrypted.type - schemas.ImportContext.properties.tdeImportOptions.description - schemas.ImportContext.properties.tdeImportOptions.properties.certificatePath.description - schemas.ImportContext.properties.tdeImportOptions.properties.certificatePath.type - schemas.ImportContext.properties.tdeImportOptions.properties.name.description - schemas.ImportContext.properties.tdeImportOptions.properties.name.type - schemas.ImportContext.properties.tdeImportOptions.properties.privateKeyPassword.description - schemas.ImportContext.properties.tdeImportOptions.properties.privateKeyPassword.type - schemas.ImportContext.properties.tdeImportOptions.properties.privateKeyPath.description - schemas.ImportContext.properties.tdeImportOptions.properties.privateKeyPath.type - schemas.ImportContext.properties.tdeImportOptions.type - schemas.InstancesRestoreBackupRequest.properties.backup.description - schemas.InstancesRestoreBackupRequest.properties.backup.type - schemas.InstancesRestoreBackupRequest.properties.restoreInstanceSettings.$ref - schemas.InstancesRestoreBackupRequest.properties.restoreInstanceSettings.description - schemas.Interval.description - schemas.Interval.id - schemas.Interval.properties.endTime.description - schemas.Interval.properties.endTime.format - schemas.Interval.properties.endTime.type - schemas.Interval.properties.startTime.description - schemas.Interval.properties.startTime.format - schemas.Interval.properties.startTime.type - schemas.Interval.type - schemas.ListBackupsResponse.description - schemas.ListBackupsResponse.id - schemas.ListBackupsResponse.properties.backups.description - schemas.ListBackupsResponse.properties.backups.items.$ref - schemas.ListBackupsResponse.properties.backups.type - schemas.ListBackupsResponse.properties.nextPageToken.description - schemas.ListBackupsResponse.properties.nextPageToken.type - schemas.ListBackupsResponse.properties.warnings.description - schemas.ListBackupsResponse.properties.warnings.items.$ref - schemas.ListBackupsResponse.properties.warnings.type - schemas.ListBackupsResponse.type - schemas.Operation.properties.targetId.description - schemas.PoolNodeConfig.description - schemas.PoolNodeConfig.id - schemas.PoolNodeConfig.properties.dnsName.description - schemas.PoolNodeConfig.properties.dnsName.readOnly - schemas.PoolNodeConfig.properties.dnsName.type - schemas.PoolNodeConfig.properties.dnsNames.description - schemas.PoolNodeConfig.properties.dnsNames.items.$ref - schemas.PoolNodeConfig.properties.dnsNames.readOnly - schemas.PoolNodeConfig.properties.dnsNames.type - schemas.PoolNodeConfig.properties.gceZone.description - schemas.PoolNodeConfig.properties.gceZone.readOnly - schemas.PoolNodeConfig.properties.gceZone.type - schemas.PoolNodeConfig.properties.ipAddresses.description - schemas.PoolNodeConfig.properties.ipAddresses.items.$ref - schemas.PoolNodeConfig.properties.ipAddresses.readOnly - schemas.PoolNodeConfig.properties.ipAddresses.type - schemas.PoolNodeConfig.properties.name.description - schemas.PoolNodeConfig.properties.name.readOnly - schemas.PoolNodeConfig.properties.name.type - schemas.PoolNodeConfig.properties.state.description - schemas.PoolNodeConfig.properties.state.enum - schemas.PoolNodeConfig.properties.state.enumDeprecated - schemas.PoolNodeConfig.properties.state.enumDescriptions - schemas.PoolNodeConfig.properties.state.readOnly - schemas.PoolNodeConfig.properties.state.type - schemas.PoolNodeConfig.type - schemas.Settings.properties.connectionPoolConfig.$ref - schemas.Settings.properties.connectionPoolConfig.description - schemas.Settings.properties.dataDiskProvisionedIops.description - schemas.Settings.properties.dataDiskProvisionedIops.format - schemas.Settings.properties.dataDiskProvisionedIops.type - schemas.Settings.properties.dataDiskProvisionedThroughput.description - schemas.Settings.properties.dataDiskProvisionedThroughput.format - schemas.Settings.properties.dataDiskProvisionedThroughput.type - schemas.Settings.properties.retainBackupsOnDelete.description - schemas.Settings.properties.retainBackupsOnDelete.type The following keys were changed: - schemas.DatabaseInstance.properties.instanceType.enum - schemas.DatabaseInstance.properties.instanceType.enumDescriptions - schemas.DatabaseInstance.properties.state.enum - schemas.DatabaseInstance.properties.state.enumDeprecated - schemas.DatabaseInstance.properties.state.enumDescriptions - schemas.DemoteMasterMySqlReplicaConfiguration.properties.clientKey.description - schemas.ExportContext.properties.databases.description - schemas.ExportContext.properties.fileType.enum - schemas.ExportContext.properties.fileType.enumDescriptions - schemas.ImportContext.properties.database.description - schemas.ImportContext.properties.fileType.enum - schemas.ImportContext.properties.fileType.enumDescriptions - schemas.IpConfiguration.properties.serverCaPool.description - schemas.MySqlReplicaConfiguration.properties.clientKey.description - schemas.OnPremisesConfiguration.properties.clientKey.description - schemas.Operation.properties.operationType.enum - schemas.Operation.properties.operationType.enumDeprecated - schemas.Operation.properties.operationType.enumDescriptions #### sqladmin:v1 The following keys were added: - resources.Backups.methods.CreateBackup.description - resources.Backups.methods.CreateBackup.flatPath - resources.Backups.methods.CreateBackup.httpMethod - resources.Backups.methods.CreateBackup.id - resources.Backups.methods.CreateBackup.parameterOrder - resources.Backups.methods.CreateBackup.parameters.parent.description - resources.Backups.methods.CreateBackup.parameters.parent.location - resources.Backups.methods.CreateBackup.parameters.parent.pattern - resources.Backups.methods.CreateBackup.parameters.parent.required - resources.Backups.methods.CreateBackup.parameters.parent.type - resources.Backups.methods.CreateBackup.path - resources.Backups.methods.CreateBackup.request.$ref - resources.Backups.methods.CreateBackup.response.$ref - resources.Backups.methods.CreateBackup.scopes - resources.Backups.methods.DeleteBackup.description - resources.Backups.methods.DeleteBackup.flatPath - resources.Backups.methods.DeleteBackup.httpMethod - resources.Backups.methods.DeleteBackup.id - resources.Backups.methods.DeleteBackup.parameterOrder - resources.Backups.methods.DeleteBackup.parameters.name.description - resources.Backups.methods.DeleteBackup.parameters.name.location - resources.Backups.methods.DeleteBackup.parameters.name.pattern - resources.Backups.methods.DeleteBackup.parameters.name.required - resources.Backups.methods.DeleteBackup.parameters.name.type - resources.Backups.methods.DeleteBackup.path - resources.Backups.methods.DeleteBackup.response.$ref - resources.Backups.methods.DeleteBackup.scopes - resources.Backups.methods.GetBackup.description - resources.Backups.methods.GetBackup.flatPath - resources.Backups.methods.GetBackup.httpMethod - resources.Backups.methods.GetBackup.id - resources.Backups.methods.GetBackup.parameterOrder - resources.Backups.methods.GetBackup.parameters.name.description - resources.Backups.methods.GetBackup.parameters.name.location - resources.Backups.methods.GetBackup.parameters.name.pattern - resources.Backups.methods.GetBackup.parameters.name.required - resources.Backups.methods.GetBackup.parameters.name.type - resources.Backups.methods.GetBackup.path - resources.Backups.methods.GetBackup.response.$ref - resources.Backups.methods.GetBackup.scopes - resources.Backups.methods.ListBackups.description - resources.Backups.methods.ListBackups.flatPath - resources.Backups.methods.ListBackups.httpMethod - resources.Backups.methods.ListBackups.id - resources.Backups.methods.ListBackups.parameterOrder - resources.Backups.methods.ListBackups.parameters.filter.description - resources.Backups.methods.ListBackups.parameters.filter.location - resources.Backups.methods.ListBackups.parameters.filter.type - resources.Backups.methods.ListBackups.parameters.pageSize.description - resources.Backups.methods.ListBackups.parameters.pageSize.format - resources.Backups.methods.ListBackups.parameters.pageSize.location - resources.Backups.methods.ListBackups.parameters.pageSize.type - resources.Backups.methods.ListBackups.parameters.pageToken.description - resources.Backups.methods.ListBackups.parameters.pageToken.location - resources.Backups.methods.ListBackups.parameters.pageToken.type - resources.Backups.methods.ListBackups.parameters.parent.description - resources.Backups.methods.ListBackups.parameters.parent.location - resources.Backups.methods.ListBackups.parameters.parent.pattern - resources.Backups.methods.ListBackups.parameters.parent.required - resources.Backups.methods.ListBackups.parameters.parent.type - resources.Backups.methods.ListBackups.path - resources.Backups.methods.ListBackups.response.$ref - resources.Backups.methods.ListBackups.scopes - resources.Backups.methods.UpdateBackup.description - resources.Backups.methods.UpdateBackup.flatPath - resources.Backups.methods.UpdateBackup.httpMethod - resources.Backups.methods.UpdateBackup.id - resources.Backups.methods.UpdateBackup.parameterOrder - resources.Backups.methods.UpdateBackup.parameters.name.description - resources.Backups.methods.UpdateBackup.parameters.name.location - resources.Backups.methods.UpdateBackup.parameters.name.pattern - resources.Backups.methods.UpdateBackup.parameters.name.required - resources.Backups.methods.UpdateBackup.parameters.name.type - resources.Backups.methods.UpdateBackup.parameters.updateMask.description - resources.Backups.methods.UpdateBackup.parameters.updateMask.format - resources.Backups.methods.UpdateBackup.parameters.updateMask.location - resources.Backups.methods.UpdateBackup.parameters.updateMask.type - resources.Backups.methods.UpdateBackup.path - resources.Backups.methods.UpdateBackup.request.$ref - resources.Backups.methods.UpdateBackup.response.$ref - resources.Backups.methods.UpdateBackup.scopes - resources.flags.methods.list.parameters.flagScope.description - resources.flags.methods.list.parameters.flagScope.enum - resources.flags.methods.list.parameters.flagScope.enumDescriptions - resources.flags.methods.list.parameters.flagScope.location - resources.flags.methods.list.parameters.flagScope.type - resources.instances.methods.delete.parameters.enableFinalBackup.description - resources.instances.methods.delete.parameters.enableFinalBackup.location - resources.instances.methods.delete.parameters.enableFinalBackup.type - resources.instances.methods.delete.parameters.finalBackupDescription.description - resources.instances.methods.delete.parameters.finalBackupDescription.location - resources.instances.methods.delete.parameters.finalBackupDescription.type - resources.instances.methods.delete.parameters.finalBackupExpiryTime.description - resources.instances.methods.delete.parameters.finalBackupExpiryTime.format - resources.instances.methods.delete.parameters.finalBackupExpiryTime.location - resources.instances.methods.delete.parameters.finalBackupExpiryTime.type - resources.instances.methods.delete.parameters.finalBackupTtlDays.description - resources.instances.methods.delete.parameters.finalBackupTtlDays.format - resources.instances.methods.delete.parameters.finalBackupTtlDays.location - resources.instances.methods.delete.parameters.finalBackupTtlDays.type - schemas.Backup.description - schemas.Backup.id - schemas.Backup.properties.backupInterval.$ref - schemas.Backup.properties.backupInterval.description - schemas.Backup.properties.backupInterval.readOnly - schemas.Backup.properties.backupKind.description - schemas.Backup.properties.backupKind.enum - schemas.Backup.properties.backupKind.enumDescriptions - schemas.Backup.properties.backupKind.readOnly - schemas.Backup.properties.backupKind.type - schemas.Backup.properties.backupRun.description - schemas.Backup.properties.backupRun.readOnly - schemas.Backup.properties.backupRun.type - schemas.Backup.properties.databaseVersion.description - schemas.Backup.properties.databaseVersion.enum - schemas.Backup.properties.databaseVersion.enumDeprecated - schemas.Backup.properties.databaseVersion.enumDescriptions - schemas.Backup.properties.databaseVersion.readOnly - schemas.Backup.properties.databaseVersion.type - schemas.Backup.properties.description.description - schemas.Backup.properties.description.type - schemas.Backup.properties.error.$ref - schemas.Backup.properties.error.description - schemas.Backup.properties.error.readOnly - schemas.Backup.properties.expiryTime.description - schemas.Backup.properties.expiryTime.format - schemas.Backup.properties.expiryTime.type - schemas.Backup.properties.instance.description - schemas.Backup.properties.instance.type - schemas.Backup.properties.instanceDeletionTime.description - schemas.Backup.properties.instanceDeletionTime.format - schemas.Backup.properties.instanceDeletionTime.readOnly - schemas.Backup.properties.instanceDeletionTime.type - schemas.Backup.properties.instanceSettings.$ref - schemas.Backup.properties.instanceSettings.description - schemas.Backup.properties.instanceSettings.readOnly - schemas.Backup.properties.kind.description - schemas.Backup.properties.kind.readOnly - schemas.Backup.properties.kind.type - schemas.Backup.properties.kmsKey.description - schemas.Backup.properties.kmsKey.readOnly - schemas.Backup.properties.kmsKey.type - schemas.Backup.properties.kmsKeyVersion.description - schemas.Backup.properties.kmsKeyVersion.readOnly - schemas.Backup.properties.kmsKeyVersion.type - schemas.Backup.properties.location.description - schemas.Backup.properties.location.type - schemas.Backup.properties.maxChargeableBytes.description - schemas.Backup.properties.maxChargeableBytes.format - schemas.Backup.properties.maxChargeableBytes.readOnly - schemas.Backup.properties.maxChargeableBytes.type - schemas.Backup.properties.name.description - schemas.Backup.properties.name.readOnly - schemas.Backup.properties.name.type - schemas.Backup.properties.satisfiesPzi.description - schemas.Backup.properties.satisfiesPzi.readOnly - schemas.Backup.properties.satisfiesPzi.type - schemas.Backup.properties.satisfiesPzs.description - schemas.Backup.properties.satisfiesPzs.readOnly - schemas.Backup.properties.satisfiesPzs.type - schemas.Backup.properties.selfLink.description - schemas.Backup.properties.selfLink.readOnly - schemas.Backup.properties.selfLink.type - schemas.Backup.properties.state.description - schemas.Backup.properties.state.enum - schemas.Backup.properties.state.enumDescriptions - schemas.Backup.properties.state.readOnly - schemas.Backup.properties.state.type - schemas.Backup.properties.timeZone.description - schemas.Backup.properties.timeZone.readOnly - schemas.Backup.properties.timeZone.type - schemas.Backup.properties.ttlDays.description - schemas.Backup.properties.ttlDays.format - schemas.Backup.properties.ttlDays.type - schemas.Backup.properties.type.description - schemas.Backup.properties.type.enum - schemas.Backup.properties.type.enumDescriptions - schemas.Backup.properties.type.readOnly - schemas.Backup.properties.type.type - schemas.Backup.type - schemas.BackupContext.properties.name.description - schemas.BackupContext.properties.name.type - schemas.BackupRun.properties.databaseVersion.description - schemas.BackupRun.properties.databaseVersion.enum - schemas.BackupRun.properties.databaseVersion.enumDeprecated - schemas.BackupRun.properties.databaseVersion.enumDescriptions - schemas.BackupRun.properties.databaseVersion.readOnly - schemas.BackupRun.properties.databaseVersion.type - schemas.ConnectPoolNodeConfig.description - schemas.ConnectPoolNodeConfig.id - schemas.ConnectPoolNodeConfig.properties.dnsName.description - schemas.ConnectPoolNodeConfig.properties.dnsName.readOnly - schemas.ConnectPoolNodeConfig.properties.dnsName.type - schemas.ConnectPoolNodeConfig.properties.dnsNames.description - schemas.ConnectPoolNodeConfig.properties.dnsNames.items.$ref - schemas.ConnectPoolNodeConfig.properties.dnsNames.readOnly - schemas.ConnectPoolNodeConfig.properties.dnsNames.type - schemas.ConnectPoolNodeConfig.properties.ipAddresses.description - schemas.ConnectPoolNodeConfig.properties.ipAddresses.items.$ref - schemas.ConnectPoolNodeConfig.properties.ipAddresses.readOnly - schemas.ConnectPoolNodeConfig.properties.ipAddresses.type - schemas.ConnectPoolNodeConfig.properties.name.description - schemas.ConnectPoolNodeConfig.properties.name.readOnly - schemas.ConnectPoolNodeConfig.properties.name.type - schemas.ConnectPoolNodeConfig.type - schemas.ConnectSettings.properties.dnsNames.description - schemas.ConnectSettings.properties.dnsNames.items.$ref - schemas.ConnectSettings.properties.dnsNames.readOnly - schemas.ConnectSettings.properties.dnsNames.type - schemas.ConnectSettings.properties.nodeCount.description - schemas.ConnectSettings.properties.nodeCount.format - schemas.ConnectSettings.properties.nodeCount.type - schemas.ConnectSettings.properties.nodes.description - schemas.ConnectSettings.properties.nodes.items.$ref - schemas.ConnectSettings.properties.nodes.readOnly - schemas.ConnectSettings.properties.nodes.type - schemas.ConnectionPoolConfig.description - schemas.ConnectionPoolConfig.id - schemas.ConnectionPoolConfig.properties.clientConnectionIdleTimeout.deprecated - schemas.ConnectionPoolConfig.properties.clientConnectionIdleTimeout.description - schemas.ConnectionPoolConfig.properties.clientConnectionIdleTimeout.format - schemas.ConnectionPoolConfig.properties.clientConnectionIdleTimeout.type - schemas.ConnectionPoolConfig.properties.connPoolSize.deprecated - schemas.ConnectionPoolConfig.properties.connPoolSize.description - schemas.ConnectionPoolConfig.properties.connPoolSize.format - schemas.ConnectionPoolConfig.properties.connPoolSize.type - schemas.ConnectionPoolConfig.properties.connectionPoolingEnabled.description - schemas.ConnectionPoolConfig.properties.connectionPoolingEnabled.type - schemas.ConnectionPoolConfig.properties.flags.description - schemas.ConnectionPoolConfig.properties.flags.items.$ref - schemas.ConnectionPoolConfig.properties.flags.type - schemas.ConnectionPoolConfig.properties.maxClientConnections.deprecated - schemas.ConnectionPoolConfig.properties.maxClientConnections.description - schemas.ConnectionPoolConfig.properties.maxClientConnections.format - schemas.ConnectionPoolConfig.properties.maxClientConnections.type - schemas.ConnectionPoolConfig.properties.poolMode.deprecated - schemas.ConnectionPoolConfig.properties.poolMode.description - schemas.ConnectionPoolConfig.properties.poolMode.enum - schemas.ConnectionPoolConfig.properties.poolMode.enumDescriptions - schemas.ConnectionPoolConfig.properties.poolMode.type - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.deprecated - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.description - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.format - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.type - schemas.ConnectionPoolConfig.properties.serverConnectionIdleTimeout.deprecated - schemas.ConnectionPoolConfig.properties.serverConnectionIdleTimeout.description - schemas.ConnectionPoolConfig.properties.serverConnectionIdleTimeout.format - schemas.ConnectionPoolConfig.properties.serverConnectionIdleTimeout.type - schemas.ConnectionPoolConfig.type - schemas.ConnectionPoolFlags.description - schemas.ConnectionPoolFlags.id - schemas.ConnectionPoolFlags.properties.name.description - schemas.ConnectionPoolFlags.properties.name.type - schemas.ConnectionPoolFlags.properties.value.description - schemas.ConnectionPoolFlags.properties.value.type - schemas.ConnectionPoolFlags.type - schemas.DatabaseInstance.properties.dnsNames.description - schemas.DatabaseInstance.properties.dnsNames.items.$ref - schemas.DatabaseInstance.properties.dnsNames.readOnly - schemas.DatabaseInstance.properties.dnsNames.type - schemas.DatabaseInstance.properties.includeReplicasForMajorVersionUpgrade.description - schemas.DatabaseInstance.properties.includeReplicasForMajorVersionUpgrade.type - schemas.DatabaseInstance.properties.nodeCount.description - schemas.DatabaseInstance.properties.nodeCount.format - schemas.DatabaseInstance.properties.nodeCount.type - schemas.DatabaseInstance.properties.nodes.description - schemas.DatabaseInstance.properties.nodes.items.$ref - schemas.DatabaseInstance.properties.nodes.readOnly - schemas.DatabaseInstance.properties.nodes.type - schemas.DnsNameMapping.description - schemas.DnsNameMapping.id - schemas.DnsNameMapping.properties.connectionType.description - schemas.DnsNameMapping.properties.connectionType.enum - schemas.DnsNameMapping.properties.connectionType.enumDescriptions - schemas.DnsNameMapping.properties.connectionType.readOnly - schemas.DnsNameMapping.properties.connectionType.type - schemas.DnsNameMapping.properties.dnsScope.description - schemas.DnsNameMapping.properties.dnsScope.enum - schemas.DnsNameMapping.properties.dnsScope.enumDescriptions - schemas.DnsNameMapping.properties.dnsScope.readOnly - schemas.DnsNameMapping.properties.dnsScope.type - schemas.DnsNameMapping.properties.name.description - schemas.DnsNameMapping.properties.name.type - schemas.DnsNameMapping.type - schemas.ExportContext.properties.tdeExportOptions.description - schemas.ExportContext.properties.tdeExportOptions.properties.certificatePath.description - schemas.ExportContext.properties.tdeExportOptions.properties.certificatePath.type - schemas.ExportContext.properties.tdeExportOptions.properties.name.description - schemas.ExportContext.properties.tdeExportOptions.properties.name.type - schemas.ExportContext.properties.tdeExportOptions.properties.privateKeyPassword.description - schemas.ExportContext.properties.tdeExportOptions.properties.privateKeyPassword.type - schemas.ExportContext.properties.tdeExportOptions.properties.privateKeyPath.description - schemas.ExportContext.properties.tdeExportOptions.properties.privateKeyPath.type - schemas.ExportContext.properties.tdeExportOptions.type - schemas.Flag.properties.flagScope.description - schemas.Flag.properties.flagScope.enum - schemas.Flag.properties.flagScope.enumDescriptions - schemas.Flag.properties.flagScope.type - schemas.Flag.properties.recommendedIntValue.description - schemas.Flag.properties.recommendedIntValue.format - schemas.Flag.properties.recommendedIntValue.type - schemas.Flag.properties.recommendedStringValue.description - schemas.Flag.properties.recommendedStringValue.type - schemas.ImportContext.properties.bakImportOptions.properties.encryptionOptions.properties.keepEncrypted.description - schemas.ImportContext.properties.bakImportOptions.properties.encryptionOptions.properties.keepEncrypted.type - schemas.ImportContext.properties.tdeImportOptions.description - schemas.ImportContext.properties.tdeImportOptions.properties.certificatePath.description - schemas.ImportContext.properties.tdeImportOptions.properties.certificatePath.type - schemas.ImportContext.properties.tdeImportOptions.properties.name.description - schemas.ImportContext.properties.tdeImportOptions.properties.name.type - schemas.ImportContext.properties.tdeImportOptions.properties.privateKeyPassword.description - schemas.ImportContext.properties.tdeImportOptions.properties.privateKeyPassword.type - schemas.ImportContext.properties.tdeImportOptions.properties.privateKeyPath.description - schemas.ImportContext.properties.tdeImportOptions.properties.privateKeyPath.type - schemas.ImportContext.properties.tdeImportOptions.type - schemas.InstancesRestoreBackupRequest.properties.backup.description - schemas.InstancesRestoreBackupRequest.properties.backup.type - schemas.InstancesRestoreBackupRequest.properties.restoreInstanceSettings.$ref - schemas.InstancesRestoreBackupRequest.properties.restoreInstanceSettings.description - schemas.Interval.description - schemas.Interval.id - schemas.Interval.properties.endTime.description - schemas.Interval.properties.endTime.format - schemas.Interval.properties.endTime.type - schemas.Interval.properties.startTime.description - schemas.Interval.properties.startTime.format - schemas.Interval.properties.startTime.type - schemas.Interval.type - schemas.ListBackupsResponse.description - schemas.ListBackupsResponse.id - schemas.ListBackupsResponse.properties.backups.description - schemas.ListBackupsResponse.properties.backups.items.$ref - schemas.ListBackupsResponse.properties.backups.type - schemas.ListBackupsResponse.properties.nextPageToken.description - schemas.ListBackupsResponse.properties.nextPageToken.type - schemas.ListBackupsResponse.properties.warnings.description - schemas.ListBackupsResponse.properties.warnings.items.$ref - schemas.ListBackupsResponse.properties.warnings.type - schemas.ListBackupsResponse.type - schemas.Operation.properties.targetId.description - schemas.PoolNodeConfig.description - schemas.PoolNodeConfig.id - schemas.PoolNodeConfig.properties.dnsName.description - schemas.PoolNodeConfig.properties.dnsName.readOnly - schemas.PoolNodeConfig.properties.dnsName.type - schemas.PoolNodeConfig.properties.dnsNames.description - schemas.PoolNodeConfig.properties.dnsNames.items.$ref - schemas.PoolNodeConfig.properties.dnsNames.readOnly - schemas.PoolNodeConfig.properties.dnsNames.type - schemas.PoolNodeConfig.properties.gceZone.description - schemas.PoolNodeConfig.properties.gceZone.readOnly - schemas.PoolNodeConfig.properties.gceZone.type - schemas.PoolNodeConfig.properties.ipAddresses.description - schemas.PoolNodeConfig.properties.ipAddresses.items.$ref - schemas.PoolNodeConfig.properties.ipAddresses.readOnly - schemas.PoolNodeConfig.properties.ipAddresses.type - schemas.PoolNodeConfig.properties.name.description - schemas.PoolNodeConfig.properties.name.readOnly - schemas.PoolNodeConfig.properties.name.type - schemas.PoolNodeConfig.properties.state.description - schemas.PoolNodeConfig.properties.state.enum - schemas.PoolNodeConfig.properties.state.enumDeprecated - schemas.PoolNodeConfig.properties.state.enumDescriptions - schemas.PoolNodeConfig.properties.state.readOnly - schemas.PoolNodeConfig.properties.state.type - schemas.PoolNodeConfig.type - schemas.Settings.properties.connectionPoolConfig.$ref - schemas.Settings.properties.connectionPoolConfig.description - schemas.Settings.properties.dataDiskProvisionedIops.description - schemas.Settings.properties.dataDiskProvisionedIops.format - schemas.Settings.properties.dataDiskProvisionedIops.type - schemas.Settings.properties.dataDiskProvisionedThroughput.description - schemas.Settings.properties.dataDiskProvisionedThroughput.format - schemas.Settings.properties.dataDiskProvisionedThroughput.type - schemas.Settings.properties.retainBackupsOnDelete.description - schemas.Settings.properties.retainBackupsOnDelete.type The following keys were changed: - schemas.ConnectSettings.properties.serverCaMode.enum - schemas.ConnectSettings.properties.serverCaMode.enumDescriptions - schemas.DatabaseInstance.properties.instanceType.enum - schemas.DatabaseInstance.properties.instanceType.enumDescriptions - schemas.DatabaseInstance.properties.state.enum - schemas.DatabaseInstance.properties.state.enumDeprecated - schemas.DatabaseInstance.properties.state.enumDescriptions - schemas.DemoteMasterMySqlReplicaConfiguration.properties.clientKey.description - schemas.ExportContext.properties.databases.description - schemas.ExportContext.properties.fileType.enum - schemas.ExportContext.properties.fileType.enumDescriptions - schemas.ImportContext.properties.database.description - schemas.ImportContext.properties.fileType.enum - schemas.ImportContext.properties.fileType.enumDescriptions - schemas.IpConfiguration.properties.serverCaPool.description - schemas.MySqlReplicaConfiguration.properties.clientKey.description - schemas.OnPremisesConfiguration.properties.clientKey.description - schemas.Operation.properties.operationType.enum - schemas.Operation.properties.operationType.enumDeprecated - schemas.Operation.properties.operationType.enumDescriptions --- discovery/sqladmin-v1.json | 1369 ++++++++++++++++++++++++++++--- discovery/sqladmin-v1beta4.json | 1363 +++++++++++++++++++++++++++--- src/apis/sqladmin/v1.ts | 1203 +++++++++++++++++++++++---- src/apis/sqladmin/v1beta4.ts | 1216 +++++++++++++++++++++++---- 4 files changed, 4541 insertions(+), 610 deletions(-) diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 49e2314af6f..939a1dc6009 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -108,6 +108,168 @@ }, "protocol": "rest", "resources": { + "Backups": { + "methods": { + "CreateBackup": { + "description": "Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.", + "flatPath": "v1/projects/{projectsId}/backups", + "httpMethod": "POST", + "id": "sql.Backups.CreateBackup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this backup is created. Format: projects/{project}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backups", + "request": { + "$ref": "Backup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "DeleteBackup": { + "description": "Deletes the backup.", + "flatPath": "v1/projects/{projectsId}/backups/{backupsId}", + "httpMethod": "DELETE", + "id": "sql.Backups.DeleteBackup", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the backup to delete. Format: projects/{project}/backups/{backup}", + "location": "path", + "pattern": "^projects/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "GetBackup": { + "description": "Retrieves a resource containing information about a backup.", + "flatPath": "v1/projects/{projectsId}/backups/{backupsId}", + "httpMethod": "GET", + "id": "sql.Backups.GetBackup", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup}", + "location": "path", + "pattern": "^projects/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Backup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "ListBackups": { + "description": "Lists all backups associated with the project.", + "flatPath": "v1/projects/{projectsId}/backups", + "httpMethod": "GET", + "id": "sql.Backups.ListBackups", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent that owns this collection of backups. Format: projects/{project}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backups", + "response": { + "$ref": "ListBackupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "UpdateBackup": { + "description": "Updates the retention period and description of the backup. You can use this API to update final backups only.", + "flatPath": "v1/projects/{projectsId}/backups/{backupsId}", + "httpMethod": "PATCH", + "id": "sql.Backups.UpdateBackup", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.", + "location": "path", + "pattern": "^projects/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields that you can update. You can update only the description and retention period of the final backup.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Backup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + } + } + }, "backupRuns": { "methods": { "delete": { @@ -593,6 +755,21 @@ "description": "Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.", "location": "query", "type": "string" + }, + "flagScope": { + "description": "Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified.", + "enum": [ + "SQL_FLAG_SCOPE_UNSPECIFIED", + "SQL_FLAG_SCOPE_DATABASE", + "SQL_FLAG_SCOPE_CONNECTION_POOL" + ], + "enumDescriptions": [ + "Assume database flags if unspecified", + "database flags", + "connection pool configuration flags" + ], + "location": "query", + "type": "string" } }, "path": "v1/flags", @@ -819,6 +996,28 @@ "instance" ], "parameters": { + "enableFinalBackup": { + "description": "Flag to opt-in for final backup. By default, it is turned off.", + "location": "query", + "type": "boolean" + }, + "finalBackupDescription": { + "description": "Optional. The description of the final backup.", + "location": "query", + "type": "string" + }, + "finalBackupExpiryTime": { + "description": "Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "finalBackupTtlDays": { + "description": "Optional. Retention period of the final backup.", + "format": "int64", + "location": "query", + "type": "string" + }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", @@ -2366,7 +2565,7 @@ } } }, - "revision": "20250117", + "revision": "20250310", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2481,132 +2680,441 @@ }, "type": "object" }, - "BackupConfiguration": { - "description": "Database instance backup configuration.", - "id": "BackupConfiguration", + "Backup": { + "description": "A backup resource.", + "id": "Backup", "properties": { - "backupRetentionSettings": { - "$ref": "BackupRetentionSettings", - "description": "Backup retention settings." - }, - "binaryLogEnabled": { - "description": "(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.", - "type": "boolean" - }, - "enabled": { - "description": "Whether this configuration is enabled.", - "type": "boolean" - }, - "kind": { - "description": "This is always `sql#backupConfiguration`.", - "type": "string" - }, - "location": { - "description": "Location of the backup", - "type": "string" - }, - "pointInTimeRecoveryEnabled": { - "description": "Whether point in time recovery is enabled.", - "type": "boolean" - }, - "replicationLogArchivingEnabled": { - "description": "Reserved for future use.", - "type": "boolean" - }, - "startTime": { - "description": "Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.", - "type": "string" - }, - "transactionLogRetentionDays": { - "description": "The number of days of transaction logs we retain for point in time restore, from 1-7.", - "format": "int32", - "type": "integer" + "backupInterval": { + "$ref": "Interval", + "description": "Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.", + "readOnly": true }, - "transactionalLogStorageState": { - "description": "Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.", + "backupKind": { + "description": "Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.", "enum": [ - "TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED", - "DISK", - "SWITCHING_TO_CLOUD_STORAGE", - "SWITCHED_TO_CLOUD_STORAGE", - "CLOUD_STORAGE" + "SQL_BACKUP_KIND_UNSPECIFIED", + "SNAPSHOT", + "PHYSICAL" ], "enumDescriptions": [ - "Unspecified.", - "The transaction logs used for PITR for the instance are stored on a data disk.", - "The transaction logs used for PITR for the instance are switching from being stored on a data disk to being stored in Cloud Storage. Only applicable to MySQL.", - "The transaction logs used for PITR for the instance are now stored in Cloud Storage. Previously, they were stored on a data disk. Only applicable to MySQL.", - "The transaction logs used for PITR for the instance are stored in Cloud Storage. Only applicable to MySQL and PostgreSQL." + "This is an unknown BackupKind.", + "Snapshot-based backups.", + "Physical backups." ], "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "BackupContext": { - "description": "Backup context.", - "id": "BackupContext", - "properties": { - "backupId": { - "description": "The identifier of the backup.", - "format": "int64", - "type": "string" - }, - "kind": { - "description": "This is always `sql#backupContext`.", - "type": "string" - } - }, - "type": "object" - }, - "BackupReencryptionConfig": { - "description": "Backup Reencryption Config", - "id": "BackupReencryptionConfig", - "properties": { - "backupLimit": { - "description": "Backup re-encryption limit", - "format": "int32", - "type": "integer" }, - "backupType": { - "description": "Type of backups users want to re-encrypt.", - "enum": [ - "BACKUP_TYPE_UNSPECIFIED", - "AUTOMATED", - "ON_DEMAND" - ], - "enumDescriptions": [ - "Unknown backup type, will be defaulted to AUTOMATIC backup type", - "Reencrypt automatic backups", - "Reencrypt on-demand backups" - ], + "backupRun": { + "description": "Output only. The mapping to backup run resource used for IAM validations.", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "BackupRetentionSettings": { - "description": "We currently only support backup retention by specifying the number of backups we will retain.", - "id": "BackupRetentionSettings", - "properties": { - "retainedBackups": { - "description": "Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.", - "format": "int32", - "type": "integer" }, - "retentionUnit": { - "description": "The unit that 'retained_backups' represents.", + "databaseVersion": { + "description": "Output only. The database version of the instance of when this backup was made.", "enum": [ - "RETENTION_UNIT_UNSPECIFIED", - "COUNT" - ], - "enumDescriptions": [ - "Backup retention unit is unspecified, will be treated as COUNT.", - "Retention will be by count, eg. \"retain the most recent 7 backups\"." - ], - "type": "string" - } + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "MYSQL_8_0", + "MYSQL_8_0_18", + "MYSQL_8_0_26", + "MYSQL_8_0_27", + "MYSQL_8_0_28", + "MYSQL_8_0_29", + "MYSQL_8_0_30", + "MYSQL_8_0_31", + "MYSQL_8_0_32", + "MYSQL_8_0_33", + "MYSQL_8_0_34", + "MYSQL_8_0_35", + "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", + "MYSQL_8_0_41", + "MYSQL_8_0_42", + "MYSQL_8_4", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_9_6", + "POSTGRES_10", + "POSTGRES_11", + "POSTGRES_12", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16", + "POSTGRES_17", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB", + "SQLSERVER_2022_STANDARD", + "SQLSERVER_2022_ENTERPRISE", + "SQLSERVER_2022_EXPRESS", + "SQLSERVER_2022_WEB" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "The database version is MySQL 5.1.", + "The database version is MySQL 5.5.", + "The database version is MySQL 5.6.", + "The database version is MySQL 5.7.", + "The database version is MySQL 8.", + "The database major version is MySQL 8.0 and the minor version is 18.", + "The database major version is MySQL 8.0 and the minor version is 26.", + "The database major version is MySQL 8.0 and the minor version is 27.", + "The database major version is MySQL 8.0 and the minor version is 28.", + "The database major version is MySQL 8.0 and the minor version is 29.", + "The database major version is MySQL 8.0 and the minor version is 30.", + "The database major version is MySQL 8.0 and the minor version is 31.", + "The database major version is MySQL 8.0 and the minor version is 32.", + "The database major version is MySQL 8.0 and the minor version is 33.", + "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.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", + "The database major version is MySQL 8.0 and the minor version is 41.", + "The database major version is MySQL 8.0 and the minor version is 42.", + "The database version is MySQL 8.4.", + "The database version is SQL Server 2017 Standard.", + "The database version is SQL Server 2017 Enterprise.", + "The database version is SQL Server 2017 Express.", + "The database version is SQL Server 2017 Web.", + "The database version is PostgreSQL 9.6.", + "The database version is PostgreSQL 10.", + "The database version is PostgreSQL 11.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "The database version is PostgreSQL 14.", + "The database version is PostgreSQL 15.", + "The database version is PostgreSQL 16.", + "The database version is PostgreSQL 17.", + "The database version is SQL Server 2019 Standard.", + "The database version is SQL Server 2019 Enterprise.", + "The database version is SQL Server 2019 Express.", + "The database version is SQL Server 2019 Web.", + "The database version is SQL Server 2022 Standard.", + "The database version is SQL Server 2022 Enterprise.", + "The database version is SQL Server 2022 Express.", + "The database version is SQL Server 2022 Web." + ], + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of this backup.", + "type": "string" + }, + "error": { + "$ref": "OperationError", + "description": "Output only. Information about why the backup operation fails (for example, when the backup state fails).", + "readOnly": true + }, + "expiryTime": { + "description": "Backup expiration time. A UTC timestamp of when this backup expired.", + "format": "google-datetime", + "type": "string" + }, + "instance": { + "description": "The name of the source database instance.", + "type": "string" + }, + "instanceDeletionTime": { + "description": "Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "instanceSettings": { + "$ref": "DatabaseInstance", + "description": "Optional. Output only. The instance setting of the source instance that's associated with this backup.", + "readOnly": true + }, + "kind": { + "description": "Output only. This is always `sql#backup`.", + "readOnly": true, + "type": "string" + }, + "kmsKey": { + "description": "Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.", + "readOnly": true, + "type": "string" + }, + "kmsKeyVersion": { + "description": "Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "The storage location of the backups. The location can be multi-regional.", + "type": "string" + }, + "maxChargeableBytes": { + "description": "Output only. The maximum chargeable bytes for the backup.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.", + "readOnly": true, + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "selfLink": { + "description": "Output only. The URI of this resource.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The status of this backup.", + "enum": [ + "SQL_BACKUP_STATE_UNSPECIFIED", + "ENQUEUED", + "RUNNING", + "FAILED", + "SUCCESSFUL", + "DELETING", + "DELETION_FAILED" + ], + "enumDescriptions": [ + "The state of the backup is unknown.", + "The backup that's added to a queue.", + "The backup is in progress.", + "The backup failed.", + "The backup is successful.", + "The backup is being deleted.", + "Deletion of the backup failed." + ], + "readOnly": true, + "type": "string" + }, + "timeZone": { + "description": "Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.", + "readOnly": true, + "type": "string" + }, + "ttlDays": { + "description": "Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Output only. The type of this backup. The type can be \"AUTOMATED\", \"ON_DEMAND\" or “FINAL”.", + "enum": [ + "SQL_BACKUP_TYPE_UNSPECIFIED", + "AUTOMATED", + "ON_DEMAND", + "FINAL" + ], + "enumDescriptions": [ + "This is an unknown backup type.", + "The backup schedule triggers a backup automatically.", + "The user triggers a backup manually.", + "The backup created when instance is deleted." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupConfiguration": { + "description": "Database instance backup configuration.", + "id": "BackupConfiguration", + "properties": { + "backupRetentionSettings": { + "$ref": "BackupRetentionSettings", + "description": "Backup retention settings." + }, + "binaryLogEnabled": { + "description": "(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.", + "type": "boolean" + }, + "enabled": { + "description": "Whether this configuration is enabled.", + "type": "boolean" + }, + "kind": { + "description": "This is always `sql#backupConfiguration`.", + "type": "string" + }, + "location": { + "description": "Location of the backup", + "type": "string" + }, + "pointInTimeRecoveryEnabled": { + "description": "Whether point in time recovery is enabled.", + "type": "boolean" + }, + "replicationLogArchivingEnabled": { + "description": "Reserved for future use.", + "type": "boolean" + }, + "startTime": { + "description": "Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.", + "type": "string" + }, + "transactionLogRetentionDays": { + "description": "The number of days of transaction logs we retain for point in time restore, from 1-7.", + "format": "int32", + "type": "integer" + }, + "transactionalLogStorageState": { + "description": "Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.", + "enum": [ + "TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED", + "DISK", + "SWITCHING_TO_CLOUD_STORAGE", + "SWITCHED_TO_CLOUD_STORAGE", + "CLOUD_STORAGE" + ], + "enumDescriptions": [ + "Unspecified.", + "The transaction logs used for PITR for the instance are stored on a data disk.", + "The transaction logs used for PITR for the instance are switching from being stored on a data disk to being stored in Cloud Storage. Only applicable to MySQL.", + "The transaction logs used for PITR for the instance are now stored in Cloud Storage. Previously, they were stored on a data disk. Only applicable to MySQL.", + "The transaction logs used for PITR for the instance are stored in Cloud Storage. Only applicable to MySQL and PostgreSQL." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupContext": { + "description": "Backup context.", + "id": "BackupContext", + "properties": { + "backupId": { + "description": "The identifier of the backup.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "This is always `sql#backupContext`.", + "type": "string" + }, + "name": { + "description": "The name of the backup. Format: projects/{project}/backups/{backup}", + "type": "string" + } + }, + "type": "object" + }, + "BackupReencryptionConfig": { + "description": "Backup Reencryption Config", + "id": "BackupReencryptionConfig", + "properties": { + "backupLimit": { + "description": "Backup re-encryption limit", + "format": "int32", + "type": "integer" + }, + "backupType": { + "description": "Type of backups users want to re-encrypt.", + "enum": [ + "BACKUP_TYPE_UNSPECIFIED", + "AUTOMATED", + "ON_DEMAND" + ], + "enumDescriptions": [ + "Unknown backup type, will be defaulted to AUTOMATIC backup type", + "Reencrypt automatic backups", + "Reencrypt on-demand backups" + ], + "type": "string" + } + }, + "type": "object" + }, + "BackupRetentionSettings": { + "description": "We currently only support backup retention by specifying the number of backups we will retain.", + "id": "BackupRetentionSettings", + "properties": { + "retainedBackups": { + "description": "Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.", + "format": "int32", + "type": "integer" + }, + "retentionUnit": { + "description": "The unit that 'retained_backups' represents.", + "enum": [ + "RETENTION_UNIT_UNSPECIFIED", + "COUNT" + ], + "enumDescriptions": [ + "Backup retention unit is unspecified, will be treated as COUNT.", + "Retention will be by count, eg. \"retain the most recent 7 backups\"." + ], + "type": "string" + } }, "type": "object" }, @@ -2628,6 +3136,155 @@ ], "type": "string" }, + "databaseVersion": { + "description": "Output only. The instance database version when this backup was made.", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "MYSQL_8_0", + "MYSQL_8_0_18", + "MYSQL_8_0_26", + "MYSQL_8_0_27", + "MYSQL_8_0_28", + "MYSQL_8_0_29", + "MYSQL_8_0_30", + "MYSQL_8_0_31", + "MYSQL_8_0_32", + "MYSQL_8_0_33", + "MYSQL_8_0_34", + "MYSQL_8_0_35", + "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", + "MYSQL_8_0_41", + "MYSQL_8_0_42", + "MYSQL_8_4", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_9_6", + "POSTGRES_10", + "POSTGRES_11", + "POSTGRES_12", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16", + "POSTGRES_17", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB", + "SQLSERVER_2022_STANDARD", + "SQLSERVER_2022_ENTERPRISE", + "SQLSERVER_2022_EXPRESS", + "SQLSERVER_2022_WEB" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "The database version is MySQL 5.1.", + "The database version is MySQL 5.5.", + "The database version is MySQL 5.6.", + "The database version is MySQL 5.7.", + "The database version is MySQL 8.", + "The database major version is MySQL 8.0 and the minor version is 18.", + "The database major version is MySQL 8.0 and the minor version is 26.", + "The database major version is MySQL 8.0 and the minor version is 27.", + "The database major version is MySQL 8.0 and the minor version is 28.", + "The database major version is MySQL 8.0 and the minor version is 29.", + "The database major version is MySQL 8.0 and the minor version is 30.", + "The database major version is MySQL 8.0 and the minor version is 31.", + "The database major version is MySQL 8.0 and the minor version is 32.", + "The database major version is MySQL 8.0 and the minor version is 33.", + "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.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", + "The database major version is MySQL 8.0 and the minor version is 41.", + "The database major version is MySQL 8.0 and the minor version is 42.", + "The database version is MySQL 8.4.", + "The database version is SQL Server 2017 Standard.", + "The database version is SQL Server 2017 Enterprise.", + "The database version is SQL Server 2017 Express.", + "The database version is SQL Server 2017 Web.", + "The database version is PostgreSQL 9.6.", + "The database version is PostgreSQL 10.", + "The database version is PostgreSQL 11.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "The database version is PostgreSQL 14.", + "The database version is PostgreSQL 15.", + "The database version is PostgreSQL 16.", + "The database version is PostgreSQL 17.", + "The database version is SQL Server 2019 Standard.", + "The database version is SQL Server 2019 Enterprise.", + "The database version is SQL Server 2019 Express.", + "The database version is SQL Server 2019 Web.", + "The database version is SQL Server 2022 Standard.", + "The database version is SQL Server 2022 Enterprise.", + "The database version is SQL Server 2022 Express.", + "The database version is SQL Server 2022 Web." + ], + "readOnly": true, + "type": "string" + }, "description": { "description": "The description of this run, only applicable to on-demand backups.", "type": "string" @@ -2823,8 +3480,41 @@ "description": "Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. This field applies to all DB types.", "type": "string" }, - "preferredZone": { - "description": "Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.", + "preferredZone": { + "description": "Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.", + "type": "string" + } + }, + "type": "object" + }, + "ConnectPoolNodeConfig": { + "description": "Details of a single node of a read pool.", + "id": "ConnectPoolNodeConfig", + "properties": { + "dnsName": { + "description": "Output only. The DNS name of the node.", + "readOnly": true, + "type": "string" + }, + "dnsNames": { + "description": "Output only. The list of DNS names used by this node.", + "items": { + "$ref": "DnsNameMapping" + }, + "readOnly": true, + "type": "array" + }, + "ipAddresses": { + "description": "Output only. Mappings containing IP addresses that can be used to connect to the node.", + "items": { + "$ref": "IpMapping" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The name of the node. Doesn't include the project ID.", + "readOnly": true, "type": "string" } }, @@ -3015,6 +3705,14 @@ "description": "The dns name of the instance.", "type": "string" }, + "dnsNames": { + "description": "Output only. The list of DNS names used by this instance.", + "items": { + "$ref": "DnsNameMapping" + }, + "readOnly": true, + "type": "array" + }, "ipAddresses": { "description": "The assigned IP addresses for the instance.", "items": { @@ -3026,6 +3724,19 @@ "description": "This is always `sql#connectSettings`.", "type": "string" }, + "nodeCount": { + "description": "The number of nodes in a read pool.", + "format": "int32", + "type": "integer" + }, + "nodes": { + "description": "Output only. Entries containing information about each node of the read pool.", + "items": { + "$ref": "ConnectPoolNodeConfig" + }, + "readOnly": true, + "type": "array" + }, "pscEnabled": { "description": "Whether PSC connectivity is enabled for this instance.", "type": "boolean" @@ -3043,14 +3754,94 @@ "enum": [ "CA_MODE_UNSPECIFIED", "GOOGLE_MANAGED_INTERNAL_CA", - "GOOGLE_MANAGED_CAS_CA" + "GOOGLE_MANAGED_CAS_CA", + "CUSTOMER_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)." + "Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS).", + "Customer-managed CA hosted on Google Cloud's Certificate Authority Service (CAS)." + ], + "type": "string" + } + }, + "type": "object" + }, + "ConnectionPoolConfig": { + "description": "The managed connection pooling configuration.", + "id": "ConnectionPoolConfig", + "properties": { + "clientConnectionIdleTimeout": { + "deprecated": true, + "description": "Client idle timeout.", + "format": "google-duration", + "type": "string" + }, + "connPoolSize": { + "deprecated": true, + "description": "Managed connection pool size.", + "format": "int32", + "type": "integer" + }, + "connectionPoolingEnabled": { + "description": "Whether managed connection pooling is enabled.", + "type": "boolean" + }, + "flags": { + "description": "Optional. List of connection pool configuration flags", + "items": { + "$ref": "ConnectionPoolFlags" + }, + "type": "array" + }, + "maxClientConnections": { + "deprecated": true, + "description": "Maximum number of client connections in connection pool.", + "format": "int32", + "type": "integer" + }, + "poolMode": { + "deprecated": true, + "description": "The managed connection pool mode for the instance.", + "enum": [ + "POOL_MODE_UNSPECIFIED", + "SESSION", + "TRANSACTION" + ], + "enumDescriptions": [ + "The pool mode is unknown.", + "The session mode for managed connection pooling.", + "The transaction(default) mode for managed connection pooling." ], "type": "string" + }, + "queryWaitTimeout": { + "deprecated": true, + "description": "Query wait timeout.", + "format": "google-duration", + "type": "string" + }, + "serverConnectionIdleTimeout": { + "deprecated": true, + "description": "Server idle timeout.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionPoolFlags": { + "description": "Connection pool flags for Cloud SQL instances managed connection pool configuration.", + "id": "ConnectionPoolFlags", + "properties": { + "name": { + "description": "Required. The name of the flag.", + "type": "string" + }, + "value": { + "description": "Required. The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value.", + "type": "string" } }, "type": "object" @@ -3339,6 +4130,14 @@ "readOnly": true, "type": "string" }, + "dnsNames": { + "description": "Output only. The list of DNS names used by this instance.", + "items": { + "$ref": "DnsNameMapping" + }, + "readOnly": true, + "type": "array" + }, "etag": { "description": "This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.", "type": "string" @@ -3365,19 +4164,25 @@ "$ref": "GeminiInstanceConfig", "description": "Gemini instance configuration." }, + "includeReplicasForMajorVersionUpgrade": { + "description": "Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.", + "type": "boolean" + }, "instanceType": { "description": "The instance type.", "enum": [ "SQL_INSTANCE_TYPE_UNSPECIFIED", "CLOUD_SQL_INSTANCE", "ON_PREMISES_INSTANCE", - "READ_REPLICA_INSTANCE" + "READ_REPLICA_INSTANCE", + "READ_POOL_INSTANCE" ], "enumDescriptions": [ "This is an unknown Cloud SQL instance type.", "A regular Cloud SQL instance that is not replicating from a primary instance.", "An instance running on the customer's premises that is not managed by Cloud SQL.", - "A Cloud SQL instance acting as a read-replica." + "A Cloud SQL instance acting as a read-replica.", + "CloudSQL read pool." ], "type": "string" }, @@ -3415,6 +4220,19 @@ "description": "Name of the Cloud SQL instance. This does not include the project ID.", "type": "string" }, + "nodeCount": { + "description": "The number of nodes in a read pool.", + "format": "int32", + "type": "integer" + }, + "nodes": { + "description": "Output only. Entries containing information about each node of the read pool.", + "items": { + "$ref": "PoolNodeConfig" + }, + "readOnly": true, + "type": "array" + }, "onPremisesConfiguration": { "$ref": "OnPremisesConfiguration", "description": "Configuration specific to on-premises instances." @@ -3517,7 +4335,8 @@ "PENDING_CREATE", "MAINTENANCE", "FAILED", - "ONLINE_MAINTENANCE" + "ONLINE_MAINTENANCE", + "REPAIRING" ], "enumDeprecated": [ false, @@ -3527,7 +4346,8 @@ false, false, false, - true + true, + false ], "enumDescriptions": [ "The state of the instance is unknown.", @@ -3537,7 +4357,8 @@ "The instance is being created.", "The instance is down for maintenance.", "The creation of the instance failed or a fatal error occurred during maintenance.", - "Deprecated" + "Deprecated", + "(Applicable to read pool nodes only.) The read pool node needs to be repaired. The database might be unavailable." ], "type": "string" }, @@ -3677,7 +4498,7 @@ "type": "string" }, "clientKey": { - "description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.", + "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.", "type": "string" }, "kind": { @@ -3744,6 +4565,47 @@ }, "type": "object" }, + "DnsNameMapping": { + "description": "DNS metadata.", + "id": "DnsNameMapping", + "properties": { + "connectionType": { + "description": "Output only. The connection type of the DNS name.", + "enum": [ + "CONNECTION_TYPE_UNSPECIFIED", + "PUBLIC", + "PRIVATE_SERVICES_ACCESS", + "PRIVATE_SERVICE_CONNECT" + ], + "enumDescriptions": [ + "Unknown connection type.", + "Public IP.", + "Private services access (private IP).", + "Private Service Connect." + ], + "readOnly": true, + "type": "string" + }, + "dnsScope": { + "description": "Output only. The scope that the DNS name applies to.", + "enum": [ + "DNS_SCOPE_UNSPECIFIED", + "INSTANCE" + ], + "enumDescriptions": [ + "Unknown DNS scope.", + "Indicates a instance-level DNS name." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The DNS name.", + "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", @@ -3831,7 +4693,7 @@ "type": "object" }, "databases": { - "description": "Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.", + "description": "Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.", "items": { "type": "string" }, @@ -3843,13 +4705,15 @@ "SQL_FILE_TYPE_UNSPECIFIED", "SQL", "CSV", - "BAK" + "BAK", + "TDE" ], "enumDescriptions": [ "Unknown file type.", "File containing SQL statements.", "File in CSV format.", - "" + "", + "TDE certificate." ], "type": "string" }, @@ -3912,6 +4776,28 @@ }, "type": "object" }, + "tdeExportOptions": { + "description": "Optional. Export parameters specific to SQL Server TDE certificates", + "properties": { + "certificatePath": { + "description": "Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the bucket. Applicable only for SQL Server instances.", + "type": "string" + }, + "name": { + "description": "Required. Certificate name. Applicable only for SQL Server instances.", + "type": "string" + }, + "privateKeyPassword": { + "description": "Required. Password that encrypts the private key.", + "type": "string" + }, + "privateKeyPath": { + "description": "Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.", + "type": "string" + } + }, + "type": "object" + }, "uri": { "description": "The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.", "type": "string" @@ -4116,6 +5002,20 @@ }, "type": "array" }, + "flagScope": { + "description": "Scope of flag.", + "enum": [ + "SQL_FLAG_SCOPE_UNSPECIFIED", + "SQL_FLAG_SCOPE_DATABASE", + "SQL_FLAG_SCOPE_CONNECTION_POOL" + ], + "enumDescriptions": [ + "Assume database flags if unspecified", + "database flags", + "connection pool configuration flags" + ], + "type": "string" + }, "inBeta": { "description": "Whether or not the flag is considered in beta.", "type": "boolean" @@ -4138,6 +5038,15 @@ "description": "This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet`", "type": "string" }, + "recommendedIntValue": { + "description": "Recommended int value in integer format for UI display.", + "format": "int64", + "type": "string" + }, + "recommendedStringValue": { + "description": "Recommended string value in string format for UI display.", + "type": "string" + }, "requiresRestart": { "description": "Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.", "type": "boolean" @@ -4289,6 +5198,10 @@ "description": "Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.", "type": "string" }, + "keepEncrypted": { + "description": "Optional. Whether the imported file remains encrypted.", + "type": "boolean" + }, "pvkPassword": { "description": "Password that encrypts the private key", "type": "string" @@ -4358,7 +5271,7 @@ "type": "object" }, "database": { - "description": "The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.", + "description": "The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.", "type": "string" }, "fileType": { @@ -4367,13 +5280,15 @@ "SQL_FILE_TYPE_UNSPECIFIED", "SQL", "CSV", - "BAK" + "BAK", + "TDE" ], "enumDescriptions": [ "Unknown file type.", "File containing SQL statements.", "File in CSV format.", - "" + "", + "TDE certificate." ], "type": "string" }, @@ -4414,6 +5329,28 @@ }, "type": "object" }, + "tdeImportOptions": { + "description": "Optional. Import parameters specific to SQL Server TDE certificates", + "properties": { + "certificatePath": { + "description": "Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.", + "type": "string" + }, + "name": { + "description": "Required. Certificate name. Applicable only for SQL Server instances.", + "type": "string" + }, + "privateKeyPassword": { + "description": "Required. Password that encrypts the private key.", + "type": "string" + }, + "privateKeyPath": { + "description": "Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.", + "type": "string" + } + }, + "type": "object" + }, "uri": { "description": "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.", "type": "string" @@ -4640,9 +5577,17 @@ "description": "Database instance restore backup request.", "id": "InstancesRestoreBackupRequest", "properties": { + "backup": { + "description": "The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.", + "type": "string" + }, "restoreBackupContext": { "$ref": "RestoreBackupContext", "description": "Parameters required to perform the restore backup operation." + }, + "restoreInstanceSettings": { + "$ref": "DatabaseInstance", + "description": "Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances." } }, "type": "object" @@ -4680,6 +5625,23 @@ }, "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" + }, "IpConfiguration": { "description": "IP Management configuration.", "id": "IpConfiguration", @@ -4739,7 +5701,7 @@ "type": "string" }, "serverCaPool": { - "description": "Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects//locations//caPools/", + "description": "Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}", "type": "string" }, "sslMode": { @@ -4795,6 +5757,31 @@ }, "type": "object" }, + "ListBackupsResponse": { + "description": "The response payload containing a list of the backups.", + "id": "ListBackupsResponse", + "properties": { + "backups": { + "description": "A list of backups.", + "items": { + "$ref": "Backup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, then there aren't subsequent pages.", + "type": "string" + }, + "warnings": { + "description": "If a region isn't unavailable or if an unknown error occurs, then a warning message is returned.", + "items": { + "$ref": "ApiWarning" + }, + "type": "array" + } + }, + "type": "object" + }, "LocationPreference": { "description": "Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.", "id": "LocationPreference", @@ -4869,7 +5856,7 @@ "type": "string" }, "clientKey": { - "description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.", + "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.", "type": "string" }, "connectRetryInterval": { @@ -4936,7 +5923,7 @@ "type": "string" }, "clientKey": { - "description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.", + "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.", "type": "string" }, "dumpFilePath": { @@ -5077,6 +6064,7 @@ "AUTO_RESTART", "REENCRYPT", "SWITCHOVER", + "UPDATE_BACKUP", "ACQUIRE_SSRS_LEASE", "RELEASE_SSRS_LEASE", "RECONFIGURE_OLD_PRIMARY", @@ -5084,7 +6072,11 @@ "SELF_SERVICE_MAINTENANCE", "SWITCHOVER_TO_REPLICA", "MAJOR_VERSION_UPGRADE", - "ADVANCED_BACKUP" + "ADVANCED_BACKUP", + "MANAGE_BACKUP", + "ENHANCED_BACKUP", + "REPAIR_READ_POOL", + "CREATE_READ_POOL" ], "enumDeprecated": [ false, @@ -5129,10 +6121,15 @@ false, false, false, + false, true, true, false, false, + true, + false, + false, + false, false ], "enumDescriptions": [ @@ -5175,6 +6172,7 @@ "Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery.", "Re-encrypts CMEK instances with latest key version.", "Switches the roles of the primary and replica pair. The target instance should be the replica.", + "Update a backup.", "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "Release a lease for the setup of SQL Server Reporting Services (SSRS).", "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.", @@ -5182,7 +6180,11 @@ "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.", "Updates the major version of a Cloud SQL instance.", - "Creates a backup for an Advanced BackupTier Cloud SQL instance." + "Deprecated: ADVANCED_BACKUP is deprecated. Use ENHANCED_BACKUP instead.", + "Changes the BackupTier of a Cloud SQL instance.", + "Creates a backup for an Enhanced BackupTier Cloud SQL instance.", + "Repairs entire read pool or specified nodes in the read pool.", + "Creates a Cloud SQL read pool instance." ], "type": "string" }, @@ -5216,6 +6218,7 @@ "description": "Optional. The sub operation based on the operation type." }, "targetId": { + "description": "Name of the resource on which this operation runs.", "type": "string" }, "targetLink": { @@ -5410,6 +6413,82 @@ }, "type": "object" }, + "PoolNodeConfig": { + "description": "Details of a single node of a read pool.", + "id": "PoolNodeConfig", + "properties": { + "dnsName": { + "description": "Output only. The DNS name of the node.", + "readOnly": true, + "type": "string" + }, + "dnsNames": { + "description": "Output only. The list of DNS names used by this node.", + "items": { + "$ref": "DnsNameMapping" + }, + "readOnly": true, + "type": "array" + }, + "gceZone": { + "description": "Output only. The serving zone of the node.", + "readOnly": true, + "type": "string" + }, + "ipAddresses": { + "description": "Output only. Mappings containing IP addresses that can be used to connect to the node.", + "items": { + "$ref": "IpMapping" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The name of the node, to be used for retrieving metrics and logs for the node.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the node.", + "enum": [ + "SQL_INSTANCE_STATE_UNSPECIFIED", + "RUNNABLE", + "SUSPENDED", + "PENDING_DELETE", + "PENDING_CREATE", + "MAINTENANCE", + "FAILED", + "ONLINE_MAINTENANCE", + "REPAIRING" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + true, + false + ], + "enumDescriptions": [ + "The state of the instance is unknown.", + "The instance is running, or has been stopped by owner.", + "The instance is not available, for example due to problems with billing.", + "The instance is being deleted.", + "The instance is being created.", + "The instance is down for maintenance.", + "The creation of the instance failed or a fatal error occurred during maintenance.", + "Deprecated", + "(Applicable to read pool nodes only.) The read pool node needs to be repaired. The database might be unavailable." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PscAutoConnectionConfig": { "description": "Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.", "id": "PscAutoConnectionConfig", @@ -5662,6 +6741,10 @@ "description": "The name of server Instance collation.", "type": "string" }, + "connectionPoolConfig": { + "$ref": "ConnectionPoolConfig", + "description": "Optional. The managed connection pooling configuration for the instance." + }, "connectorEnforcement": { "description": "Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.", "enum": [ @@ -5685,6 +6768,16 @@ "$ref": "DataCacheConfig", "description": "Configuration for data cache." }, + "dataDiskProvisionedIops": { + "description": "Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.", + "format": "int64", + "type": "string" + }, + "dataDiskProvisionedThroughput": { + "description": "Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.", + "format": "int64", + "type": "string" + }, "dataDiskSizeGb": { "description": "The size of data disk, in GB. The data disk size minimum is 10GB.", "format": "int64", @@ -5817,6 +6910,10 @@ ], "type": "string" }, + "retainBackupsOnDelete": { + "description": "Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.", + "type": "boolean" + }, "settingsVersion": { "description": "The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.", "format": "int64", diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 8e89a8d1f8b..2ac5c7e81d8 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -270,6 +270,168 @@ } } }, + "backups": { + "methods": { + "createBackup": { + "description": "Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.", + "flatPath": "sql/v1beta4/projects/{projectsId}/backups", + "httpMethod": "POST", + "id": "sql.backups.createBackup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this backup is created. Format: projects/{project}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/{+parent}/backups", + "request": { + "$ref": "Backup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "deleteBackup": { + "description": "Deletes the backup.", + "flatPath": "sql/v1beta4/projects/{projectsId}/backups/{backupsId}", + "httpMethod": "DELETE", + "id": "sql.backups.deleteBackup", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the backup to delete. Format: projects/{project}/backups/{backup}", + "location": "path", + "pattern": "^projects/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "getBackup": { + "description": "Retrieves a resource containing information about a backup.", + "flatPath": "sql/v1beta4/projects/{projectsId}/backups/{backupsId}", + "httpMethod": "GET", + "id": "sql.backups.getBackup", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup}", + "location": "path", + "pattern": "^projects/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/{+name}", + "response": { + "$ref": "Backup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "listBackups": { + "description": "Lists all backups associated with the project.", + "flatPath": "sql/v1beta4/projects/{projectsId}/backups", + "httpMethod": "GET", + "id": "sql.backups.listBackups", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent that owns this collection of backups. Format: projects/{project}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/{+parent}/backups", + "response": { + "$ref": "ListBackupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "updateBackup": { + "description": "Updates the retention period and the description of the backup. You can use this API to update final backups only.", + "flatPath": "sql/v1beta4/projects/{projectsId}/backups/{backupsId}", + "httpMethod": "PATCH", + "id": "sql.backups.updateBackup", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.", + "location": "path", + "pattern": "^projects/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields that you can update. You can update only the description and retention period of the final backup.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "sql/v1beta4/{+name}", + "request": { + "$ref": "Backup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + } + } + }, "connect": { "methods": { "generateEphemeralCert": { @@ -593,6 +755,21 @@ "description": "Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.", "location": "query", "type": "string" + }, + "flagScope": { + "description": "Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified.", + "enum": [ + "SQL_FLAG_SCOPE_UNSPECIFIED", + "SQL_FLAG_SCOPE_DATABASE", + "SQL_FLAG_SCOPE_CONNECTION_POOL" + ], + "enumDescriptions": [ + "Assume database flags if unspecified", + "database flags", + "connection pool configuration flags" + ], + "location": "query", + "type": "string" } }, "path": "sql/v1beta4/flags", @@ -819,6 +996,28 @@ "instance" ], "parameters": { + "enableFinalBackup": { + "description": "Flag to opt-in for final backup. By default, it is turned off.", + "location": "query", + "type": "boolean" + }, + "finalBackupDescription": { + "description": "Optional. The description of the final backup.", + "location": "query", + "type": "string" + }, + "finalBackupExpiryTime": { + "description": "Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "finalBackupTtlDays": { + "description": "Optional. Retention period of the final backup.", + "format": "int64", + "location": "query", + "type": "string" + }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", @@ -2366,7 +2565,7 @@ } } }, - "revision": "20250117", + "revision": "20250310", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2481,132 +2680,441 @@ }, "type": "object" }, - "BackupConfiguration": { - "description": "Database instance backup configuration.", - "id": "BackupConfiguration", + "Backup": { + "description": "A backup resource.", + "id": "Backup", "properties": { - "backupRetentionSettings": { - "$ref": "BackupRetentionSettings", - "description": "Backup retention settings." - }, - "binaryLogEnabled": { - "description": "(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.", - "type": "boolean" - }, - "enabled": { - "description": "Whether this configuration is enabled.", - "type": "boolean" - }, - "kind": { - "description": "This is always `sql#backupConfiguration`.", - "type": "string" - }, - "location": { - "description": "Location of the backup", - "type": "string" - }, - "pointInTimeRecoveryEnabled": { - "description": "Whether point in time recovery is enabled.", - "type": "boolean" - }, - "replicationLogArchivingEnabled": { - "description": "Reserved for future use.", - "type": "boolean" - }, - "startTime": { - "description": "Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.", - "type": "string" - }, - "transactionLogRetentionDays": { - "description": "The number of days of transaction logs we retain for point in time restore, from 1-7.", - "format": "int32", - "type": "integer" + "backupInterval": { + "$ref": "Interval", + "description": "Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.", + "readOnly": true }, - "transactionalLogStorageState": { - "description": "Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.", + "backupKind": { + "description": "Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.", "enum": [ - "TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED", - "DISK", - "SWITCHING_TO_CLOUD_STORAGE", - "SWITCHED_TO_CLOUD_STORAGE", - "CLOUD_STORAGE" + "SQL_BACKUP_KIND_UNSPECIFIED", + "SNAPSHOT", + "PHYSICAL" ], "enumDescriptions": [ - "Unspecified.", - "The transaction logs used for PITR for the instance are stored on a data disk.", - "The transaction logs used for PITR for the instance are switching from being stored on a data disk to being stored in Cloud Storage. Only applicable to MySQL.", - "The transaction logs used for PITR for the instance are now stored in Cloud Storage. Previously, they were stored on a data disk. Only applicable to MySQL.", - "The transaction logs used for PITR for the instance are stored in Cloud Storage. Only applicable to MySQL and PostgreSQL." + "This is an unknown BackupKind.", + "Snapshot-based backups.", + "Physical backups." ], "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "BackupContext": { - "description": "Backup context.", - "id": "BackupContext", - "properties": { - "backupId": { - "description": "The identifier of the backup.", - "format": "int64", - "type": "string" - }, - "kind": { - "description": "This is always `sql#backupContext`.", - "type": "string" - } - }, - "type": "object" - }, - "BackupReencryptionConfig": { - "description": "Backup Reencryption Config", - "id": "BackupReencryptionConfig", - "properties": { - "backupLimit": { - "description": "Backup re-encryption limit", - "format": "int32", - "type": "integer" }, - "backupType": { - "description": "Type of backups users want to re-encrypt.", - "enum": [ - "BACKUP_TYPE_UNSPECIFIED", - "AUTOMATED", - "ON_DEMAND" - ], - "enumDescriptions": [ - "Unknown backup type, will be defaulted to AUTOMATIC backup type", - "Reencrypt automatic backups", - "Reencrypt on-demand backups" - ], + "backupRun": { + "description": "Output only. The mapping to backup run resource used for IAM validations.", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "BackupRetentionSettings": { - "description": "We currently only support backup retention by specifying the number of backups we will retain.", - "id": "BackupRetentionSettings", - "properties": { - "retainedBackups": { - "description": "Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.", - "format": "int32", - "type": "integer" }, - "retentionUnit": { - "description": "The unit that 'retained_backups' represents.", + "databaseVersion": { + "description": "Output only. The database version of the instance of when this backup was made.", "enum": [ - "RETENTION_UNIT_UNSPECIFIED", - "COUNT" - ], - "enumDescriptions": [ - "Backup retention unit is unspecified, will be treated as COUNT.", - "Retention will be by count, eg. \"retain the most recent 7 backups\"." - ], - "type": "string" - } + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "MYSQL_8_0", + "MYSQL_8_0_18", + "MYSQL_8_0_26", + "MYSQL_8_0_27", + "MYSQL_8_0_28", + "MYSQL_8_0_29", + "MYSQL_8_0_30", + "MYSQL_8_0_31", + "MYSQL_8_0_32", + "MYSQL_8_0_33", + "MYSQL_8_0_34", + "MYSQL_8_0_35", + "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", + "MYSQL_8_0_41", + "MYSQL_8_0_42", + "MYSQL_8_4", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_9_6", + "POSTGRES_10", + "POSTGRES_11", + "POSTGRES_12", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16", + "POSTGRES_17", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB", + "SQLSERVER_2022_STANDARD", + "SQLSERVER_2022_ENTERPRISE", + "SQLSERVER_2022_EXPRESS", + "SQLSERVER_2022_WEB" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "The database version is MySQL 5.1.", + "The database version is MySQL 5.5.", + "The database version is MySQL 5.6.", + "The database version is MySQL 5.7.", + "The database version is MySQL 8.", + "The database major version is MySQL 8.0 and the minor version is 18.", + "The database major version is MySQL 8.0 and the minor version is 26.", + "The database major version is MySQL 8.0 and the minor version is 27.", + "The database major version is MySQL 8.0 and the minor version is 28.", + "The database major version is MySQL 8.0 and the minor version is 29.", + "The database major version is MySQL 8.0 and the minor version is 30.", + "The database major version is MySQL 8.0 and the minor version is 31.", + "The database major version is MySQL 8.0 and the minor version is 32.", + "The database major version is MySQL 8.0 and the minor version is 33.", + "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.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", + "The database major version is MySQL 8.0 and the minor version is 41.", + "The database major version is MySQL 8.0 and the minor version is 42.", + "The database version is MySQL 8.4.", + "The database version is SQL Server 2017 Standard.", + "The database version is SQL Server 2017 Enterprise.", + "The database version is SQL Server 2017 Express.", + "The database version is SQL Server 2017 Web.", + "The database version is PostgreSQL 9.6.", + "The database version is PostgreSQL 10.", + "The database version is PostgreSQL 11.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "The database version is PostgreSQL 14.", + "The database version is PostgreSQL 15.", + "The database version is PostgreSQL 16.", + "The database version is PostgreSQL 17.", + "The database version is SQL Server 2019 Standard.", + "The database version is SQL Server 2019 Enterprise.", + "The database version is SQL Server 2019 Express.", + "The database version is SQL Server 2019 Web.", + "The database version is SQL Server 2022 Standard.", + "The database version is SQL Server 2022 Enterprise.", + "The database version is SQL Server 2022 Express.", + "The database version is SQL Server 2022 Web." + ], + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of this backup.", + "type": "string" + }, + "error": { + "$ref": "OperationError", + "description": "Output only. Information about why the backup operation fails (for example, when the backup state fails).", + "readOnly": true + }, + "expiryTime": { + "description": "Backup expiration time. A UTC timestamp of when this resource expired.", + "format": "google-datetime", + "type": "string" + }, + "instance": { + "description": "The name of the database instance.", + "type": "string" + }, + "instanceDeletionTime": { + "description": "Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "instanceSettings": { + "$ref": "DatabaseInstance", + "description": "Optional. Output only. Instance setting of the source instance that's associated with this backup.", + "readOnly": true + }, + "kind": { + "description": "Output only. This is always `sql#backup`.", + "readOnly": true, + "type": "string" + }, + "kmsKey": { + "description": "Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.", + "readOnly": true, + "type": "string" + }, + "kmsKeyVersion": { + "description": "Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "The storage location of the backups. The location can be multi-regional.", + "type": "string" + }, + "maxChargeableBytes": { + "description": "Output only. The maximum chargeable bytes for the backup.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.", + "readOnly": true, + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "selfLink": { + "description": "Output only. The URI of this resource.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of this backup.", + "enum": [ + "SQL_BACKUP_STATE_UNSPECIFIED", + "ENQUEUED", + "RUNNING", + "FAILED", + "SUCCESSFUL", + "DELETING", + "DELETION_FAILED" + ], + "enumDescriptions": [ + "The state of the backup is unknown.", + "The backup that's added to a queue.", + "The backup is in progress.", + "The backup failed.", + "The backup is successful.", + "The backup is being deleted.", + "Deletion of the backup failed." + ], + "readOnly": true, + "type": "string" + }, + "timeZone": { + "description": "Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.", + "readOnly": true, + "type": "string" + }, + "ttlDays": { + "description": "Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Output only. The type of this backup. The type can be \"AUTOMATED\", \"ON_DEMAND\", or “FINAL”.", + "enum": [ + "SQL_BACKUP_TYPE_UNSPECIFIED", + "AUTOMATED", + "ON_DEMAND", + "FINAL" + ], + "enumDescriptions": [ + "This is an unknown backup type.", + "The backup schedule triggers a backup automatically.", + "The user triggers a backup manually.", + "The backup that's created when the instance is deleted." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupConfiguration": { + "description": "Database instance backup configuration.", + "id": "BackupConfiguration", + "properties": { + "backupRetentionSettings": { + "$ref": "BackupRetentionSettings", + "description": "Backup retention settings." + }, + "binaryLogEnabled": { + "description": "(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.", + "type": "boolean" + }, + "enabled": { + "description": "Whether this configuration is enabled.", + "type": "boolean" + }, + "kind": { + "description": "This is always `sql#backupConfiguration`.", + "type": "string" + }, + "location": { + "description": "Location of the backup", + "type": "string" + }, + "pointInTimeRecoveryEnabled": { + "description": "Whether point in time recovery is enabled.", + "type": "boolean" + }, + "replicationLogArchivingEnabled": { + "description": "Reserved for future use.", + "type": "boolean" + }, + "startTime": { + "description": "Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`.", + "type": "string" + }, + "transactionLogRetentionDays": { + "description": "The number of days of transaction logs we retain for point in time restore, from 1-7.", + "format": "int32", + "type": "integer" + }, + "transactionalLogStorageState": { + "description": "Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.", + "enum": [ + "TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED", + "DISK", + "SWITCHING_TO_CLOUD_STORAGE", + "SWITCHED_TO_CLOUD_STORAGE", + "CLOUD_STORAGE" + ], + "enumDescriptions": [ + "Unspecified.", + "The transaction logs used for PITR for the instance are stored on a data disk.", + "The transaction logs used for PITR for the instance are switching from being stored on a data disk to being stored in Cloud Storage. Only applicable to MySQL.", + "The transaction logs used for PITR for the instance are now stored in Cloud Storage. Previously, they were stored on a data disk. Only applicable to MySQL.", + "The transaction logs used for PITR for the instance are stored in Cloud Storage. Only applicable to MySQL and PostgreSQL." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupContext": { + "description": "Backup context.", + "id": "BackupContext", + "properties": { + "backupId": { + "description": "The identifier of the backup.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "This is always `sql#backupContext`.", + "type": "string" + }, + "name": { + "description": "The name of the backup. Format: projects/{project}/backups/{backup}", + "type": "string" + } + }, + "type": "object" + }, + "BackupReencryptionConfig": { + "description": "Backup Reencryption Config", + "id": "BackupReencryptionConfig", + "properties": { + "backupLimit": { + "description": "Backup re-encryption limit", + "format": "int32", + "type": "integer" + }, + "backupType": { + "description": "Type of backups users want to re-encrypt.", + "enum": [ + "BACKUP_TYPE_UNSPECIFIED", + "AUTOMATED", + "ON_DEMAND" + ], + "enumDescriptions": [ + "Unknown backup type, will be defaulted to AUTOMATIC backup type", + "Reencrypt automatic backups", + "Reencrypt on-demand backups" + ], + "type": "string" + } + }, + "type": "object" + }, + "BackupRetentionSettings": { + "description": "We currently only support backup retention by specifying the number of backups we will retain.", + "id": "BackupRetentionSettings", + "properties": { + "retainedBackups": { + "description": "Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.", + "format": "int32", + "type": "integer" + }, + "retentionUnit": { + "description": "The unit that 'retained_backups' represents.", + "enum": [ + "RETENTION_UNIT_UNSPECIFIED", + "COUNT" + ], + "enumDescriptions": [ + "Backup retention unit is unspecified, will be treated as COUNT.", + "Retention will be by count, eg. \"retain the most recent 7 backups\"." + ], + "type": "string" + } }, "type": "object" }, @@ -2628,6 +3136,155 @@ ], "type": "string" }, + "databaseVersion": { + "description": "Output only. The instance database version when this backup was made.", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "MYSQL_8_0", + "MYSQL_8_0_18", + "MYSQL_8_0_26", + "MYSQL_8_0_27", + "MYSQL_8_0_28", + "MYSQL_8_0_29", + "MYSQL_8_0_30", + "MYSQL_8_0_31", + "MYSQL_8_0_32", + "MYSQL_8_0_33", + "MYSQL_8_0_34", + "MYSQL_8_0_35", + "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_0_38", + "MYSQL_8_0_39", + "MYSQL_8_0_40", + "MYSQL_8_0_41", + "MYSQL_8_0_42", + "MYSQL_8_4", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_9_6", + "POSTGRES_10", + "POSTGRES_11", + "POSTGRES_12", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16", + "POSTGRES_17", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB", + "SQLSERVER_2022_STANDARD", + "SQLSERVER_2022_ENTERPRISE", + "SQLSERVER_2022_EXPRESS", + "SQLSERVER_2022_WEB" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "The database version is MySQL 5.1.", + "The database version is MySQL 5.5.", + "The database version is MySQL 5.6.", + "The database version is MySQL 5.7.", + "The database version is MySQL 8.", + "The database major version is MySQL 8.0 and the minor version is 18.", + "The database major version is MySQL 8.0 and the minor version is 26.", + "The database major version is MySQL 8.0 and the minor version is 27.", + "The database major version is MySQL 8.0 and the minor version is 28.", + "The database major version is MySQL 8.0 and the minor version is 29.", + "The database major version is MySQL 8.0 and the minor version is 30.", + "The database major version is MySQL 8.0 and the minor version is 31.", + "The database major version is MySQL 8.0 and the minor version is 32.", + "The database major version is MySQL 8.0 and the minor version is 33.", + "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.", + "The database major version is MySQL 8.0 and the minor version is 38.", + "The database major version is MySQL 8.0 and the minor version is 39.", + "The database major version is MySQL 8.0 and the minor version is 40.", + "The database major version is MySQL 8.0 and the minor version is 41.", + "The database major version is MySQL 8.0 and the minor version is 42.", + "The database version is MySQL 8.4.", + "The database version is SQL Server 2017 Standard.", + "The database version is SQL Server 2017 Enterprise.", + "The database version is SQL Server 2017 Express.", + "The database version is SQL Server 2017 Web.", + "The database version is PostgreSQL 9.6.", + "The database version is PostgreSQL 10.", + "The database version is PostgreSQL 11.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "The database version is PostgreSQL 14.", + "The database version is PostgreSQL 15.", + "The database version is PostgreSQL 16.", + "The database version is PostgreSQL 17.", + "The database version is SQL Server 2019 Standard.", + "The database version is SQL Server 2019 Enterprise.", + "The database version is SQL Server 2019 Express.", + "The database version is SQL Server 2019 Web.", + "The database version is SQL Server 2022 Standard.", + "The database version is SQL Server 2022 Enterprise.", + "The database version is SQL Server 2022 Express.", + "The database version is SQL Server 2022 Web." + ], + "readOnly": true, + "type": "string" + }, "description": { "description": "The description of this run, only applicable to on-demand backups.", "type": "string" @@ -2823,8 +3480,41 @@ "description": "Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field.", "type": "string" }, - "preferredZone": { - "description": "Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance.", + "preferredZone": { + "description": "Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance.", + "type": "string" + } + }, + "type": "object" + }, + "ConnectPoolNodeConfig": { + "description": "Details of a single node of a read pool.", + "id": "ConnectPoolNodeConfig", + "properties": { + "dnsName": { + "description": "Output only. The DNS name of the node.", + "readOnly": true, + "type": "string" + }, + "dnsNames": { + "description": "Output only. The list of DNS names used by this instance.", + "items": { + "$ref": "DnsNameMapping" + }, + "readOnly": true, + "type": "array" + }, + "ipAddresses": { + "description": "Output only. Mappings containing IP addresses that can be used to connect to the node.", + "items": { + "$ref": "IpMapping" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The name of the node. Doesn't include the project ID.", + "readOnly": true, "type": "string" } }, @@ -3015,6 +3705,14 @@ "description": "The dns name of the instance.", "type": "string" }, + "dnsNames": { + "description": "Output only. The list of DNS names used by this instance.", + "items": { + "$ref": "DnsNameMapping" + }, + "readOnly": true, + "type": "array" + }, "ipAddresses": { "description": "The assigned IP addresses for the instance.", "items": { @@ -3026,6 +3724,19 @@ "description": "This is always `sql#connectSettings`.", "type": "string" }, + "nodeCount": { + "description": "The number of nodes in a read pool.", + "format": "int32", + "type": "integer" + }, + "nodes": { + "description": "Output only. Entries containing information about each node of the read pool.", + "items": { + "$ref": "ConnectPoolNodeConfig" + }, + "readOnly": true, + "type": "array" + }, "pscEnabled": { "description": "Whether PSC connectivity is enabled for this instance.", "type": "boolean" @@ -3057,6 +3768,84 @@ }, "type": "object" }, + "ConnectionPoolConfig": { + "description": "The managed connection pooling configuration.", + "id": "ConnectionPoolConfig", + "properties": { + "clientConnectionIdleTimeout": { + "deprecated": true, + "description": "Client idle timeout.", + "format": "google-duration", + "type": "string" + }, + "connPoolSize": { + "deprecated": true, + "description": "Managed connection pool size.", + "format": "int32", + "type": "integer" + }, + "connectionPoolingEnabled": { + "description": "Whether managed connection pooling is enabled.", + "type": "boolean" + }, + "flags": { + "description": "Optional. List of connection pool configuration flags", + "items": { + "$ref": "ConnectionPoolFlags" + }, + "type": "array" + }, + "maxClientConnections": { + "deprecated": true, + "description": "Maximum number of client connections in connection pool.", + "format": "int32", + "type": "integer" + }, + "poolMode": { + "deprecated": true, + "description": "The managed connection pool mode for the instance.", + "enum": [ + "POOL_MODE_UNSPECIFIED", + "SESSION", + "TRANSACTION" + ], + "enumDescriptions": [ + "The pool mode is unknown.", + "The session mode for managed connection pooling.", + "The transaction(default) mode for managed connection pooling." + ], + "type": "string" + }, + "queryWaitTimeout": { + "deprecated": true, + "description": "Query wait timeout.", + "format": "google-duration", + "type": "string" + }, + "serverConnectionIdleTimeout": { + "deprecated": true, + "description": "Server idle timeout.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionPoolFlags": { + "description": "Connection pool flags for Cloud SQL instances managed connection pool configuration.", + "id": "ConnectionPoolFlags", + "properties": { + "name": { + "description": "Required. The name of the flag.", + "type": "string" + }, + "value": { + "description": "Required. The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value.", + "type": "string" + } + }, + "type": "object" + }, "DataCacheConfig": { "description": "Data cache configurations.", "id": "DataCacheConfig", @@ -3341,6 +4130,14 @@ "readOnly": true, "type": "string" }, + "dnsNames": { + "description": "Output only. The list of DNS names used by this instance.", + "items": { + "$ref": "DnsNameMapping" + }, + "readOnly": true, + "type": "array" + }, "etag": { "description": "This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.", "type": "string" @@ -3367,19 +4164,25 @@ "$ref": "GeminiInstanceConfig", "description": "Gemini instance configuration." }, + "includeReplicasForMajorVersionUpgrade": { + "description": "Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.", + "type": "boolean" + }, "instanceType": { "description": "The instance type.", "enum": [ "SQL_INSTANCE_TYPE_UNSPECIFIED", "CLOUD_SQL_INSTANCE", "ON_PREMISES_INSTANCE", - "READ_REPLICA_INSTANCE" + "READ_REPLICA_INSTANCE", + "READ_POOL_INSTANCE" ], "enumDescriptions": [ "This is an unknown Cloud SQL instance type.", "A regular Cloud SQL instance that is not replicating from a primary instance.", "An instance running on the customer's premises that is not managed by Cloud SQL.", - "A Cloud SQL instance acting as a read-replica." + "A Cloud SQL instance acting as a read-replica.", + "CloudSQL read pool." ], "type": "string" }, @@ -3417,6 +4220,19 @@ "description": "Name of the Cloud SQL instance. This does not include the project ID.", "type": "string" }, + "nodeCount": { + "description": "The number of nodes in a read pool.", + "format": "int32", + "type": "integer" + }, + "nodes": { + "description": "Output only. Entries containing information about each node of the read pool.", + "items": { + "$ref": "PoolNodeConfig" + }, + "readOnly": true, + "type": "array" + }, "onPremisesConfiguration": { "$ref": "OnPremisesConfiguration", "description": "Configuration specific to on-premises instances." @@ -3520,7 +4336,8 @@ "PENDING_CREATE", "MAINTENANCE", "FAILED", - "ONLINE_MAINTENANCE" + "ONLINE_MAINTENANCE", + "REPAIRING" ], "enumDeprecated": [ false, @@ -3530,7 +4347,8 @@ false, false, false, - true + true, + false ], "enumDescriptions": [ "The state of the instance is unknown.", @@ -3540,7 +4358,8 @@ "The instance is being created.", "The instance is down for maintenance.", "The creation of the instance failed or a fatal error occurred during maintenance.", - "Deprecated" + "Deprecated", + "(Applicable to read pool nodes only.) The read pool node needs to be repaired. The database might be unavailable." ], "type": "string" }, @@ -3680,7 +4499,7 @@ "type": "string" }, "clientKey": { - "description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.", + "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.", "type": "string" }, "kind": { @@ -3747,6 +4566,47 @@ }, "type": "object" }, + "DnsNameMapping": { + "description": "DNS metadata.", + "id": "DnsNameMapping", + "properties": { + "connectionType": { + "description": "Output only. The connection type of the DNS name.", + "enum": [ + "CONNECTION_TYPE_UNSPECIFIED", + "PUBLIC", + "PRIVATE_SERVICES_ACCESS", + "PRIVATE_SERVICE_CONNECT" + ], + "enumDescriptions": [ + "Unknown connection type.", + "Public IP.", + "Private services access (private IP).", + "Private Service Connect." + ], + "readOnly": true, + "type": "string" + }, + "dnsScope": { + "description": "Output only. The scope that the DNS name applies to.", + "enum": [ + "DNS_SCOPE_UNSPECIFIED", + "INSTANCE" + ], + "enumDescriptions": [ + "Unknown DNS scope.", + "Indicates a instance-level DNS name." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The DNS name.", + "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", @@ -3834,7 +4694,7 @@ "type": "object" }, "databases": { - "description": "Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.", + "description": "Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.", "items": { "type": "string" }, @@ -3846,13 +4706,15 @@ "SQL_FILE_TYPE_UNSPECIFIED", "SQL", "CSV", - "BAK" + "BAK", + "TDE" ], "enumDescriptions": [ "Unknown file type.", "File containing SQL statements.", "File in CSV format.", - "" + "", + "TDE certificate." ], "type": "string" }, @@ -3915,6 +4777,28 @@ }, "type": "object" }, + "tdeExportOptions": { + "description": "Optional. Export parameters specific to SQL Server TDE certificates", + "properties": { + "certificatePath": { + "description": "Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.", + "type": "string" + }, + "name": { + "description": "Required. Certificate name. Applicable only for SQL Server instances.", + "type": "string" + }, + "privateKeyPassword": { + "description": "Required. Password that encrypts the private key.", + "type": "string" + }, + "privateKeyPath": { + "description": "Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.", + "type": "string" + } + }, + "type": "object" + }, "uri": { "description": "The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.", "type": "string" @@ -4119,6 +5003,20 @@ }, "type": "array" }, + "flagScope": { + "description": "Scope of flag.", + "enum": [ + "SQL_FLAG_SCOPE_UNSPECIFIED", + "SQL_FLAG_SCOPE_DATABASE", + "SQL_FLAG_SCOPE_CONNECTION_POOL" + ], + "enumDescriptions": [ + "Assume database flags if unspecified", + "database flags", + "connection pool configuration flags" + ], + "type": "string" + }, "inBeta": { "description": "Whether or not the flag is considered in beta.", "type": "boolean" @@ -4141,6 +5039,15 @@ "description": "This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet`", "type": "string" }, + "recommendedIntValue": { + "description": "Recommended flag value in integer format for UI display.", + "format": "int64", + "type": "string" + }, + "recommendedStringValue": { + "description": "Recommended flag value in string format for UI display.", + "type": "string" + }, "requiresRestart": { "description": "Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.", "type": "boolean" @@ -4292,6 +5199,10 @@ "description": "Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.", "type": "string" }, + "keepEncrypted": { + "description": "Optional. Whether the imported file remains encrypted.", + "type": "boolean" + }, "pvkPassword": { "description": "Password that encrypts the private key", "type": "string" @@ -4361,7 +5272,7 @@ "type": "object" }, "database": { - "description": "The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.", + "description": "The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.", "type": "string" }, "fileType": { @@ -4370,13 +5281,15 @@ "SQL_FILE_TYPE_UNSPECIFIED", "SQL", "CSV", - "BAK" + "BAK", + "TDE" ], "enumDescriptions": [ "Unknown file type.", "File containing SQL statements.", "File in CSV format.", - "" + "", + "TDE certificate." ], "type": "string" }, @@ -4417,6 +5330,28 @@ }, "type": "object" }, + "tdeImportOptions": { + "description": "Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates", + "properties": { + "certificatePath": { + "description": "Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.", + "type": "string" + }, + "name": { + "description": "Required. Certificate name. Applicable only for SQL Server instances.", + "type": "string" + }, + "privateKeyPassword": { + "description": "Required. Password that encrypts the private key.", + "type": "string" + }, + "privateKeyPath": { + "description": "Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.", + "type": "string" + } + }, + "type": "object" + }, "uri": { "description": "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.", "type": "string" @@ -4643,9 +5578,17 @@ "description": "Database instance restore backup request.", "id": "InstancesRestoreBackupRequest", "properties": { + "backup": { + "description": "The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.", + "type": "string" + }, "restoreBackupContext": { "$ref": "RestoreBackupContext", "description": "Parameters required to perform the restore backup operation." + }, + "restoreInstanceSettings": { + "$ref": "DatabaseInstance", + "description": "Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances." } }, "type": "object" @@ -4683,6 +5626,23 @@ }, "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" + }, "IpConfiguration": { "description": "IP Management configuration.", "id": "IpConfiguration", @@ -4742,7 +5702,7 @@ "type": "string" }, "serverCaPool": { - "description": "Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects//locations//caPools/", + "description": "Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}", "type": "string" }, "sslMode": { @@ -4798,6 +5758,31 @@ }, "type": "object" }, + "ListBackupsResponse": { + "description": "The response payload containing a list of the backups.", + "id": "ListBackupsResponse", + "properties": { + "backups": { + "description": "A list of backups.", + "items": { + "$ref": "Backup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, then there aren't subsequent pages.", + "type": "string" + }, + "warnings": { + "description": "If a region isn't unavailable or if an unknown error occurs, then a warning message is returned.", + "items": { + "$ref": "ApiWarning" + }, + "type": "array" + } + }, + "type": "object" + }, "LocationPreference": { "description": "Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.", "id": "LocationPreference", @@ -4872,7 +5857,7 @@ "type": "string" }, "clientKey": { - "description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.", + "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.", "type": "string" }, "connectRetryInterval": { @@ -4939,7 +5924,7 @@ "type": "string" }, "clientKey": { - "description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.", + "description": "PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.", "type": "string" }, "dumpFilePath": { @@ -5080,6 +6065,7 @@ "AUTO_RESTART", "REENCRYPT", "SWITCHOVER", + "UPDATE_BACKUP", "ACQUIRE_SSRS_LEASE", "RELEASE_SSRS_LEASE", "RECONFIGURE_OLD_PRIMARY", @@ -5087,7 +6073,11 @@ "SELF_SERVICE_MAINTENANCE", "SWITCHOVER_TO_REPLICA", "MAJOR_VERSION_UPGRADE", - "ADVANCED_BACKUP" + "ADVANCED_BACKUP", + "MANAGE_BACKUP", + "ENHANCED_BACKUP", + "REPAIR_READ_POOL", + "CREATE_READ_POOL" ], "enumDeprecated": [ false, @@ -5132,10 +6122,15 @@ false, false, false, + false, true, true, false, false, + true, + false, + false, + false, false ], "enumDescriptions": [ @@ -5178,6 +6173,7 @@ "Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery.", "Re-encrypts CMEK instances with latest key version.", "Switches the roles of the primary and replica pair. The target instance should be the replica.", + "Update a backup.", "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "Release a lease for the setup of SQL Server Reporting Services (SSRS).", "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.", @@ -5185,7 +6181,11 @@ "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.", "Updates the major version of a Cloud SQL instance.", - "Creates a backup for an Advanced BackupTier Cloud SQL instance." + "Deprecated: ADVANCED_BACKUP is deprecated. Use ENHANCED_BACKUP instead.", + "Changes the BackupTier of a Cloud SQL instance.", + "Creates a backup for an Enhanced BackupTier Cloud SQL instance.", + "Repairs entire read pool or specified nodes in the read pool.", + "Creates a Cloud SQL read pool instance." ], "type": "string" }, @@ -5219,6 +6219,7 @@ "description": "Optional. The sub operation based on the operation type." }, "targetId": { + "description": "Name of the resource on which this operation runs.", "type": "string" }, "targetLink": { @@ -5413,6 +6414,82 @@ }, "type": "object" }, + "PoolNodeConfig": { + "description": "Details of a single node of a read pool.", + "id": "PoolNodeConfig", + "properties": { + "dnsName": { + "description": "Output only. The DNS name of the node.", + "readOnly": true, + "type": "string" + }, + "dnsNames": { + "description": "Output only. The list of DNS names used by this node.", + "items": { + "$ref": "DnsNameMapping" + }, + "readOnly": true, + "type": "array" + }, + "gceZone": { + "description": "Output only. The serving zone of the node.", + "readOnly": true, + "type": "string" + }, + "ipAddresses": { + "description": "Output only. Mappings containing IP addresses that can be used to connect to the node.", + "items": { + "$ref": "IpMapping" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The name of the node, to be used for retrieving metrics and logs for the node.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the node.", + "enum": [ + "SQL_INSTANCE_STATE_UNSPECIFIED", + "RUNNABLE", + "SUSPENDED", + "PENDING_DELETE", + "PENDING_CREATE", + "MAINTENANCE", + "FAILED", + "ONLINE_MAINTENANCE", + "REPAIRING" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + true, + false + ], + "enumDescriptions": [ + "The state of the instance is unknown.", + "The instance is running, or has been stopped by owner.", + "The instance is not available, for example due to problems with billing.", + "The instance is being deleted.", + "The instance is being created.", + "The instance is down for maintenance.", + "The creation of the instance failed or a fatal error occurred during maintenance.", + "Deprecated", + "(Applicable to read pool nodes only.) The read pool node needs to be repaired. The database might be unavailable." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PscAutoConnectionConfig": { "description": "Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.", "id": "PscAutoConnectionConfig", @@ -5665,6 +6742,10 @@ "description": "The name of server Instance collation.", "type": "string" }, + "connectionPoolConfig": { + "$ref": "ConnectionPoolConfig", + "description": "Optional. The managed connection pooling configuration for the instance." + }, "connectorEnforcement": { "description": "Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.", "enum": [ @@ -5688,6 +6769,16 @@ "$ref": "DataCacheConfig", "description": "Configuration for data cache." }, + "dataDiskProvisionedIops": { + "description": "Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.", + "format": "int64", + "type": "string" + }, + "dataDiskProvisionedThroughput": { + "description": "Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.", + "format": "int64", + "type": "string" + }, "dataDiskSizeGb": { "description": "The size of data disk, in GB. The data disk size minimum is 10GB.", "format": "int64", @@ -5820,6 +6911,10 @@ ], "type": "string" }, + "retainBackupsOnDelete": { + "description": "Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.", + "type": "boolean" + }, "settingsVersion": { "description": "The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.", "format": "int64", diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index 56bd8397139..337c4bfd5bb 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -113,6 +113,7 @@ export namespace sqladmin_v1 { export class Sqladmin { context: APIRequestContext; backupRuns: Resource$Backupruns; + Backups: Resource$Backups; connect: Resource$Connect; databases: Resource$Databases; flags: Resource$Flags; @@ -130,6 +131,7 @@ export namespace sqladmin_v1 { }; this.backupRuns = new Resource$Backupruns(this.context); + this.Backups = new Resource$Backups(this.context); this.connect = new Resource$Connect(this.context); this.databases = new Resource$Databases(this.context); this.flags = new Resource$Flags(this.context); @@ -227,6 +229,103 @@ export namespace sqladmin_v1 { */ name?: string | null; } + /** + * A backup resource. + */ + export interface Schema$Backup { + /** + * Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available. + */ + backupInterval?: Schema$Interval; + /** + * Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. + */ + backupKind?: string | null; + /** + * Output only. The mapping to backup run resource used for IAM validations. + */ + backupRun?: string | null; + /** + * Output only. The database version of the instance of when this backup was made. + */ + databaseVersion?: string | null; + /** + * The description of this backup. + */ + description?: string | null; + /** + * Output only. Information about why the backup operation fails (for example, when the backup state fails). + */ + error?: Schema$OperationError; + /** + * Backup expiration time. A UTC timestamp of when this backup expired. + */ + expiryTime?: string | null; + /** + * The name of the source database instance. + */ + instance?: string | null; + /** + * Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted. + */ + instanceDeletionTime?: string | null; + /** + * Optional. Output only. The instance setting of the source instance that's associated with this backup. + */ + instanceSettings?: Schema$DatabaseInstance; + /** + * Output only. This is always `sql#backup`. + */ + kind?: string | null; + /** + * Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption. + */ + kmsKey?: string | null; + /** + * Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance. + */ + kmsKeyVersion?: string | null; + /** + * The storage location of the backups. The location can be multi-regional. + */ + location?: string | null; + /** + * Output only. The maximum chargeable bytes for the backup. + */ + maxChargeableBytes?: string | null; + /** + * Output only. The resource name of the backup. Format: projects/{project\}/backups/{backup\}. + */ + name?: string | null; + /** + * Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Output only. The URI of this resource. + */ + selfLink?: string | null; + /** + * Output only. The status of this backup. + */ + state?: string | null; + /** + * Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen. + */ + timeZone?: string | null; + /** + * Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created. + */ + ttlDays?: string | null; + /** + * Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”. + */ + type?: string | null; + } /** * Database instance backup configuration. */ @@ -284,6 +383,10 @@ export namespace sqladmin_v1 { * This is always `sql#backupContext`. */ kind?: string | null; + /** + * The name of the backup. Format: projects/{project\}/backups/{backup\} + */ + name?: string | null; } /** * Backup Reencryption Config @@ -319,6 +422,10 @@ export namespace sqladmin_v1 { * Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */ backupKind?: string | null; + /** + * Output only. The instance database version when this backup was made. + */ + databaseVersion?: string | null; /** * The description of this run, only applicable to on-demand backups. */ @@ -463,6 +570,77 @@ export namespace sqladmin_v1 { */ preferredZone?: string | null; } + /** + * The managed connection pooling configuration. + */ + export interface Schema$ConnectionPoolConfig { + /** + * Client idle timeout. + */ + clientConnectionIdleTimeout?: string | null; + /** + * Whether managed connection pooling is enabled. + */ + connectionPoolingEnabled?: boolean | null; + /** + * Managed connection pool size. + */ + connPoolSize?: number | null; + /** + * Optional. List of connection pool configuration flags + */ + flags?: Schema$ConnectionPoolFlags[]; + /** + * Maximum number of client connections in connection pool. + */ + maxClientConnections?: number | null; + /** + * The managed connection pool mode for the instance. + */ + poolMode?: string | null; + /** + * Query wait timeout. + */ + queryWaitTimeout?: string | null; + /** + * Server idle timeout. + */ + serverConnectionIdleTimeout?: string | null; + } + /** + * Connection pool flags for Cloud SQL instances managed connection pool configuration. + */ + export interface Schema$ConnectionPoolFlags { + /** + * Required. The name of the flag. + */ + name?: string | null; + /** + * Required. The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value. + */ + value?: string | null; + } + /** + * Details of a single node of a read pool. + */ + export interface Schema$ConnectPoolNodeConfig { + /** + * Output only. The DNS name of the node. + */ + dnsName?: string | null; + /** + * Output only. The list of DNS names used by this node. + */ + dnsNames?: Schema$DnsNameMapping[]; + /** + * Output only. Mappings containing IP addresses that can be used to connect to the node. + */ + ipAddresses?: Schema$IpMapping[]; + /** + * Output only. The name of the node. Doesn't include the project ID. + */ + name?: string | null; + } /** * Connect settings retrieval response. */ @@ -483,6 +661,10 @@ export namespace sqladmin_v1 { * The dns name of the instance. */ dnsName?: string | null; + /** + * Output only. The list of DNS names used by this instance. + */ + dnsNames?: Schema$DnsNameMapping[]; /** * The assigned IP addresses for the instance. */ @@ -491,6 +673,14 @@ export namespace sqladmin_v1 { * This is always `sql#connectSettings`. */ kind?: string | null; + /** + * The number of nodes in a read pool. + */ + nodeCount?: number | null; + /** + * Output only. Entries containing information about each node of the read pool. + */ + nodes?: Schema$ConnectPoolNodeConfig[]; /** * Whether PSC connectivity is enabled for this instance. */ @@ -603,6 +793,10 @@ export namespace sqladmin_v1 { * Output only. The dns name of the instance. */ dnsName?: string | null; + /** + * Output only. The list of DNS names used by this instance. + */ + dnsNames?: Schema$DnsNameMapping[]; /** * This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. */ @@ -619,6 +813,10 @@ export namespace sqladmin_v1 { * Gemini instance configuration. */ geminiConfig?: Schema$GeminiInstanceConfig; + /** + * Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated. + */ + includeReplicasForMajorVersionUpgrade?: boolean | null; /** * The instance type. */ @@ -651,6 +849,14 @@ export namespace sqladmin_v1 { * Name of the Cloud SQL instance. This does not include the project ID. */ name?: string | null; + /** + * The number of nodes in a read pool. + */ + nodeCount?: number | null; + /** + * Output only. Entries containing information about each node of the read pool. + */ + nodes?: Schema$PoolNodeConfig[]; /** * Configuration specific to on-premises instances. */ @@ -835,7 +1041,7 @@ export namespace sqladmin_v1 { */ clientCertificate?: string | null; /** - * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8. + * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8. */ clientKey?: string | null; /** @@ -894,6 +1100,23 @@ export namespace sqladmin_v1 { */ kmsKeyVersionName?: string | null; } + /** + * DNS metadata. + */ + export interface Schema$DnsNameMapping { + /** + * Output only. The connection type of the DNS name. + */ + connectionType?: string | null; + /** + * Output only. The scope that the DNS name applies to. + */ + dnsScope?: string | null; + /** + * The DNS name. + */ + name?: 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); \} */ @@ -925,7 +1148,7 @@ export namespace sqladmin_v1 { selectQuery?: string; } | null; /** - * Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`. + * Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`. */ databases?: string[] | null; /** @@ -951,6 +1174,15 @@ export namespace sqladmin_v1 { tables?: string[]; threads?: number; } | null; + /** + * Optional. Export parameters specific to SQL Server TDE certificates + */ + tdeExportOptions?: { + certificatePath?: string; + name?: string; + privateKeyPassword?: string; + privateKeyPath?: string; + } | null; /** * The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed. */ @@ -994,6 +1226,10 @@ export namespace sqladmin_v1 { * The database version this flag applies to. Can be MySQL instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12`. SQL Server instances: `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. See [the complete list](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). */ appliesTo?: string[] | null; + /** + * Scope of flag. + */ + flagScope?: string | null; /** * Whether or not the flag is considered in beta. */ @@ -1014,6 +1250,14 @@ export namespace sqladmin_v1 { * This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet` */ name?: string | null; + /** + * Recommended int value in integer format for UI display. + */ + recommendedIntValue?: string | null; + /** + * Recommended string value in string format for UI display. + */ + recommendedStringValue?: string | null; /** * Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. */ @@ -1106,6 +1350,7 @@ export namespace sqladmin_v1 { bakType?: string; encryptionOptions?: { certPath?: string; + keepEncrypted?: boolean; pvkPassword?: string; pvkPath?: string; }; @@ -1127,7 +1372,7 @@ export namespace sqladmin_v1 { table?: string; } | null; /** - * The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified. + * The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified. */ database?: string | null; /** @@ -1150,6 +1395,15 @@ export namespace sqladmin_v1 { postgresImportOptions?: {clean?: boolean; ifExists?: boolean}; threads?: number; } | null; + /** + * Optional. Import parameters specific to SQL Server TDE certificates + */ + tdeImportOptions?: { + certificatePath?: string; + name?: string; + privateKeyPassword?: string; + privateKeyPath?: string; + } | 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. */ @@ -1329,10 +1583,18 @@ export namespace sqladmin_v1 { * Database instance restore backup request. */ export interface Schema$InstancesRestoreBackupRequest { + /** + * The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id\}/backups/{backup-uid\}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input. + */ + backup?: string | null; /** * Parameters required to perform the restore backup operation. */ restoreBackupContext?: Schema$RestoreBackupContext; + /** + * Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances. + */ + restoreInstanceSettings?: Schema$DatabaseInstance; } /** * Rotate server CA request. @@ -1361,6 +1623,19 @@ export namespace sqladmin_v1 { */ truncateLogContext?: Schema$TruncateLogContext; } + /** + * 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; + } /** * IP Management configuration. */ @@ -1402,7 +1677,7 @@ export namespace sqladmin_v1 { */ serverCaMode?: string | null; /** - * Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects//locations//caPools/ + * Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT\}/locations/{REGION\}/caPools/{CA_POOL_ID\} */ serverCaPool?: string | null; /** @@ -1427,6 +1702,23 @@ export namespace sqladmin_v1 { */ type?: string | null; } + /** + * The response payload containing a list of the backups. + */ + export interface Schema$ListBackupsResponse { + /** + * A list of backups. + */ + backups?: Schema$Backup[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, then there aren't subsequent pages. + */ + nextPageToken?: string | null; + /** + * If a region isn't unavailable or if an unknown error occurs, then a warning message is returned. + */ + warnings?: Schema$ApiWarning[]; + } /** * Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. */ @@ -1482,7 +1774,7 @@ export namespace sqladmin_v1 { */ clientCertificate?: string | null; /** - * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. + * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. */ clientKey?: string | null; /** @@ -1540,7 +1832,7 @@ export namespace sqladmin_v1 { */ clientCertificate?: string | null; /** - * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. + * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. */ clientKey?: string | null; /** @@ -1640,6 +1932,9 @@ export namespace sqladmin_v1 { * Optional. The sub operation based on the operation type. */ subOperationType?: Schema$SqlSubOperationType; + /** + * Name of the resource on which this operation runs. + */ targetId?: string | null; targetLink?: string | null; /** @@ -1786,6 +2081,35 @@ export namespace sqladmin_v1 { */ targetSizeGb?: string | null; } + /** + * Details of a single node of a read pool. + */ + export interface Schema$PoolNodeConfig { + /** + * Output only. The DNS name of the node. + */ + dnsName?: string | null; + /** + * Output only. The list of DNS names used by this node. + */ + dnsNames?: Schema$DnsNameMapping[]; + /** + * Output only. The serving zone of the node. + */ + gceZone?: string | null; + /** + * Output only. Mappings containing IP addresses that can be used to connect to the node. + */ + ipAddresses?: Schema$IpMapping[]; + /** + * Output only. The name of the node, to be used for retrieving metrics and logs for the node. + */ + name?: string | null; + /** + * Output only. The current state of the node. + */ + state?: string | null; + } /** * Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. */ @@ -1964,6 +2288,10 @@ export namespace sqladmin_v1 { * The name of server Instance collation. */ collation?: string | null; + /** + * Optional. The managed connection pooling configuration for the instance. + */ + connectionPoolConfig?: Schema$ConnectionPoolConfig; /** * Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance. */ @@ -1984,6 +2312,14 @@ export namespace sqladmin_v1 { * Configuration for data cache. */ dataCacheConfig?: Schema$DataCacheConfig; + /** + * Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. + */ + dataDiskProvisionedIops?: string | null; + /** + * Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. + */ + dataDiskProvisionedThroughput?: string | null; /** * The size of data disk, in GB. The data disk size minimum is 10GB. */ @@ -2048,6 +2384,10 @@ export namespace sqladmin_v1 { * The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances. */ replicationType?: string | null; + /** + * Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting. + */ + retainBackupsOnDelete?: boolean | null; /** * The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. */ @@ -2593,46 +2933,558 @@ export namespace sqladmin_v1 { nextPageToken?: string | null; } - export class Resource$Backupruns { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + export class Resource$Backupruns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the backup taken by a backup run. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupruns$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Backupruns$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Backupruns$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Backupruns$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Backupruns$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Backupruns$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backupruns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/backupRuns/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'id'], + pathParams: ['id', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a resource containing information about a backup run. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupruns$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Backupruns$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Backupruns$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Backupruns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Backupruns$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Backupruns$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/backupRuns/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'id'], + pathParams: ['id', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new backup run on demand. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupruns$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Backupruns$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Backupruns$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Backupruns$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Backupruns$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Backupruns$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backupruns$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/projects/{project}/instances/{instance}/backupRuns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupruns$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Backupruns$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Backupruns$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Backupruns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Backupruns$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Backupruns$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/projects/{project}/instances/{instance}/backupRuns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Backupruns$Delete + extends StandardParameters { + /** + * The ID of the backup run to delete. To find a backup run ID, use the [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/backupRuns/list) method. + */ + id?: string; + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Backupruns$Get extends StandardParameters { + /** + * The ID of this backup run. + */ + id?: string; + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Backupruns$Insert + extends StandardParameters { + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupRun; + } + export interface Params$Resource$Backupruns$List extends StandardParameters { + /** + * Cloud SQL instance ID, or "-" for all instances. This does not include the project ID. + */ + instance?: string; + /** + * Maximum number of backup runs per response. + */ + maxResults?: number; + /** + * A previously-returned page token representing part of the larger set of results to view. + */ + pageToken?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + + export class Resource$Backups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + CreateBackup( + params: Params$Resource$Backups$Createbackup, + options: StreamMethodOptions + ): GaxiosPromise; + CreateBackup( + params?: Params$Resource$Backups$Createbackup, + options?: MethodOptions + ): GaxiosPromise; + CreateBackup( + params: Params$Resource$Backups$Createbackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + CreateBackup( + params: Params$Resource$Backups$Createbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + CreateBackup( + params: Params$Resource$Backups$Createbackup, + callback: BodyResponseCallback + ): void; + CreateBackup(callback: BodyResponseCallback): void; + CreateBackup( + paramsOrCallback?: + | Params$Resource$Backups$Createbackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backups$Createbackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backups$Createbackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backups').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 backup taken by a backup run. + * Deletes the 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$Backupruns$Delete, + DeleteBackup( + params: Params$Resource$Backups$Deletebackup, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Backupruns$Delete, + DeleteBackup( + params?: Params$Resource$Backups$Deletebackup, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Backupruns$Delete, + DeleteBackup( + params: Params$Resource$Backups$Deletebackup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Backupruns$Delete, + DeleteBackup( + params: Params$Resource$Backups$Deletebackup, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Backupruns$Delete, + DeleteBackup( + params: Params$Resource$Backups$Deletebackup, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + DeleteBackup(callback: BodyResponseCallback): void; + DeleteBackup( paramsOrCallback?: - | Params$Resource$Backupruns$Delete + | Params$Resource$Backups$Deletebackup | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2645,12 +3497,12 @@ export namespace sqladmin_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Backupruns$Delete; + {}) as Params$Resource$Backups$Deletebackup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Backupruns$Delete; + params = {} as Params$Resource$Backups$Deletebackup; options = {}; } @@ -2663,18 +3515,15 @@ export namespace sqladmin_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/projects/{project}/instances/{instance}/backupRuns/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'instance', 'id'], - pathParams: ['id', 'instance', 'project'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -2688,56 +3537,57 @@ export namespace sqladmin_v1 { } /** - * Retrieves a resource containing information about a backup run. + * Retrieves a resource containing information about 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. */ - get( - params: Params$Resource$Backupruns$Get, + GetBackup( + params: Params$Resource$Backups$Getbackup, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Backupruns$Get, + GetBackup( + params?: Params$Resource$Backups$Getbackup, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Backupruns$Get, + ): GaxiosPromise; + GetBackup( + params: Params$Resource$Backups$Getbackup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Backupruns$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + GetBackup( + params: Params$Resource$Backups$Getbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Backupruns$Get, - callback: BodyResponseCallback + GetBackup( + params: Params$Resource$Backups$Getbackup, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + GetBackup(callback: BodyResponseCallback): void; + GetBackup( paramsOrCallback?: - | Params$Resource$Backupruns$Get - | BodyResponseCallback + | Params$Resource$Backups$Getbackup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$Get; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backups$Getbackup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Backupruns$Get; + params = {} as Params$Resource$Backups$Getbackup; options = {}; } @@ -2750,82 +3600,84 @@ export namespace sqladmin_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/projects/{project}/instances/{instance}/backupRuns/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'instance', 'id'], - pathParams: ['id', 'instance', 'project'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a new backup run on demand. + * Lists all backups 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. */ - insert( - params: Params$Resource$Backupruns$Insert, + ListBackups( + params: Params$Resource$Backups$Listbackups, options: StreamMethodOptions ): GaxiosPromise; - insert( - params?: Params$Resource$Backupruns$Insert, + ListBackups( + params?: Params$Resource$Backups$Listbackups, options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Backupruns$Insert, + ): GaxiosPromise; + ListBackups( + params: Params$Resource$Backups$Listbackups, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Backupruns$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ListBackups( + params: Params$Resource$Backups$Listbackups, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Backupruns$Insert, - callback: BodyResponseCallback + ListBackups( + params: Params$Resource$Backups$Listbackups, + callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + ListBackups( + callback: BodyResponseCallback + ): void; + ListBackups( paramsOrCallback?: - | Params$Resource$Backupruns$Insert - | BodyResponseCallback + | Params$Resource$Backups$Listbackups + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Backupruns$Insert; + {}) as Params$Resource$Backups$Listbackups; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Backupruns$Insert; + params = {} as Params$Resource$Backups$Listbackups; options = {}; } @@ -2838,85 +3690,82 @@ export namespace sqladmin_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/projects/{project}/instances/{instance}/backupRuns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/backups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'instance'], - pathParams: ['instance', 'project'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. + * Updates the retention period and description of the backup. You can use this API to update final backups 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. */ - list( - params: Params$Resource$Backupruns$List, + UpdateBackup( + params: Params$Resource$Backups$Updatebackup, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Backupruns$List, + UpdateBackup( + params?: Params$Resource$Backups$Updatebackup, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Backupruns$List, + ): GaxiosPromise; + UpdateBackup( + params: Params$Resource$Backups$Updatebackup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Backupruns$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + UpdateBackup( + params: Params$Resource$Backups$Updatebackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Backupruns$List, - callback: BodyResponseCallback + UpdateBackup( + params: Params$Resource$Backups$Updatebackup, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + UpdateBackup(callback: BodyResponseCallback): void; + UpdateBackup( paramsOrCallback?: - | Params$Resource$Backupruns$List - | BodyResponseCallback + | Params$Resource$Backups$Updatebackup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$List; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backups$Updatebackup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Backupruns$List; + params = {} as Params$Resource$Backups$Updatebackup; options = {}; } @@ -2929,92 +3778,88 @@ export namespace sqladmin_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/projects/{project}/instances/{instance}/backupRuns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'instance'], - pathParams: ['instance', 'project'], + 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$Backupruns$Delete + export interface Params$Resource$Backups$Createbackup extends StandardParameters { /** - * The ID of the backup run to delete. To find a backup run ID, use the [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/backupRuns/list) method. - */ - id?: string; - /** - * Cloud SQL instance ID. This does not include the project ID. + * Required. The parent resource where this backup is created. Format: projects/{project\} */ - instance?: string; + parent?: string; + /** - * Project ID of the project that contains the instance. + * Request body metadata */ - project?: string; + requestBody?: Schema$Backup; } - export interface Params$Resource$Backupruns$Get extends StandardParameters { - /** - * The ID of this backup run. - */ - id?: string; + export interface Params$Resource$Backups$Deletebackup + extends StandardParameters { /** - * Cloud SQL instance ID. This does not include the project ID. + * Required. The name of the backup to delete. Format: projects/{project\}/backups/{backup\} */ - instance?: string; + name?: string; + } + export interface Params$Resource$Backups$Getbackup + extends StandardParameters { /** - * Project ID of the project that contains the instance. + * Required. The name of the backup to retrieve. Format: projects/{project\}/backups/{backup\} */ - project?: string; + name?: string; } - export interface Params$Resource$Backupruns$Insert + export interface Params$Resource$Backups$Listbackups extends StandardParameters { /** - * Cloud SQL instance ID. This does not include the project ID. + * Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime\>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location. */ - instance?: string; + filter?: string; /** - * Project ID of the project that contains the instance. + * The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000. */ - project?: string; - + pageSize?: number; /** - * Request body metadata + * A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token. */ - requestBody?: Schema$BackupRun; - } - export interface Params$Resource$Backupruns$List extends StandardParameters { + pageToken?: string; /** - * Cloud SQL instance ID, or "-" for all instances. This does not include the project ID. + * Required. The parent that owns this collection of backups. Format: projects/{project\} */ - instance?: string; + parent?: string; + } + export interface Params$Resource$Backups$Updatebackup + extends StandardParameters { /** - * Maximum number of backup runs per response. + * Output only. The resource name of the backup. Format: projects/{project\}/backups/{backup\}. */ - maxResults?: number; + name?: string; /** - * A previously-returned page token representing part of the larger set of results to view. + * The list of fields that you can update. You can update only the description and retention period of the final backup. */ - pageToken?: string; + updateMask?: string; + /** - * Project ID of the project that contains the instance. + * Request body metadata */ - project?: string; + requestBody?: Schema$Backup; } export class Resource$Connect { @@ -3962,6 +4807,10 @@ export namespace sqladmin_v1 { * Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions. */ databaseVersion?: string; + /** + * Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified. + */ + flagScope?: string; } export class Resource$Instances { @@ -6600,6 +7449,22 @@ export namespace sqladmin_v1 { requestBody?: Schema$InstancesCloneRequest; } export interface Params$Resource$Instances$Delete extends StandardParameters { + /** + * Flag to opt-in for final backup. By default, it is turned off. + */ + enableFinalBackup?: boolean; + /** + * Optional. The description of the final backup. + */ + finalBackupDescription?: string; + /** + * Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired. + */ + finalBackupExpiryTime?: string; + /** + * Optional. Retention period of the final backup. + */ + finalBackupTtlDays?: string; /** * Cloud SQL instance ID. This does not include the project ID. */ diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index a438ebad264..02c47e9d45a 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -113,6 +113,7 @@ export namespace sqladmin_v1beta4 { export class Sqladmin { context: APIRequestContext; backupRuns: Resource$Backupruns; + backups: Resource$Backups; connect: Resource$Connect; databases: Resource$Databases; flags: Resource$Flags; @@ -130,6 +131,7 @@ export namespace sqladmin_v1beta4 { }; this.backupRuns = new Resource$Backupruns(this.context); + this.backups = new Resource$Backups(this.context); this.connect = new Resource$Connect(this.context); this.databases = new Resource$Databases(this.context); this.flags = new Resource$Flags(this.context); @@ -227,6 +229,103 @@ export namespace sqladmin_v1beta4 { */ name?: string | null; } + /** + * A backup resource. + */ + export interface Schema$Backup { + /** + * Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available. + */ + backupInterval?: Schema$Interval; + /** + * Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. + */ + backupKind?: string | null; + /** + * Output only. The mapping to backup run resource used for IAM validations. + */ + backupRun?: string | null; + /** + * Output only. The database version of the instance of when this backup was made. + */ + databaseVersion?: string | null; + /** + * The description of this backup. + */ + description?: string | null; + /** + * Output only. Information about why the backup operation fails (for example, when the backup state fails). + */ + error?: Schema$OperationError; + /** + * Backup expiration time. A UTC timestamp of when this resource expired. + */ + expiryTime?: string | null; + /** + * The name of the database instance. + */ + instance?: string | null; + /** + * Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted. + */ + instanceDeletionTime?: string | null; + /** + * Optional. Output only. Instance setting of the source instance that's associated with this backup. + */ + instanceSettings?: Schema$DatabaseInstance; + /** + * Output only. This is always `sql#backup`. + */ + kind?: string | null; + /** + * Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption. + */ + kmsKey?: string | null; + /** + * Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance. + */ + kmsKeyVersion?: string | null; + /** + * The storage location of the backups. The location can be multi-regional. + */ + location?: string | null; + /** + * Output only. The maximum chargeable bytes for the backup. + */ + maxChargeableBytes?: string | null; + /** + * Output only. The resource name of the backup. Format: projects/{project\}/backups/{backup\}. + */ + name?: string | null; + /** + * Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Output only. The URI of this resource. + */ + selfLink?: string | null; + /** + * Output only. The state of this backup. + */ + state?: string | null; + /** + * Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen. + */ + timeZone?: string | null; + /** + * Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created. + */ + ttlDays?: string | null; + /** + * Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND", or “FINAL”. + */ + type?: string | null; + } /** * Database instance backup configuration. */ @@ -284,6 +383,10 @@ export namespace sqladmin_v1beta4 { * This is always `sql#backupContext`. */ kind?: string | null; + /** + * The name of the backup. Format: projects/{project\}/backups/{backup\} + */ + name?: string | null; } /** * Backup Reencryption Config @@ -319,6 +422,10 @@ export namespace sqladmin_v1beta4 { * Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */ backupKind?: string | null; + /** + * Output only. The instance database version when this backup was made. + */ + databaseVersion?: string | null; /** * The description of this run, only applicable to on-demand backups. */ @@ -463,6 +570,77 @@ export namespace sqladmin_v1beta4 { */ preferredZone?: string | null; } + /** + * The managed connection pooling configuration. + */ + export interface Schema$ConnectionPoolConfig { + /** + * Client idle timeout. + */ + clientConnectionIdleTimeout?: string | null; + /** + * Whether managed connection pooling is enabled. + */ + connectionPoolingEnabled?: boolean | null; + /** + * Managed connection pool size. + */ + connPoolSize?: number | null; + /** + * Optional. List of connection pool configuration flags + */ + flags?: Schema$ConnectionPoolFlags[]; + /** + * Maximum number of client connections in connection pool. + */ + maxClientConnections?: number | null; + /** + * The managed connection pool mode for the instance. + */ + poolMode?: string | null; + /** + * Query wait timeout. + */ + queryWaitTimeout?: string | null; + /** + * Server idle timeout. + */ + serverConnectionIdleTimeout?: string | null; + } + /** + * Connection pool flags for Cloud SQL instances managed connection pool configuration. + */ + export interface Schema$ConnectionPoolFlags { + /** + * Required. The name of the flag. + */ + name?: string | null; + /** + * Required. The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value. + */ + value?: string | null; + } + /** + * Details of a single node of a read pool. + */ + export interface Schema$ConnectPoolNodeConfig { + /** + * Output only. The DNS name of the node. + */ + dnsName?: string | null; + /** + * Output only. The list of DNS names used by this instance. + */ + dnsNames?: Schema$DnsNameMapping[]; + /** + * Output only. Mappings containing IP addresses that can be used to connect to the node. + */ + ipAddresses?: Schema$IpMapping[]; + /** + * Output only. The name of the node. Doesn't include the project ID. + */ + name?: string | null; + } /** * Connect settings retrieval response. */ @@ -483,6 +661,10 @@ export namespace sqladmin_v1beta4 { * The dns name of the instance. */ dnsName?: string | null; + /** + * Output only. The list of DNS names used by this instance. + */ + dnsNames?: Schema$DnsNameMapping[]; /** * The assigned IP addresses for the instance. */ @@ -491,6 +673,14 @@ export namespace sqladmin_v1beta4 { * This is always `sql#connectSettings`. */ kind?: string | null; + /** + * The number of nodes in a read pool. + */ + nodeCount?: number | null; + /** + * Output only. Entries containing information about each node of the read pool. + */ + nodes?: Schema$ConnectPoolNodeConfig[]; /** * Whether PSC connectivity is enabled for this instance. */ @@ -603,6 +793,10 @@ export namespace sqladmin_v1beta4 { * Output only. The dns name of the instance. */ dnsName?: string | null; + /** + * Output only. The list of DNS names used by this instance. + */ + dnsNames?: Schema$DnsNameMapping[]; /** * This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. */ @@ -619,6 +813,10 @@ export namespace sqladmin_v1beta4 { * Gemini instance configuration. */ geminiConfig?: Schema$GeminiInstanceConfig; + /** + * Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated. + */ + includeReplicasForMajorVersionUpgrade?: boolean | null; /** * The instance type. */ @@ -651,6 +849,14 @@ export namespace sqladmin_v1beta4 { * Name of the Cloud SQL instance. This does not include the project ID. */ name?: string | null; + /** + * The number of nodes in a read pool. + */ + nodeCount?: number | null; + /** + * Output only. Entries containing information about each node of the read pool. + */ + nodes?: Schema$PoolNodeConfig[]; /** * Configuration specific to on-premises instances. */ @@ -838,7 +1044,7 @@ export namespace sqladmin_v1beta4 { */ clientCertificate?: string | null; /** - * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8. + * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8. */ clientKey?: string | null; /** @@ -897,6 +1103,23 @@ export namespace sqladmin_v1beta4 { */ kmsKeyVersionName?: string | null; } + /** + * DNS metadata. + */ + export interface Schema$DnsNameMapping { + /** + * Output only. The connection type of the DNS name. + */ + connectionType?: string | null; + /** + * Output only. The scope that the DNS name applies to. + */ + dnsScope?: string | null; + /** + * The DNS name. + */ + name?: 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); \} */ @@ -928,7 +1151,7 @@ export namespace sqladmin_v1beta4 { selectQuery?: string; } | null; /** - * Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`. + * Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`. */ databases?: string[] | null; /** @@ -954,6 +1177,15 @@ export namespace sqladmin_v1beta4 { tables?: string[]; threads?: number; } | null; + /** + * Optional. Export parameters specific to SQL Server TDE certificates + */ + tdeExportOptions?: { + certificatePath?: string; + name?: string; + privateKeyPassword?: string; + privateKeyPath?: string; + } | null; /** * The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed. */ @@ -997,6 +1229,10 @@ export namespace sqladmin_v1beta4 { * The database version this flag applies to. Can be MySQL instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12`. SQL Server instances: `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. See [the complete list](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). */ appliesTo?: string[] | null; + /** + * Scope of flag. + */ + flagScope?: string | null; /** * Whether or not the flag is considered in beta. */ @@ -1017,6 +1253,14 @@ export namespace sqladmin_v1beta4 { * This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet` */ name?: string | null; + /** + * Recommended flag value in integer format for UI display. + */ + recommendedIntValue?: string | null; + /** + * Recommended flag value in string format for UI display. + */ + recommendedStringValue?: string | null; /** * Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. */ @@ -1109,6 +1353,7 @@ export namespace sqladmin_v1beta4 { bakType?: string; encryptionOptions?: { certPath?: string; + keepEncrypted?: boolean; pvkPassword?: string; pvkPath?: string; }; @@ -1130,7 +1375,7 @@ export namespace sqladmin_v1beta4 { table?: string; } | null; /** - * The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified. + * The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified. */ database?: string | null; /** @@ -1153,6 +1398,15 @@ export namespace sqladmin_v1beta4 { postgresImportOptions?: {clean?: boolean; ifExists?: boolean}; threads?: number; } | null; + /** + * Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates + */ + tdeImportOptions?: { + certificatePath?: string; + name?: string; + privateKeyPassword?: string; + privateKeyPath?: string; + } | 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. */ @@ -1332,10 +1586,18 @@ export namespace sqladmin_v1beta4 { * Database instance restore backup request. */ export interface Schema$InstancesRestoreBackupRequest { + /** + * The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id\}/backups/{backup-uid\}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input. + */ + backup?: string | null; /** * Parameters required to perform the restore backup operation. */ restoreBackupContext?: Schema$RestoreBackupContext; + /** + * Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances. + */ + restoreInstanceSettings?: Schema$DatabaseInstance; } /** * Rotate Server CA request. @@ -1364,6 +1626,19 @@ export namespace sqladmin_v1beta4 { */ truncateLogContext?: Schema$TruncateLogContext; } + /** + * 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; + } /** * IP Management configuration. */ @@ -1405,7 +1680,7 @@ export namespace sqladmin_v1beta4 { */ serverCaMode?: string | null; /** - * Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects//locations//caPools/ + * Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT\}/locations/{REGION\}/caPools/{CA_POOL_ID\} */ serverCaPool?: string | null; /** @@ -1430,6 +1705,23 @@ export namespace sqladmin_v1beta4 { */ type?: string | null; } + /** + * The response payload containing a list of the backups. + */ + export interface Schema$ListBackupsResponse { + /** + * A list of backups. + */ + backups?: Schema$Backup[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, then there aren't subsequent pages. + */ + nextPageToken?: string | null; + /** + * If a region isn't unavailable or if an unknown error occurs, then a warning message is returned. + */ + warnings?: Schema$ApiWarning[]; + } /** * Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. */ @@ -1485,7 +1777,7 @@ export namespace sqladmin_v1beta4 { */ clientCertificate?: string | null; /** - * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. + * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. */ clientKey?: string | null; /** @@ -1543,7 +1835,7 @@ export namespace sqladmin_v1beta4 { */ clientCertificate?: string | null; /** - * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. + * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. */ clientKey?: string | null; /** @@ -1643,6 +1935,9 @@ export namespace sqladmin_v1beta4 { * Optional. The sub operation based on the operation type. */ subOperationType?: Schema$SqlSubOperationType; + /** + * Name of the resource on which this operation runs. + */ targetId?: string | null; targetLink?: string | null; /** @@ -1789,6 +2084,35 @@ export namespace sqladmin_v1beta4 { */ targetSizeGb?: string | null; } + /** + * Details of a single node of a read pool. + */ + export interface Schema$PoolNodeConfig { + /** + * Output only. The DNS name of the node. + */ + dnsName?: string | null; + /** + * Output only. The list of DNS names used by this node. + */ + dnsNames?: Schema$DnsNameMapping[]; + /** + * Output only. The serving zone of the node. + */ + gceZone?: string | null; + /** + * Output only. Mappings containing IP addresses that can be used to connect to the node. + */ + ipAddresses?: Schema$IpMapping[]; + /** + * Output only. The name of the node, to be used for retrieving metrics and logs for the node. + */ + name?: string | null; + /** + * Output only. The current state of the node. + */ + state?: string | null; + } /** * Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. */ @@ -1967,6 +2291,10 @@ export namespace sqladmin_v1beta4 { * The name of server Instance collation. */ collation?: string | null; + /** + * Optional. The managed connection pooling configuration for the instance. + */ + connectionPoolConfig?: Schema$ConnectionPoolConfig; /** * Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance. */ @@ -1987,6 +2315,14 @@ export namespace sqladmin_v1beta4 { * Configuration for data cache. */ dataCacheConfig?: Schema$DataCacheConfig; + /** + * Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. + */ + dataDiskProvisionedIops?: string | null; + /** + * Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. + */ + dataDiskProvisionedThroughput?: string | null; /** * The size of data disk, in GB. The data disk size minimum is 10GB. */ @@ -2051,6 +2387,10 @@ export namespace sqladmin_v1beta4 { * The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances. */ replicationType?: string | null; + /** + * Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting. + */ + retainBackupsOnDelete?: boolean | null; /** * The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. */ @@ -2590,46 +2930,560 @@ export namespace sqladmin_v1beta4 { nextPageToken?: string | null; } - export class Resource$Backupruns { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + export class Resource$Backupruns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the backup taken by a backup run. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupruns$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Backupruns$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Backupruns$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Backupruns$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Backupruns$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Backupruns$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backupruns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'id'], + pathParams: ['id', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a resource containing information about a backup run. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupruns$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Backupruns$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Backupruns$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Backupruns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Backupruns$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Backupruns$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'id'], + pathParams: ['id', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new backup run on demand. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupruns$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Backupruns$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Backupruns$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Backupruns$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Backupruns$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Backupruns$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backupruns$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupruns$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Backupruns$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Backupruns$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Backupruns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Backupruns$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Backupruns$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Backupruns$Delete + extends StandardParameters { + /** + * The ID of the backup run to delete. To find a backup run ID, use the [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/backupRuns/list) method. + */ + id?: string; + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Backupruns$Get extends StandardParameters { + /** + * The ID of this backup run. + */ + id?: string; + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Backupruns$Insert + extends StandardParameters { + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupRun; + } + export interface Params$Resource$Backupruns$List extends StandardParameters { + /** + * Cloud SQL instance ID, or "-" for all instances. This does not include the project ID. + */ + instance?: string; + /** + * Maximum number of backup runs per response. + */ + maxResults?: number; + /** + * A previously-returned page token representing part of the larger set of results to view. + */ + pageToken?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + + export class Resource$Backups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + createBackup( + params: Params$Resource$Backups$Createbackup, + options: StreamMethodOptions + ): GaxiosPromise; + createBackup( + params?: Params$Resource$Backups$Createbackup, + options?: MethodOptions + ): GaxiosPromise; + createBackup( + params: Params$Resource$Backups$Createbackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createBackup( + params: Params$Resource$Backups$Createbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createBackup( + params: Params$Resource$Backups$Createbackup, + callback: BodyResponseCallback + ): void; + createBackup(callback: BodyResponseCallback): void; + createBackup( + paramsOrCallback?: + | Params$Resource$Backups$Createbackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backups$Createbackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backups$Createbackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/sql/v1beta4/{+parent}/backups').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 backup taken by a backup run. + * Deletes the 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$Backupruns$Delete, + deleteBackup( + params: Params$Resource$Backups$Deletebackup, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Backupruns$Delete, + deleteBackup( + params?: Params$Resource$Backups$Deletebackup, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Backupruns$Delete, + deleteBackup( + params: Params$Resource$Backups$Deletebackup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Backupruns$Delete, + deleteBackup( + params: Params$Resource$Backups$Deletebackup, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Backupruns$Delete, + deleteBackup( + params: Params$Resource$Backups$Deletebackup, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + deleteBackup(callback: BodyResponseCallback): void; + deleteBackup( paramsOrCallback?: - | Params$Resource$Backupruns$Delete + | Params$Resource$Backups$Deletebackup | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2642,12 +3496,12 @@ export namespace sqladmin_v1beta4 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Backupruns$Delete; + {}) as Params$Resource$Backups$Deletebackup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Backupruns$Delete; + params = {} as Params$Resource$Backups$Deletebackup; options = {}; } @@ -2660,18 +3514,18 @@ export namespace sqladmin_v1beta4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/sql/v1beta4/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['project', 'instance', 'id'], - pathParams: ['id', 'instance', 'project'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -2685,56 +3539,57 @@ export namespace sqladmin_v1beta4 { } /** - * Retrieves a resource containing information about a backup run. + * Retrieves a resource containing information about 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. */ - get( - params: Params$Resource$Backupruns$Get, + getBackup( + params: Params$Resource$Backups$Getbackup, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Backupruns$Get, + getBackup( + params?: Params$Resource$Backups$Getbackup, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Backupruns$Get, + ): GaxiosPromise; + getBackup( + params: Params$Resource$Backups$Getbackup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Backupruns$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getBackup( + params: Params$Resource$Backups$Getbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Backupruns$Get, - callback: BodyResponseCallback + getBackup( + params: Params$Resource$Backups$Getbackup, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getBackup(callback: BodyResponseCallback): void; + getBackup( paramsOrCallback?: - | Params$Resource$Backupruns$Get - | BodyResponseCallback + | Params$Resource$Backups$Getbackup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$Get; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backups$Getbackup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Backupruns$Get; + params = {} as Params$Resource$Backups$Getbackup; options = {}; } @@ -2747,82 +3602,87 @@ export namespace sqladmin_v1beta4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/sql/v1beta4/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'instance', 'id'], - pathParams: ['id', 'instance', 'project'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a new backup run on demand. + * Lists all backups 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. */ - insert( - params: Params$Resource$Backupruns$Insert, + listBackups( + params: Params$Resource$Backups$Listbackups, options: StreamMethodOptions ): GaxiosPromise; - insert( - params?: Params$Resource$Backupruns$Insert, + listBackups( + params?: Params$Resource$Backups$Listbackups, options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Backupruns$Insert, + ): GaxiosPromise; + listBackups( + params: Params$Resource$Backups$Listbackups, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Backupruns$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listBackups( + params: Params$Resource$Backups$Listbackups, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Backupruns$Insert, - callback: BodyResponseCallback + listBackups( + params: Params$Resource$Backups$Listbackups, + callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + listBackups( + callback: BodyResponseCallback + ): void; + listBackups( paramsOrCallback?: - | Params$Resource$Backupruns$Insert - | BodyResponseCallback + | Params$Resource$Backups$Listbackups + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Backupruns$Insert; + {}) as Params$Resource$Backups$Listbackups; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Backupruns$Insert; + params = {} as Params$Resource$Backups$Listbackups; options = {}; } @@ -2835,86 +3695,82 @@ export namespace sqladmin_v1beta4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/sql/v1beta4/{+parent}/backups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['project', 'instance'], - pathParams: ['instance', 'project'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. + * Updates the retention period and the description of the backup. You can use this API to update final backups 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. */ - list( - params: Params$Resource$Backupruns$List, + updateBackup( + params: Params$Resource$Backups$Updatebackup, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Backupruns$List, + updateBackup( + params?: Params$Resource$Backups$Updatebackup, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Backupruns$List, + ): GaxiosPromise; + updateBackup( + params: Params$Resource$Backups$Updatebackup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Backupruns$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + updateBackup( + params: Params$Resource$Backups$Updatebackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Backupruns$List, - callback: BodyResponseCallback + updateBackup( + params: Params$Resource$Backups$Updatebackup, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + updateBackup(callback: BodyResponseCallback): void; + updateBackup( paramsOrCallback?: - | Params$Resource$Backupruns$List - | BodyResponseCallback + | Params$Resource$Backups$Updatebackup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$List; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backups$Updatebackup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Backupruns$List; + params = {} as Params$Resource$Backups$Updatebackup; options = {}; } @@ -2927,93 +3783,91 @@ export namespace sqladmin_v1beta4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/sql/v1beta4/projects/{project}/instances/{instance}/backupRuns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/sql/v1beta4/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['project', 'instance'], - pathParams: ['instance', 'project'], + 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$Backupruns$Delete + export interface Params$Resource$Backups$Createbackup extends StandardParameters { /** - * The ID of the backup run to delete. To find a backup run ID, use the [list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/backupRuns/list) method. - */ - id?: string; - /** - * Cloud SQL instance ID. This does not include the project ID. + * Required. The parent resource where this backup is created. Format: projects/{project\} */ - instance?: string; + parent?: string; + /** - * Project ID of the project that contains the instance. + * Request body metadata */ - project?: string; + requestBody?: Schema$Backup; } - export interface Params$Resource$Backupruns$Get extends StandardParameters { - /** - * The ID of this backup run. - */ - id?: string; + export interface Params$Resource$Backups$Deletebackup + extends StandardParameters { /** - * Cloud SQL instance ID. This does not include the project ID. + * Required. The name of the backup to delete. Format: projects/{project\}/backups/{backup\} */ - instance?: string; + name?: string; + } + export interface Params$Resource$Backups$Getbackup + extends StandardParameters { /** - * Project ID of the project that contains the instance. + * Required. The name of the backup to retrieve. Format: projects/{project\}/backups/{backup\} */ - project?: string; + name?: string; } - export interface Params$Resource$Backupruns$Insert + export interface Params$Resource$Backups$Listbackups extends StandardParameters { /** - * Cloud SQL instance ID. This does not include the project ID. + * Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime\>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location. */ - instance?: string; + filter?: string; /** - * Project ID of the project that contains the instance. + * The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000. */ - project?: string; - + pageSize?: number; /** - * Request body metadata + * A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token. */ - requestBody?: Schema$BackupRun; - } - export interface Params$Resource$Backupruns$List extends StandardParameters { + pageToken?: string; /** - * Cloud SQL instance ID, or "-" for all instances. This does not include the project ID. + * Required. The parent that owns this collection of backups. Format: projects/{project\} */ - instance?: string; + parent?: string; + } + export interface Params$Resource$Backups$Updatebackup + extends StandardParameters { /** - * Maximum number of backup runs per response. + * Output only. The resource name of the backup. Format: projects/{project\}/backups/{backup\}. */ - maxResults?: number; + name?: string; /** - * A previously-returned page token representing part of the larger set of results to view. + * The list of fields that you can update. You can update only the description and retention period of the final backup. */ - pageToken?: string; + updateMask?: string; + /** - * Project ID of the project that contains the instance. + * Request body metadata */ - project?: string; + requestBody?: Schema$Backup; } export class Resource$Connect { @@ -3963,6 +4817,10 @@ export namespace sqladmin_v1beta4 { * Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions. */ databaseVersion?: string; + /** + * Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified. + */ + flagScope?: string; } export class Resource$Instances { @@ -6607,6 +7465,22 @@ export namespace sqladmin_v1beta4 { requestBody?: Schema$InstancesCloneRequest; } export interface Params$Resource$Instances$Delete extends StandardParameters { + /** + * Flag to opt-in for final backup. By default, it is turned off. + */ + enableFinalBackup?: boolean; + /** + * Optional. The description of the final backup. + */ + finalBackupDescription?: string; + /** + * Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired. + */ + finalBackupExpiryTime?: string; + /** + * Optional. Retention period of the final backup. + */ + finalBackupTtlDays?: string; /** * Cloud SQL instance ID. This does not include the project ID. */ From 6e6acfc0934a86ee93fd7cfe1269b9d8ca39654a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 123/144] fix(storage): update the API #### storage:v1 The following keys were changed: - resources.folders.methods.insert.parameters.recursive.description - schemas.Policy.properties.bindings.items.properties.members.description - schemas.Policy.properties.bindings.items.properties.role.description - schemas.TestIamPermissionsResponse.properties.permissions.description --- discovery/storage-v1.json | 12 +++++------ src/apis/storage/v1.ts | 42 +++++++++++++++++++-------------------- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index f1745c067dc..5748546c828 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -93,7 +93,7 @@ "location": "us-west4" } ], - "etag": "\"3133343838373034343130353038353234313337\"", + "etag": "\"323434373038373139383836363433393338\"", "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" @@ -1678,7 +1678,7 @@ "type": "string" }, "recursive": { - "description": "If true, any parent folder which doesn’t exist will be created automatically.", + "description": "If true, any parent folder which doesn't exist will be created automatically.", "location": "query", "type": "boolean" } @@ -4364,7 +4364,7 @@ } } }, - "revision": "20241206", + "revision": "20250224", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -6075,7 +6075,7 @@ "storage.managedFolders.setIamPolicy" ] }, - "description": "A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows: \n- allUsers — A special identifier that represents anyone on the internet; with or without a Google account. \n- allAuthenticatedUsers — A special identifier that represents anyone who is authenticated with a Google account or a service account. \n- user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com. \n- serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . \n- group:emailid — An email address that represents a Google group. For example, group:admins@example.com. \n- domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com. \n- projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project \n- projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project \n- projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project", + "description": "A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows: \n- allUsers - A special identifier that represents anyone on the internet; with or without a Google account. \n- allAuthenticatedUsers - A special identifier that represents anyone who is authenticated with a Google account or a service account. \n- user:emailid - An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com. \n- serviceAccount:emailid - An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . \n- group:emailid - An email address that represents a Google group. For example, group:admins@example.com. \n- domain:domain - A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com. \n- projectOwner:projectid - Owners of the given project. For example, projectOwner:my-example-project \n- projectEditor:projectid - Editors of the given project. For example, projectEditor:my-example-project \n- projectViewer:projectid - Viewers of the given project. For example, projectViewer:my-example-project", "items": { "type": "string" }, @@ -6089,7 +6089,7 @@ "storage.managedFolders.setIamPolicy" ] }, - "description": "The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.\nThe new IAM roles are: \n- roles/storage.admin — Full control of Google Cloud Storage resources. \n- roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects. \n- roles/storage.objectCreator — Access to create objects in Google Cloud Storage. \n- roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are: \n- roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role. \n- roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role. \n- roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role. \n- roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role. \n- roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.", + "description": "The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.\nThe new IAM roles are: \n- roles/storage.admin - Full control of Google Cloud Storage resources. \n- roles/storage.objectViewer - Read-Only access to Google Cloud Storage objects. \n- roles/storage.objectCreator - Access to create objects in Google Cloud Storage. \n- roles/storage.objectAdmin - Full control of Google Cloud Storage objects. The legacy IAM roles are: \n- roles/storage.legacyObjectReader - Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role. \n- roles/storage.legacyObjectOwner - Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role. \n- roles/storage.legacyBucketReader - Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role. \n- roles/storage.legacyBucketWriter - Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role. \n- roles/storage.legacyBucketOwner - Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.", "type": "string" } }, @@ -6207,7 +6207,7 @@ "type": "string" }, "permissions": { - "description": "The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets, objects, or managedFolders. The supported permissions are as follows: \n- storage.buckets.delete — Delete bucket. \n- storage.buckets.get — Read bucket metadata. \n- storage.buckets.getIamPolicy — Read bucket IAM policy. \n- storage.buckets.create — Create bucket. \n- storage.buckets.list — List buckets. \n- storage.buckets.setIamPolicy — Update bucket IAM policy. \n- storage.buckets.update — Update bucket metadata. \n- storage.objects.delete — Delete object. \n- storage.objects.get — Read object data and metadata. \n- storage.objects.getIamPolicy — Read object IAM policy. \n- storage.objects.create — Create object. \n- storage.objects.list — List objects. \n- storage.objects.setIamPolicy — Update object IAM policy. \n- storage.objects.update — Update object metadata. \n- storage.managedFolders.delete — Delete managed folder. \n- storage.managedFolders.get — Read managed folder metadata. \n- storage.managedFolders.getIamPolicy — Read managed folder IAM policy. \n- storage.managedFolders.create — Create managed folder. \n- storage.managedFolders.list — List managed folders. \n- storage.managedFolders.setIamPolicy — Update managed folder IAM policy.", + "description": "The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets, objects, or managedFolders. The supported permissions are as follows: \n- storage.buckets.delete - Delete bucket. \n- storage.buckets.get - Read bucket metadata. \n- storage.buckets.getIamPolicy - Read bucket IAM policy. \n- storage.buckets.create - Create bucket. \n- storage.buckets.list - List buckets. \n- storage.buckets.setIamPolicy - Update bucket IAM policy. \n- storage.buckets.update - Update bucket metadata. \n- storage.objects.delete - Delete object. \n- storage.objects.get - Read object data and metadata. \n- storage.objects.getIamPolicy - Read object IAM policy. \n- storage.objects.create - Create object. \n- storage.objects.list - List objects. \n- storage.objects.setIamPolicy - Update object IAM policy. \n- storage.objects.update - Update object metadata. \n- storage.managedFolders.delete - Delete managed folder. \n- storage.managedFolders.get - Read managed folder metadata. \n- storage.managedFolders.getIamPolicy - Read managed folder IAM policy. \n- storage.managedFolders.create - Create managed folder. \n- storage.managedFolders.list - List managed folders. \n- storage.managedFolders.setIamPolicy - Update managed folder IAM policy.", "items": { "type": "string" }, diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 6a8a7c2b694..a037b5f64c8 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -1324,26 +1324,26 @@ export namespace storage_v1 { kind?: string | null; /** * The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets, objects, or managedFolders. The supported permissions are as follows: - * - storage.buckets.delete — Delete bucket. - * - storage.buckets.get — Read bucket metadata. - * - storage.buckets.getIamPolicy — Read bucket IAM policy. - * - storage.buckets.create — Create bucket. - * - storage.buckets.list — List buckets. - * - storage.buckets.setIamPolicy — Update bucket IAM policy. - * - storage.buckets.update — Update bucket metadata. - * - storage.objects.delete — Delete object. - * - storage.objects.get — Read object data and metadata. - * - storage.objects.getIamPolicy — Read object IAM policy. - * - storage.objects.create — Create object. - * - storage.objects.list — List objects. - * - storage.objects.setIamPolicy — Update object IAM policy. - * - storage.objects.update — Update object metadata. - * - storage.managedFolders.delete — Delete managed folder. - * - storage.managedFolders.get — Read managed folder metadata. - * - storage.managedFolders.getIamPolicy — Read managed folder IAM policy. - * - storage.managedFolders.create — Create managed folder. - * - storage.managedFolders.list — List managed folders. - * - storage.managedFolders.setIamPolicy — Update managed folder IAM policy. + * - storage.buckets.delete - Delete bucket. + * - storage.buckets.get - Read bucket metadata. + * - storage.buckets.getIamPolicy - Read bucket IAM policy. + * - storage.buckets.create - Create bucket. + * - storage.buckets.list - List buckets. + * - storage.buckets.setIamPolicy - Update bucket IAM policy. + * - storage.buckets.update - Update bucket metadata. + * - storage.objects.delete - Delete object. + * - storage.objects.get - Read object data and metadata. + * - storage.objects.getIamPolicy - Read object IAM policy. + * - storage.objects.create - Create object. + * - storage.objects.list - List objects. + * - storage.objects.setIamPolicy - Update object IAM policy. + * - storage.objects.update - Update object metadata. + * - storage.managedFolders.delete - Delete managed folder. + * - storage.managedFolders.get - Read managed folder metadata. + * - storage.managedFolders.getIamPolicy - Read managed folder IAM policy. + * - storage.managedFolders.create - Create managed folder. + * - storage.managedFolders.list - List managed folders. + * - storage.managedFolders.setIamPolicy - Update managed folder IAM policy. */ permissions?: string[] | null; } @@ -5394,7 +5394,7 @@ export namespace storage_v1 { */ bucket?: string; /** - * If true, any parent folder which doesn’t exist will be created automatically. + * If true, any parent folder which doesn't exist will be created automatically. */ recursive?: boolean; From b89df9cc0e084d0da9c3796fc5feb8509c2295d9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 124/144] fix(storagetransfer): update the API #### storagetransfer:v1 The following keys were changed: - schemas.LoggingConfig.properties.logActions.items.enumDescriptions - schemas.Schedule.properties.endTimeOfDay.description - schemas.TransferOptions.properties.overwriteObjectsAlreadyExistingInSink.description --- discovery/storagetransfer-v1.json | 8 ++++---- src/apis/storagetransfer/v1.ts | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/discovery/storagetransfer-v1.json b/discovery/storagetransfer-v1.json index 7e47fd67a92..0f731d1a341 100644 --- a/discovery/storagetransfer-v1.json +++ b/discovery/storagetransfer-v1.json @@ -632,7 +632,7 @@ } } }, - "revision": "20241005", + "revision": "20250301", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -1080,7 +1080,7 @@ "Default value. This value is unused.", "Listing objects in a bucket.", "Deleting objects at the source or the destination.", - "Copying objects to Google Cloud Storage." + "Copying objects to the destination." ], "type": "string" }, @@ -1476,7 +1476,7 @@ "properties": { "endTimeOfDay": { "$ref": "TimeOfDay", - "description": "The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, `end_time_of_day` specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the following: * If `end_time_of_day` is not set and `schedule_end_date` is set, then a default value of `23:59:59` is used for `end_time_of_day`. * If `end_time_of_day` is set and `schedule_end_date` is not set, then INVALID_ARGUMENT is returned." + "description": "The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, `end_time_of_day` specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combination of schedule_start_date and start_time_of_day, and is subject to the following: * If `end_time_of_day` is not set and `schedule_end_date` is set, then a default value of `23:59:59` is used for `end_time_of_day`. * If `end_time_of_day` is set and `schedule_end_date` is not set, then INVALID_ARGUMENT is returned." }, "repeatInterval": { "description": "Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.", @@ -1849,7 +1849,7 @@ "description": "Represents the selected metadata options for a transfer job." }, "overwriteObjectsAlreadyExistingInSink": { - "description": "When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.", + "description": "When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are overwritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.", "type": "boolean" }, "overwriteWhen": { diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index d5478090b1d..1bff981ba8e 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -628,7 +628,7 @@ export namespace storagetransfer_v1 { */ export interface Schema$Schedule { /** - * The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, `end_time_of_day` specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the following: * If `end_time_of_day` is not set and `schedule_end_date` is set, then a default value of `23:59:59` is used for `end_time_of_day`. * If `end_time_of_day` is set and `schedule_end_date` is not set, then INVALID_ARGUMENT is returned. + * The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, `end_time_of_day` specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combination of schedule_start_date and start_time_of_day, and is subject to the following: * If `end_time_of_day` is not set and `schedule_end_date` is set, then a default value of `23:59:59` is used for `end_time_of_day`. * If `end_time_of_day` is set and `schedule_end_date` is not set, then INVALID_ARGUMENT is returned. */ endTimeOfDay?: Schema$TimeOfDay; /** @@ -911,7 +911,7 @@ export namespace storagetransfer_v1 { */ metadataOptions?: Schema$MetadataOptions; /** - * When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. + * When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are overwritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. */ overwriteObjectsAlreadyExistingInSink?: boolean | null; /** From c0991ed37bc5e3738a05367f78124c194aa4c9a0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 125/144] feat(tagmanager)!: update the API BREAKING CHANGE: This release has breaking changes. #### tagmanager:v1 The following keys were deleted: - schemas.AccountAccess.properties.permission.annotations.required - schemas.Condition.properties.parameter.annotations.required - schemas.Condition.properties.type.annotations.required - schemas.Container.properties.name.annotations.required - schemas.Container.properties.timeZoneCountryId.annotations.required - schemas.Container.properties.timeZoneId.annotations.required - schemas.Container.properties.usageContext.annotations.required - schemas.Environment.properties.name.annotations.required - schemas.Folder.properties.name.annotations.required - schemas.Parameter.properties.type.annotations.required - schemas.Tag.properties.name.annotations.required - schemas.Tag.properties.type.annotations.required - schemas.Trigger.properties.name.annotations.required - schemas.Trigger.properties.type.annotations.required - schemas.UserAccess.properties.accountAccess.annotations.required - schemas.UserAccess.properties.emailAddress.annotations.required - schemas.Variable.properties.name.annotations.required - schemas.Variable.properties.type.annotations.required The following keys were changed: - schemas.Account.properties.name.description - schemas.Account.properties.shareData.description - schemas.AccountAccess.properties.permission.description - schemas.Condition.properties.parameter.description - schemas.Condition.properties.type.description - schemas.Container.properties.domainName.description - schemas.Container.properties.enabledBuiltInVariable.description - schemas.Container.properties.name.description - schemas.Container.properties.notes.description - schemas.Container.properties.timeZoneCountryId.description - schemas.Container.properties.timeZoneId.description - schemas.Container.properties.usageContext.description - schemas.ContainerAccess.properties.containerId.description - schemas.ContainerAccess.properties.permission.description - schemas.ContainerVersion.properties.name.description - schemas.ContainerVersion.properties.notes.description - schemas.Environment.properties.description.description - schemas.Environment.properties.enableDebug.description - schemas.Environment.properties.name.description - schemas.Environment.properties.url.description - schemas.Folder.properties.name.description - schemas.Macro.properties.disablingRuleId.description - schemas.Macro.properties.enablingRuleId.description - schemas.Macro.properties.name.description - schemas.Macro.properties.notes.description - schemas.Macro.properties.parameter.description - schemas.Macro.properties.scheduleEndMs.description - schemas.Macro.properties.scheduleStartMs.description - schemas.Macro.properties.type.description - schemas.Parameter.properties.key.description - schemas.Parameter.properties.list.description - schemas.Parameter.properties.map.description - schemas.Parameter.properties.type.description - schemas.Parameter.properties.type.enumDescriptions - schemas.Parameter.properties.value.description - schemas.Rule.properties.condition.description - schemas.Rule.properties.name.description - schemas.Rule.properties.notes.description - schemas.Tag.properties.blockingRuleId.description - schemas.Tag.properties.blockingTriggerId.description - schemas.Tag.properties.firingRuleId.description - schemas.Tag.properties.firingTriggerId.description - schemas.Tag.properties.liveOnly.description - schemas.Tag.properties.name.description - schemas.Tag.properties.notes.description - schemas.Tag.properties.parameter.description - schemas.Tag.properties.paused.description - schemas.Tag.properties.priority.description - schemas.Tag.properties.scheduleEndMs.description - schemas.Tag.properties.scheduleStartMs.description - schemas.Tag.properties.type.description - schemas.Trigger.properties.autoEventFilter.description - schemas.Trigger.properties.checkValidation.description - schemas.Trigger.properties.continuousTimeMinMilliseconds.description - schemas.Trigger.properties.customEventFilter.description - schemas.Trigger.properties.eventName.description - schemas.Trigger.properties.filter.description - schemas.Trigger.properties.horizontalScrollPercentageList.description - schemas.Trigger.properties.interval.description - schemas.Trigger.properties.intervalSeconds.description - schemas.Trigger.properties.limit.description - schemas.Trigger.properties.maxTimerLengthSeconds.description - schemas.Trigger.properties.name.description - schemas.Trigger.properties.parameter.description - schemas.Trigger.properties.selector.description - schemas.Trigger.properties.totalTimeMinMilliseconds.description - schemas.Trigger.properties.type.description - schemas.Trigger.properties.uniqueTriggerId.description - schemas.Trigger.properties.verticalScrollPercentageList.description - schemas.Trigger.properties.visibilitySelector.description - schemas.Trigger.properties.visiblePercentageMax.description - schemas.Trigger.properties.visiblePercentageMin.description - schemas.Trigger.properties.waitForTags.description - schemas.Trigger.properties.waitForTagsTimeout.description - schemas.UserAccess.properties.accountAccess.description - schemas.UserAccess.properties.containerAccess.description - schemas.UserAccess.properties.emailAddress.description - schemas.Variable.properties.disablingTriggerId.description - schemas.Variable.properties.enablingTriggerId.description - schemas.Variable.properties.name.description - schemas.Variable.properties.notes.description - schemas.Variable.properties.parameter.description - schemas.Variable.properties.scheduleEndMs.description - schemas.Variable.properties.scheduleStartMs.description - schemas.Variable.properties.type.description #### tagmanager:v2 The following keys were deleted: - schemas.Client.properties.name.annotations.required - schemas.Client.properties.type.annotations.required - schemas.Condition.properties.parameter.annotations.required - schemas.Condition.properties.type.annotations.required - schemas.Container.properties.name.annotations.required - schemas.Container.properties.usageContext.annotations.required - schemas.Environment.properties.name.annotations.required - schemas.Folder.properties.name.annotations.required - schemas.Parameter.properties.type.annotations.required - schemas.Tag.properties.name.annotations.required - schemas.Tag.properties.type.annotations.required - schemas.Transformation.properties.name.annotations.required - schemas.Transformation.properties.type.annotations.required - schemas.Trigger.properties.name.annotations.required - schemas.Trigger.properties.type.annotations.required - schemas.Variable.properties.name.annotations.required - schemas.Variable.properties.type.annotations.required - schemas.Workspace.properties.name.annotations.required The following keys were added: - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.flatPath - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.httpMethod - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.id - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameterOrder - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.acknowledgePermissions.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.acknowledgePermissions.location - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.acknowledgePermissions.type - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.galleryOwner.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.galleryOwner.location - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.galleryOwner.type - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.galleryRepository.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.galleryRepository.location - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.galleryRepository.type - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.gallerySha.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.gallerySha.location - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.gallerySha.type - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.parent.location - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.parent.pattern - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.parent.required - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.parameters.parent.type - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.path - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.response.$ref - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.import_from_gallery.scopes - schemas.GalleryReference.properties.galleryTemplateId.description - schemas.GalleryReference.properties.galleryTemplateId.type - schemas.GetContainerSnippetResponse.properties.containerConfig.description - schemas.GetContainerSnippetResponse.properties.containerConfig.type The following keys were changed: - resources.accounts.methods.get.parameters.path.description - resources.accounts.methods.update.parameters.path.description - resources.accounts.resources.containers.methods.combine.parameters.path.description - resources.accounts.resources.containers.methods.create.parameters.parent.description - resources.accounts.resources.containers.methods.delete.parameters.path.description - resources.accounts.resources.containers.methods.get.parameters.path.description - resources.accounts.resources.containers.methods.list.parameters.parent.description - resources.accounts.resources.containers.methods.lookup.parameters.destinationId.description - resources.accounts.resources.containers.methods.lookup.parameters.tagId.description - resources.accounts.resources.containers.methods.move_tag_id.parameters.path.description - resources.accounts.resources.containers.methods.snippet.parameters.path.description - resources.accounts.resources.containers.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.destinations.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.destinations.methods.link.parameters.parent.description - resources.accounts.resources.containers.resources.destinations.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.environments.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.environments.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.environments.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.environments.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.environments.methods.reauthorize.parameters.path.description - resources.accounts.resources.containers.resources.environments.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.version_headers.methods.latest.parameters.parent.description - resources.accounts.resources.containers.resources.version_headers.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.versions.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.versions.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.versions.methods.live.parameters.parent.description - resources.accounts.resources.containers.resources.versions.methods.publish.parameters.path.description - resources.accounts.resources.containers.resources.versions.methods.set_latest.parameters.path.description - resources.accounts.resources.containers.resources.versions.methods.undelete.parameters.path.description - resources.accounts.resources.containers.resources.versions.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.methods.create_version.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.methods.getStatus.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.methods.quick_preview.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.methods.resolve_conflict.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.methods.sync.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.built_in_variables.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.built_in_variables.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.built_in_variables.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.built_in_variables.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.clients.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.clients.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.clients.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.clients.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.clients.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.clients.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.folders.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.folders.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.folders.methods.entities.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.folders.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.folders.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.folders.methods.move_entities_to_folder.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.folders.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.folders.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.gtag_config.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.gtag_config.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.gtag_config.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.gtag_config.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.gtag_config.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.tags.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.tags.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.tags.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.tags.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.tags.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.tags.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.templates.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.transformations.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.transformations.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.transformations.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.transformations.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.transformations.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.transformations.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.triggers.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.triggers.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.triggers.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.triggers.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.triggers.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.triggers.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.variables.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.variables.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.variables.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.variables.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.variables.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.variables.methods.update.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.zones.methods.create.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.zones.methods.delete.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.zones.methods.get.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.zones.methods.list.parameters.parent.description - resources.accounts.resources.containers.resources.workspaces.resources.zones.methods.revert.parameters.path.description - resources.accounts.resources.containers.resources.workspaces.resources.zones.methods.update.parameters.path.description - resources.accounts.resources.user_permissions.methods.create.parameters.parent.description - resources.accounts.resources.user_permissions.methods.delete.parameters.path.description - resources.accounts.resources.user_permissions.methods.get.parameters.path.description - resources.accounts.resources.user_permissions.methods.list.parameters.parent.description - resources.accounts.resources.user_permissions.methods.update.parameters.path.description - schemas.Account.properties.name.description - schemas.Account.properties.shareData.description - schemas.AccountAccess.properties.permission.description - schemas.BuiltInVariable.properties.type.description - schemas.Client.properties.name.description - schemas.Client.properties.notes.description - schemas.Client.properties.parameter.description - schemas.Client.properties.priority.description - schemas.Client.properties.type.description - schemas.Condition.properties.parameter.description - schemas.Condition.properties.type.description - schemas.Container.properties.domainName.description - schemas.Container.properties.name.description - schemas.Container.properties.notes.description - schemas.Container.properties.taggingServerUrls.description - schemas.Container.properties.usageContext.description - schemas.ContainerAccess.properties.containerId.description - schemas.ContainerAccess.properties.permission.description - schemas.ContainerVersion.properties.description.description - schemas.ContainerVersion.properties.name.description - schemas.Environment.properties.description.description - schemas.Environment.properties.enableDebug.description - schemas.Environment.properties.name.description - schemas.Environment.properties.url.description - schemas.Folder.properties.name.description - schemas.Folder.properties.notes.description - schemas.GtagConfig.properties.parameter.description - schemas.GtagConfig.properties.type.description - schemas.Parameter.properties.isWeakReference.description - schemas.Parameter.properties.key.description - schemas.Parameter.properties.list.description - schemas.Parameter.properties.map.description - schemas.Parameter.properties.type.description - schemas.Parameter.properties.type.enumDescriptions - schemas.Parameter.properties.value.description - schemas.Tag.properties.blockingRuleId.description - schemas.Tag.properties.blockingTriggerId.description - schemas.Tag.properties.consentSettings.description - schemas.Tag.properties.firingRuleId.description - schemas.Tag.properties.firingTriggerId.description - schemas.Tag.properties.liveOnly.description - schemas.Tag.properties.monitoringMetadata.description - schemas.Tag.properties.monitoringMetadataTagNameKey.description - schemas.Tag.properties.name.description - schemas.Tag.properties.notes.description - schemas.Tag.properties.parameter.description - schemas.Tag.properties.paused.description - schemas.Tag.properties.priority.description - schemas.Tag.properties.scheduleEndMs.description - schemas.Tag.properties.scheduleStartMs.description - schemas.Tag.properties.type.description - schemas.Transformation.properties.name.description - schemas.Transformation.properties.notes.description - schemas.Transformation.properties.parameter.description - schemas.Transformation.properties.type.description - schemas.Trigger.properties.autoEventFilter.description - schemas.Trigger.properties.checkValidation.description - schemas.Trigger.properties.continuousTimeMinMilliseconds.description - schemas.Trigger.properties.customEventFilter.description - schemas.Trigger.properties.eventName.description - schemas.Trigger.properties.filter.description - schemas.Trigger.properties.horizontalScrollPercentageList.description - schemas.Trigger.properties.interval.description - schemas.Trigger.properties.intervalSeconds.description - schemas.Trigger.properties.limit.description - schemas.Trigger.properties.maxTimerLengthSeconds.description - schemas.Trigger.properties.name.description - schemas.Trigger.properties.notes.description - schemas.Trigger.properties.parameter.description - schemas.Trigger.properties.selector.description - schemas.Trigger.properties.totalTimeMinMilliseconds.description - schemas.Trigger.properties.type.description - schemas.Trigger.properties.uniqueTriggerId.description - schemas.Trigger.properties.verticalScrollPercentageList.description - schemas.Trigger.properties.visibilitySelector.description - schemas.Trigger.properties.visiblePercentageMax.description - schemas.Trigger.properties.visiblePercentageMin.description - schemas.Trigger.properties.waitForTags.description - schemas.Trigger.properties.waitForTagsTimeout.description - schemas.UserPermission.properties.accountAccess.description - schemas.UserPermission.properties.containerAccess.description - schemas.UserPermission.properties.emailAddress.description - schemas.Variable.properties.disablingTriggerId.description - schemas.Variable.properties.enablingTriggerId.description - schemas.Variable.properties.name.description - schemas.Variable.properties.notes.description - schemas.Variable.properties.parameter.description - schemas.Variable.properties.scheduleEndMs.description - schemas.Variable.properties.scheduleStartMs.description - schemas.Variable.properties.type.description - schemas.Workspace.properties.description.description - schemas.Workspace.properties.name.description --- discovery/tagmanager-v1.json | 276 ++++++----------- discovery/tagmanager-v2.json | 558 ++++++++++++++++------------------- src/apis/tagmanager/v1.ts | 168 +++++------ src/apis/tagmanager/v2.ts | 511 ++++++++++++++++++++------------ 4 files changed, 736 insertions(+), 777 deletions(-) diff --git a/discovery/tagmanager-v1.json b/discovery/tagmanager-v1.json index 781c63e49f7..2fe3b7b0709 100644 --- a/discovery/tagmanager-v1.json +++ b/discovery/tagmanager-v1.json @@ -1932,7 +1932,7 @@ } } }, - "revision": "20230705", + "revision": "20250310", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -1948,11 +1948,11 @@ "type": "string" }, "name": { - "description": "Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update", + "description": "Account display name.", "type": "string" }, "shareData": { - "description": "Whether the account shares data anonymously with Google and others. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update", + "description": "Whether the account shares data anonymously with Google and others.", "type": "boolean" } }, @@ -1963,12 +1963,7 @@ "id": "AccountAccess", "properties": { "permission": { - "annotations": { - "required": [ - "tagmanager.accounts.permissions.create" - ] - }, - "description": "List of Account permissions. Valid account permissions are read and manage. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update", + "description": "List of Account permissions. Valid account permissions are read and manage.", "items": { "enum": [ "read", @@ -1998,26 +1993,14 @@ "id": "Condition", "properties": { "parameter": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.triggers.create", - "tagmanager.accounts.containers.triggers.update" - ] - }, - "description": "A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update", + "description": "A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. ", "items": { "$ref": "Parameter" }, "type": "array" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.triggers.create", - "tagmanager.accounts.containers.triggers.update" - ] - }, - "description": "The type of operator for this condition. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update", + "description": "The type of operator for this condition.", "enum": [ "equals", "contains", @@ -2062,14 +2045,14 @@ "type": "string" }, "domainName": { - "description": "Optional list of domain names associated with the Container. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "Optional list of domain names associated with the Container.", "items": { "type": "string" }, "type": "array" }, "enabledBuiltInVariable": { - "description": "List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId.", "items": { "enum": [ "pageUrl", @@ -2294,16 +2277,11 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.create" - ] - }, - "description": "Container display name. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "Container display name.", "type": "string" }, "notes": { - "description": "Container Notes. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "Container Notes.", "type": "string" }, "publicId": { @@ -2311,31 +2289,15 @@ "type": "string" }, "timeZoneCountryId": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.create" - ] - }, - "description": "Container Country ID. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "Container Country ID.", "type": "string" }, "timeZoneId": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.create" - ] - }, - "description": "Container Time Zone ID. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "Container Time Zone ID.", "type": "string" }, "usageContext": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.create", - "tagmanager.accounts.containers.update" - ] - }, - "description": "List of Usage Contexts for the Container. Valid values include: web, android, ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "List of Usage Contexts for the Container. Valid values include: web, android, ios.", "items": { "enum": [ "web", @@ -2365,11 +2327,11 @@ "id": "ContainerAccess", "properties": { "containerId": { - "description": "GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update", + "description": "GTM Container ID.", "type": "string" }, "permission": { - "description": "List of Container permissions. Valid container permissions are: read, edit, delete, publish. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update", + "description": "List of Container permissions. Valid container permissions are: read, edit, delete, publish.", "items": { "enum": [ "read", @@ -2438,11 +2400,11 @@ "type": "array" }, "name": { - "description": "Container version display name. @mutable tagmanager.accounts.containers.versions.update", + "description": "Container version display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this container version in the container. @mutable tagmanager.accounts.containers.versions.update", + "description": "User notes on how to apply this container version in the container.", "type": "string" }, "rule": { @@ -2585,11 +2547,11 @@ "type": "string" }, "description": { - "description": "The environment description. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update", + "description": "The environment description. Can be set or changed only on USER type environments.", "type": "string" }, "enableDebug": { - "description": "Whether or not to enable debug by default on for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update", + "description": "Whether or not to enable debug by default on for the environment.", "type": "boolean" }, "environmentId": { @@ -2601,13 +2563,7 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.environments.create", - "tagmanager.accounts.containers.environments.update" - ] - }, - "description": "The environment display name. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update", + "description": "The environment display name. Can be set or changed only on USER type environments.", "type": "string" }, "type": { @@ -2627,7 +2583,7 @@ "type": "string" }, "url": { - "description": "Default preview page url for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update", + "description": "Default preview page url for the environment.", "type": "string" } }, @@ -2654,13 +2610,7 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.folders.create", - "tagmanager.accounts.containers.folders.update" - ] - }, - "description": "Folder display name. @mutable tagmanager.accounts.containers.folders.create @mutable tagmanager.accounts.containers.folders.update", + "description": "Folder display name.", "type": "string" } }, @@ -2840,14 +2790,14 @@ "type": "string" }, "disablingRuleId": { - "description": "For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update", + "description": "For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.", "items": { "type": "string" }, "type": "array" }, "enablingRuleId": { - "description": "For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update", + "description": "For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set.", "items": { "type": "string" }, @@ -2862,15 +2812,15 @@ "type": "string" }, "name": { - "description": "Macro display name. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update", + "description": "Macro display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this macro in the container. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update", + "description": "User notes on how to apply this macro in the container.", "type": "string" }, "parameter": { - "description": "The macro's parameters. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update", + "description": "The macro's parameters.", "items": { "$ref": "Parameter" }, @@ -2881,17 +2831,17 @@ "type": "string" }, "scheduleEndMs": { - "description": "The end timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update", + "description": "The end timestamp in milliseconds to schedule a macro.", "format": "int64", "type": "string" }, "scheduleStartMs": { - "description": "The start timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update", + "description": "The start timestamp in milliseconds to schedule a macro.", "format": "int64", "type": "string" }, "type": { - "description": "GTM Macro Type. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update", + "description": "GTM Macro Type.", "type": "string" } }, @@ -2902,35 +2852,25 @@ "id": "Parameter", "properties": { "key": { - "description": "The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.", "type": "string" }, "list": { - "description": "This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "This list parameter's parameters (keys will be ignored).", "items": { "$ref": "Parameter" }, "type": "array" }, "map": { - "description": "This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "This map parameter's parameters (must have keys; keys must be unique).", "items": { "$ref": "Parameter" }, "type": "array" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.tags.create", - "tagmanager.accounts.containers.tags.update", - "tagmanager.accounts.containers.triggers.create", - "tagmanager.accounts.containers.triggers.update", - "tagmanager.accounts.containers.variables.create", - "tagmanager.accounts.containers.variables.update" - ] - }, - "description": "The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name ", "enum": [ "template", "integer", @@ -2941,7 +2881,7 @@ "tagReference" ], "enumDescriptions": [ - "May include variable references (such as \"{{myVariable}}\").", + "May include variable references.", "", "", "", @@ -2952,7 +2892,7 @@ "type": "string" }, "value": { - "description": "A parameter's value (may contain variable references such as \"{{myVariable}}\") as appropriate to the specified type. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "A parameter's value (may contain variable references). as appropriate to the specified type.", "type": "string" } }, @@ -2982,7 +2922,7 @@ "type": "string" }, "condition": { - "description": "The list of conditions that make up this rule (implicit AND between them). @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update", + "description": "The list of conditions that make up this rule (implicit AND between them).", "items": { "$ref": "Condition" }, @@ -2997,11 +2937,11 @@ "type": "string" }, "name": { - "description": "Rule display name. @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update", + "description": "Rule display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this rule in the container. @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update", + "description": "User notes on how to apply this rule in the container.", "type": "string" }, "ruleId": { @@ -3035,14 +2975,14 @@ }, "blockingRuleId": { "deprecated": true, - "description": "Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.", "items": { "type": "string" }, "type": "array" }, "blockingTriggerId": { - "description": "Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.", "items": { "type": "string" }, @@ -3058,39 +2998,33 @@ }, "firingRuleId": { "deprecated": true, - "description": "Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.", "items": { "type": "string" }, "type": "array" }, "firingTriggerId": { - "description": "Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.", "items": { "type": "string" }, "type": "array" }, "liveOnly": { - "description": "If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).", "type": "boolean" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.tags.create", - "tagmanager.accounts.containers.tags.update" - ] - }, - "description": "Tag display name. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "Tag display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "User notes on how to apply this tag in the container.", "type": "string" }, "parameter": { - "description": "The tag's parameters. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "The tag's parameters.", "items": { "$ref": "Parameter" }, @@ -3101,20 +3035,20 @@ "type": "string" }, "paused": { - "description": "True if the tag is paused. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "True if the tag is paused.", "type": "boolean" }, "priority": { "$ref": "Parameter", - "description": "User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update" + "description": "User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0." }, "scheduleEndMs": { - "description": "The end timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "The end timestamp in milliseconds to schedule a tag.", "format": "int64", "type": "string" }, "scheduleStartMs": { - "description": "The start timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "The start timestamp in milliseconds to schedule a tag.", "format": "int64", "type": "string" }, @@ -3151,12 +3085,7 @@ "type": "array" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.tags.create" - ] - }, - "description": "GTM Tag Type. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update", + "description": "GTM Tag Type.", "type": "string" } }, @@ -3185,7 +3114,7 @@ "type": "string" }, "autoEventFilter": { - "description": "Used in the case of auto event tracking. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update", + "description": "Used in the case of auto event tracking.", "items": { "$ref": "Condition" }, @@ -3193,7 +3122,7 @@ }, "checkValidation": { "$ref": "Parameter", - "description": "Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers." }, "containerId": { "description": "GTM Container ID.", @@ -3201,10 +3130,10 @@ }, "continuousTimeMinMilliseconds": { "$ref": "Parameter", - "description": "A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger." }, "customEventFilter": { - "description": "Used in the case of custom event, which is fired iff all Conditions are true. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update", + "description": "Used in the case of custom event, which is fired iff all Conditions are true.", "items": { "$ref": "Condition" }, @@ -3212,10 +3141,10 @@ }, "eventName": { "$ref": "Parameter", - "description": "Name of the GTM event that is fired. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "Name of the GTM event that is fired. Only valid for Timer triggers." }, "filter": { - "description": "The trigger will only fire iff all Conditions are true. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update", + "description": "The trigger will only fire iff all Conditions are true.", "items": { "$ref": "Condition" }, @@ -3227,36 +3156,30 @@ }, "horizontalScrollPercentageList": { "$ref": "Parameter", - "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers." }, "interval": { "$ref": "Parameter", - "description": "Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers." }, "intervalSeconds": { "$ref": "Parameter", - "description": "Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger." }, "limit": { "$ref": "Parameter", - "description": "Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers." }, "maxTimerLengthSeconds": { "$ref": "Parameter", - "description": "Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger." }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.triggers.create", - "tagmanager.accounts.containers.triggers.update" - ] - }, - "description": "Trigger display name. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update", + "description": "Trigger display name.", "type": "string" }, "parameter": { - "description": "Additional parameters. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "Additional parameters.", "items": { "$ref": "Parameter" }, @@ -3268,23 +3191,18 @@ }, "selector": { "$ref": "Parameter", - "description": "A click trigger CSS selector (i.e. \"a\", \"button\" etc.). Only valid for AMP Click trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "A click trigger CSS selector (i.e. \"a\", \"button\" etc.). Only valid for AMP Click trigger." }, "totalTimeMinMilliseconds": { "$ref": "Parameter", - "description": "A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger." }, "triggerId": { "description": "The Trigger ID uniquely identifies the GTM Trigger.", "type": "string" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.triggers.create" - ] - }, - "description": "Defines the data layer event that causes this trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update", + "description": "Defines the data layer event that causes this trigger.", "enum": [ "pageview", "domReady", @@ -3331,31 +3249,31 @@ }, "uniqueTriggerId": { "$ref": "Parameter", - "description": "Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers." }, "verticalScrollPercentageList": { "$ref": "Parameter", - "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers." }, "visibilitySelector": { "$ref": "Parameter", - "description": "A visibility trigger CSS selector (i.e. \"#id\"). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "A visibility trigger CSS selector (i.e. \"#id\"). Only valid for AMP Visibility trigger." }, "visiblePercentageMax": { "$ref": "Parameter", - "description": "A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger." }, "visiblePercentageMin": { "$ref": "Parameter", - "description": "A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger." }, "waitForTags": { "$ref": "Parameter", - "description": "Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers." }, "waitForTagsTimeout": { "$ref": "Parameter", - "description": "How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update" + "description": "How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers." } }, "type": "object" @@ -3366,31 +3284,21 @@ "properties": { "accountAccess": { "$ref": "AccountAccess", - "annotations": { - "required": [ - "tagmanager.accounts.permissions.create" - ] - }, - "description": "GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update" + "description": "GTM Account access permissions." }, "accountId": { "description": "GTM Account ID.", "type": "string" }, "containerAccess": { - "description": "GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update", + "description": "GTM Container access permissions.", "items": { "$ref": "ContainerAccess" }, "type": "array" }, "emailAddress": { - "annotations": { - "required": [ - "tagmanager.accounts.permissions.create" - ] - }, - "description": "User's email address. @mutable tagmanager.accounts.permissions.create", + "description": "User's email address.", "type": "string" }, "permissionId": { @@ -3413,14 +3321,14 @@ "type": "string" }, "disablingTriggerId": { - "description": "For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update", + "description": "For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.", "items": { "type": "string" }, "type": "array" }, "enablingTriggerId": { - "description": "For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update", + "description": "For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.", "items": { "type": "string" }, @@ -3431,21 +3339,15 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.variables.create", - "tagmanager.accounts.containers.variables.update" - ] - }, - "description": "Variable display name. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update", + "description": "Variable display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this variable in the container. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update", + "description": "User notes on how to apply this variable in the container.", "type": "string" }, "parameter": { - "description": "The variable's parameters. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update", + "description": "The variable's parameters.", "items": { "$ref": "Parameter" }, @@ -3456,23 +3358,17 @@ "type": "string" }, "scheduleEndMs": { - "description": "The end timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update", + "description": "The end timestamp in milliseconds to schedule a variable.", "format": "int64", "type": "string" }, "scheduleStartMs": { - "description": "The start timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update", + "description": "The start timestamp in milliseconds to schedule a variable.", "format": "int64", "type": "string" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.variables.create", - "tagmanager.accounts.containers.variables.update" - ] - }, - "description": "GTM Variable Type. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update", + "description": "GTM Variable Type.", "type": "string" }, "variableId": { diff --git a/discovery/tagmanager-v2.json b/discovery/tagmanager-v2.json index e269bcdd17c..999720282a5 100644 --- a/discovery/tagmanager-v2.json +++ b/discovery/tagmanager-v2.json @@ -134,7 +134,7 @@ ], "parameters": { "path": { - "description": "GTM Account's API relative path. Example: accounts/{account_id}", + "description": "GTM Account's API relative path.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -194,7 +194,7 @@ "type": "string" }, "path": { - "description": "GTM Account's API relative path. Example: accounts/{account_id}", + "description": "GTM Account's API relative path.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -236,7 +236,7 @@ "type": "string" }, "path": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -276,7 +276,7 @@ ], "parameters": { "parent": { - "description": "GTM Account's API relative path. Example: accounts/{account_id}.", + "description": "GTM Account's API relative path.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -304,7 +304,7 @@ ], "parameters": { "path": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -326,7 +326,7 @@ ], "parameters": { "path": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -357,7 +357,7 @@ "type": "string" }, "parent": { - "description": "GTM Account's API relative path. Example: accounts/{account_id}.", + "description": "GTM Account's API relative path.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -381,12 +381,12 @@ "parameterOrder": [], "parameters": { "destinationId": { - "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.", + "description": "Destination ID linked to a GTM Container, e.g. AW-123456789. 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.", + "description": "Tag ID for a GTM Container, e.g. GTM-123456789. Only one of destination_id or tag_id should be set.", "location": "query", "type": "string" } @@ -430,7 +430,7 @@ "type": "boolean" }, "path": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -465,7 +465,7 @@ ], "parameters": { "path": { - "description": "Container snippet's API relative path. Example: accounts/{account_id}/containers/{container_id}:snippet", + "description": "Container snippet's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -496,7 +496,7 @@ "type": "string" }, "path": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -528,7 +528,7 @@ ], "parameters": { "path": { - "description": "Google Tag Destination's API relative path. Example: accounts/{account_id}/containers/{container_id}/destinations/{destination_link_id}", + "description": "Google Tag Destination's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/destinations/[^/]+$", "required": true, @@ -564,7 +564,7 @@ "type": "string" }, "parent": { - "description": "GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM parent Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -589,7 +589,7 @@ ], "parameters": { "parent": { - "description": "GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM parent Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -619,7 +619,7 @@ ], "parameters": { "parent": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -647,7 +647,7 @@ ], "parameters": { "path": { - "description": "GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id}", + "description": "GTM Environment's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "required": true, @@ -669,7 +669,7 @@ ], "parameters": { "path": { - "description": "GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id}", + "description": "GTM Environment's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "required": true, @@ -700,7 +700,7 @@ "type": "string" }, "parent": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -726,7 +726,7 @@ ], "parameters": { "path": { - "description": "GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id}", + "description": "GTM Environment's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "required": true, @@ -759,7 +759,7 @@ "type": "string" }, "path": { - "description": "GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id}", + "description": "GTM Environment's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/environments/[^/]+$", "required": true, @@ -791,7 +791,7 @@ ], "parameters": { "parent": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -827,7 +827,7 @@ "type": "string" }, "parent": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -858,7 +858,7 @@ ], "parameters": { "path": { - "description": "GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id}", + "description": "GTM ContainerVersion's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "required": true, @@ -885,7 +885,7 @@ "type": "string" }, "path": { - "description": "GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id}", + "description": "GTM ContainerVersion's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "required": true, @@ -912,7 +912,7 @@ ], "parameters": { "parent": { - "description": "GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -943,7 +943,7 @@ "type": "string" }, "path": { - "description": "GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id}", + "description": "GTM ContainerVersion's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "required": true, @@ -968,7 +968,7 @@ ], "parameters": { "path": { - "description": "GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id}", + "description": "GTM ContainerVersion's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "required": true, @@ -993,7 +993,7 @@ ], "parameters": { "path": { - "description": "GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id}", + "description": "GTM ContainerVersion's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "required": true, @@ -1023,7 +1023,7 @@ "type": "string" }, "path": { - "description": "GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id}", + "description": "GTM ContainerVersion's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/versions/[^/]+$", "required": true, @@ -1055,7 +1055,7 @@ ], "parameters": { "parent": { - "description": "GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM parent Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -1083,7 +1083,7 @@ ], "parameters": { "path": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1111,7 +1111,7 @@ ], "parameters": { "path": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1133,7 +1133,7 @@ ], "parameters": { "path": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1159,7 +1159,7 @@ ], "parameters": { "path": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1190,7 +1190,7 @@ "type": "string" }, "parent": { - "description": "GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id}", + "description": "GTM parent Container's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+$", "required": true, @@ -1216,7 +1216,7 @@ ], "parameters": { "path": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1246,7 +1246,7 @@ "type": "string" }, "path": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1271,7 +1271,7 @@ ], "parameters": { "path": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1301,7 +1301,7 @@ "type": "string" }, "path": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1333,7 +1333,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1596,7 +1596,7 @@ ], "parameters": { "path": { - "description": "GTM BuiltInVariable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables", + "description": "GTM BuiltInVariable's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/built_in_variables$", "required": true, @@ -1861,7 +1861,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -1887,7 +1887,7 @@ ], "parameters": { "path": { - "description": "GTM BuiltInVariable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables", + "description": "GTM BuiltInVariable's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2153,7 +2153,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2181,7 +2181,7 @@ ], "parameters": { "path": { - "description": "GTM Client's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/clients/{client_id}", + "description": "GTM Client's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "required": true, @@ -2203,7 +2203,7 @@ ], "parameters": { "path": { - "description": "GTM Client's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/clients/{client_id}", + "description": "GTM Client's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "required": true, @@ -2234,7 +2234,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2265,7 +2265,7 @@ "type": "string" }, "path": { - "description": "GTM Client's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/clients/{client_id}", + "description": "GTM Client's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "required": true, @@ -2295,7 +2295,7 @@ "type": "string" }, "path": { - "description": "GTM Client's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/clients/{client_id}", + "description": "GTM Client's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/clients/[^/]+$", "required": true, @@ -2327,7 +2327,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2355,7 +2355,7 @@ ], "parameters": { "path": { - "description": "GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id}", + "description": "GTM Folder's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "required": true, @@ -2382,7 +2382,7 @@ "type": "string" }, "path": { - "description": "GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id}", + "description": "GTM Folder's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "required": true, @@ -2408,7 +2408,7 @@ ], "parameters": { "path": { - "description": "GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id}", + "description": "GTM Folder's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "required": true, @@ -2439,7 +2439,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2465,7 +2465,7 @@ ], "parameters": { "path": { - "description": "GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id}", + "description": "GTM Folder's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "required": true, @@ -2513,7 +2513,7 @@ "type": "string" }, "path": { - "description": "GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id}", + "description": "GTM Folder's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "required": true, @@ -2543,7 +2543,7 @@ "type": "string" }, "path": { - "description": "GTM Folder's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/folders/{folder_id}", + "description": "GTM Folder's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/folders/[^/]+$", "required": true, @@ -2575,7 +2575,7 @@ ], "parameters": { "parent": { - "description": "Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2603,7 +2603,7 @@ ], "parameters": { "path": { - "description": "Google tag config's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/gtag_config/{gtag_config_id}", + "description": "Google tag config's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "required": true, @@ -2625,7 +2625,7 @@ ], "parameters": { "path": { - "description": "Google tag config's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/gtag_config/{gtag_config_id}", + "description": "Google tag config's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "required": true, @@ -2656,7 +2656,7 @@ "type": "string" }, "parent": { - "description": "Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2687,7 +2687,7 @@ "type": "string" }, "path": { - "description": "Google tag config's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/gtag_config/{gtag_config_id}", + "description": "Google tag config's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$", "required": true, @@ -2719,7 +2719,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2747,7 +2747,7 @@ ], "parameters": { "path": { - "description": "GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id}", + "description": "GTM Tag's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "required": true, @@ -2769,7 +2769,7 @@ ], "parameters": { "path": { - "description": "GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id}", + "description": "GTM Tag's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "required": true, @@ -2800,7 +2800,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2831,7 +2831,7 @@ "type": "string" }, "path": { - "description": "GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id}", + "description": "GTM Tag's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "required": true, @@ -2861,7 +2861,7 @@ "type": "string" }, "path": { - "description": "GTM Tag's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/tags/{tag_id}", + "description": "GTM Tag's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/tags/[^/]+$", "required": true, @@ -2893,7 +2893,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -2921,7 +2921,7 @@ ], "parameters": { "path": { - "description": "GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id}", + "description": "GTM Custom Template's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "required": true, @@ -2943,7 +2943,7 @@ ], "parameters": { "path": { - "description": "GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id}", + "description": "GTM Custom Template's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "required": true, @@ -2959,6 +2959,51 @@ "https://www.googleapis.com/auth/tagmanager.readonly" ] }, + "import_from_gallery": { + "description": "Imports a GTM Custom Template from Gallery.", + "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates:import_from_gallery", + "httpMethod": "POST", + "id": "tagmanager.accounts.containers.workspaces.templates.import_from_gallery", + "parameterOrder": [ + "parent" + ], + "parameters": { + "acknowledgePermissions": { + "description": "Must be set to true to allow Gallery template to be imported into the workspace. If this bit is false, the import operation will fail.", + "location": "query", + "type": "boolean" + }, + "galleryOwner": { + "description": "Owner of the Gallery template to import", + "location": "query", + "type": "string" + }, + "galleryRepository": { + "description": "Repository of the Gallery template to import", + "location": "query", + "type": "string" + }, + "gallerySha": { + "description": "SHA version of the Gallery template to import. Defaulted to the latest SHA version if not provided.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "GTM Workspace's API relative path.", + "location": "path", + "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "tagmanager/v2/{+parent}/templates:import_from_gallery", + "response": { + "$ref": "CustomTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/tagmanager.edit.containers" + ] + }, "list": { "description": "Lists all GTM Templates of a GTM container workspace.", "flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/templates", @@ -2974,7 +3019,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3005,7 +3050,7 @@ "type": "string" }, "path": { - "description": "GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id}", + "description": "GTM Custom Template's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "required": true, @@ -3035,7 +3080,7 @@ "type": "string" }, "path": { - "description": "GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id}", + "description": "GTM Custom Template's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/templates/[^/]+$", "required": true, @@ -3067,7 +3112,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3095,7 +3140,7 @@ ], "parameters": { "path": { - "description": "GTM Transformation's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/transformations/{transformation_id}", + "description": "GTM Transformation's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "required": true, @@ -3117,7 +3162,7 @@ ], "parameters": { "path": { - "description": "GTM Transformation's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/transformations/{transformation_id}", + "description": "GTM Transformation's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "required": true, @@ -3148,7 +3193,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3179,7 +3224,7 @@ "type": "string" }, "path": { - "description": "GTM Transformation's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/transformations/{transformation_id}", + "description": "GTM Transformation's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "required": true, @@ -3209,7 +3254,7 @@ "type": "string" }, "path": { - "description": "GTM Transformation's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/transformations/{transformation_id}", + "description": "GTM Transformation's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/transformations/[^/]+$", "required": true, @@ -3241,7 +3286,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3269,7 +3314,7 @@ ], "parameters": { "path": { - "description": "GTM Trigger's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id}", + "description": "GTM Trigger's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "required": true, @@ -3291,7 +3336,7 @@ ], "parameters": { "path": { - "description": "GTM Trigger's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id}", + "description": "GTM Trigger's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "required": true, @@ -3322,7 +3367,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3353,7 +3398,7 @@ "type": "string" }, "path": { - "description": "GTM Trigger's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id}", + "description": "GTM Trigger's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "required": true, @@ -3383,7 +3428,7 @@ "type": "string" }, "path": { - "description": "GTM Trigger's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/triggers/{trigger_id}", + "description": "GTM Trigger's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/triggers/[^/]+$", "required": true, @@ -3415,7 +3460,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3443,7 +3488,7 @@ ], "parameters": { "path": { - "description": "GTM Variable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id}", + "description": "GTM Variable's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "required": true, @@ -3465,7 +3510,7 @@ ], "parameters": { "path": { - "description": "GTM Variable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id}", + "description": "GTM Variable's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "required": true, @@ -3496,7 +3541,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3527,7 +3572,7 @@ "type": "string" }, "path": { - "description": "GTM Variable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id}", + "description": "GTM Variable's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "required": true, @@ -3557,7 +3602,7 @@ "type": "string" }, "path": { - "description": "GTM Variable's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/variables/{variable_id}", + "description": "GTM Variable's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/variables/[^/]+$", "required": true, @@ -3589,7 +3634,7 @@ ], "parameters": { "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3617,7 +3662,7 @@ ], "parameters": { "path": { - "description": "GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id}", + "description": "GTM Zone's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "required": true, @@ -3639,7 +3684,7 @@ ], "parameters": { "path": { - "description": "GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id}", + "description": "GTM Zone's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "required": true, @@ -3670,7 +3715,7 @@ "type": "string" }, "parent": { - "description": "GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}", + "description": "GTM Workspace's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$", "required": true, @@ -3701,7 +3746,7 @@ "type": "string" }, "path": { - "description": "GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id}", + "description": "GTM Zone's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "required": true, @@ -3731,7 +3776,7 @@ "type": "string" }, "path": { - "description": "GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id}", + "description": "GTM Zone's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/zones/[^/]+$", "required": true, @@ -3767,7 +3812,7 @@ ], "parameters": { "parent": { - "description": "GTM Account's API relative path. Example: accounts/{account_id}", + "description": "GTM Account's API relative path.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -3795,7 +3840,7 @@ ], "parameters": { "path": { - "description": "GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id}", + "description": "GTM UserPermission's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "required": true, @@ -3817,7 +3862,7 @@ ], "parameters": { "path": { - "description": "GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id}", + "description": "GTM UserPermission's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "required": true, @@ -3847,7 +3892,7 @@ "type": "string" }, "parent": { - "description": "GTM Account's API relative path. Example: accounts/{account_id}", + "description": "GTM Account's API relative path.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -3872,7 +3917,7 @@ ], "parameters": { "path": { - "description": "GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id}", + "description": "GTM UserPermission's API relative path.", "location": "path", "pattern": "^accounts/[^/]+/user_permissions/[^/]+$", "required": true, @@ -3895,7 +3940,7 @@ } } }, - "revision": "20241204", + "revision": "20250310", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -3915,7 +3960,7 @@ "type": "string" }, "name": { - "description": "Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update", + "description": "Account display name.", "type": "string" }, "path": { @@ -3923,7 +3968,7 @@ "type": "string" }, "shareData": { - "description": "Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update", + "description": "Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service.", "type": "boolean" }, "tagManagerUrl": { @@ -3938,7 +3983,7 @@ "id": "AccountAccess", "properties": { "permission": { - "description": "Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update", + "description": "Whether the user has no access, user access, or admin access to an account.", "enum": [ "accountPermissionUnspecified", "noAccess", @@ -3991,7 +4036,7 @@ "type": "string" }, "type": { - "description": "Type of built-in variable. @required.tagmanager.accounts.containers.workspaces.built_in_variable.update @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update", + "description": "Type of built-in variable.", "enum": [ "builtInVariableTypeUnspecified", "pageUrl", @@ -4253,21 +4298,15 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.clients.create", - "tagmanager.accounts.containers.workspaces.clients.update" - ] - }, - "description": "Client display name. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update", + "description": "Client display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "User notes on how to apply this tag in the container.", "type": "string" }, "parameter": { - "description": "The client's parameters. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update", + "description": "The client's parameters.", "items": { "$ref": "Parameter" }, @@ -4282,7 +4321,7 @@ "type": "string" }, "priority": { - "description": "Priority determines relative firing order. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update", + "description": "Priority determines relative firing order.", "format": "int32", "type": "integer" }, @@ -4291,13 +4330,7 @@ "type": "string" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.clients.create", - "tagmanager.accounts.containers.workspaces.clients.update" - ] - }, - "description": "Client type. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update", + "description": "Client type.", "type": "string" }, "workspaceId": { @@ -4312,26 +4345,14 @@ "id": "Condition", "properties": { "parameter": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.triggers.create", - "tagmanager.accounts.containers.workspaces.triggers.update" - ] - }, - "description": "A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. ", "items": { "$ref": "Parameter" }, "type": "array" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.triggers.create", - "tagmanager.accounts.containers.workspaces.triggers.update" - ] - }, - "description": "The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "The type of operator for this condition.", "enum": [ "conditionTypeUnspecified", "equals", @@ -4378,7 +4399,7 @@ "type": "string" }, "domainName": { - "description": "List of domain names associated with the Container. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "List of domain names associated with the Container.", "items": { "type": "string" }, @@ -4393,17 +4414,11 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.create", - "tagmanager.accounts.containers.update" - ] - }, - "description": "Container display name. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "Container display name.", "type": "string" }, "notes": { - "description": "Container Notes. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "Container Notes.", "type": "string" }, "path": { @@ -4426,20 +4441,14 @@ "type": "string" }, "taggingServerUrls": { - "description": "List of server-side container URLs for the Container. If multiple URLs are provided, all URL paths must match. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "List of server-side container URLs for the Container. If multiple URLs are provided, all URL paths must match.", "items": { "type": "string" }, "type": "array" }, "usageContext": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.create", - "tagmanager.accounts.containers.update" - ] - }, - "description": "List of Usage Contexts for the Container. Valid values include: web, android, or ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update", + "description": "List of Usage Contexts for the Container. Valid values include: web, android, or ios.", "items": { "enum": [ "usageContextUnspecified", @@ -4473,11 +4482,11 @@ "id": "ContainerAccess", "properties": { "containerId": { - "description": "GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update", + "description": "GTM Container ID.", "type": "string" }, "permission": { - "description": "List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update", + "description": "List of Container permissions.", "enum": [ "containerPermissionUnspecified", "noAccess", @@ -4607,7 +4616,7 @@ "type": "boolean" }, "description": { - "description": "Container version description. @mutable tagmanager.accounts.containers.versions.update", + "description": "Container version description.", "type": "string" }, "fingerprint": { @@ -4629,7 +4638,7 @@ "type": "array" }, "name": { - "description": "Container version display name. @mutable tagmanager.accounts.containers.versions.update", + "description": "Container version display name.", "type": "string" }, "path": { @@ -4979,11 +4988,11 @@ "type": "string" }, "description": { - "description": "The environment description. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update", + "description": "The environment description. Can be set or changed only on USER type environments.", "type": "string" }, "enableDebug": { - "description": "Whether or not to enable debug by default for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update", + "description": "Whether or not to enable debug by default for the environment.", "type": "boolean" }, "environmentId": { @@ -4995,13 +5004,7 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.environments.create", - "tagmanager.accounts.containers.environments.update" - ] - }, - "description": "The environment display name. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update", + "description": "The environment display name. Can be set or changed only on USER type environments.", "type": "string" }, "path": { @@ -5029,7 +5032,7 @@ "type": "string" }, "url": { - "description": "Default preview page url for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update", + "description": "Default preview page url for the environment.", "type": "string" }, "workspaceId": { @@ -5060,17 +5063,11 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.folders.create", - "tagmanager.accounts.containers.workspaces.folders.update" - ] - }, - "description": "Folder display name. @mutable tagmanager.accounts.containers.workspaces.folders.create @mutable tagmanager.accounts.containers.workspaces.folders.update", + "description": "Folder display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this folder in the container. @mutable tagmanager.accounts.containers.workspaces.folders.create @mutable tagmanager.accounts.containers.workspaces.folders.update", + "description": "User notes on how to apply this folder in the container.", "type": "string" }, "path": { @@ -5124,6 +5121,10 @@ "description": "Represents the link between a custom template and an entry on the Community Template Gallery site.", "id": "GalleryReference", "properties": { + "galleryTemplateId": { + "description": "ID for the gallery template that is generated once during first sync and travels with the template redirects.", + "type": "string" + }, "host": { "description": "The name of the host for the community gallery template.", "type": "string" @@ -5158,6 +5159,10 @@ "GetContainerSnippetResponse": { "id": "GetContainerSnippetResponse", "properties": { + "containerConfig": { + "description": "Server container config param for manually provisioning a tagging server.", + "type": "string" + }, "snippet": { "description": "Tagging snippet for a Container.", "type": "string" @@ -5207,7 +5212,7 @@ "type": "string" }, "parameter": { - "description": "The Google tag config's parameters. @mutable tagmanager.accounts.containers.workspaces.gtag_config.create @mutable tagmanager.accounts.containers.workspaces.gtag_config.update", + "description": "The Google tag config's parameters.", "items": { "$ref": "Parameter" }, @@ -5222,7 +5227,7 @@ "type": "string" }, "type": { - "description": "Google tag config type. @required tagmanager.accounts.containers.workspaces.gtag_config.create @required tagmanager.accounts.containers.workspaces.gtag_config.update @mutable tagmanager.accounts.containers.workspaces.gtag_config.create @mutable tagmanager.accounts.containers.workspaces.gtag_config.update", + "description": "Google tag config type.", "type": "string" }, "workspaceId": { @@ -5552,39 +5557,29 @@ "id": "Parameter", "properties": { "isWeakReference": { - "description": "Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update", + "description": "Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.", "type": "boolean" }, "key": { - "description": "The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.", "type": "string" }, "list": { - "description": "This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "This list parameter's parameters (keys will be ignored).", "items": { "$ref": "Parameter" }, "type": "array" }, "map": { - "description": "This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "This map parameter's parameters (must have keys; keys must be unique).", "items": { "$ref": "Parameter" }, "type": "array" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.tags.create", - "tagmanager.accounts.containers.workspaces.tags.update", - "tagmanager.accounts.containers.workspaces.triggers.create", - "tagmanager.accounts.containers.workspaces.triggers.update", - "tagmanager.accounts.containers.workspaces.variables.create", - "tagmanager.accounts.containers.workspaces.variables.update" - ] - }, - "description": "The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name ", "enum": [ "typeUnspecified", "template", @@ -5597,7 +5592,7 @@ ], "enumDescriptions": [ "", - "May include variable references (such as \"{{myVariable}}\").", + "May include variable references.", "", "", "", @@ -5608,7 +5603,7 @@ "type": "string" }, "value": { - "description": "A parameter's value (may contain variable references such as \"{{myVariable}}\") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "A parameter's value (may contain variable references). as appropriate to the specified type.", "type": "string" } }, @@ -5805,14 +5800,14 @@ }, "blockingRuleId": { "deprecated": true, - "description": "Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire.", "items": { "type": "string" }, "type": "array" }, "blockingTriggerId": { - "description": "Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.", "items": { "type": "string" }, @@ -5820,7 +5815,7 @@ }, "consentSettings": { "$ref": "TagConsentSetting", - "description": "Consent settings of a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update" + "description": "Consent settings of a tag." }, "containerId": { "description": "GTM Container ID.", @@ -5832,47 +5827,41 @@ }, "firingRuleId": { "deprecated": true, - "description": "Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false.", "items": { "type": "string" }, "type": "array" }, "firingTriggerId": { - "description": "Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.", "items": { "type": "string" }, "type": "array" }, "liveOnly": { - "description": "If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).", "type": "boolean" }, "monitoringMetadata": { "$ref": "Parameter", - "description": "A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes: - This parameter must be type MAP. - Each parameter in the map are type TEMPLATE, however cannot contain variable references. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update" + "description": "A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes: - This parameter must be type MAP. - Each parameter in the map are type TEMPLATE, however cannot contain variable references. " }, "monitoringMetadataTagNameKey": { - "description": "If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified.", "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.tags.create", - "tagmanager.accounts.containers.workspaces.tags.update" - ] - }, - "description": "Tag display name. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "Tag display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "User notes on how to apply this tag in the container.", "type": "string" }, "parameter": { - "description": "The tag's parameters. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "The tag's parameters.", "items": { "$ref": "Parameter" }, @@ -5887,20 +5876,20 @@ "type": "string" }, "paused": { - "description": "Indicates whether the tag is paused, which prevents the tag from firing. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "Indicates whether the tag is paused, which prevents the tag from firing.", "type": "boolean" }, "priority": { "$ref": "Parameter", - "description": "User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update" + "description": "User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0." }, "scheduleEndMs": { - "description": "The end timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "The end timestamp in milliseconds to schedule a tag.", "format": "int64", "type": "string" }, "scheduleStartMs": { - "description": "The start timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "The start timestamp in milliseconds to schedule a tag.", "format": "int64", "type": "string" }, @@ -5943,13 +5932,7 @@ "type": "array" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.tags.create", - "tagmanager.accounts.containers.workspaces.tags.update" - ] - }, - "description": "GTM Tag Type. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update", + "description": "GTM Tag Type.", "type": "string" }, "workspaceId": { @@ -6015,21 +5998,15 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.transformations.create", - "tagmanager.accounts.containers.workspaces.transformations.update" - ] - }, - "description": "Transformation display name. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update", + "description": "Transformation display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this transformation in the container. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update", + "description": "User notes on how to apply this transformation in the container.", "type": "string" }, "parameter": { - "description": "The transformation's parameters. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update", + "description": "The transformation's parameters.", "items": { "$ref": "Parameter" }, @@ -6052,13 +6029,7 @@ "type": "string" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.transformations.create", - "tagmanager.accounts.containers.workspaces.transformations.update" - ] - }, - "description": "Transformation type. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update", + "description": "Transformation type.", "type": "string" }, "workspaceId": { @@ -6077,7 +6048,7 @@ "type": "string" }, "autoEventFilter": { - "description": "Used in the case of auto event tracking. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "Used in the case of auto event tracking.", "items": { "$ref": "Condition" }, @@ -6085,7 +6056,7 @@ }, "checkValidation": { "$ref": "Parameter", - "description": "Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers." }, "containerId": { "description": "GTM Container ID.", @@ -6093,10 +6064,10 @@ }, "continuousTimeMinMilliseconds": { "$ref": "Parameter", - "description": "A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger." }, "customEventFilter": { - "description": "Used in the case of custom event, which is fired iff all Conditions are true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "Used in the case of custom event, which is fired iff all Conditions are true.", "items": { "$ref": "Condition" }, @@ -6104,10 +6075,10 @@ }, "eventName": { "$ref": "Parameter", - "description": "Name of the GTM event that is fired. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "Name of the GTM event that is fired. Only valid for Timer triggers." }, "filter": { - "description": "The trigger will only fire iff all Conditions are true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "The trigger will only fire iff all Conditions are true.", "items": { "$ref": "Condition" }, @@ -6119,40 +6090,34 @@ }, "horizontalScrollPercentageList": { "$ref": "Parameter", - "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers." }, "interval": { "$ref": "Parameter", - "description": "Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers." }, "intervalSeconds": { "$ref": "Parameter", - "description": "Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger." }, "limit": { "$ref": "Parameter", - "description": "Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers." }, "maxTimerLengthSeconds": { "$ref": "Parameter", - "description": "Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger." }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.triggers.create", - "tagmanager.accounts.containers.workspaces.triggers.update" - ] - }, - "description": "Trigger display name. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "Trigger display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this trigger in the container. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "User notes on how to apply this trigger in the container.", "type": "string" }, "parameter": { - "description": "Additional parameters. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "Additional parameters.", "items": { "$ref": "Parameter" }, @@ -6168,7 +6133,7 @@ }, "selector": { "$ref": "Parameter", - "description": "A click trigger CSS selector (i.e. \"a\", \"button\" etc.). Only valid for AMP Click trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "A click trigger CSS selector (i.e. \"a\", \"button\" etc.). Only valid for AMP Click trigger." }, "tagManagerUrl": { "description": "Auto generated link to the tag manager UI", @@ -6176,19 +6141,14 @@ }, "totalTimeMinMilliseconds": { "$ref": "Parameter", - "description": "A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger." }, "triggerId": { "description": "The Trigger ID uniquely identifies the GTM Trigger.", "type": "string" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.triggers.create" - ] - }, - "description": "Defines the data layer event that causes this trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update", + "description": "Defines the data layer event that causes this trigger.", "enum": [ "eventTypeUnspecified", "pageview", @@ -6267,31 +6227,31 @@ }, "uniqueTriggerId": { "$ref": "Parameter", - "description": "Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers." }, "verticalScrollPercentageList": { "$ref": "Parameter", - "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers." }, "visibilitySelector": { "$ref": "Parameter", - "description": "A visibility trigger CSS selector (i.e. \"#id\"). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "A visibility trigger CSS selector (i.e. \"#id\"). Only valid for AMP Visibility trigger." }, "visiblePercentageMax": { "$ref": "Parameter", - "description": "A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger." }, "visiblePercentageMin": { "$ref": "Parameter", - "description": "A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger." }, "waitForTags": { "$ref": "Parameter", - "description": "Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers." }, "waitForTagsTimeout": { "$ref": "Parameter", - "description": "How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update" + "description": "How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers." }, "workspaceId": { "description": "GTM Workspace ID.", @@ -6306,21 +6266,21 @@ "properties": { "accountAccess": { "$ref": "AccountAccess", - "description": "GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update" + "description": "GTM Account access permissions." }, "accountId": { "description": "The Account ID uniquely identifies the GTM Account.", "type": "string" }, "containerAccess": { - "description": "GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update", + "description": "GTM Container access permissions.", "items": { "$ref": "ContainerAccess" }, "type": "array" }, "emailAddress": { - "description": "User's email address. @mutable tagmanager.accounts.permissions.create", + "description": "User's email address.", "type": "string" }, "path": { @@ -6343,14 +6303,14 @@ "type": "string" }, "disablingTriggerId": { - "description": "For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update", + "description": "For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.", "items": { "type": "string" }, "type": "array" }, "enablingTriggerId": { - "description": "For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update", + "description": "For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.", "items": { "type": "string" }, @@ -6365,21 +6325,15 @@ "description": "Option to convert a variable value to other value." }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.variables.create", - "tagmanager.accounts.containers.workspaces.variables.update" - ] - }, - "description": "Variable display name. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update", + "description": "Variable display name.", "type": "string" }, "notes": { - "description": "User notes on how to apply this variable in the container. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update", + "description": "User notes on how to apply this variable in the container.", "type": "string" }, "parameter": { - "description": "The variable's parameters. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update", + "description": "The variable's parameters.", "items": { "$ref": "Parameter" }, @@ -6394,12 +6348,12 @@ "type": "string" }, "scheduleEndMs": { - "description": "The end timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update", + "description": "The end timestamp in milliseconds to schedule a variable.", "format": "int64", "type": "string" }, "scheduleStartMs": { - "description": "The start timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update", + "description": "The start timestamp in milliseconds to schedule a variable.", "format": "int64", "type": "string" }, @@ -6408,13 +6362,7 @@ "type": "string" }, "type": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.variables.create", - "tagmanager.accounts.containers.workspaces.variables.update" - ] - }, - "description": "GTM Variable Type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update", + "description": "GTM Variable Type.", "type": "string" }, "variableId": { @@ -6477,7 +6425,7 @@ "type": "string" }, "description": { - "description": "Workspace description. @mutable tagmanager.accounts.containers.workspaces.create @mutable tagmanager.accounts.containers.workspaces.update", + "description": "Workspace description.", "type": "string" }, "fingerprint": { @@ -6485,13 +6433,7 @@ "type": "string" }, "name": { - "annotations": { - "required": [ - "tagmanager.accounts.containers.workspaces.create", - "tagmanager.accounts.containers.workspaces.update" - ] - }, - "description": "Workspace display name. @mutable tagmanager.accounts.containers.workspaces.create @mutable tagmanager.accounts.containers.workspaces.update", + "description": "Workspace display name.", "type": "string" }, "path": { diff --git a/src/apis/tagmanager/v1.ts b/src/apis/tagmanager/v1.ts index bf2d2cf5e76..74dd01efdb6 100644 --- a/src/apis/tagmanager/v1.ts +++ b/src/apis/tagmanager/v1.ts @@ -137,11 +137,11 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update + * Account display name. */ name?: string | null; /** - * Whether the account shares data anonymously with Google and others. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update + * Whether the account shares data anonymously with Google and others. */ shareData?: boolean | null; } @@ -150,7 +150,7 @@ export namespace tagmanager_v1 { */ export interface Schema$AccountAccess { /** - * List of Account permissions. Valid account permissions are read and manage. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * List of Account permissions. Valid account permissions are read and manage. */ permission?: string[] | null; } @@ -159,11 +159,11 @@ export namespace tagmanager_v1 { */ export interface Schema$Condition { /** - * A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. */ parameter?: Schema$Parameter[]; /** - * The type of operator for this condition. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * The type of operator for this condition. */ type?: string | null; } @@ -180,11 +180,11 @@ export namespace tagmanager_v1 { */ containerId?: string | null; /** - * Optional list of domain names associated with the Container. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * Optional list of domain names associated with the Container. */ domainName?: string[] | null; /** - * List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId. */ enabledBuiltInVariable?: string[] | null; /** @@ -192,11 +192,11 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Container display name. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * Container display name. */ name?: string | null; /** - * Container Notes. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * Container Notes. */ notes?: string | null; /** @@ -204,15 +204,15 @@ export namespace tagmanager_v1 { */ publicId?: string | null; /** - * Container Country ID. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * Container Country ID. */ timeZoneCountryId?: string | null; /** - * Container Time Zone ID. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * Container Time Zone ID. */ timeZoneId?: string | null; /** - * List of Usage Contexts for the Container. Valid values include: web, android, ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * List of Usage Contexts for the Container. Valid values include: web, android, ios. */ usageContext?: string[] | null; } @@ -221,11 +221,11 @@ export namespace tagmanager_v1 { */ export interface Schema$ContainerAccess { /** - * GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * GTM Container ID. */ containerId?: string | null; /** - * List of Container permissions. Valid container permissions are: read, edit, delete, publish. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * List of Container permissions. Valid container permissions are: read, edit, delete, publish. */ permission?: string[] | null; } @@ -266,11 +266,11 @@ export namespace tagmanager_v1 { */ macro?: Schema$Macro[]; /** - * Container version display name. @mutable tagmanager.accounts.containers.versions.update + * Container version display name. */ name?: string | null; /** - * User notes on how to apply this container version in the container. @mutable tagmanager.accounts.containers.versions.update + * User notes on how to apply this container version in the container. */ notes?: string | null; /** @@ -387,11 +387,11 @@ export namespace tagmanager_v1 { containerId?: string | null; containerVersionId?: string | null; /** - * The environment description. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update + * The environment description. Can be set or changed only on USER type environments. */ description?: string | null; /** - * Whether or not to enable debug by default on for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update + * Whether or not to enable debug by default on for the environment. */ enableDebug?: boolean | null; /** @@ -403,7 +403,7 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * The environment display name. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update + * The environment display name. Can be set or changed only on USER type environments. */ name?: string | null; /** @@ -411,7 +411,7 @@ export namespace tagmanager_v1 { */ type?: string | null; /** - * Default preview page url for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update + * Default preview page url for the environment. */ url?: string | null; } @@ -436,7 +436,7 @@ export namespace tagmanager_v1 { */ folderId?: string | null; /** - * Folder display name. @mutable tagmanager.accounts.containers.folders.create @mutable tagmanager.accounts.containers.folders.update + * Folder display name. */ name?: string | null; } @@ -555,11 +555,11 @@ export namespace tagmanager_v1 { */ containerId?: string | null; /** - * For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update + * For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. */ disablingRuleId?: string[] | null; /** - * For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update + * For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. */ enablingRuleId?: string[] | null; /** @@ -571,15 +571,15 @@ export namespace tagmanager_v1 { */ macroId?: string | null; /** - * Macro display name. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update + * Macro display name. */ name?: string | null; /** - * User notes on how to apply this macro in the container. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update + * User notes on how to apply this macro in the container. */ notes?: string | null; /** - * The macro's parameters. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update + * The macro's parameters. */ parameter?: Schema$Parameter[]; /** @@ -587,15 +587,15 @@ export namespace tagmanager_v1 { */ parentFolderId?: string | null; /** - * The end timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update + * The end timestamp in milliseconds to schedule a macro. */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update + * The start timestamp in milliseconds to schedule a macro. */ scheduleStartMs?: string | null; /** - * GTM Macro Type. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update + * GTM Macro Type. */ type?: string | null; } @@ -604,23 +604,23 @@ export namespace tagmanager_v1 { */ export interface Schema$Parameter { /** - * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. */ key?: string | null; /** - * This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * This list parameter's parameters (keys will be ignored). */ list?: Schema$Parameter[]; /** - * This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * This map parameter's parameters (must have keys; keys must be unique). */ map?: Schema$Parameter[]; /** - * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name */ type?: string | null; /** - * A parameter's value (may contain variable references such as "{{myVariable\}\}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * A parameter's value (may contain variable references). as appropriate to the specified type. */ value?: string | null; } @@ -646,7 +646,7 @@ export namespace tagmanager_v1 { */ accountId?: string | null; /** - * The list of conditions that make up this rule (implicit AND between them). @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update + * The list of conditions that make up this rule (implicit AND between them). */ condition?: Schema$Condition[]; /** @@ -658,11 +658,11 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Rule display name. @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update + * Rule display name. */ name?: string | null; /** - * User notes on how to apply this rule in the container. @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update + * User notes on how to apply this rule in the container. */ notes?: string | null; /** @@ -689,11 +689,11 @@ export namespace tagmanager_v1 { */ accountId?: string | null; /** - * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. */ blockingRuleId?: string[] | null; /** - * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. */ blockingTriggerId?: string[] | null; /** @@ -705,27 +705,27 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. */ firingRuleId?: string[] | null; /** - * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. */ firingTriggerId?: string[] | null; /** - * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). */ liveOnly?: boolean | null; /** - * Tag display name. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * Tag display name. */ name?: string | null; /** - * User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * User notes on how to apply this tag in the container. */ notes?: string | null; /** - * The tag's parameters. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * The tag's parameters. */ parameter?: Schema$Parameter[]; /** @@ -733,19 +733,19 @@ export namespace tagmanager_v1 { */ parentFolderId?: string | null; /** - * True if the tag is paused. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * True if the tag is paused. */ paused?: boolean | null; /** - * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. */ priority?: Schema$Parameter; /** - * The end timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * The end timestamp in milliseconds to schedule a tag. */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * The start timestamp in milliseconds to schedule a tag. */ scheduleStartMs?: string | null; /** @@ -765,7 +765,7 @@ export namespace tagmanager_v1 { */ teardownTag?: Schema$TeardownTag[]; /** - * GTM Tag Type. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update + * GTM Tag Type. */ type?: string | null; } @@ -788,11 +788,11 @@ export namespace tagmanager_v1 { */ accountId?: string | null; /** - * Used in the case of auto event tracking. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Used in the case of auto event tracking. */ autoEventFilter?: Schema$Condition[]; /** - * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. */ checkValidation?: Schema$Parameter; /** @@ -800,19 +800,19 @@ export namespace tagmanager_v1 { */ containerId?: string | null; /** - * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. */ continuousTimeMinMilliseconds?: Schema$Parameter; /** - * Used in the case of custom event, which is fired iff all Conditions are true. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Used in the case of custom event, which is fired iff all Conditions are true. */ customEventFilter?: Schema$Condition[]; /** - * Name of the GTM event that is fired. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Name of the GTM event that is fired. Only valid for Timer triggers. */ eventName?: Schema$Parameter; /** - * The trigger will only fire iff all Conditions are true. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * The trigger will only fire iff all Conditions are true. */ filter?: Schema$Condition[]; /** @@ -820,31 +820,31 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. */ horizontalScrollPercentageList?: Schema$Parameter; /** - * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. */ interval?: Schema$Parameter; /** - * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. */ intervalSeconds?: Schema$Parameter; /** - * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. */ limit?: Schema$Parameter; /** - * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. */ maxTimerLengthSeconds?: Schema$Parameter; /** - * Trigger display name. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Trigger display name. */ name?: string | null; /** - * Additional parameters. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Additional parameters. */ parameter?: Schema$Parameter[]; /** @@ -852,11 +852,11 @@ export namespace tagmanager_v1 { */ parentFolderId?: string | null; /** - * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. */ selector?: Schema$Parameter; /** - * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. */ totalTimeMinMilliseconds?: Schema$Parameter; /** @@ -864,35 +864,35 @@ export namespace tagmanager_v1 { */ triggerId?: string | null; /** - * Defines the data layer event that causes this trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Defines the data layer event that causes this trigger. */ type?: string | null; /** - * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. */ uniqueTriggerId?: Schema$Parameter; /** - * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. */ verticalScrollPercentageList?: Schema$Parameter; /** - * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. */ visibilitySelector?: Schema$Parameter; /** - * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. */ visiblePercentageMax?: Schema$Parameter; /** - * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. */ visiblePercentageMin?: Schema$Parameter; /** - * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. */ waitForTags?: Schema$Parameter; /** - * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update + * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. */ waitForTagsTimeout?: Schema$Parameter; } @@ -901,7 +901,7 @@ export namespace tagmanager_v1 { */ export interface Schema$UserAccess { /** - * GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * GTM Account access permissions. */ accountAccess?: Schema$AccountAccess; /** @@ -909,11 +909,11 @@ export namespace tagmanager_v1 { */ accountId?: string | null; /** - * GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * GTM Container access permissions. */ containerAccess?: Schema$ContainerAccess[]; /** - * User's email address. @mutable tagmanager.accounts.permissions.create + * User's email address. */ emailAddress?: string | null; /** @@ -934,11 +934,11 @@ export namespace tagmanager_v1 { */ containerId?: string | null; /** - * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update + * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. */ disablingTriggerId?: string[] | null; /** - * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update + * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. */ enablingTriggerId?: string[] | null; /** @@ -946,15 +946,15 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Variable display name. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update + * Variable display name. */ name?: string | null; /** - * User notes on how to apply this variable in the container. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update + * User notes on how to apply this variable in the container. */ notes?: string | null; /** - * The variable's parameters. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update + * The variable's parameters. */ parameter?: Schema$Parameter[]; /** @@ -962,15 +962,15 @@ export namespace tagmanager_v1 { */ parentFolderId?: string | null; /** - * The end timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update + * The end timestamp in milliseconds to schedule a variable. */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update + * The start timestamp in milliseconds to schedule a variable. */ scheduleStartMs?: string | null; /** - * GTM Variable Type. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update + * GTM Variable Type. */ type?: string | null; /** diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 44a1b64aee8..6526485e360 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -141,7 +141,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update + * Account display name. */ name?: string | null; /** @@ -149,7 +149,7 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update + * Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. */ shareData?: boolean | null; /** @@ -162,7 +162,7 @@ export namespace tagmanager_v2 { */ export interface Schema$AccountAccess { /** - * Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * Whether the user has no access, user access, or admin access to an account. */ permission?: string | null; } @@ -197,7 +197,7 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * Type of built-in variable. @required.tagmanager.accounts.containers.workspaces.built_in_variable.update @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update + * Type of built-in variable. */ type?: string | null; /** @@ -223,15 +223,15 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Client display name. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update + * Client display name. */ name?: string | null; /** - * User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * User notes on how to apply this tag in the container. */ notes?: string | null; /** - * The client's parameters. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update + * The client's parameters. */ parameter?: Schema$Parameter[]; /** @@ -243,7 +243,7 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * Priority determines relative firing order. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update + * Priority determines relative firing order. */ priority?: number | null; /** @@ -251,7 +251,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string | null; /** - * Client type. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update + * Client type. */ type?: string | null; /** @@ -264,11 +264,11 @@ export namespace tagmanager_v2 { */ export interface Schema$Condition { /** - * A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. */ parameter?: Schema$Parameter[]; /** - * The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * The type of operator for this condition. */ type?: string | null; } @@ -285,7 +285,7 @@ export namespace tagmanager_v2 { */ containerId?: string | null; /** - * List of domain names associated with the Container. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * List of domain names associated with the Container. */ domainName?: string[] | null; /** @@ -297,11 +297,11 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Container display name. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * Container display name. */ name?: string | null; /** - * Container Notes. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * Container Notes. */ notes?: string | null; /** @@ -313,7 +313,7 @@ export namespace tagmanager_v2 { */ publicId?: string | null; /** - * List of server-side container URLs for the Container. If multiple URLs are provided, all URL paths must match. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * List of server-side container URLs for the Container. If multiple URLs are provided, all URL paths must match. */ taggingServerUrls?: string[] | null; /** @@ -325,7 +325,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string | null; /** - * List of Usage Contexts for the Container. Valid values include: web, android, or ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update + * List of Usage Contexts for the Container. Valid values include: web, android, or ios. */ usageContext?: string[] | null; } @@ -334,11 +334,11 @@ export namespace tagmanager_v2 { */ export interface Schema$ContainerAccess { /** - * GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * GTM Container ID. */ containerId?: string | null; /** - * List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * List of Container permissions. */ permission?: string | null; } @@ -437,7 +437,7 @@ export namespace tagmanager_v2 { */ deleted?: boolean | null; /** - * Container version description. @mutable tagmanager.accounts.containers.versions.update + * Container version description. */ description?: string | null; /** @@ -453,7 +453,7 @@ export namespace tagmanager_v2 { */ gtagConfig?: Schema$GtagConfig[]; /** - * Container version display name. @mutable tagmanager.accounts.containers.versions.update + * Container version display name. */ name?: string | null; /** @@ -750,11 +750,11 @@ export namespace tagmanager_v2 { */ containerVersionId?: string | null; /** - * The environment description. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update + * The environment description. Can be set or changed only on USER type environments. */ description?: string | null; /** - * Whether or not to enable debug by default for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update + * Whether or not to enable debug by default for the environment. */ enableDebug?: boolean | null; /** @@ -766,7 +766,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * The environment display name. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update + * The environment display name. Can be set or changed only on USER type environments. */ name?: string | null; /** @@ -782,7 +782,7 @@ export namespace tagmanager_v2 { */ type?: string | null; /** - * Default preview page url for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update + * Default preview page url for the environment. */ url?: string | null; /** @@ -811,11 +811,11 @@ export namespace tagmanager_v2 { */ folderId?: string | null; /** - * Folder display name. @mutable tagmanager.accounts.containers.workspaces.folders.create @mutable tagmanager.accounts.containers.workspaces.folders.update + * Folder display name. */ name?: string | null; /** - * User notes on how to apply this folder in the container. @mutable tagmanager.accounts.containers.workspaces.folders.create @mutable tagmanager.accounts.containers.workspaces.folders.update + * User notes on how to apply this folder in the container. */ notes?: string | null; /** @@ -856,6 +856,10 @@ export namespace tagmanager_v2 { * Represents the link between a custom template and an entry on the Community Template Gallery site. */ export interface Schema$GalleryReference { + /** + * ID for the gallery template that is generated once during first sync and travels with the template redirects. + */ + galleryTemplateId?: string | null; /** * The name of the host for the community gallery template. */ @@ -886,6 +890,10 @@ export namespace tagmanager_v2 { version?: string | null; } export interface Schema$GetContainerSnippetResponse { + /** + * Server container config param for manually provisioning a tagging server. + */ + containerConfig?: string | null; /** * Tagging snippet for a Container. */ @@ -925,7 +933,7 @@ export namespace tagmanager_v2 { */ gtagConfigId?: string | null; /** - * The Google tag config's parameters. @mutable tagmanager.accounts.containers.workspaces.gtag_config.create @mutable tagmanager.accounts.containers.workspaces.gtag_config.update + * The Google tag config's parameters. */ parameter?: Schema$Parameter[]; /** @@ -937,7 +945,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string | null; /** - * Google tag config type. @required tagmanager.accounts.containers.workspaces.gtag_config.create @required tagmanager.accounts.containers.workspaces.gtag_config.update @mutable tagmanager.accounts.containers.workspaces.gtag_config.create @mutable tagmanager.accounts.containers.workspaces.gtag_config.update + * Google tag config type. */ type?: string | null; /** @@ -1166,27 +1174,27 @@ export namespace tagmanager_v2 { */ export interface Schema$Parameter { /** - * Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update + * Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. */ isWeakReference?: boolean | null; /** - * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. */ key?: string | null; /** - * This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * This list parameter's parameters (keys will be ignored). */ list?: Schema$Parameter[]; /** - * This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * This map parameter's parameters (must have keys; keys must be unique). */ map?: Schema$Parameter[]; /** - * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name */ type?: string | null; /** - * A parameter's value (may contain variable references such as "{{myVariable\}\}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * A parameter's value (may contain variable references). as appropriate to the specified type. */ value?: string | null; } @@ -1349,15 +1357,15 @@ export namespace tagmanager_v2 { */ accountId?: string | null; /** - * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. */ blockingRuleId?: string[] | null; /** - * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. */ blockingTriggerId?: string[] | null; /** - * Consent settings of a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * Consent settings of a tag. */ consentSettings?: Schema$TagConsentSetting; /** @@ -1369,35 +1377,35 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. */ firingRuleId?: string[] | null; /** - * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. */ firingTriggerId?: string[] | null; /** - * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). */ liveOnly?: boolean | null; /** - * A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes: - This parameter must be type MAP. - Each parameter in the map are type TEMPLATE, however cannot contain variable references. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes: - This parameter must be type MAP. - Each parameter in the map are type TEMPLATE, however cannot contain variable references. */ monitoringMetadata?: Schema$Parameter; /** - * If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified. */ monitoringMetadataTagNameKey?: string | null; /** - * Tag display name. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * Tag display name. */ name?: string | null; /** - * User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * User notes on how to apply this tag in the container. */ notes?: string | null; /** - * The tag's parameters. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * The tag's parameters. */ parameter?: Schema$Parameter[]; /** @@ -1409,19 +1417,19 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * Indicates whether the tag is paused, which prevents the tag from firing. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * Indicates whether the tag is paused, which prevents the tag from firing. */ paused?: boolean | null; /** - * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. */ priority?: Schema$Parameter; /** - * The end timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * The end timestamp in milliseconds to schedule a tag. */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * The start timestamp in milliseconds to schedule a tag. */ scheduleStartMs?: string | null; /** @@ -1445,7 +1453,7 @@ export namespace tagmanager_v2 { */ teardownTag?: Schema$TeardownTag[]; /** - * GTM Tag Type. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + * GTM Tag Type. */ type?: string | null; /** @@ -1493,15 +1501,15 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Transformation display name. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update + * Transformation display name. */ name?: string | null; /** - * User notes on how to apply this transformation in the container. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update + * User notes on how to apply this transformation in the container. */ notes?: string | null; /** - * The transformation's parameters. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update + * The transformation's parameters. */ parameter?: Schema$Parameter[]; /** @@ -1521,7 +1529,7 @@ export namespace tagmanager_v2 { */ transformationId?: string | null; /** - * Transformation type. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update + * Transformation type. */ type?: string | null; /** @@ -1538,11 +1546,11 @@ export namespace tagmanager_v2 { */ accountId?: string | null; /** - * Used in the case of auto event tracking. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Used in the case of auto event tracking. */ autoEventFilter?: Schema$Condition[]; /** - * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. */ checkValidation?: Schema$Parameter; /** @@ -1550,19 +1558,19 @@ export namespace tagmanager_v2 { */ containerId?: string | null; /** - * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. */ continuousTimeMinMilliseconds?: Schema$Parameter; /** - * Used in the case of custom event, which is fired iff all Conditions are true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Used in the case of custom event, which is fired iff all Conditions are true. */ customEventFilter?: Schema$Condition[]; /** - * Name of the GTM event that is fired. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Name of the GTM event that is fired. Only valid for Timer triggers. */ eventName?: Schema$Parameter; /** - * The trigger will only fire iff all Conditions are true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * The trigger will only fire iff all Conditions are true. */ filter?: Schema$Condition[]; /** @@ -1570,35 +1578,35 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. */ horizontalScrollPercentageList?: Schema$Parameter; /** - * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. */ interval?: Schema$Parameter; /** - * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. */ intervalSeconds?: Schema$Parameter; /** - * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. */ limit?: Schema$Parameter; /** - * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. */ maxTimerLengthSeconds?: Schema$Parameter; /** - * Trigger display name. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Trigger display name. */ name?: string | null; /** - * User notes on how to apply this trigger in the container. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * User notes on how to apply this trigger in the container. */ notes?: string | null; /** - * Additional parameters. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Additional parameters. */ parameter?: Schema$Parameter[]; /** @@ -1610,7 +1618,7 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. */ selector?: Schema$Parameter; /** @@ -1618,7 +1626,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string | null; /** - * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. */ totalTimeMinMilliseconds?: Schema$Parameter; /** @@ -1626,35 +1634,35 @@ export namespace tagmanager_v2 { */ triggerId?: string | null; /** - * Defines the data layer event that causes this trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Defines the data layer event that causes this trigger. */ type?: string | null; /** - * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. */ uniqueTriggerId?: Schema$Parameter; /** - * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. */ verticalScrollPercentageList?: Schema$Parameter; /** - * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. */ visibilitySelector?: Schema$Parameter; /** - * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. */ visiblePercentageMax?: Schema$Parameter; /** - * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. */ visiblePercentageMin?: Schema$Parameter; /** - * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. */ waitForTags?: Schema$Parameter; /** - * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update + * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. */ waitForTagsTimeout?: Schema$Parameter; /** @@ -1667,7 +1675,7 @@ export namespace tagmanager_v2 { */ export interface Schema$UserPermission { /** - * GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * GTM Account access permissions. */ accountAccess?: Schema$AccountAccess; /** @@ -1675,11 +1683,11 @@ export namespace tagmanager_v2 { */ accountId?: string | null; /** - * GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update + * GTM Container access permissions. */ containerAccess?: Schema$ContainerAccess[]; /** - * User's email address. @mutable tagmanager.accounts.permissions.create + * User's email address. */ emailAddress?: string | null; /** @@ -1700,11 +1708,11 @@ export namespace tagmanager_v2 { */ containerId?: string | null; /** - * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update + * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. */ disablingTriggerId?: string[] | null; /** - * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update + * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. */ enablingTriggerId?: string[] | null; /** @@ -1716,15 +1724,15 @@ export namespace tagmanager_v2 { */ formatValue?: Schema$VariableFormatValue; /** - * Variable display name. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update + * Variable display name. */ name?: string | null; /** - * User notes on how to apply this variable in the container. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update + * User notes on how to apply this variable in the container. */ notes?: string | null; /** - * The variable's parameters. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update + * The variable's parameters. */ parameter?: Schema$Parameter[]; /** @@ -1736,11 +1744,11 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * The end timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update + * The end timestamp in milliseconds to schedule a variable. */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update + * The start timestamp in milliseconds to schedule a variable. */ scheduleStartMs?: string | null; /** @@ -1748,7 +1756,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string | null; /** - * GTM Variable Type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update + * GTM Variable Type. */ type?: string | null; /** @@ -1795,7 +1803,7 @@ export namespace tagmanager_v2 { */ containerId?: string | null; /** - * Workspace description. @mutable tagmanager.accounts.containers.workspaces.create @mutable tagmanager.accounts.containers.workspaces.update + * Workspace description. */ description?: string | null; /** @@ -1803,7 +1811,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Workspace display name. @mutable tagmanager.accounts.containers.workspaces.create @mutable tagmanager.accounts.containers.workspaces.update + * Workspace display name. */ name?: string | null; /** @@ -2193,7 +2201,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Get extends StandardParameters { /** - * GTM Account's API relative path. Example: accounts/{account_id\} + * GTM Account's API relative path. */ path?: string; } @@ -2213,7 +2221,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Account's API relative path. Example: accounts/{account_id\} + * GTM Account's API relative path. */ path?: string; @@ -3060,7 +3068,7 @@ export namespace tagmanager_v2 { */ containerId?: string; /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ path?: string; /** @@ -3071,7 +3079,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Create extends StandardParameters { /** - * GTM Account's API relative path. Example: accounts/{account_id\}. + * GTM Account's API relative path. */ parent?: string; @@ -3083,14 +3091,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Delete extends StandardParameters { /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Get extends StandardParameters { /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ path?: string; } @@ -3101,18 +3109,18 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Account's API relative path. Example: accounts/{account_id\}. + * GTM Account's API relative path. */ parent?: string; } 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\}. Only one of destination_id or tag_id should be set. + * Destination ID linked to a GTM Container, e.g. AW-123456789. 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. + * Tag ID for a GTM Container, e.g. GTM-123456789. Only one of destination_id or tag_id should be set. */ tagId?: string; } @@ -3135,7 +3143,7 @@ export namespace tagmanager_v2 { */ copyUsers?: boolean; /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ path?: string; /** @@ -3150,7 +3158,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Snippet extends StandardParameters { /** - * Container snippet's API relative path. Example: accounts/{account_id\}/containers/{container_id\}:snippet + * Container snippet's API relative path. */ path?: string; } @@ -3161,7 +3169,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ path?: string; @@ -3449,7 +3457,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Destinations$Get extends StandardParameters { /** - * Google Tag Destination's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/destinations/{destination_link_id\} + * Google Tag Destination's API relative path. */ path?: string; } @@ -3464,14 +3472,14 @@ export namespace tagmanager_v2 { */ destinationId?: string; /** - * GTM parent Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM parent Container's API relative path. */ parent?: string; } export interface Params$Resource$Accounts$Containers$Destinations$List extends StandardParameters { /** - * GTM parent Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM parent Container's API relative path. */ parent?: string; } @@ -4018,7 +4026,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Environments$Create extends StandardParameters { /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ parent?: string; @@ -4030,14 +4038,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Environments$Delete extends StandardParameters { /** - * GTM Environment's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/environments/{environment_id\} + * GTM Environment's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Environments$Get extends StandardParameters { /** - * GTM Environment's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/environments/{environment_id\} + * GTM Environment's API relative path. */ path?: string; } @@ -4048,14 +4056,14 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ parent?: string; } export interface Params$Resource$Accounts$Containers$Environments$Reauthorize extends StandardParameters { /** - * GTM Environment's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/environments/{environment_id\} + * GTM Environment's API relative path. */ path?: string; @@ -4071,7 +4079,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Environment's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/environments/{environment_id\} + * GTM Environment's API relative path. */ path?: string; @@ -4714,7 +4722,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Versions$Delete extends StandardParameters { /** - * GTM ContainerVersion's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/versions/{version_id\} + * GTM ContainerVersion's API relative path. */ path?: string; } @@ -4725,14 +4733,14 @@ export namespace tagmanager_v2 { */ containerVersionId?: string; /** - * GTM ContainerVersion's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/versions/{version_id\} + * GTM ContainerVersion's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Versions$Live extends StandardParameters { /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ parent?: string; } @@ -4743,21 +4751,21 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM ContainerVersion's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/versions/{version_id\} + * GTM ContainerVersion's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Versions$Set_latest extends StandardParameters { /** - * GTM ContainerVersion's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/versions/{version_id\} + * GTM ContainerVersion's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Versions$Undelete extends StandardParameters { /** - * GTM ContainerVersion's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/versions/{version_id\} + * GTM ContainerVersion's API relative path. */ path?: string; } @@ -4768,7 +4776,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM ContainerVersion's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/versions/{version_id\} + * GTM ContainerVersion's API relative path. */ path?: string; @@ -4978,7 +4986,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Version_headers$Latest extends StandardParameters { /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ parent?: string; } @@ -4993,7 +5001,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM Container's API relative path. */ parent?: string; } @@ -5961,7 +5969,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Create extends StandardParameters { /** - * GTM parent Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM parent Container's API relative path. */ parent?: string; @@ -5973,7 +5981,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Create_version extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ path?: string; @@ -5985,21 +5993,21 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Delete extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Get extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Getstatus extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ path?: string; } @@ -6010,14 +6018,14 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM parent Container's API relative path. Example: accounts/{account_id\}/containers/{container_id\} + * GTM parent Container's API relative path. */ parent?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Quick_preview extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ path?: string; } @@ -6028,7 +6036,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ path?: string; @@ -6040,7 +6048,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Sync extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ path?: string; } @@ -6051,7 +6059,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ path?: string; @@ -6449,7 +6457,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; /** @@ -6460,7 +6468,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Delete extends StandardParameters { /** - * GTM BuiltInVariable's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/built_in_variables + * GTM BuiltInVariable's API relative path. */ path?: string; /** @@ -6475,14 +6483,14 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Revert extends StandardParameters { /** - * GTM BuiltInVariable's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/built_in_variables + * GTM BuiltInVariable's API relative path. */ path?: string; /** @@ -7041,7 +7049,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Clients$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; @@ -7053,14 +7061,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Clients$Delete extends StandardParameters { /** - * GTM Client's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/clients/{client_id\} + * GTM Client's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Clients$Get extends StandardParameters { /** - * GTM Client's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/clients/{client_id\} + * GTM Client's API relative path. */ path?: string; } @@ -7071,7 +7079,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } @@ -7082,7 +7090,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Client's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/clients/{client_id\} + * GTM Client's API relative path. */ path?: string; } @@ -7093,7 +7101,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Client's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/clients/{client_id\} + * GTM Client's API relative path. */ path?: string; @@ -7828,7 +7836,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; @@ -7840,7 +7848,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Delete extends StandardParameters { /** - * GTM Folder's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/folders/{folder_id\} + * GTM Folder's API relative path. */ path?: string; } @@ -7851,14 +7859,14 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Folder's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/folders/{folder_id\} + * GTM Folder's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Get extends StandardParameters { /** - * GTM Folder's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/folders/{folder_id\} + * GTM Folder's API relative path. */ path?: string; } @@ -7869,14 +7877,14 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Move_entities_to_folder extends StandardParameters { /** - * GTM Folder's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/folders/{folder_id\} + * GTM Folder's API relative path. */ path?: string; /** @@ -7904,7 +7912,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Folder's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/folders/{folder_id\} + * GTM Folder's API relative path. */ path?: string; } @@ -7915,7 +7923,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Folder's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/folders/{folder_id\} + * GTM Folder's API relative path. */ path?: string; @@ -8383,7 +8391,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Gtag_config$Create extends StandardParameters { /** - * Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * Workspace's API relative path. */ parent?: string; @@ -8395,14 +8403,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Gtag_config$Delete extends StandardParameters { /** - * Google tag config's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/gtag_config/{gtag_config_id\} + * Google tag config's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Gtag_config$Get extends StandardParameters { /** - * Google tag config's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/gtag_config/{gtag_config_id\} + * Google tag config's API relative path. */ path?: string; } @@ -8413,7 +8421,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * Workspace's API relative path. */ parent?: string; } @@ -8424,7 +8432,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * Google tag config's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/gtag_config/{gtag_config_id\} + * Google tag config's API relative path. */ path?: string; @@ -8977,7 +8985,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; @@ -8989,14 +8997,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Delete extends StandardParameters { /** - * GTM Tag's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/tags/{tag_id\} + * GTM Tag's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Get extends StandardParameters { /** - * GTM Tag's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/tags/{tag_id\} + * GTM Tag's API relative path. */ path?: string; } @@ -9007,7 +9015,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } @@ -9018,7 +9026,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Tag's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/tags/{tag_id\} + * GTM Tag's API relative path. */ path?: string; } @@ -9029,7 +9037,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Tag's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/tags/{tag_id\} + * GTM Tag's API relative path. */ path?: string; @@ -9310,6 +9318,96 @@ export namespace tagmanager_v2 { } } + /** + * Imports a GTM Custom Template from Gallery. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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_from_gallery( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery, + options: StreamMethodOptions + ): GaxiosPromise; + import_from_gallery( + params?: Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery, + options?: MethodOptions + ): GaxiosPromise; + import_from_gallery( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import_from_gallery( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import_from_gallery( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery, + callback: BodyResponseCallback + ): void; + import_from_gallery( + callback: BodyResponseCallback + ): void; + import_from_gallery( + paramsOrCallback?: + | Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://tagmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/tagmanager/v2/{+parent}/templates:import_from_gallery' + ).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); + } + } + /** * Lists all GTM Templates of a GTM container workspace. * @@ -9591,7 +9689,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; @@ -9603,17 +9701,40 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Delete extends StandardParameters { /** - * GTM Custom Template's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/templates/{template_id\} + * GTM Custom Template's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Get extends StandardParameters { /** - * GTM Custom Template's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/templates/{template_id\} + * GTM Custom Template's API relative path. */ path?: string; } + export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Import_from_gallery + extends StandardParameters { + /** + * Must be set to true to allow Gallery template to be imported into the workspace. If this bit is false, the import operation will fail. + */ + acknowledgePermissions?: boolean; + /** + * Owner of the Gallery template to import + */ + galleryOwner?: string; + /** + * Repository of the Gallery template to import + */ + galleryRepository?: string; + /** + * SHA version of the Gallery template to import. Defaulted to the latest SHA version if not provided. + */ + gallerySha?: string; + /** + * GTM Workspace's API relative path. + */ + parent?: string; + } export interface Params$Resource$Accounts$Containers$Workspaces$Templates$List extends StandardParameters { /** @@ -9621,7 +9742,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } @@ -9632,7 +9753,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Custom Template's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/templates/{template_id\} + * GTM Custom Template's API relative path. */ path?: string; } @@ -9643,7 +9764,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Custom Template's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/templates/{template_id\} + * GTM Custom Template's API relative path. */ path?: string; @@ -10211,7 +10332,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Transformations$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; @@ -10223,14 +10344,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Transformations$Delete extends StandardParameters { /** - * GTM Transformation's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/transformations/{transformation_id\} + * GTM Transformation's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Transformations$Get extends StandardParameters { /** - * GTM Transformation's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/transformations/{transformation_id\} + * GTM Transformation's API relative path. */ path?: string; } @@ -10241,7 +10362,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } @@ -10252,7 +10373,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Transformation's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/transformations/{transformation_id\} + * GTM Transformation's API relative path. */ path?: string; } @@ -10263,7 +10384,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Transformation's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/transformations/{transformation_id\} + * GTM Transformation's API relative path. */ path?: string; @@ -10825,7 +10946,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; @@ -10837,14 +10958,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Delete extends StandardParameters { /** - * GTM Trigger's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/triggers/{trigger_id\} + * GTM Trigger's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Get extends StandardParameters { /** - * GTM Trigger's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/triggers/{trigger_id\} + * GTM Trigger's API relative path. */ path?: string; } @@ -10855,7 +10976,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } @@ -10866,7 +10987,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Trigger's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/triggers/{trigger_id\} + * GTM Trigger's API relative path. */ path?: string; } @@ -10877,7 +10998,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Trigger's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/triggers/{trigger_id\} + * GTM Trigger's API relative path. */ path?: string; @@ -11439,7 +11560,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; @@ -11451,14 +11572,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Delete extends StandardParameters { /** - * GTM Variable's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/variables/{variable_id\} + * GTM Variable's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Get extends StandardParameters { /** - * GTM Variable's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/variables/{variable_id\} + * GTM Variable's API relative path. */ path?: string; } @@ -11469,7 +11590,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } @@ -11480,7 +11601,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Variable's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/variables/{variable_id\} + * GTM Variable's API relative path. */ path?: string; } @@ -11491,7 +11612,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Variable's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/variables/{variable_id\} + * GTM Variable's API relative path. */ path?: string; @@ -12048,7 +12169,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Zones$Create extends StandardParameters { /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; @@ -12060,14 +12181,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Workspaces$Zones$Delete extends StandardParameters { /** - * GTM Zone's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/zones/{zone_id\} + * GTM Zone's API relative path. */ path?: string; } export interface Params$Resource$Accounts$Containers$Workspaces$Zones$Get extends StandardParameters { /** - * GTM Zone's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/zones/{zone_id\} + * GTM Zone's API relative path. */ path?: string; } @@ -12078,7 +12199,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Workspace's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\} + * GTM Workspace's API relative path. */ parent?: string; } @@ -12089,7 +12210,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Zone's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/zones/{zone_id\} + * GTM Zone's API relative path. */ path?: string; } @@ -12100,7 +12221,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string; /** - * GTM Zone's API relative path. Example: accounts/{account_id\}/containers/{container_id\}/workspaces/{workspace_id\}/zones/{zone_id\} + * GTM Zone's API relative path. */ path?: string; @@ -12563,7 +12684,7 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$User_permissions$Create extends StandardParameters { /** - * GTM Account's API relative path. Example: accounts/{account_id\} + * GTM Account's API relative path. */ parent?: string; @@ -12575,14 +12696,14 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$User_permissions$Delete extends StandardParameters { /** - * GTM UserPermission's API relative path. Example: accounts/{account_id\}/user_permissions/{user_permission_id\} + * GTM UserPermission's API relative path. */ path?: string; } export interface Params$Resource$Accounts$User_permissions$Get extends StandardParameters { /** - * GTM UserPermission's API relative path. Example: accounts/{account_id\}/user_permissions/{user_permission_id\} + * GTM UserPermission's API relative path. */ path?: string; } @@ -12593,14 +12714,14 @@ export namespace tagmanager_v2 { */ pageToken?: string; /** - * GTM Account's API relative path. Example: accounts/{account_id\} + * GTM Account's API relative path. */ parent?: string; } export interface Params$Resource$Accounts$User_permissions$Update extends StandardParameters { /** - * GTM UserPermission's API relative path. Example: accounts/{account_id\}/user_permissions/{user_permission_id\} + * GTM UserPermission's API relative path. */ path?: string; From fa7e976a82e99666719f1b3596b8953a93dacbf2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 126/144] fix(tasks): update the API #### tasks:v1 The following keys were changed: - resources.tasklists.methods.list.parameters.maxResults.description - resources.tasks.methods.move.parameters.destinationTasklist.description - resources.tasks.methods.move.parameters.parent.description - resources.tasks.methods.move.parameters.previous.description --- discovery/tasks-v1.json | 10 +++++----- src/apis/tasks/v1.ts | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/tasks-v1.json b/discovery/tasks-v1.json index 6a25e448fc0..3438080b4e9 100644 --- a/discovery/tasks-v1.json +++ b/discovery/tasks-v1.json @@ -182,7 +182,7 @@ "parameterOrder": [], "parameters": { "maxResults": { - "description": "Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).", + "description": "Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000).", "format": "int32", "location": "query", "type": "integer" @@ -470,17 +470,17 @@ ], "parameters": { "destinationTasklist": { - "description": "Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists. Optional.", + "description": "Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists.", "location": "query", "type": "string" }, "parent": { - "description": "New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Assigned tasks can not be set as parent task (have subtasks) or be moved under a parent task (become subtasks). Optional.", + "description": "Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned tasks can not be set as parent task (have subtasks) or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty.", "location": "query", "type": "string" }, "previous": { - "description": "New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Optional.", + "description": "Optional. New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Exceptions: 1. Tasks that are both completed and hidden can only be moved to position 0, so the previous field must be empty.", "location": "query", "type": "string" }, @@ -576,7 +576,7 @@ } } }, - "revision": "20250105", + "revision": "20250302", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "AssignmentInfo": { diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index 2448e686cd9..8272c1f7c18 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -849,7 +849,7 @@ export namespace tasks_v1 { } export interface Params$Resource$Tasklists$List extends StandardParameters { /** - * Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100). + * Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000). */ maxResults?: number; /** @@ -1675,15 +1675,15 @@ export namespace tasks_v1 { } export interface Params$Resource$Tasks$Move extends StandardParameters { /** - * Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists. Optional. + * Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists. */ destinationTasklist?: string; /** - * New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Assigned tasks can not be set as parent task (have subtasks) or be moved under a parent task (become subtasks). Optional. + * Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned tasks can not be set as parent task (have subtasks) or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty. */ parent?: string; /** - * New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Optional. + * Optional. New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Exceptions: 1. Tasks that are both completed and hidden can only be moved to position 0, so the previous field must be empty. */ previous?: string; /** From 4ab28c78e4b0babe0efe17888ba158ff6e767ec1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 127/144] feat(testing): update the API #### testing:v1 The following keys were added: - schemas.LabInfo.properties.regionCode.description - schemas.LabInfo.properties.regionCode.type --- discovery/testing-v1.json | 6 +++++- src/apis/testing/v1.ts | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/discovery/testing-v1.json b/discovery/testing-v1.json index bf710ac6950..7a28f144f76 100644 --- a/discovery/testing-v1.json +++ b/discovery/testing-v1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20241231", + "revision": "20250304", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -1723,6 +1723,10 @@ "name": { "description": "Lab name where the device is hosted. If empty, the device is hosted in a Google owned lab.", "type": "string" + }, + "regionCode": { + "description": "The Unicode country/region code (CLDR) of the lab where the device is hosted. E.g. \"US\" for United States, \"CH\" for Switzerland.", + "type": "string" } }, "type": "object" diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index f49031c4d3f..2a62798d70e 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -1018,6 +1018,10 @@ export namespace testing_v1 { * Lab name where the device is hosted. If empty, the device is hosted in a Google owned lab. */ name?: string | null; + /** + * The Unicode country/region code (CLDR) of the lab where the device is hosted. E.g. "US" for United States, "CH" for Switzerland. + */ + regionCode?: string | null; } /** * Specifies an intent that starts the main launcher activity. From 948c1030b2f61508a679bd8059bff560b60ca6ae Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 128/144] feat(tpu): update the API #### tpu:v2alpha1 The following keys were added: - schemas.AttachedDisk.properties.workerIds.description - schemas.AttachedDisk.properties.workerIds.items.type - schemas.AttachedDisk.properties.workerIds.type - schemas.SchedulingConfig.properties.terminationTimestamp.description - schemas.SchedulingConfig.properties.terminationTimestamp.format - schemas.SchedulingConfig.properties.terminationTimestamp.readOnly - schemas.SchedulingConfig.properties.terminationTimestamp.type The following keys were changed: - schemas.AttachedDisk.description --- discovery/tpu-v2alpha1.json | 17 +++++++++++++++-- src/apis/tpu/v2alpha1.ts | 10 +++++++++- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/discovery/tpu-v2alpha1.json b/discovery/tpu-v2alpha1.json index ec793b0bcbd..d1b51dd4d7a 100644 --- a/discovery/tpu-v2alpha1.json +++ b/discovery/tpu-v2alpha1.json @@ -1021,7 +1021,7 @@ } } }, - "revision": "20250116", + "revision": "20250306", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1104,7 +1104,7 @@ "type": "object" }, "AttachedDisk": { - "description": "A node-attached disk resource. Next ID: 8;", + "description": "A node-attached disk resource.", "id": "AttachedDisk", "properties": { "mode": { @@ -1124,6 +1124,13 @@ "sourceDisk": { "description": "Specifies the full path to an existing disk. For example: \"projects/my-project/zones/us-central1-c/disks/my-disk\".", "type": "string" + }, + "workerIds": { + "description": "Optional. The list of worker IDs this disk is attached to.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2155,6 +2162,12 @@ "spot": { "description": "Optional. Defines whether the node is Spot VM.", "type": "boolean" + }, + "terminationTimestamp": { + "description": "Output only. The time at which the node will be terminated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/src/apis/tpu/v2alpha1.ts b/src/apis/tpu/v2alpha1.ts index a4f4f7a183f..4abd9f9829e 100644 --- a/src/apis/tpu/v2alpha1.ts +++ b/src/apis/tpu/v2alpha1.ts @@ -172,7 +172,7 @@ export namespace tpu_v2alpha1 { */ export interface Schema$ActiveData {} /** - * A node-attached disk resource. Next ID: 8; + * A node-attached disk resource. */ export interface Schema$AttachedDisk { /** @@ -183,6 +183,10 @@ export namespace tpu_v2alpha1 { * Specifies the full path to an existing disk. For example: "projects/my-project/zones/us-central1-c/disks/my-disk". */ sourceDisk?: string | null; + /** + * Optional. The list of worker IDs this disk is attached to. + */ + workerIds?: string[] | null; } /** * BestEffort tier definition. @@ -896,6 +900,10 @@ export namespace tpu_v2alpha1 { * Optional. Defines whether the node is Spot VM. */ spot?: boolean | null; + /** + * Output only. The time at which the node will be terminated. + */ + terminationTimestamp?: string | null; } /** * A service account. From b599b7ac4d0021b2a92959fddedaabb2406d9581 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 129/144] fix(transcoder): update the API #### transcoder:v1 The following keys were changed: - schemas.MuxStream.properties.container.description --- discovery/transcoder-v1.json | 4 ++-- src/apis/transcoder/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/transcoder-v1.json b/discovery/transcoder-v1.json index 16daefe2b58..0266188249a 100644 --- a/discovery/transcoder-v1.json +++ b/discovery/transcoder-v1.json @@ -385,7 +385,7 @@ } } }, - "revision": "20241009", + "revision": "20250219", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { @@ -1486,7 +1486,7 @@ "id": "MuxStream", "properties": { "container": { - "description": "The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats)", + "description": "The container format. The default is `mp4` Supported streaming formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` Supported standalone file formats: - `mp4` - `mp3` - `ogg` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats)", "type": "string" }, "elementaryStreams": { diff --git a/src/apis/transcoder/v1.ts b/src/apis/transcoder/v1.ts index ab5d0b11be0..9cd9f4a5d39 100644 --- a/src/apis/transcoder/v1.ts +++ b/src/apis/transcoder/v1.ts @@ -944,7 +944,7 @@ export namespace transcoder_v1 { */ export interface Schema$MuxStream { /** - * The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` - `ogg` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) + * The container format. The default is `mp4` Supported streaming formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` Supported standalone file formats: - `mp4` - `mp3` - `ogg` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) */ container?: string | null; /** From 8e97ed64328a243f2f524ef6c4c00e22d58531f2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 130/144] fix(travelimpactmodel): update the API #### travelimpactmodel:v1 The following keys were changed: - resources.flights.methods.computeFlightEmissions.description --- discovery/travelimpactmodel-v1.json | 4 ++-- src/apis/travelimpactmodel/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/travelimpactmodel-v1.json b/discovery/travelimpactmodel-v1.json index e2c075395d1..efd533c02b1 100644 --- a/discovery/travelimpactmodel-v1.json +++ b/discovery/travelimpactmodel-v1.json @@ -99,7 +99,7 @@ "flights": { "methods": { "computeFlightEmissions": { - "description": "Stateless method to retrieve emission estimates. Details on how emission estimates are computed: https://github.com/google/travel-impact-model The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: - The flight is unknown to the server. - The input flight leg is missing one or more identifiers. - The flight date is in the past. - The aircraft type is not supported by the model. - Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.", + "description": "Stateless method to retrieve emission estimates. Details on how emission estimates are computed: https://github.com/google/travel-impact-model The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: * The flight is unknown to the server. * The input flight leg is missing one or more identifiers. * The flight date is in the past. * The aircraft type is not supported by the model. * Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.", "flatPath": "v1/flights:computeFlightEmissions", "httpMethod": "POST", "id": "travelimpactmodel.flights.computeFlightEmissions", @@ -116,7 +116,7 @@ } } }, - "revision": "20241027", + "revision": "20250224", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { diff --git a/src/apis/travelimpactmodel/v1.ts b/src/apis/travelimpactmodel/v1.ts index 308e8fb4a30..fe1ce5fc8ab 100644 --- a/src/apis/travelimpactmodel/v1.ts +++ b/src/apis/travelimpactmodel/v1.ts @@ -251,7 +251,7 @@ export namespace travelimpactmodel_v1 { } /** - * Stateless method to retrieve emission estimates. Details on how emission estimates are computed: https://github.com/google/travel-impact-model The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: - The flight is unknown to the server. - The input flight leg is missing one or more identifiers. - The flight date is in the past. - The aircraft type is not supported by the model. - Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error. + * Stateless method to retrieve emission estimates. Details on how emission estimates are computed: https://github.com/google/travel-impact-model The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: * The flight is unknown to the server. * The input flight leg is missing one or more identifiers. * The flight date is in the past. * The aircraft type is not supported by the model. * Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. From 27acf91076c3ffbd95e52681d8f859bc2d79ee87 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 131/144] feat(vault): update the API #### vault:v1 The following keys were added: - schemas.DriveDocumentIds.description - schemas.DriveDocumentIds.id - schemas.DriveDocumentIds.properties.ids.description - schemas.DriveDocumentIds.properties.ids.items.type - schemas.DriveDocumentIds.properties.ids.type - schemas.DriveDocumentIds.type - schemas.DriveDocumentInfo.description - schemas.DriveDocumentInfo.id - schemas.DriveDocumentInfo.properties.documentIds.$ref - schemas.DriveDocumentInfo.properties.documentIds.description - schemas.DriveDocumentInfo.type - schemas.DriveOptions.properties.includeSharedDrives.deprecated - schemas.ExportOptions.properties.geminiOptions.$ref - schemas.ExportOptions.properties.geminiOptions.description - schemas.GeminiExportOptions.description - schemas.GeminiExportOptions.id - schemas.GeminiExportOptions.properties.exportFormat.description - schemas.GeminiExportOptions.properties.exportFormat.enum - schemas.GeminiExportOptions.properties.exportFormat.enumDescriptions - schemas.GeminiExportOptions.properties.exportFormat.type - schemas.GeminiExportOptions.type - schemas.GeminiOptions.description - schemas.GeminiOptions.id - schemas.GeminiOptions.type - schemas.Query.properties.driveDocumentInfo.$ref - schemas.Query.properties.driveDocumentInfo.description - schemas.Query.properties.geminiOptions.$ref - schemas.Query.properties.geminiOptions.description The following keys were changed: - schemas.CalendarExportOptions.properties.exportFormat.enum - schemas.CalendarExportOptions.properties.exportFormat.enumDescriptions - schemas.DriveOptions.description - schemas.GroupsExportOptions.properties.exportFormat.enum - schemas.GroupsExportOptions.properties.exportFormat.enumDescriptions - schemas.HangoutsChatExportOptions.properties.exportFormat.enum - schemas.HangoutsChatExportOptions.properties.exportFormat.enumDescriptions - schemas.Hold.properties.corpus.enum - schemas.Hold.properties.corpus.enumDescriptions - schemas.MailExportOptions.properties.exportFormat.enum - schemas.MailExportOptions.properties.exportFormat.enumDescriptions - schemas.Query.properties.corpus.enum - schemas.Query.properties.corpus.enumDescriptions - schemas.Query.properties.method.enum - schemas.Query.properties.method.enumDeprecated - schemas.Query.properties.method.enumDescriptions - schemas.Query.properties.searchMethod.enum - schemas.Query.properties.searchMethod.enumDeprecated - schemas.Query.properties.searchMethod.enumDescriptions - schemas.VoiceExportOptions.properties.exportFormat.enum - schemas.VoiceExportOptions.properties.exportFormat.enumDescriptions --- discovery/vault-v1.json | 129 +++++++++++++++++++++++++++++++++------- src/apis/vault/v1.ts | 45 +++++++++++++- 2 files changed, 153 insertions(+), 21 deletions(-) diff --git a/discovery/vault-v1.json b/discovery/vault-v1.json index d2e11c9063e..24b8bfc9778 100644 --- a/discovery/vault-v1.json +++ b/discovery/vault-v1.json @@ -1203,7 +1203,7 @@ } } }, - "revision": "20241121", + "revision": "20250212", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { @@ -1346,13 +1346,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", - "ICS" + "ICS", + "XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", - "Export as ICS. Only available for Calendar." + "Export as ICS. Only available for Calendar.", + "Export as XML. Only available for Gemini." ], "type": "string" } @@ -1575,6 +1577,31 @@ }, "type": "object" }, + "DriveDocumentIds": { + "description": "Specify Drive documents by document ID.", + "id": "DriveDocumentIds", + "properties": { + "ids": { + "description": "Required. A list of Drive document IDs.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DriveDocumentInfo": { + "description": "The Drive documents to search.", + "id": "DriveDocumentInfo", + "properties": { + "documentIds": { + "$ref": "DriveDocumentIds", + "description": "Specify Drive documents by document ID." + } + }, + "type": "object" + }, "DriveExportOptions": { "description": "Options for Drive exports.", "id": "DriveExportOptions", @@ -1587,7 +1614,7 @@ "type": "object" }, "DriveOptions": { - "description": "Additional options for Drive search", + "description": "Additional options for Drive search.", "id": "DriveOptions", "properties": { "clientSideEncryptedOption": { @@ -1607,6 +1634,7 @@ "type": "string" }, "includeSharedDrives": { + "deprecated": true, "description": "Set to **true** to include shared drives.", "type": "boolean" }, @@ -1706,6 +1734,10 @@ "$ref": "DriveExportOptions", "description": "Options for Drive exports." }, + "geminiOptions": { + "$ref": "GeminiExportOptions", + "description": "Option available for Gemini export." + }, "groupsOptions": { "$ref": "GroupsExportOptions", "description": "Options for Groups exports." @@ -1763,6 +1795,37 @@ }, "type": "object" }, + "GeminiExportOptions": { + "description": "The options for Gemini exports.", + "id": "GeminiExportOptions", + "properties": { + "exportFormat": { + "description": "The file format for exported messages.", + "enum": [ + "EXPORT_FORMAT_UNSPECIFIED", + "MBOX", + "PST", + "ICS", + "XML" + ], + "enumDescriptions": [ + "No export format specified.", + "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", + "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", + "Export as ICS. Only available for Calendar.", + "Export as XML. Only available for Gemini." + ], + "type": "string" + } + }, + "type": "object" + }, + "GeminiOptions": { + "description": "Additional options for Gemini search", + "id": "GeminiOptions", + "properties": {}, + "type": "object" + }, "GroupsCountResult": { "description": "Groups specific count metrics.", "id": "GroupsCountResult", @@ -1811,13 +1874,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", - "ICS" + "ICS", + "XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", - "Export as ICS. Only available for Calendar." + "Export as ICS. Only available for Calendar.", + "Export as XML. Only available for Gemini." ], "type": "string" } @@ -1834,13 +1899,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", - "ICS" + "ICS", + "XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", - "Export as ICS. Only available for Calendar." + "Export as ICS. Only available for Calendar.", + "Export as XML. Only available for Gemini." ], "type": "string" } @@ -2037,7 +2104,8 @@ "GROUPS", "HANGOUTS_CHAT", "VOICE", - "CALENDAR" + "CALENDAR", + "GEMINI" ], "enumDescriptions": [ "No service specified.", @@ -2046,7 +2114,8 @@ "Groups.", "For export, Google Chat only. For holds, Google Chat and classic Hangouts.", "Google Voice.", - "Calendar." + "Calendar.", + "Gemini." ], "type": "string" }, @@ -2226,13 +2295,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", - "ICS" + "ICS", + "XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", - "Export as ICS. Only available for Calendar." + "Export as ICS. Only available for Calendar.", + "Export as XML. Only available for Gemini." ], "type": "string" }, @@ -2428,7 +2499,8 @@ "GROUPS", "HANGOUTS_CHAT", "VOICE", - "CALENDAR" + "CALENDAR", + "GEMINI" ], "enumDescriptions": [ "No service specified.", @@ -2437,7 +2509,8 @@ "Groups.", "For export, Google Chat only. For holds, Google Chat and classic Hangouts.", "Google Voice.", - "Calendar." + "Calendar.", + "Gemini." ], "type": "string" }, @@ -2457,6 +2530,10 @@ ], "type": "string" }, + "driveDocumentInfo": { + "$ref": "DriveDocumentInfo", + "description": "Required when **SearchMethod** is **DRIVE_DOCUMENT**." + }, "driveOptions": { "$ref": "DriveOptions", "description": "Set Drive search-specific options." @@ -2466,6 +2543,10 @@ "format": "google-datetime", "type": "string" }, + "geminiOptions": { + "$ref": "GeminiOptions", + "description": "Set Gemini search-specific options." + }, "hangoutsChatInfo": { "$ref": "HangoutsChatInfo", "description": "Required when **SearchMethod** is **ROOM**. (read-only)" @@ -2488,7 +2569,8 @@ "ENTIRE_ORG", "ROOM", "SITES_URL", - "SHARED_DRIVE" + "SHARED_DRIVE", + "DRIVE_DOCUMENT" ], "enumDeprecated": [ false, @@ -2498,6 +2580,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2508,7 +2591,8 @@ "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/v1/Query#hangoutschatinfo).", "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/vault/reference/rest/v1/Query#sitesurlinfo).", - "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v1/Query#shareddriveinfo)." + "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v1/Query#shareddriveinfo).", + "Retrieve the documents specified in DriveDocumentInfo." ], "type": "string" }, @@ -2527,7 +2611,8 @@ "ENTIRE_ORG", "ROOM", "SITES_URL", - "SHARED_DRIVE" + "SHARED_DRIVE", + "DRIVE_DOCUMENT" ], "enumDeprecated": [ false, @@ -2537,6 +2622,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2547,7 +2633,8 @@ "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/v1/Query#hangoutschatinfo).", "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/vault/reference/rest/v1/Query#sitesurlinfo).", - "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v1/Query#shareddriveinfo)." + "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v1/Query#shareddriveinfo).", + "Retrieve the documents specified in DriveDocumentInfo." ], "type": "string" }, @@ -2770,13 +2857,15 @@ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", - "ICS" + "ICS", + "XML" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", - "Export as ICS. Only available for Calendar." + "Export as ICS. Only available for Calendar.", + "Export as XML. Only available for Gemini." ], "type": "string" } diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index 868bb510f5e..0b3da461ae5 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -374,6 +374,24 @@ export namespace vault_v1 { */ totalCount?: string | null; } + /** + * Specify Drive documents by document ID. + */ + export interface Schema$DriveDocumentIds { + /** + * Required. A list of Drive document IDs. + */ + ids?: string[] | null; + } + /** + * The Drive documents to search. + */ + export interface Schema$DriveDocumentInfo { + /** + * Specify Drive documents by document ID. + */ + documentIds?: Schema$DriveDocumentIds; + } /** * Options for Drive exports. */ @@ -384,7 +402,7 @@ export namespace vault_v1 { includeAccessInfo?: boolean | null; } /** - * Additional options for Drive search + * Additional options for Drive search. */ export interface Schema$DriveOptions { /** @@ -469,6 +487,10 @@ export namespace vault_v1 { * Options for Drive exports. */ driveOptions?: Schema$DriveExportOptions; + /** + * Option available for Gemini export. + */ + geminiOptions?: Schema$GeminiExportOptions; /** * Options for Groups exports. */ @@ -507,6 +529,19 @@ export namespace vault_v1 { */ totalArtifactCount?: string | null; } + /** + * The options for Gemini exports. + */ + export interface Schema$GeminiExportOptions { + /** + * The file format for exported messages. + */ + exportFormat?: string | null; + } + /** + * Additional options for Gemini search + */ + export interface Schema$GeminiOptions {} /** * Groups specific count metrics. */ @@ -937,6 +972,10 @@ export namespace vault_v1 { * The data source to search. */ dataScope?: string | null; + /** + * Required when **SearchMethod** is **DRIVE_DOCUMENT**. + */ + driveDocumentInfo?: Schema$DriveDocumentInfo; /** * Set Drive search-specific options. */ @@ -945,6 +984,10 @@ export namespace vault_v1 { * The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. */ endTime?: string | null; + /** + * Set Gemini search-specific options. + */ + geminiOptions?: Schema$GeminiOptions; /** * Required when **SearchMethod** is **ROOM**. (read-only) */ From 346824aec3fe4a8c71f4b6c718605574f8db48f2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 132/144] feat(verifiedaccess): update the API #### verifiedaccess:v2 The following keys were added: - schemas.Antivirus.description - schemas.Antivirus.id - schemas.Antivirus.properties.state.description - schemas.Antivirus.properties.state.enum - schemas.Antivirus.properties.state.enumDescriptions - schemas.Antivirus.properties.state.readOnly - schemas.Antivirus.properties.state.type - schemas.Antivirus.type - schemas.CrowdStrikeAgent.properties.agentId.readOnly - schemas.CrowdStrikeAgent.properties.customerId.readOnly - schemas.DeviceSignals.properties.allowScreenLock.readOnly - schemas.DeviceSignals.properties.antivirus.$ref - schemas.DeviceSignals.properties.antivirus.description - schemas.DeviceSignals.properties.antivirus.readOnly - schemas.DeviceSignals.properties.browserVersion.readOnly - schemas.DeviceSignals.properties.builtInDnsClientEnabled.readOnly - schemas.DeviceSignals.properties.chromeRemoteDesktopAppBlocked.readOnly - schemas.DeviceSignals.properties.crowdStrikeAgent.readOnly - schemas.DeviceSignals.properties.deviceAffiliationIds.readOnly - schemas.DeviceSignals.properties.deviceEnrollmentDomain.readOnly - schemas.DeviceSignals.properties.deviceManufacturer.readOnly - schemas.DeviceSignals.properties.deviceModel.readOnly - schemas.DeviceSignals.properties.diskEncryption.readOnly - schemas.DeviceSignals.properties.displayName.readOnly - schemas.DeviceSignals.properties.imei.readOnly - schemas.DeviceSignals.properties.macAddresses.readOnly - schemas.DeviceSignals.properties.meid.readOnly - schemas.DeviceSignals.properties.operatingSystem.readOnly - schemas.DeviceSignals.properties.osFirewall.readOnly - schemas.DeviceSignals.properties.osVersion.readOnly - schemas.DeviceSignals.properties.passwordProtectionWarningTrigger.readOnly - schemas.DeviceSignals.properties.profileAffiliationIds.readOnly - schemas.DeviceSignals.properties.profileEnrollmentDomain.readOnly - schemas.DeviceSignals.properties.realtimeUrlCheckMode.readOnly - schemas.DeviceSignals.properties.safeBrowsingProtectionLevel.readOnly - schemas.DeviceSignals.properties.screenLockSecured.readOnly - schemas.DeviceSignals.properties.secureBootMode.readOnly - schemas.DeviceSignals.properties.serialNumber.readOnly - schemas.DeviceSignals.properties.siteIsolationEnabled.readOnly - schemas.DeviceSignals.properties.thirdPartyBlockingEnabled.readOnly - schemas.DeviceSignals.properties.trigger.readOnly - schemas.DeviceSignals.properties.windowsMachineDomain.readOnly - schemas.DeviceSignals.properties.windowsUserDomain.readOnly - schemas.VerifyChallengeResponseResult.properties.attestedDeviceId.readOnly - schemas.VerifyChallengeResponseResult.properties.customerId.readOnly - schemas.VerifyChallengeResponseResult.properties.deviceEnrollmentId.readOnly - schemas.VerifyChallengeResponseResult.properties.devicePermanentId.readOnly - schemas.VerifyChallengeResponseResult.properties.deviceSignal.readOnly - schemas.VerifyChallengeResponseResult.properties.deviceSignals.readOnly - schemas.VerifyChallengeResponseResult.properties.keyTrustLevel.readOnly - schemas.VerifyChallengeResponseResult.properties.profileCustomerId.readOnly - schemas.VerifyChallengeResponseResult.properties.profileKeyTrustLevel.readOnly - schemas.VerifyChallengeResponseResult.properties.profilePermanentId.description - schemas.VerifyChallengeResponseResult.properties.profilePermanentId.readOnly - schemas.VerifyChallengeResponseResult.properties.profilePermanentId.type - schemas.VerifyChallengeResponseResult.properties.signedPublicKeyAndChallenge.readOnly - schemas.VerifyChallengeResponseResult.properties.virtualDeviceId.readOnly - schemas.VerifyChallengeResponseResult.properties.virtualProfileId.readOnly The following keys were changed: - schemas.CrowdStrikeAgent.properties.agentId.description - schemas.CrowdStrikeAgent.properties.customerId.description - schemas.DeviceSignals.properties.allowScreenLock.description - schemas.DeviceSignals.properties.browserVersion.description - schemas.DeviceSignals.properties.builtInDnsClientEnabled.description - schemas.DeviceSignals.properties.chromeRemoteDesktopAppBlocked.description - schemas.DeviceSignals.properties.crowdStrikeAgent.description - schemas.DeviceSignals.properties.deviceAffiliationIds.description - schemas.DeviceSignals.properties.deviceEnrollmentDomain.description - schemas.DeviceSignals.properties.deviceManufacturer.description - schemas.DeviceSignals.properties.deviceModel.description - schemas.DeviceSignals.properties.diskEncryption.description - schemas.DeviceSignals.properties.displayName.description - schemas.DeviceSignals.properties.imei.description - schemas.DeviceSignals.properties.macAddresses.description - schemas.DeviceSignals.properties.meid.description - schemas.DeviceSignals.properties.operatingSystem.description - schemas.DeviceSignals.properties.osFirewall.description - schemas.DeviceSignals.properties.osVersion.description - schemas.DeviceSignals.properties.passwordProtectionWarningTrigger.description - schemas.DeviceSignals.properties.profileAffiliationIds.description - schemas.DeviceSignals.properties.profileEnrollmentDomain.description - schemas.DeviceSignals.properties.realtimeUrlCheckMode.description - schemas.DeviceSignals.properties.safeBrowsingProtectionLevel.description - schemas.DeviceSignals.properties.screenLockSecured.description - schemas.DeviceSignals.properties.secureBootMode.description - schemas.DeviceSignals.properties.serialNumber.description - schemas.DeviceSignals.properties.siteIsolationEnabled.description - schemas.DeviceSignals.properties.thirdPartyBlockingEnabled.description - schemas.DeviceSignals.properties.trigger.description - schemas.DeviceSignals.properties.windowsMachineDomain.description - schemas.DeviceSignals.properties.windowsUserDomain.description - schemas.VerifyChallengeResponseResult.properties.attestedDeviceId.description - schemas.VerifyChallengeResponseResult.properties.customerId.description - schemas.VerifyChallengeResponseResult.properties.deviceEnrollmentId.description - schemas.VerifyChallengeResponseResult.properties.devicePermanentId.description - schemas.VerifyChallengeResponseResult.properties.deviceSignal.description - schemas.VerifyChallengeResponseResult.properties.deviceSignals.description - schemas.VerifyChallengeResponseResult.properties.keyTrustLevel.description - schemas.VerifyChallengeResponseResult.properties.profileCustomerId.description - schemas.VerifyChallengeResponseResult.properties.profileKeyTrustLevel.description - schemas.VerifyChallengeResponseResult.properties.signedPublicKeyAndChallenge.description - schemas.VerifyChallengeResponseResult.properties.virtualDeviceId.description - schemas.VerifyChallengeResponseResult.properties.virtualProfileId.description --- discovery/verifiedaccess-v2.json | 168 ++++++++++++++++++++++--------- src/apis/verifiedaccess/v2.ts | 105 +++++++++++-------- 2 files changed, 184 insertions(+), 89 deletions(-) diff --git a/discovery/verifiedaccess-v2.json b/discovery/verifiedaccess-v2.json index 5637a6fa092..b708dc950be 100644 --- a/discovery/verifiedaccess-v2.json +++ b/discovery/verifiedaccess-v2.json @@ -146,9 +146,33 @@ } } }, - "revision": "20241112", + "revision": "20250225", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { + "Antivirus": { + "description": "Antivirus information on a device.", + "id": "Antivirus", + "properties": { + "state": { + "description": "Output only. The state of the antivirus on the device. Introduced in Chrome M136.", + "enum": [ + "STATE_UNSPECIFIED", + "MISSING", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Unspecified.", + "No antivirus was detected on the device.", + "At least one antivirus was installed on the device but none was enabled.", + "At least one antivirus was enabled on the device." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Challenge": { "description": "Result message for VerifiedAccess.GenerateChallenge.", "id": "Challenge", @@ -166,11 +190,13 @@ "id": "CrowdStrikeAgent", "properties": { "agentId": { - "description": "The Agent ID of the Crowdstrike agent.", + "description": "Output only. The Agent ID of the Crowdstrike agent.", + "readOnly": true, "type": "string" }, "customerId": { - "description": "The Customer ID to which the agent belongs to.", + "description": "Output only. The Customer ID to which the agent belongs to.", + "readOnly": true, "type": "string" } }, @@ -181,46 +207,60 @@ "id": "DeviceSignals", "properties": { "allowScreenLock": { - "description": "Value of the AllowScreenLock policy on the device. See https://chromeenterprise.google/policies/?policy=AllowScreenLock for more details. Available on ChromeOS only.", + "description": "Output only. Value of the AllowScreenLock policy on the device. See https://chromeenterprise.google/policies/?policy=AllowScreenLock for more details. Available on ChromeOS only.", + "readOnly": true, "type": "boolean" }, + "antivirus": { + "$ref": "Antivirus", + "description": "Output only. Information about Antivirus software on the device. Available on Windows only.", + "readOnly": true + }, "browserVersion": { - "description": "Current version of the Chrome browser which generated this set of signals. Example value: \"107.0.5286.0\".", + "description": "Output only. Current version of the Chrome browser which generated this set of signals. Example value: \"107.0.5286.0\".", + "readOnly": true, "type": "string" }, "builtInDnsClientEnabled": { - "description": "Whether Chrome's built-in DNS client is used. The OS DNS client is otherwise used. This value may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled.", + "description": "Output only. Whether Chrome's built-in DNS client is used. The OS DNS client is otherwise used. This value may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled.", + "readOnly": true, "type": "boolean" }, "chromeRemoteDesktopAppBlocked": { - "description": "Whether access to the Chrome Remote Desktop application is blocked via a policy.", + "description": "Output only. Whether access to the Chrome Remote Desktop application is blocked via a policy.", + "readOnly": true, "type": "boolean" }, "crowdStrikeAgent": { "$ref": "CrowdStrikeAgent", - "description": "Crowdstrike agent properties installed on the device, if any. Available on Windows and MacOS only." + "description": "Output only. Crowdstrike agent properties installed on the device, if any. Available on Windows and MacOS only.", + "readOnly": true }, "deviceAffiliationIds": { - "description": "Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the device. When the sets of device and profile affiliation IDs overlap, it means that the organizations managing the device and user are affiliated. To learn more about user affiliation, visit https://support.google.com/chrome/a/answer/12801245?ref_topic=9027936.", + "description": "Output only. Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the device. When the sets of device and profile affiliation IDs overlap, it means that the organizations managing the device and user are affiliated. To learn more about user affiliation, visit https://support.google.com/chrome/a/answer/12801245?ref_topic=9027936.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "deviceEnrollmentDomain": { - "description": "Enrollment domain of the customer which is currently managing the device.", + "description": "Output only. Enrollment domain of the customer which is currently managing the device.", + "readOnly": true, "type": "string" }, "deviceManufacturer": { - "description": "The name of the device's manufacturer.", + "description": "Output only. The name of the device's manufacturer.", + "readOnly": true, "type": "string" }, "deviceModel": { - "description": "The name of the device's model.", + "description": "Output only. The name of the device's model.", + "readOnly": true, "type": "string" }, "diskEncryption": { - "description": "The encryption state of the disk. On ChromeOS, the main disk is always ENCRYPTED.", + "description": "Output only. The encryption state of the disk. On ChromeOS, the main disk is always ENCRYPTED.", "enum": [ "DISK_ENCRYPTION_UNSPECIFIED", "DISK_ENCRYPTION_UNKNOWN", @@ -233,10 +273,12 @@ "The main disk is not encrypted.", "The main disk is encrypted." ], + "readOnly": true, "type": "string" }, "displayName": { - "description": "The display name of the device, as defined by the user.", + "description": "Output only. The display name of the device, as defined by the user.", + "readOnly": true, "type": "string" }, "hostname": { @@ -244,28 +286,31 @@ "type": "string" }, "imei": { - "description": "International Mobile Equipment Identity (IMEI) of the device. Available on ChromeOS only.", + "description": "Output only. International Mobile Equipment Identity (IMEI) of the device. Available on ChromeOS only.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "macAddresses": { - "description": "MAC addresses of the device.", + "description": "Output only. MAC addresses of the device.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "meid": { - "description": "Mobile Equipment Identifier (MEID) of the device. Available on ChromeOS only.", + "description": "Output only. Mobile Equipment Identifier (MEID) of the device. Available on ChromeOS only.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "operatingSystem": { - "description": "The type of the Operating System currently running on the device.", + "description": "Output only. The type of the Operating System currently running on the device.", "enum": [ "OPERATING_SYSTEM_UNSPECIFIED", "CHROME_OS", @@ -282,10 +327,11 @@ "Mac Os X.", "Linux" ], + "readOnly": true, "type": "string" }, "osFirewall": { - "description": "The state of the OS level firewall. On ChromeOS, the value will always be ENABLED on regular devices and UNKNOWN on devices in developer mode. Support for MacOS 15 (Sequoia) and later has been introduced in Chrome M131.", + "description": "Output only. The state of the OS level firewall. On ChromeOS, the value will always be ENABLED on regular devices and UNKNOWN on devices in developer mode. Support for MacOS 15 (Sequoia) and later has been introduced in Chrome M131.", "enum": [ "OS_FIREWALL_UNSPECIFIED", "OS_FIREWALL_UNKNOWN", @@ -298,14 +344,16 @@ "The OS firewall is disabled.", "The OS firewall is enabled." ], + "readOnly": true, "type": "string" }, "osVersion": { - "description": "The current version of the Operating System. On Windows and linux, the value will also include the security patch information.", + "description": "Output only. The current version of the Operating System. On Windows and linux, the value will also include the security patch information.", + "readOnly": true, "type": "string" }, "passwordProtectionWarningTrigger": { - "description": "Whether the Password Protection Warning feature is enabled or not. Password protection alerts users when they reuse their protected password on potentially suspicious sites. This setting is controlled by an enterprise policy: https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger. Note that the policy unset does not have the same effects as having the policy explicitly set to `PASSWORD_PROTECTION_OFF`.", + "description": "Output only. Whether the Password Protection Warning feature is enabled or not. Password protection alerts users when they reuse their protected password on potentially suspicious sites. This setting is controlled by an enterprise policy: https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger. Note that the policy unset does not have the same effects as having the policy explicitly set to `PASSWORD_PROTECTION_OFF`.", "enum": [ "PASSWORD_PROTECTION_WARNING_TRIGGER_UNSPECIFIED", "POLICY_UNSET", @@ -320,21 +368,24 @@ "Password protection warning is shown if a protected password is re-used.", "Password protection warning is shown if a protected password is re-used on a known phishing website." ], + "readOnly": true, "type": "string" }, "profileAffiliationIds": { - "description": "Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the Chrome Profile’s user or ChromeOS user.", + "description": "Output only. Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the Chrome Profile’s user or ChromeOS user.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "profileEnrollmentDomain": { - "description": "Enrollment domain of the customer which is currently managing the profile.", + "description": "Output only. Enrollment domain of the customer which is currently managing the profile.", + "readOnly": true, "type": "string" }, "realtimeUrlCheckMode": { - "description": "Whether Enterprise-grade (i.e. custom) unsafe URL scanning is enabled or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode", + "description": "Output only. Whether Enterprise-grade (i.e. custom) unsafe URL scanning is enabled or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode", "enum": [ "REALTIME_URL_CHECK_MODE_UNSPECIFIED", "REALTIME_URL_CHECK_MODE_DISABLED", @@ -345,10 +396,11 @@ "Disabled. Consumer Safe Browsing checks are applied.", "Realtime check for main frame URLs is enabled." ], + "readOnly": true, "type": "string" }, "safeBrowsingProtectionLevel": { - "description": "Safe Browsing Protection Level. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel.", + "description": "Output only. Safe Browsing Protection Level. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel.", "enum": [ "SAFE_BROWSING_PROTECTION_LEVEL_UNSPECIFIED", "INACTIVE", @@ -361,10 +413,11 @@ "Safe Browsing is active in the standard mode.", "Safe Browsing is active in the enhanced mode." ], + "readOnly": true, "type": "string" }, "screenLockSecured": { - "description": "The state of the Screen Lock password protection. On ChromeOS, this value will always be ENABLED as there is not way to disable requiring a password or pin when unlocking the device.", + "description": "Output only. The state of the Screen Lock password protection. On ChromeOS, this value will always be ENABLED as there is not way to disable requiring a password or pin when unlocking the device.", "enum": [ "SCREEN_LOCK_SECURED_UNSPECIFIED", "SCREEN_LOCK_SECURED_UNKNOWN", @@ -377,10 +430,11 @@ "The Screen Lock is not password-protected.", "The Screen Lock is password-protected." ], + "readOnly": true, "type": "string" }, "secureBootMode": { - "description": "Whether the device's startup software has its Secure Boot feature enabled. Available on Windows only.", + "description": "Output only. Whether the device's startup software has its Secure Boot feature enabled. Available on Windows only.", "enum": [ "SECURE_BOOT_MODE_UNSPECIFIED", "SECURE_BOOT_MODE_UNKNOWN", @@ -393,14 +447,17 @@ "Secure Boot was disabled on the startup software.", "Secure Boot was enabled on the startup software." ], + "readOnly": true, "type": "string" }, "serialNumber": { - "description": "The serial number of the device. On Windows, this represents the BIOS's serial number. Not available on most Linux distributions.", + "description": "Output only. The serial number of the device. On Windows, this represents the BIOS's serial number. Not available on most Linux distributions.", + "readOnly": true, "type": "string" }, "siteIsolationEnabled": { - "description": "Whether the Site Isolation (a.k.a Site Per Process) setting is enabled. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SitePerProcess", + "description": "Output only. Whether the Site Isolation (a.k.a Site Per Process) setting is enabled. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SitePerProcess", + "readOnly": true, "type": "boolean" }, "systemDnsServers": { @@ -411,11 +468,12 @@ "type": "array" }, "thirdPartyBlockingEnabled": { - "description": "Whether Chrome is blocking third-party software injection or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/?policy=ThirdPartyBlockingEnabled. Available on Windows only.", + "description": "Output only. Whether Chrome is blocking third-party software injection or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/?policy=ThirdPartyBlockingEnabled. Available on Windows only.", + "readOnly": true, "type": "boolean" }, "trigger": { - "description": "The trigger which generated this set of signals.", + "description": "Output only. The trigger which generated this set of signals.", "enum": [ "TRIGGER_UNSPECIFIED", "TRIGGER_BROWSER_NAVIGATION", @@ -426,14 +484,17 @@ "When navigating to an URL inside a browser.", "When signing into an account on the ChromeOS login screen." ], + "readOnly": true, "type": "string" }, "windowsMachineDomain": { - "description": "Windows domain that the current machine has joined. Available on Windows only.", + "description": "Output only. Windows domain that the current machine has joined. Available on Windows only.", + "readOnly": true, "type": "string" }, "windowsUserDomain": { - "description": "Windows domain for the current OS user. Available on Windows only.", + "description": "Output only. Windows domain for the current OS user. Available on Windows only.", + "readOnly": true, "type": "string" } }, @@ -466,31 +527,37 @@ "id": "VerifyChallengeResponseResult", "properties": { "attestedDeviceId": { - "description": "Attested device ID (ADID).", + "description": "Output only. Attested device ID (ADID).", + "readOnly": true, "type": "string" }, "customerId": { - "description": "Unique customer id that this device belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers", + "description": "Output only. Unique customer id that this device belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers", + "readOnly": true, "type": "string" }, "deviceEnrollmentId": { - "description": "Device enrollment id for ChromeOS devices.", + "description": "Output only. Device enrollment id for ChromeOS devices.", + "readOnly": true, "type": "string" }, "devicePermanentId": { - "description": "Device permanent id is returned in this field (for the machine response only).", + "description": "Output only. Device permanent id is returned in this field (for the machine response only).", + "readOnly": true, "type": "string" }, "deviceSignal": { - "description": "Deprecated. Device signal in json string representation. Prefer using `device_signals` instead.", + "description": "Output only. Deprecated. Device signal in json string representation. Prefer using `device_signals` instead.", + "readOnly": true, "type": "string" }, "deviceSignals": { "$ref": "DeviceSignals", - "description": "Device signals." + "description": "Output only. Device signals.", + "readOnly": true }, "keyTrustLevel": { - "description": "Device attested key trust level.", + "description": "Output only. Device attested key trust level.", "enum": [ "KEY_TRUST_LEVEL_UNSPECIFIED", "CHROME_OS_VERIFIED_MODE", @@ -507,14 +574,16 @@ "Chrome Browser with the key stored at OS level.", "Chrome Browser without an attestation key." ], + "readOnly": true, "type": "string" }, "profileCustomerId": { - "description": "Unique customer id that this profile belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers", + "description": "Output only. Unique customer id that this profile belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers", + "readOnly": true, "type": "string" }, "profileKeyTrustLevel": { - "description": "Profile attested key trust level.", + "description": "Output only. Profile attested key trust level.", "enum": [ "KEY_TRUST_LEVEL_UNSPECIFIED", "CHROME_OS_VERIFIED_MODE", @@ -531,18 +600,27 @@ "Chrome Browser with the key stored at OS level.", "Chrome Browser without an attestation key." ], + "readOnly": true, + "type": "string" + }, + "profilePermanentId": { + "description": "Output only. The unique server-side ID of a profile on the device.", + "readOnly": true, "type": "string" }, "signedPublicKeyAndChallenge": { - "description": "Certificate Signing Request (in the SPKAC format, base64 encoded) is returned in this field. This field will be set only if device has included CSR in its challenge response. (the option to include CSR is now available for both user and machine responses)", + "description": "Output only. Certificate Signing Request (in the SPKAC format, base64 encoded) is returned in this field. This field will be set only if device has included CSR in its challenge response. (the option to include CSR is now available for both user and machine responses)", + "readOnly": true, "type": "string" }, "virtualDeviceId": { - "description": "Virtual device id of the device. The definition of virtual device id is platform-specific.", + "description": "Output only. Virtual device id of the device. The definition of virtual device id is platform-specific.", + "readOnly": true, "type": "string" }, "virtualProfileId": { - "description": "The ID of a profile on the device.", + "description": "Output only. The client-provided ID of a profile on the device.", + "readOnly": true, "type": "string" } }, diff --git a/src/apis/verifiedaccess/v2.ts b/src/apis/verifiedaccess/v2.ts index 9ed55e0a974..0967c4101d6 100644 --- a/src/apis/verifiedaccess/v2.ts +++ b/src/apis/verifiedaccess/v2.ts @@ -124,6 +124,15 @@ export namespace verifiedaccess_v2 { } } + /** + * Antivirus information on a device. + */ + export interface Schema$Antivirus { + /** + * Output only. The state of the antivirus on the device. Introduced in Chrome M136. + */ + state?: string | null; + } /** * Result message for VerifiedAccess.GenerateChallenge. */ @@ -138,11 +147,11 @@ export namespace verifiedaccess_v2 { */ export interface Schema$CrowdStrikeAgent { /** - * The Agent ID of the Crowdstrike agent. + * Output only. The Agent ID of the Crowdstrike agent. */ agentId?: string | null; /** - * The Customer ID to which the agent belongs to. + * Output only. The Customer ID to which the agent belongs to. */ customerId?: string | null; } @@ -151,47 +160,51 @@ export namespace verifiedaccess_v2 { */ export interface Schema$DeviceSignals { /** - * Value of the AllowScreenLock policy on the device. See https://chromeenterprise.google/policies/?policy=AllowScreenLock for more details. Available on ChromeOS only. + * Output only. Value of the AllowScreenLock policy on the device. See https://chromeenterprise.google/policies/?policy=AllowScreenLock for more details. Available on ChromeOS only. */ allowScreenLock?: boolean | null; /** - * Current version of the Chrome browser which generated this set of signals. Example value: "107.0.5286.0". + * Output only. Information about Antivirus software on the device. Available on Windows only. + */ + antivirus?: Schema$Antivirus; + /** + * Output only. Current version of the Chrome browser which generated this set of signals. Example value: "107.0.5286.0". */ browserVersion?: string | null; /** - * Whether Chrome's built-in DNS client is used. The OS DNS client is otherwise used. This value may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled. + * Output only. Whether Chrome's built-in DNS client is used. The OS DNS client is otherwise used. This value may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled. */ builtInDnsClientEnabled?: boolean | null; /** - * Whether access to the Chrome Remote Desktop application is blocked via a policy. + * Output only. Whether access to the Chrome Remote Desktop application is blocked via a policy. */ chromeRemoteDesktopAppBlocked?: boolean | null; /** - * Crowdstrike agent properties installed on the device, if any. Available on Windows and MacOS only. + * Output only. Crowdstrike agent properties installed on the device, if any. Available on Windows and MacOS only. */ crowdStrikeAgent?: Schema$CrowdStrikeAgent; /** - * Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the device. When the sets of device and profile affiliation IDs overlap, it means that the organizations managing the device and user are affiliated. To learn more about user affiliation, visit https://support.google.com/chrome/a/answer/12801245?ref_topic=9027936. + * Output only. Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the device. When the sets of device and profile affiliation IDs overlap, it means that the organizations managing the device and user are affiliated. To learn more about user affiliation, visit https://support.google.com/chrome/a/answer/12801245?ref_topic=9027936. */ deviceAffiliationIds?: string[] | null; /** - * Enrollment domain of the customer which is currently managing the device. + * Output only. Enrollment domain of the customer which is currently managing the device. */ deviceEnrollmentDomain?: string | null; /** - * The name of the device's manufacturer. + * Output only. The name of the device's manufacturer. */ deviceManufacturer?: string | null; /** - * The name of the device's model. + * Output only. The name of the device's model. */ deviceModel?: string | null; /** - * The encryption state of the disk. On ChromeOS, the main disk is always ENCRYPTED. + * Output only. The encryption state of the disk. On ChromeOS, the main disk is always ENCRYPTED. */ diskEncryption?: string | null; /** - * The display name of the device, as defined by the user. + * Output only. The display name of the device, as defined by the user. */ displayName?: string | null; /** @@ -199,63 +212,63 @@ export namespace verifiedaccess_v2 { */ hostname?: string | null; /** - * International Mobile Equipment Identity (IMEI) of the device. Available on ChromeOS only. + * Output only. International Mobile Equipment Identity (IMEI) of the device. Available on ChromeOS only. */ imei?: string[] | null; /** - * MAC addresses of the device. + * Output only. MAC addresses of the device. */ macAddresses?: string[] | null; /** - * Mobile Equipment Identifier (MEID) of the device. Available on ChromeOS only. + * Output only. Mobile Equipment Identifier (MEID) of the device. Available on ChromeOS only. */ meid?: string[] | null; /** - * The type of the Operating System currently running on the device. + * Output only. The type of the Operating System currently running on the device. */ operatingSystem?: string | null; /** - * The state of the OS level firewall. On ChromeOS, the value will always be ENABLED on regular devices and UNKNOWN on devices in developer mode. Support for MacOS 15 (Sequoia) and later has been introduced in Chrome M131. + * Output only. The state of the OS level firewall. On ChromeOS, the value will always be ENABLED on regular devices and UNKNOWN on devices in developer mode. Support for MacOS 15 (Sequoia) and later has been introduced in Chrome M131. */ osFirewall?: string | null; /** - * The current version of the Operating System. On Windows and linux, the value will also include the security patch information. + * Output only. The current version of the Operating System. On Windows and linux, the value will also include the security patch information. */ osVersion?: string | null; /** - * Whether the Password Protection Warning feature is enabled or not. Password protection alerts users when they reuse their protected password on potentially suspicious sites. This setting is controlled by an enterprise policy: https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger. Note that the policy unset does not have the same effects as having the policy explicitly set to `PASSWORD_PROTECTION_OFF`. + * Output only. Whether the Password Protection Warning feature is enabled or not. Password protection alerts users when they reuse their protected password on potentially suspicious sites. This setting is controlled by an enterprise policy: https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger. Note that the policy unset does not have the same effects as having the policy explicitly set to `PASSWORD_PROTECTION_OFF`. */ passwordProtectionWarningTrigger?: string | null; /** - * Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the Chrome Profile’s user or ChromeOS user. + * Output only. Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the Chrome Profile’s user or ChromeOS user. */ profileAffiliationIds?: string[] | null; /** - * Enrollment domain of the customer which is currently managing the profile. + * Output only. Enrollment domain of the customer which is currently managing the profile. */ profileEnrollmentDomain?: string | null; /** - * Whether Enterprise-grade (i.e. custom) unsafe URL scanning is enabled or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode + * Output only. Whether Enterprise-grade (i.e. custom) unsafe URL scanning is enabled or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode */ realtimeUrlCheckMode?: string | null; /** - * Safe Browsing Protection Level. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel. + * Output only. Safe Browsing Protection Level. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel. */ safeBrowsingProtectionLevel?: string | null; /** - * The state of the Screen Lock password protection. On ChromeOS, this value will always be ENABLED as there is not way to disable requiring a password or pin when unlocking the device. + * Output only. The state of the Screen Lock password protection. On ChromeOS, this value will always be ENABLED as there is not way to disable requiring a password or pin when unlocking the device. */ screenLockSecured?: string | null; /** - * Whether the device's startup software has its Secure Boot feature enabled. Available on Windows only. + * Output only. Whether the device's startup software has its Secure Boot feature enabled. Available on Windows only. */ secureBootMode?: string | null; /** - * The serial number of the device. On Windows, this represents the BIOS's serial number. Not available on most Linux distributions. + * Output only. The serial number of the device. On Windows, this represents the BIOS's serial number. Not available on most Linux distributions. */ serialNumber?: string | null; /** - * Whether the Site Isolation (a.k.a Site Per Process) setting is enabled. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SitePerProcess + * Output only. Whether the Site Isolation (a.k.a Site Per Process) setting is enabled. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SitePerProcess */ siteIsolationEnabled?: boolean | null; /** @@ -263,19 +276,19 @@ export namespace verifiedaccess_v2 { */ systemDnsServers?: string[] | null; /** - * Whether Chrome is blocking third-party software injection or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/?policy=ThirdPartyBlockingEnabled. Available on Windows only. + * Output only. Whether Chrome is blocking third-party software injection or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/?policy=ThirdPartyBlockingEnabled. Available on Windows only. */ thirdPartyBlockingEnabled?: boolean | null; /** - * The trigger which generated this set of signals. + * Output only. The trigger which generated this set of signals. */ trigger?: string | null; /** - * Windows domain that the current machine has joined. Available on Windows only. + * Output only. Windows domain that the current machine has joined. Available on Windows only. */ windowsMachineDomain?: string | null; /** - * Windows domain for the current OS user. Available on Windows only. + * Output only. Windows domain for the current OS user. Available on Windows only. */ windowsUserDomain?: string | null; } @@ -301,51 +314,55 @@ export namespace verifiedaccess_v2 { */ export interface Schema$VerifyChallengeResponseResult { /** - * Attested device ID (ADID). + * Output only. Attested device ID (ADID). */ attestedDeviceId?: string | null; /** - * Unique customer id that this device belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers + * Output only. Unique customer id that this device belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers */ customerId?: string | null; /** - * Device enrollment id for ChromeOS devices. + * Output only. Device enrollment id for ChromeOS devices. */ deviceEnrollmentId?: string | null; /** - * Device permanent id is returned in this field (for the machine response only). + * Output only. Device permanent id is returned in this field (for the machine response only). */ devicePermanentId?: string | null; /** - * Deprecated. Device signal in json string representation. Prefer using `device_signals` instead. + * Output only. Deprecated. Device signal in json string representation. Prefer using `device_signals` instead. */ deviceSignal?: string | null; /** - * Device signals. + * Output only. Device signals. */ deviceSignals?: Schema$DeviceSignals; /** - * Device attested key trust level. + * Output only. Device attested key trust level. */ keyTrustLevel?: string | null; /** - * Unique customer id that this profile belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers + * Output only. Unique customer id that this profile belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers */ profileCustomerId?: string | null; /** - * Profile attested key trust level. + * Output only. Profile attested key trust level. */ profileKeyTrustLevel?: string | null; /** - * Certificate Signing Request (in the SPKAC format, base64 encoded) is returned in this field. This field will be set only if device has included CSR in its challenge response. (the option to include CSR is now available for both user and machine responses) + * Output only. The unique server-side ID of a profile on the device. + */ + profilePermanentId?: string | null; + /** + * Output only. Certificate Signing Request (in the SPKAC format, base64 encoded) is returned in this field. This field will be set only if device has included CSR in its challenge response. (the option to include CSR is now available for both user and machine responses) */ signedPublicKeyAndChallenge?: string | null; /** - * Virtual device id of the device. The definition of virtual device id is platform-specific. + * Output only. Virtual device id of the device. The definition of virtual device id is platform-specific. */ virtualDeviceId?: string | null; /** - * The ID of a profile on the device. + * Output only. The client-provided ID of a profile on the device. */ virtualProfileId?: string | null; } From b2790e84b3ec1b7bbada9c8f1564f0c6f2a0f313 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 133/144] fix(videointelligence): update the API #### videointelligence:v1 The following keys were changed: - resources.operations.resources.projects.resources.locations.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.operations.methods.cancel.description --- discovery/videointelligence-v1.json | 6 +++--- src/apis/videointelligence/v1.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/discovery/videointelligence-v1.json b/discovery/videointelligence-v1.json index e0de005dcc6..ae524dbc9e7 100644 --- a/discovery/videointelligence-v1.json +++ b/discovery/videointelligence-v1.json @@ -114,7 +114,7 @@ "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`.", + "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/operations/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "videointelligence.operations.projects.locations.operations.cancel", @@ -203,7 +203,7 @@ "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`.", + "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": "videointelligence.projects.locations.operations.cancel", @@ -350,7 +350,7 @@ } } }, - "revision": "20231214", + "revision": "20250130", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 6cbcff27f2a..8d4419fc9fa 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -3429,7 +3429,7 @@ export namespace videointelligence_v1 { } /** - * 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`. + * 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`. @@ -3765,7 +3765,7 @@ export namespace videointelligence_v1 { } /** - * 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`. + * 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`. From 77a80eff2280635be946669f1b96a2aded5c7a01 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:50 +0000 Subject: [PATCH 134/144] fix(vmmigration): update the API #### vmmigration:v1alpha1 The following keys were changed: - schemas.AvailableUpdates.description - schemas.CutoverJob.description #### vmmigration:v1 The following keys were changed: - schemas.AvailableUpdates.description - schemas.CutoverJob.description --- discovery/vmmigration-v1.json | 6 +++--- discovery/vmmigration-v1alpha1.json | 6 +++--- src/apis/vmmigration/v1.ts | 4 ++-- src/apis/vmmigration/v1alpha1.ts | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index f3b7dff1081..01b5fa324d8 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-v1.json @@ -2220,7 +2220,7 @@ } } }, - "revision": "20250116", + "revision": "20250213", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2310,7 +2310,7 @@ "type": "object" }, "AvailableUpdates": { - "description": "Holds informatiom about the available versions for upgrade.", + "description": "Holds information about the available versions for upgrade.", "id": "AvailableUpdates", "properties": { "inPlaceUpdate": { @@ -3514,7 +3514,7 @@ "type": "object" }, "CutoverJob": { - "description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.", + "description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot.", "id": "CutoverJob", "properties": { "computeEngineDisksTargetDetails": { diff --git a/discovery/vmmigration-v1alpha1.json b/discovery/vmmigration-v1alpha1.json index ea6dbaedb4f..0e0ea2d376a 100644 --- a/discovery/vmmigration-v1alpha1.json +++ b/discovery/vmmigration-v1alpha1.json @@ -2220,7 +2220,7 @@ } } }, - "revision": "20250116", + "revision": "20250213", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2310,7 +2310,7 @@ "type": "object" }, "AvailableUpdates": { - "description": "Holds informatiom about the available versions for upgrade.", + "description": "Holds information about the available versions for upgrade.", "id": "AvailableUpdates", "properties": { "inPlaceUpdate": { @@ -3530,7 +3530,7 @@ "type": "object" }, "CutoverJob": { - "description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot.", + "description": "CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot.", "id": "CutoverJob", "properties": { "computeEngineDisksTargetDetails": { diff --git a/src/apis/vmmigration/v1.ts b/src/apis/vmmigration/v1.ts index 84cb8d2022f..a19504a0c52 100644 --- a/src/apis/vmmigration/v1.ts +++ b/src/apis/vmmigration/v1.ts @@ -189,7 +189,7 @@ export namespace vmmigration_v1 { type?: string | null; } /** - * Holds informatiom about the available versions for upgrade. + * Holds information about the available versions for upgrade. */ export interface Schema$AvailableUpdates { /** @@ -911,7 +911,7 @@ export namespace vmmigration_v1 { estimatedCutoverJobDuration?: string | null; } /** - * CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + * CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. */ export interface Schema$CutoverJob { /** diff --git a/src/apis/vmmigration/v1alpha1.ts b/src/apis/vmmigration/v1alpha1.ts index 5c96beaea06..6f46c8a5db2 100644 --- a/src/apis/vmmigration/v1alpha1.ts +++ b/src/apis/vmmigration/v1alpha1.ts @@ -189,7 +189,7 @@ export namespace vmmigration_v1alpha1 { type?: string | null; } /** - * Holds informatiom about the available versions for upgrade. + * Holds information about the available versions for upgrade. */ export interface Schema$AvailableUpdates { /** @@ -920,7 +920,7 @@ export namespace vmmigration_v1alpha1 { estimatedCutoverJobDuration?: string | null; } /** - * CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and clonning the VM using the replicated snapshot. + * CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and cloning the VM using the replicated snapshot. */ export interface Schema$CutoverJob { /** From 75b4b0e15a05b24c3a9012714f50b774c3cbc0f3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 135/144] feat(vmwareengine): update the API #### vmwareengine:v1 The following keys were added: - resources.projects.resources.locations.resources.announcements.methods.get.description - resources.projects.resources.locations.resources.announcements.methods.get.flatPath - resources.projects.resources.locations.resources.announcements.methods.get.httpMethod - resources.projects.resources.locations.resources.announcements.methods.get.id - resources.projects.resources.locations.resources.announcements.methods.get.parameterOrder - resources.projects.resources.locations.resources.announcements.methods.get.parameters.name.description - resources.projects.resources.locations.resources.announcements.methods.get.parameters.name.location - resources.projects.resources.locations.resources.announcements.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.announcements.methods.get.parameters.name.required - resources.projects.resources.locations.resources.announcements.methods.get.parameters.name.type - resources.projects.resources.locations.resources.announcements.methods.get.path - resources.projects.resources.locations.resources.announcements.methods.get.response.$ref - resources.projects.resources.locations.resources.announcements.methods.get.scopes - resources.projects.resources.locations.resources.announcements.methods.list.description - resources.projects.resources.locations.resources.announcements.methods.list.flatPath - resources.projects.resources.locations.resources.announcements.methods.list.httpMethod - resources.projects.resources.locations.resources.announcements.methods.list.id - resources.projects.resources.locations.resources.announcements.methods.list.parameterOrder - resources.projects.resources.locations.resources.announcements.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.announcements.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.announcements.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.announcements.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.announcements.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.announcements.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.announcements.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.announcements.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.announcements.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.announcements.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.announcements.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.announcements.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.announcements.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.announcements.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.announcements.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.announcements.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.announcements.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.announcements.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.announcements.methods.list.path - resources.projects.resources.locations.resources.announcements.methods.list.response.$ref - resources.projects.resources.locations.resources.announcements.methods.list.scopes - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.flatPath - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.httpMethod - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.id - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.parameterOrder - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.parameters.name.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.parameters.name.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.parameters.name.required - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.parameters.name.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.path - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.response.$ref - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.get.scopes - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.flatPath - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.httpMethod - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.id - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameterOrder - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.path - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.response.$ref - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.list.scopes - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.flatPath - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.httpMethod - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.id - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameterOrder - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.path - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.request.$ref - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.response.$ref - resources.projects.resources.locations.resources.privateClouds.resources.upgrades.methods.patch.scopes - schemas.Announcement.description - schemas.Announcement.id - schemas.Announcement.properties.activityType.description - schemas.Announcement.properties.activityType.type - schemas.Announcement.properties.cluster.description - schemas.Announcement.properties.cluster.type - schemas.Announcement.properties.code.description - schemas.Announcement.properties.code.type - schemas.Announcement.properties.createTime.description - schemas.Announcement.properties.createTime.format - schemas.Announcement.properties.createTime.readOnly - schemas.Announcement.properties.createTime.type - schemas.Announcement.properties.description.description - schemas.Announcement.properties.description.readOnly - schemas.Announcement.properties.description.type - schemas.Announcement.properties.metadata.additionalProperties.type - schemas.Announcement.properties.metadata.description - schemas.Announcement.properties.metadata.readOnly - schemas.Announcement.properties.metadata.type - schemas.Announcement.properties.name.description - schemas.Announcement.properties.name.readOnly - schemas.Announcement.properties.name.type - schemas.Announcement.properties.privateCloud.description - schemas.Announcement.properties.privateCloud.type - schemas.Announcement.properties.state.description - schemas.Announcement.properties.state.enum - schemas.Announcement.properties.state.enumDescriptions - schemas.Announcement.properties.state.readOnly - schemas.Announcement.properties.state.type - schemas.Announcement.properties.targetResourceType.description - schemas.Announcement.properties.targetResourceType.readOnly - schemas.Announcement.properties.targetResourceType.type - schemas.Announcement.properties.updateTime.description - schemas.Announcement.properties.updateTime.format - schemas.Announcement.properties.updateTime.readOnly - schemas.Announcement.properties.updateTime.type - schemas.Announcement.type - schemas.Constraints.description - schemas.Constraints.id - schemas.Constraints.properties.minHoursDay.description - schemas.Constraints.properties.minHoursDay.format - schemas.Constraints.properties.minHoursDay.readOnly - schemas.Constraints.properties.minHoursDay.type - schemas.Constraints.properties.minHoursWeek.description - schemas.Constraints.properties.minHoursWeek.format - schemas.Constraints.properties.minHoursWeek.readOnly - schemas.Constraints.properties.minHoursWeek.type - schemas.Constraints.properties.rescheduleDateRange.$ref - schemas.Constraints.properties.rescheduleDateRange.description - schemas.Constraints.properties.rescheduleDateRange.readOnly - schemas.Constraints.type - schemas.Interval.description - schemas.Interval.id - schemas.Interval.properties.endTime.description - schemas.Interval.properties.endTime.format - schemas.Interval.properties.endTime.type - schemas.Interval.properties.startTime.description - schemas.Interval.properties.startTime.format - schemas.Interval.properties.startTime.type - schemas.Interval.type - schemas.ListAnnouncementsResponse.description - schemas.ListAnnouncementsResponse.id - schemas.ListAnnouncementsResponse.properties.announcements.description - schemas.ListAnnouncementsResponse.properties.announcements.items.$ref - schemas.ListAnnouncementsResponse.properties.announcements.type - schemas.ListAnnouncementsResponse.properties.nextPageToken.description - schemas.ListAnnouncementsResponse.properties.nextPageToken.type - schemas.ListAnnouncementsResponse.properties.unreachable.description - schemas.ListAnnouncementsResponse.properties.unreachable.items.type - schemas.ListAnnouncementsResponse.properties.unreachable.type - schemas.ListAnnouncementsResponse.type - schemas.ListUpgradesResponse.description - schemas.ListUpgradesResponse.id - schemas.ListUpgradesResponse.properties.nextPageToken.description - schemas.ListUpgradesResponse.properties.nextPageToken.type - schemas.ListUpgradesResponse.properties.unreachable.description - schemas.ListUpgradesResponse.properties.unreachable.items.type - schemas.ListUpgradesResponse.properties.unreachable.type - schemas.ListUpgradesResponse.properties.upgrades.description - schemas.ListUpgradesResponse.properties.upgrades.items.$ref - schemas.ListUpgradesResponse.properties.upgrades.type - schemas.ListUpgradesResponse.type - schemas.Schedule.description - schemas.Schedule.id - schemas.Schedule.properties.constraints.$ref - schemas.Schedule.properties.constraints.description - schemas.Schedule.properties.constraints.readOnly - schemas.Schedule.properties.editWindow.$ref - schemas.Schedule.properties.editWindow.description - schemas.Schedule.properties.editWindow.readOnly - schemas.Schedule.properties.lastEditor.description - schemas.Schedule.properties.lastEditor.enum - schemas.Schedule.properties.lastEditor.enumDescriptions - schemas.Schedule.properties.lastEditor.readOnly - schemas.Schedule.properties.lastEditor.type - schemas.Schedule.properties.startTime.description - schemas.Schedule.properties.startTime.format - schemas.Schedule.properties.startTime.type - schemas.Schedule.properties.weeklyWindows.description - schemas.Schedule.properties.weeklyWindows.items.$ref - schemas.Schedule.properties.weeklyWindows.type - schemas.Schedule.type - schemas.TimeOfDay.description - schemas.TimeOfDay.id - schemas.TimeOfDay.properties.hours.description - schemas.TimeOfDay.properties.hours.format - schemas.TimeOfDay.properties.hours.type - schemas.TimeOfDay.properties.minutes.description - schemas.TimeOfDay.properties.minutes.format - schemas.TimeOfDay.properties.minutes.type - schemas.TimeOfDay.properties.nanos.description - schemas.TimeOfDay.properties.nanos.format - schemas.TimeOfDay.properties.nanos.type - schemas.TimeOfDay.properties.seconds.description - schemas.TimeOfDay.properties.seconds.format - schemas.TimeOfDay.properties.seconds.type - schemas.TimeOfDay.type - schemas.TimeWindow.description - schemas.TimeWindow.id - schemas.TimeWindow.properties.dayOfWeek.description - schemas.TimeWindow.properties.dayOfWeek.enum - schemas.TimeWindow.properties.dayOfWeek.enumDescriptions - schemas.TimeWindow.properties.dayOfWeek.type - schemas.TimeWindow.properties.duration.description - schemas.TimeWindow.properties.duration.format - schemas.TimeWindow.properties.duration.type - schemas.TimeWindow.properties.startTime.$ref - schemas.TimeWindow.properties.startTime.description - schemas.TimeWindow.type - schemas.Upgrade.description - schemas.Upgrade.id - schemas.Upgrade.properties.componentUpgrades.description - schemas.Upgrade.properties.componentUpgrades.items.$ref - schemas.Upgrade.properties.componentUpgrades.readOnly - schemas.Upgrade.properties.componentUpgrades.type - schemas.Upgrade.properties.createTime.description - schemas.Upgrade.properties.createTime.format - schemas.Upgrade.properties.createTime.readOnly - schemas.Upgrade.properties.createTime.type - schemas.Upgrade.properties.description.description - schemas.Upgrade.properties.description.readOnly - schemas.Upgrade.properties.description.type - schemas.Upgrade.properties.endTime.description - schemas.Upgrade.properties.endTime.format - schemas.Upgrade.properties.endTime.readOnly - schemas.Upgrade.properties.endTime.type - schemas.Upgrade.properties.estimatedDuration.description - schemas.Upgrade.properties.estimatedDuration.format - schemas.Upgrade.properties.estimatedDuration.readOnly - schemas.Upgrade.properties.estimatedDuration.type - schemas.Upgrade.properties.etag.description - schemas.Upgrade.properties.etag.type - schemas.Upgrade.properties.name.description - schemas.Upgrade.properties.name.readOnly - schemas.Upgrade.properties.name.type - schemas.Upgrade.properties.schedule.$ref - schemas.Upgrade.properties.schedule.description - schemas.Upgrade.properties.startVersion.description - schemas.Upgrade.properties.startVersion.readOnly - schemas.Upgrade.properties.startVersion.type - schemas.Upgrade.properties.state.description - schemas.Upgrade.properties.state.enum - schemas.Upgrade.properties.state.enumDescriptions - schemas.Upgrade.properties.state.readOnly - schemas.Upgrade.properties.state.type - schemas.Upgrade.properties.targetVersion.description - schemas.Upgrade.properties.targetVersion.readOnly - schemas.Upgrade.properties.targetVersion.type - schemas.Upgrade.properties.type.description - schemas.Upgrade.properties.type.enum - schemas.Upgrade.properties.type.enumDescriptions - schemas.Upgrade.properties.type.readOnly - schemas.Upgrade.properties.type.type - schemas.Upgrade.properties.uid.description - schemas.Upgrade.properties.uid.readOnly - schemas.Upgrade.properties.uid.type - schemas.Upgrade.properties.updateTime.description - schemas.Upgrade.properties.updateTime.format - schemas.Upgrade.properties.updateTime.readOnly - schemas.Upgrade.properties.updateTime.type - schemas.Upgrade.properties.version.description - schemas.Upgrade.properties.version.readOnly - schemas.Upgrade.properties.version.type - schemas.Upgrade.type - schemas.VmwareUpgradeComponent.description - schemas.VmwareUpgradeComponent.id - schemas.VmwareUpgradeComponent.properties.componentType.description - schemas.VmwareUpgradeComponent.properties.componentType.enum - schemas.VmwareUpgradeComponent.properties.componentType.enumDescriptions - schemas.VmwareUpgradeComponent.properties.componentType.readOnly - schemas.VmwareUpgradeComponent.properties.componentType.type - schemas.VmwareUpgradeComponent.properties.state.description - schemas.VmwareUpgradeComponent.properties.state.enum - schemas.VmwareUpgradeComponent.properties.state.enumDescriptions - schemas.VmwareUpgradeComponent.properties.state.readOnly - schemas.VmwareUpgradeComponent.properties.state.type - schemas.VmwareUpgradeComponent.type --- discovery/vmwareengine-v1.json | 666 ++++++++++++++++++++++- src/apis/vmwareengine/v1.ts | 942 ++++++++++++++++++++++++++++++--- 2 files changed, 1538 insertions(+), 70 deletions(-) diff --git a/discovery/vmwareengine-v1.json b/discovery/vmwareengine-v1.json index eeb4badb317..c6cdddfb121 100644 --- a/discovery/vmwareengine-v1.json +++ b/discovery/vmwareengine-v1.json @@ -202,6 +202,81 @@ } }, "resources": { + "announcements": { + "methods": { + "get": { + "description": "Retrieves a `Announcement` by its resource name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/announcements/{announcementsId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.announcements.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the announcement to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/announcement-uuid`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/announcements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Announcement" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `Announcements` for a given region and project", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/announcements", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.announcements.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of announcement runs, you can exclude the ones named `example-announcement` by specifying `name != \"example-announcement\"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-announcement\") (createTime > \"2021-04-12T08:15:10.40Z\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"announcement-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"announcement-2\") ```", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of announcements to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAnnouncements` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnouncements` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to be queried for announcements. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/announcements", + "response": { + "$ref": "ListAnnouncementsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "dnsBindPermission": { "methods": { "grant": { @@ -2754,6 +2829,120 @@ ] } } + }, + "upgrades": { + "methods": { + "get": { + "description": "Retrieves a private cloud `Upgrade` resource by its resource name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/upgrades/{upgradesId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.upgrades.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `Upgrade` resource to be retrieved. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/upgrades/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Upgrade" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists past, ongoing and upcoming `Upgrades` for the given private cloud.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/upgrades", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.upgrades.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of upgrades, you can exclude the ones named `example-upgrade1` by specifying `name != \"example-upgrade1\"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-upgrade\") (createTime > \"2021-04-12T08:15:10.40Z\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"upgrade-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"upgrade-2\") ```", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of `Upgrades` to return in one page. The service may return fewer resources than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListUpgrades` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUpgrades` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Query a list of `Upgrades` for the given private cloud resource name. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/upgrades", + "response": { + "$ref": "ListUpgradesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update the private cloud `Upgrade` resource. Only `schedule` field can updated. The schedule can only be updated when the upgrade has not started and schedule edit window is open. Only fields specified in `update_mask` are considered.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/upgrades/{upgradesId}", + "httpMethod": "PATCH", + "id": "vmwareengine.projects.locations.privateClouds.upgrades.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/upgrades/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A 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 guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 `Upgrade` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Upgrade" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -3173,9 +3362,86 @@ } } }, - "revision": "20241009", + "revision": "20250218", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { + "Announcement": { + "description": "Announcement for the resources of Vmware Engine.", + "id": "Announcement", + "properties": { + "activityType": { + "description": "Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource.", + "type": "string" + }, + "cluster": { + "description": "A Cluster resource name.", + "type": "string" + }, + "code": { + "description": "Required. Code of the announcement. Indicates the presence of a VMware Engine related announcement and corresponds to a related message in the `description` field.", + "type": "string" + }, + "createTime": { + "description": "Output only. Creation time of this resource. It also serves as start time of notification.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. Description of the announcement.", + "readOnly": true, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. Additional structured details about this announcement.", + "readOnly": true, + "type": "object" + }, + "name": { + "description": "Output only. The resource name of the announcement. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/my-announcement-id`", + "readOnly": true, + "type": "string" + }, + "privateCloud": { + "description": "A Private Cloud resource name.", + "type": "string" + }, + "state": { + "description": "Output only. State of the resource. New values may be added to this enum when appropriate.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE", + "DELETING", + "CREATING" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "Active announcement which should be visible to user.", + "Inactive announcement which should not be visible to user.", + "Announcement which is being deleted", + "Announcement which being created" + ], + "readOnly": true, + "type": "string" + }, + "targetResourceType": { + "description": "Output only. Target Resource Type defines the type of the target for the announcement", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last update time of this resource.", + "format": "google-datetime", + "readOnly": true, + "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", @@ -3377,6 +3643,30 @@ }, "type": "object" }, + "Constraints": { + "description": "Constraints to be applied while editing a schedule. These constraints ensure that `Upgrade` specific requirements are met.", + "id": "Constraints", + "properties": { + "minHoursDay": { + "description": "Output only. Minimum number of hours must be allotted for the upgrade activities for each selected day. This is a minimum; the upgrade schedule can allot more hours for the given day.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "minHoursWeek": { + "description": "Output only. The minimum number of weekly hours must be allotted for the upgrade activities. This is just a minimum; the schedule can assign more weekly hours.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "rescheduleDateRange": { + "$ref": "Interval", + "description": "Output only. Output Only. The user can only reschedule an upgrade that starts within this range.", + "readOnly": true + } + }, + "type": "object" + }, "Credentials": { "description": "Credentials for a private cloud.", "id": "Credentials", @@ -3768,6 +4058,23 @@ }, "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" + }, "IpRange": { "description": "An IP range provided in any one of the supported formats.", "id": "IpRange", @@ -3787,6 +4094,31 @@ }, "type": "object" }, + "ListAnnouncementsResponse": { + "description": "Response message for VmwareEngine.ListAnnouncements", + "id": "ListAnnouncementsResponse", + "properties": { + "announcements": { + "description": "A list of announcement runs.", + "items": { + "$ref": "Announcement" + }, + "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" + }, + "unreachable": { + "description": "list of unreachable locations", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListClustersResponse": { "description": "Response message for VmwareEngine.ListClusters", "id": "ListClustersResponse", @@ -4177,6 +4509,31 @@ }, "type": "object" }, + "ListUpgradesResponse": { + "description": "Response message for VmwareEngine.ListUpgrades.", + "id": "ListUpgradesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "List of unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "upgrades": { + "description": "A list of `Upgrades`.", + "items": { + "$ref": "Upgrade" + }, + "type": "array" + } + }, + "type": "object" + }, "ListVmwareEngineNetworksResponse": { "description": "Response message for VmwareEngine.ListVmwareEngineNetworks", "id": "ListVmwareEngineNetworksResponse", @@ -5307,6 +5664,50 @@ }, "type": "object" }, + "Schedule": { + "description": "Schedule for the upgrade.", + "id": "Schedule", + "properties": { + "constraints": { + "$ref": "Constraints", + "description": "Output only. Output Only. Constraints applied to the schedule. These constraints should be applicable at the time of any rescheduling.", + "readOnly": true + }, + "editWindow": { + "$ref": "Interval", + "description": "Output only. Output Only. The schedule is open for edits during this time interval or window.", + "readOnly": true + }, + "lastEditor": { + "description": "Output only. Output Only. Indicates who most recently edited the upgrade schedule. The value is updated whenever the upgrade is rescheduled.", + "enum": [ + "EDITOR_UNSPECIFIED", + "SYSTEM", + "USER" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "The upgrade is scheduled by the System or internal service.", + "The upgrade is scheduled by the end user." + ], + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Required. The scheduled start time for the upgrade.", + "format": "google-datetime", + "type": "string" + }, + "weeklyWindows": { + "description": "Required. Weekly time windows for upgrade activities. The server performs upgrade activities during these time windows to minimize disruptions.", + "items": { + "$ref": "TimeWindow" + }, + "type": "array" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -5464,6 +5865,73 @@ }, "type": "object" }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TimeWindow": { + "description": "Represents the time window to perform upgrade activities.", + "id": "TimeWindow", + "properties": { + "dayOfWeek": { + "description": "Required. Day of the week for this window.", + "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" + }, + "duration": { + "description": "Required. The duration of the window. The max allowed duration for any window is 24 hours.", + "format": "google-duration", + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Required. Time in UTC when the window starts." + } + }, + "type": "object" + }, "UndeletePrivateCloudRequest": { "description": "Request message for VmwareEngine.UndeletePrivateCloud", "id": "UndeletePrivateCloudRequest", @@ -5475,6 +5943,135 @@ }, "type": "object" }, + "Upgrade": { + "description": "Describes Private cloud Upgrade.", + "id": "Upgrade", + "properties": { + "componentUpgrades": { + "description": "Output only. Output Only. The list of component upgrades.", + "items": { + "$ref": "VmwareUpgradeComponent" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. Output Only. Creation time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade.", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Output Only. End time of the upgrade.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "estimatedDuration": { + "description": "Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "The etag for the upgrade resource. If this is provided on update, it must match the server's etag.", + "type": "string" + }, + "name": { + "description": "Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`", + "readOnly": true, + "type": "string" + }, + "schedule": { + "$ref": "Schedule", + "description": "Schedule details for the upgrade." + }, + "startVersion": { + "description": "Output only. Output Only. The start version", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the upgrade.", + "enum": [ + "STATE_UNSPECIFIED", + "SCHEDULED", + "ONGOING", + "SUCCEEDED", + "PAUSED", + "FAILED", + "CANCELLING", + "CANCELLED", + "RESCHEDULING" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "The upgrade is scheduled but not started yet.", + "The upgrade is currently in progress and has not completed yet.", + "The upgrade completed successfully.", + "The upgrade is currently paused.", + "The upgrade failed.", + "The upgrade is in process of being canceled.", + "The upgrade is canceled.", + "The upgrade is in process of being rescheduled." + ], + "readOnly": true, + "type": "string" + }, + "targetVersion": { + "description": "Output only. Output Only. The target version", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. Output Only. The type of upgrade.", + "enum": [ + "TYPE_UNSPECIFIED", + "VSPHERE_UPGRADE", + "VSPHERE_PATCH", + "WORKAROUND", + "FIRMWARE_UPGRADE", + "SWITCH_UPGRADE", + "OTHER", + "INFRASTRUCTURE_UPGRADE" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "Upgrade of vmware components when a major version is available. 7.0u2 -> 7.0u3.", + "Patching of vmware components when a minor version is available. 7.0u2c -> 7.0u2d.", + "Workarounds are hotfixes for vulnerabilities or issues applied to mitigate the known vulnerability or issue until a patch or update is released. The description of the upgrade will have more details.", + "Firmware upgrade for VMware product used in the private cloud.", + "Switch upgrade.", + "The upgrade type that doesn't fall into any other category.", + "Infrastructure upgrade in BM node maintenance." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-generated unique identifier for the resource.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Output Only. Last update time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Output only. ", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Vcenter": { "description": "Details about a vCenter Server management appliance.", "id": "Vcenter", @@ -5587,6 +6184,73 @@ }, "type": "object" }, + "VmwareUpgradeComponent": { + "description": "Per component upgrade resource", + "id": "VmwareUpgradeComponent", + "properties": { + "componentType": { + "description": "Output only. Type of component", + "enum": [ + "VMWARE_COMPONENT_TYPE_UNSPECIFIED", + "VCENTER", + "ESXI", + "NSXT_UC", + "NSXT_EDGE", + "NSXT_MGR", + "HCX", + "VSAN", + "DVS", + "NAMESERVER_VM", + "KMS_VM", + "WITNESS_VM", + "NSXT", + "CLUSTER" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "vcenter", + "esxi nodes + transport nodes", + "nsxt upgrade coordinator", + "nsxt edges cluster", + "nsxt managers/management plane", + "hcx", + "VSAN cluster", + "DVS switch", + "Nameserver VMs", + "KMS VM used for vsan encryption", + "witness VM in case of stretch PC", + "nsxt", + "Cluster is used in case of BM" + ], + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. Component's upgrade state.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "PAUSED", + "SUCCEEDED", + "FAILED", + "NOT_STARTED", + "NOT_APPLICABLE" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "Component's upgrade is in progress", + "The component's upgrade is paused. Will be resumed when upgrade job is resumed", + "The component's upgrade is successfully completed", + "The component's upgrade has failed. This will move to resume if upgrade is resumed or stay as is", + "Component's upgrade has not started yet", + "Component's upgrade is not applicable in this upgrade. It will be skipped." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "VpcNetwork": { "description": "Represents a VMware Engine VPC network that is managed by a VMware Engine network resource.", "id": "VpcNetwork", diff --git a/src/apis/vmwareengine/v1.ts b/src/apis/vmwareengine/v1.ts index 362399b53cd..0549a892e54 100644 --- a/src/apis/vmwareengine/v1.ts +++ b/src/apis/vmwareengine/v1.ts @@ -124,6 +124,55 @@ export namespace vmwareengine_v1 { } } + /** + * Announcement for the resources of Vmware Engine. + */ + export interface Schema$Announcement { + /** + * Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource. + */ + activityType?: string | null; + /** + * A Cluster resource name. + */ + cluster?: string | null; + /** + * Required. Code of the announcement. Indicates the presence of a VMware Engine related announcement and corresponds to a related message in the `description` field. + */ + code?: string | null; + /** + * Output only. Creation time of this resource. It also serves as start time of notification. + */ + createTime?: string | null; + /** + * Output only. Description of the announcement. + */ + description?: string | null; + /** + * Output only. Additional structured details about this announcement. + */ + metadata?: {[key: string]: string} | null; + /** + * Output only. The resource name of the announcement. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/my-announcement-id` + */ + name?: string | null; + /** + * A Private Cloud resource name. + */ + privateCloud?: string | null; + /** + * Output only. State of the resource. New values may be added to this enum when appropriate. + */ + state?: string | null; + /** + * Output only. Target Resource Type defines the type of the target for the announcement + */ + targetResourceType?: string | null; + /** + * Output only. Last update time of this resource. + */ + updateTime?: string | null; + } /** * 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. */ @@ -258,6 +307,23 @@ export namespace vmwareengine_v1 { */ updateTime?: string | null; } + /** + * Constraints to be applied while editing a schedule. These constraints ensure that `Upgrade` specific requirements are met. + */ + export interface Schema$Constraints { + /** + * Output only. Minimum number of hours must be allotted for the upgrade activities for each selected day. This is a minimum; the upgrade schedule can allot more hours for the given day. + */ + minHoursDay?: number | null; + /** + * Output only. The minimum number of weekly hours must be allotted for the upgrade activities. This is just a minimum; the schedule can assign more weekly hours. + */ + minHoursWeek?: number | null; + /** + * Output only. Output Only. The user can only reschedule an upgrade that starts within this range. + */ + rescheduleDateRange?: Schema$Interval; + } /** * Credentials for a private cloud. */ @@ -509,6 +575,19 @@ export namespace vmwareengine_v1 { */ uid?: 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; + } /** * An IP range provided in any one of the supported formats. */ @@ -526,6 +605,23 @@ export namespace vmwareengine_v1 { */ ipAddressRange?: string | null; } + /** + * Response message for VmwareEngine.ListAnnouncements + */ + export interface Schema$ListAnnouncementsResponse { + /** + * A list of announcement runs. + */ + announcements?: Schema$Announcement[]; + /** + * 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; + /** + * list of unreachable locations + */ + unreachable?: string[] | null; + } /** * Response message for VmwareEngine.ListClusters */ @@ -795,6 +891,23 @@ export namespace vmwareengine_v1 { */ unreachable?: string[] | null; } + /** + * Response message for VmwareEngine.ListUpgrades. + */ + export interface Schema$ListUpgradesResponse { + /** + * 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; + /** + * List of unreachable resources. + */ + unreachable?: string[] | null; + /** + * A list of `Upgrades`. + */ + upgrades?: Schema$Upgrade[]; + } /** * Response message for VmwareEngine.ListVmwareEngineNetworks */ @@ -1488,6 +1601,31 @@ export namespace vmwareengine_v1 { */ requestId?: string | null; } + /** + * Schedule for the upgrade. + */ + export interface Schema$Schedule { + /** + * Output only. Output Only. Constraints applied to the schedule. These constraints should be applicable at the time of any rescheduling. + */ + constraints?: Schema$Constraints; + /** + * Output only. Output Only. The schedule is open for edits during this time interval or window. + */ + editWindow?: Schema$Interval; + /** + * Output only. Output Only. Indicates who most recently edited the upgrade schedule. The value is updated whenever the upgrade is rescheduled. + */ + lastEditor?: string | null; + /** + * Required. The scheduled start time for the upgrade. + */ + startTime?: string | null; + /** + * Required. Weekly time windows for upgrade activities. The server performs upgrade activities during these time windows to minimize disruptions. + */ + weeklyWindows?: Schema$TimeWindow[]; + } /** * Request message for `SetIamPolicy` method. */ @@ -1591,6 +1729,44 @@ export namespace vmwareengine_v1 { */ scaleOut?: 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 a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + */ + minutes?: number | null; + /** + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + */ + nanos?: number | null; + /** + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + } + /** + * Represents the time window to perform upgrade activities. + */ + export interface Schema$TimeWindow { + /** + * Required. Day of the week for this window. + */ + dayOfWeek?: string | null; + /** + * Required. The duration of the window. The max allowed duration for any window is 24 hours. + */ + duration?: string | null; + /** + * Required. Time in UTC when the window starts. + */ + startTime?: Schema$TimeOfDay; + } /** * Request message for VmwareEngine.UndeletePrivateCloud */ @@ -1600,6 +1776,71 @@ export namespace vmwareengine_v1 { */ requestId?: string | null; } + /** + * Describes Private cloud Upgrade. + */ + export interface Schema$Upgrade { + /** + * Output only. Output Only. The list of component upgrades. + */ + componentUpgrades?: Schema$VmwareUpgradeComponent[]; + /** + * Output only. Output Only. Creation time of this resource. + */ + createTime?: string | null; + /** + * Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade. + */ + description?: string | null; + /** + * Output only. Output Only. End time of the upgrade. + */ + endTime?: string | null; + /** + * Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary. + */ + estimatedDuration?: string | null; + /** + * The etag for the upgrade resource. If this is provided on update, it must match the server's etag. + */ + etag?: string | null; + /** + * Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade` + */ + name?: string | null; + /** + * Schedule details for the upgrade. + */ + schedule?: Schema$Schedule; + /** + * Output only. Output Only. The start version + */ + startVersion?: string | null; + /** + * Output only. The current state of the upgrade. + */ + state?: string | null; + /** + * Output only. Output Only. The target version + */ + targetVersion?: string | null; + /** + * Output only. Output Only. The type of upgrade. + */ + type?: string | null; + /** + * Output only. System-generated unique identifier for the resource. + */ + uid?: string | null; + /** + * Output only. Output Only. Last update time of this resource. + */ + updateTime?: string | null; + /** + * Output only. + */ + version?: string | null; + } /** * Details about a vCenter Server management appliance. */ @@ -1662,6 +1903,19 @@ export namespace vmwareengine_v1 { */ vpcNetworks?: Schema$VpcNetwork[]; } + /** + * Per component upgrade resource + */ + export interface Schema$VmwareUpgradeComponent { + /** + * Output only. Type of component + */ + componentType?: string | null; + /** + * Output only. Component's upgrade state. + */ + state?: string | null; + } /** * Represents a VMware Engine VPC network that is managed by a VMware Engine network resource. */ @@ -1687,6 +1941,7 @@ export namespace vmwareengine_v1 { export class Resource$Projects$Locations { context: APIRequestContext; + announcements: Resource$Projects$Locations$Announcements; dnsBindPermission: Resource$Projects$Locations$Dnsbindpermission; networkPeerings: Resource$Projects$Locations$Networkpeerings; networkPolicies: Resource$Projects$Locations$Networkpolicies; @@ -1697,6 +1952,9 @@ export namespace vmwareengine_v1 { vmwareEngineNetworks: Resource$Projects$Locations$Vmwareenginenetworks; constructor(context: APIRequestContext) { this.context = context; + this.announcements = new Resource$Projects$Locations$Announcements( + this.context + ); this.dnsBindPermission = new Resource$Projects$Locations$Dnsbindpermission(this.context); this.networkPeerings = new Resource$Projects$Locations$Networkpeerings( @@ -2021,65 +2279,64 @@ export namespace vmwareengine_v1 { pageToken?: string; } - export class Resource$Projects$Locations$Dnsbindpermission { + export class Resource$Projects$Locations$Announcements { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Grants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the intranet VPC associated with the project. DnsBindPermission is a global resource and location can only be global. + * Retrieves a `Announcement` by its 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. */ - grant( - params: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, + get( + params: Params$Resource$Projects$Locations$Announcements$Get, options: StreamMethodOptions ): GaxiosPromise; - grant( - params?: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, + get( + params?: Params$Resource$Projects$Locations$Announcements$Get, options?: MethodOptions - ): GaxiosPromise; - grant( - params: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Announcements$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - grant( - params: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Announcements$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - grant( - params: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Announcements$Get, + callback: BodyResponseCallback ): void; - grant(callback: BodyResponseCallback): void; - grant( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dnsbindpermission$Grant - | BodyResponseCallback + | Params$Resource$Projects$Locations$Announcements$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$Dnsbindpermission$Grant; + {}) as Params$Resource$Projects$Locations$Announcements$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dnsbindpermission$Grant; + params = {} as Params$Resource$Projects$Locations$Announcements$Get; options = {}; } @@ -2092,8 +2349,8 @@ export namespace vmwareengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:grant').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -2104,68 +2361,74 @@ export namespace vmwareengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Revokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project. DnsBindPermission is a global resource and location can only be global. + * Lists `Announcements` for a given region and 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. */ - revoke( - params: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, + list( + params: Params$Resource$Projects$Locations$Announcements$List, options: StreamMethodOptions ): GaxiosPromise; - revoke( - params?: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, + list( + params?: Params$Resource$Projects$Locations$Announcements$List, options?: MethodOptions - ): GaxiosPromise; - revoke( - params: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Announcements$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - revoke( - params: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Announcements$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - revoke( - params: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Announcements$List, + callback: BodyResponseCallback ): void; - revoke(callback: BodyResponseCallback): void; - revoke( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dnsbindpermission$Revoke - | BodyResponseCallback + | Params$Resource$Projects$Locations$Announcements$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$Dnsbindpermission$Revoke; + {}) as Params$Resource$Projects$Locations$Announcements$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dnsbindpermission$Revoke; + params = {} as Params$Resource$Projects$Locations$Announcements$List; options = {}; } @@ -2178,41 +2441,254 @@ export namespace vmwareengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:revoke').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/announcements').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$Dnsbindpermission$Grant + export interface Params$Resource$Projects$Locations$Announcements$Get extends StandardParameters { /** - * Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/dnsBindPermission` + * Required. The resource name of the announcement to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/announcements/announcement-uuid` */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrantDnsBindPermissionRequest; } - export interface Params$Resource$Projects$Locations$Dnsbindpermission$Revoke + export interface Params$Resource$Projects$Locations$Announcements$List + extends StandardParameters { + /** + * A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `\>`, or `<`. For example, if you are filtering a list of announcement runs, you can exclude the ones named `example-announcement` by specifying `name != "example-announcement"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-announcement") (createTime \> "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "announcement-1") AND (createTime \> "2021-04-12T08:15:10.40Z") OR (name = "announcement-2") ``` + */ + filter?: string; + /** + * Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported. + */ + orderBy?: string; + /** + * The maximum number of announcements to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListAnnouncements` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnouncements` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the location to be queried for announcements. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dnsbindpermission { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Grants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the intranet VPC associated with the project. DnsBindPermission is a global resource and location can only be global. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + grant( + params: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, + options: StreamMethodOptions + ): GaxiosPromise; + grant( + params?: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, + options?: MethodOptions + ): GaxiosPromise; + grant( + params: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + grant( + params: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + grant( + params: Params$Resource$Projects$Locations$Dnsbindpermission$Grant, + callback: BodyResponseCallback + ): void; + grant(callback: BodyResponseCallback): void; + grant( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dnsbindpermission$Grant + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dnsbindpermission$Grant; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Dnsbindpermission$Grant; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:grant').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); + } + } + + /** + * Revokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project. DnsBindPermission is a global resource and location can only be global. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + revoke( + params: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, + options: StreamMethodOptions + ): GaxiosPromise; + revoke( + params?: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, + options?: MethodOptions + ): GaxiosPromise; + revoke( + params: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + revoke( + params: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + revoke( + params: Params$Resource$Projects$Locations$Dnsbindpermission$Revoke, + callback: BodyResponseCallback + ): void; + revoke(callback: BodyResponseCallback): void; + revoke( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dnsbindpermission$Revoke + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dnsbindpermission$Revoke; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Dnsbindpermission$Revoke; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:revoke').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$Dnsbindpermission$Grant + extends StandardParameters { + /** + * Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/dnsBindPermission` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GrantDnsBindPermissionRequest; + } + export interface Params$Resource$Projects$Locations$Dnsbindpermission$Revoke extends StandardParameters { /** * Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/dnsBindPermission` @@ -4589,6 +5065,7 @@ export namespace vmwareengine_v1 { loggingServers: Resource$Projects$Locations$Privateclouds$Loggingservers; managementDnsZoneBindings: Resource$Projects$Locations$Privateclouds$Managementdnszonebindings; subnets: Resource$Projects$Locations$Privateclouds$Subnets; + upgrades: Resource$Projects$Locations$Privateclouds$Upgrades; constructor(context: APIRequestContext) { this.context = context; this.clusters = new Resource$Projects$Locations$Privateclouds$Clusters( @@ -4613,6 +5090,9 @@ export namespace vmwareengine_v1 { this.subnets = new Resource$Projects$Locations$Privateclouds$Subnets( this.context ); + this.upgrades = new Resource$Projects$Locations$Privateclouds$Upgrades( + this.context + ); } /** @@ -9865,6 +10345,330 @@ export namespace vmwareengine_v1 { requestBody?: Schema$Subnet; } + export class Resource$Projects$Locations$Privateclouds$Upgrades { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a private cloud `Upgrade` resource by its 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$Projects$Locations$Privateclouds$Upgrades$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Privateclouds$Upgrades$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Upgrades$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Upgrades$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Upgrades$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.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 past, ongoing and upcoming `Upgrades` for the given private cloud. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Privateclouds$Upgrades$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Privateclouds$Upgrades$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Upgrades$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Upgrades$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Upgrades$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/upgrades').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 the private cloud `Upgrade` resource. Only `schedule` field can updated. The schedule can only be updated when the upgrade has not started and schedule edit window is open. Only fields specified in `update_mask` are considered. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Privateclouds$Upgrades$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Privateclouds$Upgrades$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Upgrades$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Upgrades$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Upgrades$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Upgrades$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.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$Privateclouds$Upgrades$Get + extends StandardParameters { + /** + * Required. The name of the `Upgrade` resource to be retrieved. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Upgrades$List + extends StandardParameters { + /** + * A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `\>`, or `<`. For example, if you are filtering a list of upgrades, you can exclude the ones named `example-upgrade1` by specifying `name != "example-upgrade1"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-upgrade") (createTime \> "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "upgrade-1") AND (createTime \> "2021-04-12T08:15:10.40Z") OR (name = "upgrade-2") ``` + */ + filter?: string; + /** + * Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported. + */ + orderBy?: string; + /** + * The maximum number of `Upgrades` to return in one page. The service may return fewer resources than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListUpgrades` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUpgrades` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Query a list of `Upgrades` for the given private cloud resource name. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Upgrades$Patch + extends StandardParameters { + /** + * Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade` + */ + name?: string; + /** + * Optional. A 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 guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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 `Upgrade` 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$Upgrade; + } + export class Resource$Projects$Locations$Privateconnections { context: APIRequestContext; peeringRoutes: Resource$Projects$Locations$Privateconnections$Peeringroutes; From 5fe5027fd1f1cff2f15ad6962f91cf718bd40c06 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 136/144] feat(walletobjects): update the API #### walletobjects:v1 The following keys were added: - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.description - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.flatPath - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.httpMethod - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.id - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.parameterOrder - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.path - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.request.$ref - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.response.$ref - resources.walletobjects.resources.v1.resources.privateContent.methods.setPassUpdateNotice.scopes - schemas.SetPassUpdateNoticeRequest.description - schemas.SetPassUpdateNoticeRequest.id - schemas.SetPassUpdateNoticeRequest.properties.externalPassId.description - schemas.SetPassUpdateNoticeRequest.properties.externalPassId.type - schemas.SetPassUpdateNoticeRequest.properties.updateUri.description - schemas.SetPassUpdateNoticeRequest.properties.updateUri.type - schemas.SetPassUpdateNoticeRequest.properties.updatedPassJwtSignature.description - schemas.SetPassUpdateNoticeRequest.properties.updatedPassJwtSignature.type - schemas.SetPassUpdateNoticeRequest.type - schemas.SetPassUpdateNoticeResponse.description - schemas.SetPassUpdateNoticeResponse.id - schemas.SetPassUpdateNoticeResponse.type The following keys were changed: - schemas.Image.description --- discovery/walletobjects-v1.json | 59 +++++++++++- src/apis/walletobjects/v1.ts | 156 +++++++++++++++++++++++++++++++- 2 files changed, 212 insertions(+), 3 deletions(-) diff --git a/discovery/walletobjects-v1.json b/discovery/walletobjects-v1.json index 3a8a3bfa9c3..b7e59580b74 100644 --- a/discovery/walletobjects-v1.json +++ b/discovery/walletobjects-v1.json @@ -2679,9 +2679,39 @@ ] } } + }, + "walletobjects": { + "resources": { + "v1": { + "resources": { + "privateContent": { + "methods": { + "setPassUpdateNotice": { + "description": "Provide Google with information about awaiting private pass update. This will allow Google to provide the update notification to the device that currently holds this pass.", + "flatPath": "walletobjects/v1/privateContent/setPassUpdateNotice", + "httpMethod": "POST", + "id": "walletobjects.walletobjects.v1.privateContent.setPassUpdateNotice", + "parameterOrder": [], + "parameters": {}, + "path": "walletobjects/v1/privateContent/setPassUpdateNotice", + "request": { + "$ref": "SetPassUpdateNoticeRequest" + }, + "response": { + "$ref": "SetPassUpdateNoticeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/wallet_object.issuer" + ] + } + } + } + } + } + } } }, - "revision": "20241203", + "revision": "20250312", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -6164,7 +6194,7 @@ "type": "object" }, "Image": { - "description": "Wrapping type for Google hosted images. Next ID: 7", + "description": "Wrapping type for Google hosted images.", "id": "Image", "properties": { "contentDescription": { @@ -8572,6 +8602,31 @@ }, "type": "object" }, + "SetPassUpdateNoticeRequest": { + "description": "Request to send a private pass update notice information to Google, so that devices can then fetch the notice prompting the user to update a pass.", + "id": "SetPassUpdateNoticeRequest", + "properties": { + "externalPassId": { + "description": "Required. A fully qualified identifier of the pass that the issuer wants to notify the pass holder(s) about. Formatted as .", + "type": "string" + }, + "updateUri": { + "description": "Required. The issuer endpoint URI the pass holder needs to follow in order to receive an updated pass JWT. It can not contain any sensitive information. The endpoint needs to authenticate the user before giving the user the updated JWT. Example update URI https://someissuer.com/update/passId=someExternalPassId", + "type": "string" + }, + "updatedPassJwtSignature": { + "description": "Required. The JWT signature of the updated pass that the issuer wants to notify Google about. Only devices that report a different JWT signature than this JWT signature will receive the update notification.", + "type": "string" + } + }, + "type": "object" + }, + "SetPassUpdateNoticeResponse": { + "description": "A response to a request to notify Google of an awaiting update to a private pass.", + "id": "SetPassUpdateNoticeResponse", + "properties": {}, + "type": "object" + }, "SignUpInfo": { "id": "SignUpInfo", "properties": { diff --git a/src/apis/walletobjects/v1.ts b/src/apis/walletobjects/v1.ts index a416fa10331..e441ca0bead 100644 --- a/src/apis/walletobjects/v1.ts +++ b/src/apis/walletobjects/v1.ts @@ -131,6 +131,7 @@ export namespace walletobjects_v1 { smarttap: Resource$Smarttap; transitclass: Resource$Transitclass; transitobject: Resource$Transitobject; + walletobjects: Resource$Walletobjects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -157,6 +158,7 @@ export namespace walletobjects_v1 { this.smarttap = new Resource$Smarttap(this.context); this.transitclass = new Resource$Transitclass(this.context); this.transitobject = new Resource$Transitobject(this.context); + this.walletobjects = new Resource$Walletobjects(this.context); } } @@ -2147,7 +2149,7 @@ export namespace walletobjects_v1 { sortIndex?: number | null; } /** - * Wrapping type for Google hosted images. Next ID: 7 + * Wrapping type for Google hosted images. */ export interface Schema$Image { /** @@ -3584,6 +3586,27 @@ export namespace walletobjects_v1 { */ animationType?: string | null; } + /** + * Request to send a private pass update notice information to Google, so that devices can then fetch the notice prompting the user to update a pass. + */ + export interface Schema$SetPassUpdateNoticeRequest { + /** + * Required. A fully qualified identifier of the pass that the issuer wants to notify the pass holder(s) about. Formatted as . + */ + externalPassId?: string | null; + /** + * Required. The JWT signature of the updated pass that the issuer wants to notify Google about. Only devices that report a different JWT signature than this JWT signature will receive the update notification. + */ + updatedPassJwtSignature?: string | null; + /** + * Required. The issuer endpoint URI the pass holder needs to follow in order to receive an updated pass JWT. It can not contain any sensitive information. The endpoint needs to authenticate the user before giving the user the updated JWT. Example update URI https://someissuer.com/update/passId=someExternalPassId + */ + updateUri?: string | null; + } + /** + * A response to a request to notify Google of an awaiting update to a private pass. + */ + export interface Schema$SetPassUpdateNoticeResponse {} export interface Schema$SignUpInfo { /** * ID of the class the user can sign up for. @@ -14292,4 +14315,135 @@ export namespace walletobjects_v1 { */ requestBody?: Schema$TransitObject; } + + export class Resource$Walletobjects { + context: APIRequestContext; + v1: Resource$Walletobjects$V1; + constructor(context: APIRequestContext) { + this.context = context; + this.v1 = new Resource$Walletobjects$V1(this.context); + } + } + + export class Resource$Walletobjects$V1 { + context: APIRequestContext; + privateContent: Resource$Walletobjects$V1$Privatecontent; + constructor(context: APIRequestContext) { + this.context = context; + this.privateContent = new Resource$Walletobjects$V1$Privatecontent( + this.context + ); + } + } + + export class Resource$Walletobjects$V1$Privatecontent { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Provide Google with information about awaiting private pass update. This will allow Google to provide the update notification to the device that currently holds this pass. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setPassUpdateNotice( + params: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, + options: StreamMethodOptions + ): GaxiosPromise; + setPassUpdateNotice( + params?: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, + options?: MethodOptions + ): GaxiosPromise; + setPassUpdateNotice( + params: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPassUpdateNotice( + params: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPassUpdateNotice( + params: Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice, + callback: BodyResponseCallback + ): void; + setPassUpdateNotice( + callback: BodyResponseCallback + ): void; + setPassUpdateNotice( + paramsOrCallback?: + | Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://walletobjects.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/walletobjects/v1/privateContent/setPassUpdateNotice' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Walletobjects$V1$Privatecontent$Setpassupdatenotice + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$SetPassUpdateNoticeRequest; + } } From 3909aa10ca8edd0f599c11afaefc1d89a8a58de4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 137/144] fix(workflowexecutions): update the API #### workflowexecutions:v1 The following keys were changed: - schemas.Execution.properties.executionHistoryLevel.description - schemas.StepEntry.properties.navigationInfo.description - schemas.StepEntry.properties.stepEntryMetadata.description - schemas.StepEntry.properties.variableData.description --- discovery/workflowexecutions-v1.json | 10 +++++----- src/apis/workflowexecutions/v1.ts | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/discovery/workflowexecutions-v1.json b/discovery/workflowexecutions-v1.json index 3ef4fd20ec0..81fa1688751 100644 --- a/discovery/workflowexecutions-v1.json +++ b/discovery/workflowexecutions-v1.json @@ -517,7 +517,7 @@ } } }, - "revision": "20241001", + "revision": "20250211", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -651,7 +651,7 @@ "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.", + "description": "Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution.", "enum": [ "EXECUTION_HISTORY_LEVEL_UNSPECIFIED", "EXECUTION_HISTORY_BASIC", @@ -995,7 +995,7 @@ }, "navigationInfo": { "$ref": "NavigationInfo", - "description": "Output only. The NavigationInfo associated to this step.", + "description": "Output only. The NavigationInfo associated with this step.", "readOnly": true }, "routine": { @@ -1029,7 +1029,7 @@ }, "stepEntryMetadata": { "$ref": "StepEntryMetadata", - "description": "Output only. The StepEntryMetadata associated to this step.", + "description": "Output only. The StepEntryMetadata associated with this step.", "readOnly": true }, "stepType": { @@ -1089,7 +1089,7 @@ }, "variableData": { "$ref": "VariableData", - "description": "Output only. The VariableData associated to this step.", + "description": "Output only. The VariableData associated with this step.", "readOnly": true } }, diff --git a/src/apis/workflowexecutions/v1.ts b/src/apis/workflowexecutions/v1.ts index c6384461a81..27bdbe2a0be 100644 --- a/src/apis/workflowexecutions/v1.ts +++ b/src/apis/workflowexecutions/v1.ts @@ -216,7 +216,7 @@ export namespace workflowexecutions_v1 { */ 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. + * Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution. */ executionHistoryLevel?: string | null; /** @@ -449,7 +449,7 @@ export namespace workflowexecutions_v1 { */ name?: string | null; /** - * Output only. The NavigationInfo associated to this step. + * Output only. The NavigationInfo associated with this step. */ navigationInfo?: Schema$NavigationInfo; /** @@ -465,7 +465,7 @@ export namespace workflowexecutions_v1 { */ step?: string | null; /** - * Output only. The StepEntryMetadata associated to this step. + * Output only. The StepEntryMetadata associated with this step. */ stepEntryMetadata?: Schema$StepEntryMetadata; /** @@ -477,7 +477,7 @@ export namespace workflowexecutions_v1 { */ updateTime?: string | null; /** - * Output only. The VariableData associated to this step. + * Output only. The VariableData associated with this step. */ variableData?: Schema$VariableData; } From 4cd01bb2e21be4f644b788572f66a12837940afc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 138/144] fix(workflows): update the API #### workflows:v1 The following keys were changed: - schemas.Workflow.properties.executionHistoryLevel.description --- discovery/workflows-v1.json | 4 ++-- src/apis/workflows/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/workflows-v1.json b/discovery/workflows-v1.json index 86c5169e5a0..56c73897cd8 100644 --- a/discovery/workflows-v1.json +++ b/discovery/workflows-v1.json @@ -485,7 +485,7 @@ } } }, - "revision": "20241204", + "revision": "20250212", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -777,7 +777,7 @@ "type": "string" }, "executionHistoryLevel": { - "description": "Optional. Describes the level of the execution history feature to apply to this workflow.", + "description": "Optional. Describes the execution history level to apply to this workflow.", "enum": [ "EXECUTION_HISTORY_LEVEL_UNSPECIFIED", "EXECUTION_HISTORY_BASIC", diff --git a/src/apis/workflows/v1.ts b/src/apis/workflows/v1.ts index 1ed3dad8014..b81ffeb230e 100644 --- a/src/apis/workflows/v1.ts +++ b/src/apis/workflows/v1.ts @@ -322,7 +322,7 @@ export namespace workflows_v1 { */ description?: string | null; /** - * Optional. Describes the level of the execution history feature to apply to this workflow. + * Optional. Describes the execution history level to apply to this workflow. */ executionHistoryLevel?: string | null; /** From c268199ccd810d5271785a82f003084f83aececb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 139/144] feat(workloadmanager): update the API #### workloadmanager:v1 The following keys were added: - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.description - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.flatPath - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.httpMethod - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.id - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.parameterOrder - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.parameters.name.description - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.parameters.name.location - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.parameters.name.required - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.parameters.name.type - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.path - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.response.$ref - resources.projects.resources.locations.resources.discoveredprofiles.methods.get.scopes - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.description - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.flatPath - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.httpMethod - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.id - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameterOrder - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.path - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.response.$ref - resources.projects.resources.locations.resources.discoveredprofiles.methods.list.scopes - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.description - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.flatPath - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.httpMethod - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.id - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.parameterOrder - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.parameters.name.description - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.parameters.name.location - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.parameters.name.required - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.parameters.name.type - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.path - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.response.$ref - resources.projects.resources.locations.resources.discoveredprofiles.resources.healthes.methods.get.scopes - resources.projects.resources.locations.resources.insights.methods.delete.description - resources.projects.resources.locations.resources.insights.methods.delete.flatPath - resources.projects.resources.locations.resources.insights.methods.delete.httpMethod - resources.projects.resources.locations.resources.insights.methods.delete.id - resources.projects.resources.locations.resources.insights.methods.delete.parameterOrder - resources.projects.resources.locations.resources.insights.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.insights.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.insights.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.insights.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.insights.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.insights.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.insights.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.insights.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.insights.methods.delete.path - resources.projects.resources.locations.resources.insights.methods.delete.response.$ref - resources.projects.resources.locations.resources.insights.methods.delete.scopes - resources.projects.resources.locations.resources.rules.methods.list.parameters.evaluationType.description - resources.projects.resources.locations.resources.rules.methods.list.parameters.evaluationType.enum - resources.projects.resources.locations.resources.rules.methods.list.parameters.evaluationType.enumDescriptions - resources.projects.resources.locations.resources.rules.methods.list.parameters.evaluationType.location - resources.projects.resources.locations.resources.rules.methods.list.parameters.evaluationType.type - schemas.APILayerServer.description - schemas.APILayerServer.id - schemas.APILayerServer.properties.name.description - schemas.APILayerServer.properties.name.readOnly - schemas.APILayerServer.properties.name.type - schemas.APILayerServer.properties.osVersion.description - schemas.APILayerServer.properties.osVersion.readOnly - schemas.APILayerServer.properties.osVersion.type - schemas.APILayerServer.properties.resources.description - schemas.APILayerServer.properties.resources.items.$ref - schemas.APILayerServer.properties.resources.readOnly - schemas.APILayerServer.properties.resources.type - schemas.APILayerServer.type - schemas.AvailabilityGroup.description - schemas.AvailabilityGroup.id - schemas.AvailabilityGroup.properties.databases.description - schemas.AvailabilityGroup.properties.databases.items.type - schemas.AvailabilityGroup.properties.databases.readOnly - schemas.AvailabilityGroup.properties.databases.type - schemas.AvailabilityGroup.properties.name.description - schemas.AvailabilityGroup.properties.name.readOnly - schemas.AvailabilityGroup.properties.name.type - schemas.AvailabilityGroup.properties.primaryServer.description - schemas.AvailabilityGroup.properties.primaryServer.readOnly - schemas.AvailabilityGroup.properties.primaryServer.type - schemas.AvailabilityGroup.properties.secondaryServers.description - schemas.AvailabilityGroup.properties.secondaryServers.items.type - schemas.AvailabilityGroup.properties.secondaryServers.readOnly - schemas.AvailabilityGroup.properties.secondaryServers.type - schemas.AvailabilityGroup.type - schemas.BackendServer.description - schemas.BackendServer.id - schemas.BackendServer.properties.backupFile.description - schemas.BackendServer.properties.backupFile.readOnly - schemas.BackendServer.properties.backupFile.type - schemas.BackendServer.properties.backupSchedule.description - schemas.BackendServer.properties.backupSchedule.readOnly - schemas.BackendServer.properties.backupSchedule.type - schemas.BackendServer.properties.name.description - schemas.BackendServer.properties.name.readOnly - schemas.BackendServer.properties.name.type - schemas.BackendServer.properties.osVersion.description - schemas.BackendServer.properties.osVersion.readOnly - schemas.BackendServer.properties.osVersion.type - schemas.BackendServer.properties.resources.description - schemas.BackendServer.properties.resources.items.$ref - schemas.BackendServer.properties.resources.readOnly - schemas.BackendServer.properties.resources.type - schemas.BackendServer.type - schemas.BackupProperties.description - schemas.BackupProperties.id - schemas.BackupProperties.properties.latestBackupStatus.description - schemas.BackupProperties.properties.latestBackupStatus.enum - schemas.BackupProperties.properties.latestBackupStatus.enumDescriptions - schemas.BackupProperties.properties.latestBackupStatus.readOnly - schemas.BackupProperties.properties.latestBackupStatus.type - schemas.BackupProperties.properties.latestBackupTime.description - schemas.BackupProperties.properties.latestBackupTime.format - schemas.BackupProperties.properties.latestBackupTime.type - schemas.BackupProperties.type - schemas.CloudResource.description - schemas.CloudResource.id - schemas.CloudResource.properties.instanceProperties.$ref - schemas.CloudResource.properties.instanceProperties.description - schemas.CloudResource.properties.instanceProperties.readOnly - schemas.CloudResource.properties.kind.description - schemas.CloudResource.properties.kind.enum - schemas.CloudResource.properties.kind.enumDescriptions - schemas.CloudResource.properties.kind.readOnly - schemas.CloudResource.properties.kind.type - schemas.CloudResource.properties.name.description - schemas.CloudResource.properties.name.readOnly - schemas.CloudResource.properties.name.type - schemas.CloudResource.type - schemas.Cluster.description - schemas.Cluster.id - schemas.Cluster.properties.nodes.description - schemas.Cluster.properties.nodes.items.type - schemas.Cluster.properties.nodes.readOnly - schemas.Cluster.properties.nodes.type - schemas.Cluster.properties.witnessServer.description - schemas.Cluster.properties.witnessServer.readOnly - schemas.Cluster.properties.witnessServer.type - schemas.Cluster.type - schemas.ComponentHealth.description - schemas.ComponentHealth.id - schemas.ComponentHealth.properties.component.description - schemas.ComponentHealth.properties.component.type - schemas.ComponentHealth.properties.componentHealthChecks.description - schemas.ComponentHealth.properties.componentHealthChecks.items.$ref - schemas.ComponentHealth.properties.componentHealthChecks.type - schemas.ComponentHealth.properties.componentHealthType.description - schemas.ComponentHealth.properties.componentHealthType.enum - schemas.ComponentHealth.properties.componentHealthType.enumDescriptions - schemas.ComponentHealth.properties.componentHealthType.readOnly - schemas.ComponentHealth.properties.componentHealthType.type - schemas.ComponentHealth.properties.isRequired.description - schemas.ComponentHealth.properties.isRequired.readOnly - schemas.ComponentHealth.properties.isRequired.type - schemas.ComponentHealth.properties.state.description - schemas.ComponentHealth.properties.state.enum - schemas.ComponentHealth.properties.state.enumDescriptions - schemas.ComponentHealth.properties.state.readOnly - schemas.ComponentHealth.properties.state.type - schemas.ComponentHealth.properties.subComponentHealthes.description - schemas.ComponentHealth.properties.subComponentHealthes.items.$ref - schemas.ComponentHealth.properties.subComponentHealthes.type - schemas.ComponentHealth.type - schemas.Database.description - schemas.Database.id - schemas.Database.properties.backupFile.description - schemas.Database.properties.backupFile.readOnly - schemas.Database.properties.backupFile.type - schemas.Database.properties.backupSchedule.description - schemas.Database.properties.backupSchedule.readOnly - schemas.Database.properties.backupSchedule.type - schemas.Database.properties.hostVm.description - schemas.Database.properties.hostVm.readOnly - schemas.Database.properties.hostVm.type - schemas.Database.properties.name.description - schemas.Database.properties.name.readOnly - schemas.Database.properties.name.type - schemas.Database.type - schemas.DatabaseProperties.description - schemas.DatabaseProperties.id - schemas.DatabaseProperties.properties.backupProperties.$ref - schemas.DatabaseProperties.properties.backupProperties.description - schemas.DatabaseProperties.properties.backupProperties.readOnly - schemas.DatabaseProperties.properties.databaseType.description - schemas.DatabaseProperties.properties.databaseType.enum - schemas.DatabaseProperties.properties.databaseType.enumDescriptions - schemas.DatabaseProperties.properties.databaseType.readOnly - schemas.DatabaseProperties.properties.databaseType.type - schemas.DatabaseProperties.type - schemas.FrontEndServer.description - schemas.FrontEndServer.id - schemas.FrontEndServer.properties.name.description - schemas.FrontEndServer.properties.name.readOnly - schemas.FrontEndServer.properties.name.type - schemas.FrontEndServer.properties.osVersion.description - schemas.FrontEndServer.properties.osVersion.readOnly - schemas.FrontEndServer.properties.osVersion.type - schemas.FrontEndServer.properties.resources.description - schemas.FrontEndServer.properties.resources.items.$ref - schemas.FrontEndServer.properties.resources.readOnly - schemas.FrontEndServer.properties.resources.type - schemas.FrontEndServer.type - schemas.HealthCheck.description - schemas.HealthCheck.id - schemas.HealthCheck.properties.message.description - schemas.HealthCheck.properties.message.readOnly - schemas.HealthCheck.properties.message.type - schemas.HealthCheck.properties.metric.description - schemas.HealthCheck.properties.metric.readOnly - schemas.HealthCheck.properties.metric.type - schemas.HealthCheck.properties.resource.$ref - schemas.HealthCheck.properties.resource.description - schemas.HealthCheck.properties.resource.readOnly - schemas.HealthCheck.properties.source.description - schemas.HealthCheck.properties.source.readOnly - schemas.HealthCheck.properties.source.type - schemas.HealthCheck.properties.state.description - schemas.HealthCheck.properties.state.enum - schemas.HealthCheck.properties.state.enumDescriptions - schemas.HealthCheck.properties.state.readOnly - schemas.HealthCheck.properties.state.type - schemas.HealthCheck.type - schemas.Instance.description - schemas.Instance.id - schemas.Instance.properties.name.description - schemas.Instance.properties.name.readOnly - schemas.Instance.properties.name.type - schemas.Instance.properties.region.description - schemas.Instance.properties.region.readOnly - schemas.Instance.properties.region.type - schemas.Instance.properties.status.description - schemas.Instance.properties.status.enum - schemas.Instance.properties.status.enumDescriptions - schemas.Instance.properties.status.readOnly - schemas.Instance.properties.status.type - schemas.Instance.type - schemas.InstanceProperties.description - schemas.InstanceProperties.id - schemas.InstanceProperties.properties.instanceNumber.description - schemas.InstanceProperties.properties.instanceNumber.type - schemas.InstanceProperties.properties.machineType.description - schemas.InstanceProperties.properties.machineType.type - schemas.InstanceProperties.properties.role.deprecated - schemas.InstanceProperties.properties.role.description - schemas.InstanceProperties.properties.role.enum - schemas.InstanceProperties.properties.role.enumDescriptions - schemas.InstanceProperties.properties.role.type - schemas.InstanceProperties.properties.roles.description - schemas.InstanceProperties.properties.roles.items.enum - schemas.InstanceProperties.properties.roles.items.enumDescriptions - schemas.InstanceProperties.properties.roles.items.type - schemas.InstanceProperties.properties.roles.type - schemas.InstanceProperties.properties.sapInstanceProperties.$ref - schemas.InstanceProperties.properties.sapInstanceProperties.description - schemas.InstanceProperties.properties.status.description - schemas.InstanceProperties.properties.status.type - schemas.InstanceProperties.properties.upcomingMaintenanceEvent.$ref - schemas.InstanceProperties.properties.upcomingMaintenanceEvent.description - schemas.InstanceProperties.type - schemas.Layer.description - schemas.Layer.id - schemas.Layer.properties.applicationType.description - schemas.Layer.properties.applicationType.type - schemas.Layer.properties.databaseType.description - schemas.Layer.properties.databaseType.type - schemas.Layer.properties.instances.description - schemas.Layer.properties.instances.items.$ref - schemas.Layer.properties.instances.type - schemas.Layer.properties.sid.description - schemas.Layer.properties.sid.readOnly - schemas.Layer.properties.sid.type - schemas.Layer.type - schemas.ListDiscoveredProfilesResponse.description - schemas.ListDiscoveredProfilesResponse.id - schemas.ListDiscoveredProfilesResponse.properties.nextPageToken.description - schemas.ListDiscoveredProfilesResponse.properties.nextPageToken.readOnly - schemas.ListDiscoveredProfilesResponse.properties.nextPageToken.type - schemas.ListDiscoveredProfilesResponse.properties.unreachable.description - schemas.ListDiscoveredProfilesResponse.properties.unreachable.items.type - schemas.ListDiscoveredProfilesResponse.properties.unreachable.type - schemas.ListDiscoveredProfilesResponse.properties.workloadProfiles.description - schemas.ListDiscoveredProfilesResponse.properties.workloadProfiles.items.$ref - schemas.ListDiscoveredProfilesResponse.properties.workloadProfiles.readOnly - schemas.ListDiscoveredProfilesResponse.properties.workloadProfiles.type - schemas.ListDiscoveredProfilesResponse.type - schemas.LoadBalancerServer.description - schemas.LoadBalancerServer.id - schemas.LoadBalancerServer.properties.ip.description - schemas.LoadBalancerServer.properties.ip.readOnly - schemas.LoadBalancerServer.properties.ip.type - schemas.LoadBalancerServer.properties.vm.description - schemas.LoadBalancerServer.properties.vm.readOnly - schemas.LoadBalancerServer.properties.vm.type - schemas.LoadBalancerServer.type - schemas.Product.description - schemas.Product.id - schemas.Product.properties.name.description - schemas.Product.properties.name.type - schemas.Product.properties.version.description - schemas.Product.properties.version.type - schemas.Product.type - schemas.SapComponent.description - schemas.SapComponent.id - schemas.SapComponent.properties.databaseProperties.$ref - schemas.SapComponent.properties.databaseProperties.description - schemas.SapComponent.properties.databaseProperties.readOnly - schemas.SapComponent.properties.haHosts.description - schemas.SapComponent.properties.haHosts.items.type - schemas.SapComponent.properties.haHosts.type - schemas.SapComponent.properties.resources.description - schemas.SapComponent.properties.resources.items.$ref - schemas.SapComponent.properties.resources.readOnly - schemas.SapComponent.properties.resources.type - schemas.SapComponent.properties.sid.description - schemas.SapComponent.properties.sid.readOnly - schemas.SapComponent.properties.sid.type - schemas.SapComponent.properties.topologyType.description - schemas.SapComponent.properties.topologyType.enum - schemas.SapComponent.properties.topologyType.enumDescriptions - schemas.SapComponent.properties.topologyType.type - schemas.SapComponent.type - schemas.SapDiscoveryResourceInstanceProperties.properties.diskMounts.description - schemas.SapDiscoveryResourceInstanceProperties.properties.diskMounts.items.$ref - schemas.SapDiscoveryResourceInstanceProperties.properties.diskMounts.type - schemas.SapDiscoveryResourceInstancePropertiesDiskMount.description - schemas.SapDiscoveryResourceInstancePropertiesDiskMount.id - schemas.SapDiscoveryResourceInstancePropertiesDiskMount.properties.mountPoint.description - schemas.SapDiscoveryResourceInstancePropertiesDiskMount.properties.mountPoint.type - schemas.SapDiscoveryResourceInstancePropertiesDiskMount.properties.name.description - schemas.SapDiscoveryResourceInstancePropertiesDiskMount.properties.name.type - schemas.SapDiscoveryResourceInstancePropertiesDiskMount.type - schemas.SapInstanceProperties.description - schemas.SapInstanceProperties.id - schemas.SapInstanceProperties.properties.numbers.description - schemas.SapInstanceProperties.properties.numbers.items.type - schemas.SapInstanceProperties.properties.numbers.type - schemas.SapInstanceProperties.type - schemas.SapWorkload.description - schemas.SapWorkload.id - schemas.SapWorkload.properties.application.$ref - schemas.SapWorkload.properties.application.description - schemas.SapWorkload.properties.application.readOnly - schemas.SapWorkload.properties.architecture.description - schemas.SapWorkload.properties.architecture.enum - schemas.SapWorkload.properties.architecture.enumDescriptions - schemas.SapWorkload.properties.architecture.readOnly - schemas.SapWorkload.properties.architecture.type - schemas.SapWorkload.properties.database.$ref - schemas.SapWorkload.properties.database.description - schemas.SapWorkload.properties.database.readOnly - schemas.SapWorkload.properties.metadata.additionalProperties.type - schemas.SapWorkload.properties.metadata.description - schemas.SapWorkload.properties.metadata.readOnly - schemas.SapWorkload.properties.metadata.type - schemas.SapWorkload.properties.products.description - schemas.SapWorkload.properties.products.items.$ref - schemas.SapWorkload.properties.products.readOnly - schemas.SapWorkload.properties.products.type - schemas.SapWorkload.type - schemas.SqlserverWorkload.description - schemas.SqlserverWorkload.id - schemas.SqlserverWorkload.properties.ags.description - schemas.SqlserverWorkload.properties.ags.items.$ref - schemas.SqlserverWorkload.properties.ags.readOnly - schemas.SqlserverWorkload.properties.ags.type - schemas.SqlserverWorkload.properties.cluster.$ref - schemas.SqlserverWorkload.properties.cluster.description - schemas.SqlserverWorkload.properties.cluster.readOnly - schemas.SqlserverWorkload.properties.databases.description - schemas.SqlserverWorkload.properties.databases.items.$ref - schemas.SqlserverWorkload.properties.databases.readOnly - schemas.SqlserverWorkload.properties.databases.type - schemas.SqlserverWorkload.properties.loadBalancerServer.$ref - schemas.SqlserverWorkload.properties.loadBalancerServer.description - schemas.SqlserverWorkload.properties.loadBalancerServer.readOnly - schemas.SqlserverWorkload.type - schemas.ThreeTierWorkload.description - schemas.ThreeTierWorkload.id - schemas.ThreeTierWorkload.properties.apiLayer.$ref - schemas.ThreeTierWorkload.properties.apiLayer.description - schemas.ThreeTierWorkload.properties.apiLayer.readOnly - schemas.ThreeTierWorkload.properties.backend.$ref - schemas.ThreeTierWorkload.properties.backend.description - schemas.ThreeTierWorkload.properties.backend.readOnly - schemas.ThreeTierWorkload.properties.endpoint.description - schemas.ThreeTierWorkload.properties.endpoint.readOnly - schemas.ThreeTierWorkload.properties.endpoint.type - schemas.ThreeTierWorkload.properties.frontend.$ref - schemas.ThreeTierWorkload.properties.frontend.description - schemas.ThreeTierWorkload.properties.frontend.readOnly - schemas.ThreeTierWorkload.type - schemas.UpcomingMaintenanceEvent.description - schemas.UpcomingMaintenanceEvent.id - schemas.UpcomingMaintenanceEvent.properties.endTime.description - schemas.UpcomingMaintenanceEvent.properties.endTime.format - schemas.UpcomingMaintenanceEvent.properties.endTime.type - schemas.UpcomingMaintenanceEvent.properties.maintenanceStatus.description - schemas.UpcomingMaintenanceEvent.properties.maintenanceStatus.type - schemas.UpcomingMaintenanceEvent.properties.startTime.description - schemas.UpcomingMaintenanceEvent.properties.startTime.format - schemas.UpcomingMaintenanceEvent.properties.startTime.type - schemas.UpcomingMaintenanceEvent.properties.type.description - schemas.UpcomingMaintenanceEvent.properties.type.type - schemas.UpcomingMaintenanceEvent.type - schemas.WorkloadProfile.description - schemas.WorkloadProfile.id - schemas.WorkloadProfile.properties.application.$ref - schemas.WorkloadProfile.properties.application.deprecated - schemas.WorkloadProfile.properties.application.description - schemas.WorkloadProfile.properties.ascs.$ref - schemas.WorkloadProfile.properties.ascs.deprecated - schemas.WorkloadProfile.properties.ascs.description - schemas.WorkloadProfile.properties.database.$ref - schemas.WorkloadProfile.properties.database.deprecated - schemas.WorkloadProfile.properties.database.description - schemas.WorkloadProfile.properties.labels.additionalProperties.type - schemas.WorkloadProfile.properties.labels.description - schemas.WorkloadProfile.properties.labels.type - schemas.WorkloadProfile.properties.name.description - schemas.WorkloadProfile.properties.name.type - schemas.WorkloadProfile.properties.refreshedTime.description - schemas.WorkloadProfile.properties.refreshedTime.format - schemas.WorkloadProfile.properties.refreshedTime.type - schemas.WorkloadProfile.properties.sapWorkload.$ref - schemas.WorkloadProfile.properties.sapWorkload.description - schemas.WorkloadProfile.properties.sqlserverWorkload.$ref - schemas.WorkloadProfile.properties.sqlserverWorkload.description - schemas.WorkloadProfile.properties.state.deprecated - schemas.WorkloadProfile.properties.state.description - schemas.WorkloadProfile.properties.state.enum - schemas.WorkloadProfile.properties.state.enumDescriptions - schemas.WorkloadProfile.properties.state.readOnly - schemas.WorkloadProfile.properties.state.type - schemas.WorkloadProfile.properties.threeTierWorkload.$ref - schemas.WorkloadProfile.properties.threeTierWorkload.description - schemas.WorkloadProfile.properties.workloadType.description - schemas.WorkloadProfile.properties.workloadType.enum - schemas.WorkloadProfile.properties.workloadType.enumDescriptions - schemas.WorkloadProfile.properties.workloadType.type - schemas.WorkloadProfile.type - schemas.WorkloadProfileHealth.description - schemas.WorkloadProfileHealth.id - schemas.WorkloadProfileHealth.properties.checkTime.description - schemas.WorkloadProfileHealth.properties.checkTime.format - schemas.WorkloadProfileHealth.properties.checkTime.type - schemas.WorkloadProfileHealth.properties.componentHealthes.description - schemas.WorkloadProfileHealth.properties.componentHealthes.items.$ref - schemas.WorkloadProfileHealth.properties.componentHealthes.type - schemas.WorkloadProfileHealth.properties.state.description - schemas.WorkloadProfileHealth.properties.state.enum - schemas.WorkloadProfileHealth.properties.state.enumDescriptions - schemas.WorkloadProfileHealth.properties.state.readOnly - schemas.WorkloadProfileHealth.properties.state.type - schemas.WorkloadProfileHealth.type --- discovery/workloadmanager-v1.json | 1143 ++++++++++++++++++++++++++++- src/apis/workloadmanager/v1.ts | 1112 ++++++++++++++++++++++++++-- 2 files changed, 2157 insertions(+), 98 deletions(-) diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index ad028b6d2de..bb705e230d3 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -177,6 +177,107 @@ } }, "resources": { + "discoveredprofiles": { + "methods": { + "get": { + "description": "Gets details of a discovered workload profile.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles/{discoveredprofilesId}", + "httpMethod": "GET", + "id": "workloadmanager.projects.locations.discoveredprofiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/discoveredprofiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "WorkloadProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List discovered workload profiles", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles", + "httpMethod": "GET", + "id": "workloadmanager.projects.locations.discoveredprofiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering 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. Parent value for ListDiscoveredProfilesRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/discoveredprofiles", + "response": { + "$ref": "ListDiscoveredProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "healthes": { + "methods": { + "get": { + "description": "Get the health of a discovered workload profile.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles/{discoveredprofilesId}/healthes/{healthesId}", + "httpMethod": "GET", + "id": "workloadmanager.projects.locations.discoveredprofiles.healthes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/discoveredprofiles/[^/]+/healthes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "WorkloadProfileHealth" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "evaluations": { "methods": { "create": { @@ -564,6 +665,36 @@ }, "insights": { "methods": { + "delete": { + "description": "Delete the data insights from workload manager data warehouse.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}", + "httpMethod": "DELETE", + "id": "workloadmanager.projects.locations.insights.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The system id of the SAP system resource to delete. Formatted as projects/{project}/locations/{location}/sapSystems/{sap_system_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/insights/[^/]+$", + "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/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "writeInsight": { "description": "Write the data insights to workload manager data warehouse.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insights:writeInsight", @@ -733,6 +864,25 @@ "location": "query", "type": "string" }, + "evaluationType": { + "description": "Optional. The evaluation type of the rules will be applied to. The Cloud Storage bucket name for custom rules.", + "enum": [ + "EVALUATION_TYPE_UNSPECIFIED", + "SAP", + "SQL_SERVER", + "OTHER", + "SCC_IAC" + ], + "enumDescriptions": [ + "Not specified", + "SAP best practices", + "SQL best practices", + "Customized best practices", + "SCC IaC (Infra as Code) best practices" + ], + "location": "query", + "type": "string" + }, "filter": { "description": "Filter based on primary_category, secondary_category", "location": "query", @@ -772,9 +922,34 @@ } } }, - "revision": "20250120", + "revision": "20250310", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { + "APILayerServer": { + "description": "The API layer server", + "id": "APILayerServer", + "properties": { + "name": { + "description": "Output only. The api layer name", + "readOnly": true, + "type": "string" + }, + "osVersion": { + "description": "Output only. OS information", + "readOnly": true, + "type": "string" + }, + "resources": { + "description": "Output only. resources in the component", + "items": { + "$ref": "CloudResource" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "AgentCommand": { "description": "* An AgentCommand specifies a one-time executable program for the agent to run.", "id": "AgentCommand", @@ -793,6 +968,101 @@ }, "type": "object" }, + "AvailabilityGroup": { + "description": "The availability groups for sqlserver", + "id": "AvailabilityGroup", + "properties": { + "databases": { + "description": "Output only. The databases", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The availability group name", + "readOnly": true, + "type": "string" + }, + "primaryServer": { + "description": "Output only. The primary server", + "readOnly": true, + "type": "string" + }, + "secondaryServers": { + "description": "Output only. The secondary servers", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "BackendServer": { + "description": "The backend server", + "id": "BackendServer", + "properties": { + "backupFile": { + "description": "Output only. The backup file", + "readOnly": true, + "type": "string" + }, + "backupSchedule": { + "description": "Output only. The backup schedule", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The backend name", + "readOnly": true, + "type": "string" + }, + "osVersion": { + "description": "Output only. OS information", + "readOnly": true, + "type": "string" + }, + "resources": { + "description": "Output only. resources in the component", + "items": { + "$ref": "CloudResource" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "BackupProperties": { + "description": "Backup properties.", + "id": "BackupProperties", + "properties": { + "latestBackupStatus": { + "description": "Output only. The state of the latest backup.", + "enum": [ + "BACKUP_STATE_UNSPECIFIED", + "BACKUP_STATE_SUCCESS", + "BACKUP_STATE_FAILURE" + ], + "enumDescriptions": [ + "unspecified", + "SUCCESS state", + "FAILURE state" + ], + "readOnly": true, + "type": "string" + }, + "latestBackupTime": { + "description": "The time when the latest backup was performed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "BigQueryDestination": { "description": "Message describing big query destination", "id": "BigQueryDestination", @@ -814,6 +1084,76 @@ "properties": {}, "type": "object" }, + "CloudResource": { + "description": "The resource on GCP", + "id": "CloudResource", + "properties": { + "instanceProperties": { + "$ref": "InstanceProperties", + "description": "Output only. All instance properties.", + "readOnly": true + }, + "kind": { + "description": "Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.", + "enum": [ + "RESOURCE_KIND_UNSPECIFIED", + "RESOURCE_KIND_INSTANCE", + "RESOURCE_KIND_DISK", + "RESOURCE_KIND_ADDRESS", + "RESOURCE_KIND_FILESTORE", + "RESOURCE_KIND_HEALTH_CHECK", + "RESOURCE_KIND_FORWARDING_RULE", + "RESOURCE_KIND_BACKEND_SERVICE", + "RESOURCE_KIND_SUBNETWORK", + "RESOURCE_KIND_NETWORK", + "RESOURCE_KIND_PUBLIC_ADDRESS", + "RESOURCE_KIND_INSTANCE_GROUP" + ], + "enumDescriptions": [ + "Unspecified resource kind.", + "This is a compute instance.", + "This is a compute disk.", + "This is a compute address.", + "This is a filestore instance.", + "This is a compute health check.", + "This is a compute forwarding rule.", + "This is a compute backend service.", + "This is a compute subnetwork.", + "This is a compute network.", + "This is a public accessible IP Address.", + "This is a compute instance group." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. resource name", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Cluster": { + "description": "The cluster for sqlserver", + "id": "Cluster", + "properties": { + "nodes": { + "description": "Output only. The nodes", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "witnessServer": { + "description": "Output only. The witness server", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Command": { "description": "* Command specifies the type of command to execute.", "id": "Command", @@ -829,6 +1169,134 @@ }, "type": "object" }, + "ComponentHealth": { + "description": "HealthCondition contains the detailed health check of each component.", + "id": "ComponentHealth", + "properties": { + "component": { + "description": "The component of a workload.", + "type": "string" + }, + "componentHealthChecks": { + "description": "The detailed health checks of the component.", + "items": { + "$ref": "HealthCheck" + }, + "type": "array" + }, + "componentHealthType": { + "description": "Output only. The type of the component health.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_REQUIRED", + "TYPE_OPTIONAL", + "TYPE_SPECIAL" + ], + "enumDescriptions": [ + "Unspecified", + "required", + "optional", + "special" + ], + "readOnly": true, + "type": "string" + }, + "isRequired": { + "description": "Output only. The requirement of the component.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The health state of the component.", + "enum": [ + "HEALTH_STATE_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY", + "CRITICAL", + "UNSUPPORTED" + ], + "enumDescriptions": [ + "Unspecified", + "healthy workload", + "unhealthy workload", + "has critical issues", + "unsupported" + ], + "readOnly": true, + "type": "string" + }, + "subComponentHealthes": { + "description": "Sub component health.", + "items": { + "$ref": "ComponentHealth" + }, + "type": "array" + } + }, + "type": "object" + }, + "Database": { + "description": "The database for sqlserver", + "id": "Database", + "properties": { + "backupFile": { + "description": "Output only. The backup file", + "readOnly": true, + "type": "string" + }, + "backupSchedule": { + "description": "Output only. The backup schedule", + "readOnly": true, + "type": "string" + }, + "hostVm": { + "description": "Output only. The host VM", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The database name", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DatabaseProperties": { + "description": "Database Properties.", + "id": "DatabaseProperties", + "properties": { + "backupProperties": { + "$ref": "BackupProperties", + "description": "Output only. Backup properties.", + "readOnly": true + }, + "databaseType": { + "description": "Output only. Type of the database. HANA, DB2, etc.", + "enum": [ + "DATABASE_TYPE_UNSPECIFIED", + "HANA", + "MAX_DB", + "DB2", + "ORACLE", + "SQLSERVER", + "ASE" + ], + "enumDescriptions": [ + "unspecified", + "SAP HANA", + "SAP MAX_DB", + "IBM DB2", + "Oracle Database", + "Microsoft SQL Server", + "SAP Sybase ASE" + ], + "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", @@ -1106,6 +1574,31 @@ }, "type": "object" }, + "FrontEndServer": { + "description": "The front end server", + "id": "FrontEndServer", + "properties": { + "name": { + "description": "Output only. The frontend name", + "readOnly": true, + "type": "string" + }, + "osVersion": { + "description": "Output only. OS information", + "readOnly": true, + "type": "string" + }, + "resources": { + "description": "Output only. resources in the component", + "items": { + "$ref": "CloudResource" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GceInstanceFilter": { "description": "Message describing compute engine instance filter", "id": "GceInstanceFilter", @@ -1120,35 +1613,256 @@ }, "type": "object" }, - "Insight": { - "description": "A presentation of host resource usage where the workload runs.", - "id": "Insight", + "HealthCheck": { + "description": "HealthCheck contains the detailed health check of a component based on asource.", + "id": "HealthCheck", + "properties": { + "message": { + "description": "Output only. The message of the health check.", + "readOnly": true, + "type": "string" + }, + "metric": { + "description": "Output only. The health check source metric name.", + "readOnly": true, + "type": "string" + }, + "resource": { + "$ref": "CloudResource", + "description": "Output only. The resource the check performs on.", + "readOnly": true + }, + "source": { + "description": "Output only. The source of the health check.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the health check.", + "enum": [ + "STATE_UNSPECIFIED", + "PASSED", + "FAILED", + "DEGRADED", + "SKIPPED", + "UNSUPPORTED" + ], + "enumDescriptions": [ + "Unspecified", + "passed", + "failed", + "degraded", + "skipped", + "unsupported" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Insight": { + "description": "A presentation of host resource usage where the workload runs.", + "id": "Insight", + "properties": { + "instanceId": { + "description": "Required. The instance id where the insight is generated from", + "type": "string" + }, + "sapDiscovery": { + "$ref": "SapDiscovery", + "description": "The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes." + }, + "sapValidation": { + "$ref": "SapValidation", + "description": "The insights data for the SAP workload validation." + }, + "sentTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "sqlserverValidation": { + "$ref": "SqlserverValidation", + "description": "The insights data for the sqlserver workload validation." + }, + "torsoValidation": { + "$ref": "TorsoValidation", + "description": "The insights data for workload validation of torso workloads." + } + }, + "type": "object" + }, + "Instance": { + "description": "a vm instance", + "id": "Instance", + "properties": { + "name": { + "description": "Output only. name of the VM", + "readOnly": true, + "type": "string" + }, + "region": { + "description": "Output only. The location of the VM", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. The state of the VM", + "enum": [ + "INSTANCESTATE_UNSPECIFIED", + "PROVISIONING", + "STAGING", + "RUNNING", + "STOPPING", + "STOPPED", + "TERMINATED", + "SUSPENDING", + "SUSPENDED", + "REPAIRING", + "DEPROVISIONING" + ], + "enumDescriptions": [ + "The Status of the VM is unspecified", + "Resources are being allocated for the instance.", + "All required resources have been allocated and the instance is being started.", + "The instance is running.", + "The instance is currently stopping (either being deleted or killed).", + "The instance has stopped due to various reasons (user request, VM preemption, project freezing, etc.).", + "The instance has failed in some way.", + "The instance is suspending.", + "The instance is suspended.", + "The instance is in repair.", + "The instance is in de-provisioning state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InstanceProperties": { + "description": "Instance Properties.", + "id": "InstanceProperties", + "properties": { + "instanceNumber": { + "description": "Optional. Instance number.", + "type": "string" + }, + "machineType": { + "description": "Optional. Instance machine type.", + "type": "string" + }, + "role": { + "deprecated": true, + "description": "Optional. Instance role.", + "enum": [ + "INSTANCE_ROLE_UNSPECIFIED", + "INSTANCE_ROLE_ASCS", + "INSTANCE_ROLE_ERS", + "INSTANCE_ROLE_APP_SERVER", + "INSTANCE_ROLE_HANA_PRIMARY", + "INSTANCE_ROLE_HANA_SECONDARY" + ], + "enumDescriptions": [ + "Unspecified role.", + "ASCS role.", + "ERS role.", + "APP server.", + "HANA primary role.", + "HANA secondary role." + ], + "type": "string" + }, + "roles": { + "description": "Optional. Instance roles.", + "items": { + "enum": [ + "INSTANCE_ROLE_UNSPECIFIED", + "INSTANCE_ROLE_ASCS", + "INSTANCE_ROLE_ERS", + "INSTANCE_ROLE_APP_SERVER", + "INSTANCE_ROLE_HANA_PRIMARY", + "INSTANCE_ROLE_HANA_SECONDARY" + ], + "enumDescriptions": [ + "Unspecified role.", + "ASCS role.", + "ERS role.", + "APP server.", + "HANA primary role.", + "HANA secondary role." + ], + "type": "string" + }, + "type": "array" + }, + "sapInstanceProperties": { + "$ref": "SapInstanceProperties", + "description": "Optional. SAP Instance properties." + }, + "status": { + "description": "Optional. Instance status.", + "type": "string" + }, + "upcomingMaintenanceEvent": { + "$ref": "UpcomingMaintenanceEvent", + "description": "Optional. the next maintenance event on VM" + } + }, + "type": "object" + }, + "Layer": { + "description": "The database layer", + "id": "Layer", + "properties": { + "applicationType": { + "description": "the application layer", + "type": "string" + }, + "databaseType": { + "description": "Optional. the database layer", + "type": "string" + }, + "instances": { + "description": "Optional. instances in a layer", + "items": { + "$ref": "Instance" + }, + "type": "array" + }, + "sid": { + "description": "Output only. system identification of a layer", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ListDiscoveredProfilesResponse": { + "description": "List discovered profile Response returns discovered profiles from agents", + "id": "ListDiscoveredProfilesResponse", "properties": { - "instanceId": { - "description": "Required. The instance id where the insight is generated from", - "type": "string" - }, - "sapDiscovery": { - "$ref": "SapDiscovery", - "description": "The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes." - }, - "sapValidation": { - "$ref": "SapValidation", - "description": "The insights data for the SAP workload validation." - }, - "sentTime": { - "description": "Output only. [Output only] Create time stamp", - "format": "google-datetime", + "nextPageToken": { + "description": "Output only. A token identifying a page of results the server should return", "readOnly": true, "type": "string" }, - "sqlserverValidation": { - "$ref": "SqlserverValidation", - "description": "The insights data for the sqlserver workload validation." + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" }, - "torsoValidation": { - "$ref": "TorsoValidation", - "description": "The insights data for workload validation of torso workloads." + "workloadProfiles": { + "description": "Output only. The list of workload profiles", + "items": { + "$ref": "WorkloadProfile" + }, + "readOnly": true, + "type": "array" } }, "type": "object" @@ -1293,6 +2007,23 @@ }, "type": "object" }, + "LoadBalancerServer": { + "description": "The load balancer for sqlserver", + "id": "LoadBalancerServer", + "properties": { + "ip": { + "description": "Output only. The IP address", + "readOnly": true, + "type": "string" + }, + "vm": { + "description": "Output only. The VM name", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -1418,6 +2149,21 @@ }, "type": "object" }, + "Product": { + "description": "Product contains the details of a product.", + "id": "Product", + "properties": { + "name": { + "description": "Optional. Name of the product.", + "type": "string" + }, + "version": { + "description": "Optional. Version of the product.", + "type": "string" + } + }, + "type": "object" + }, "Resource": { "description": "Message represent resource in execution result", "id": "Resource", @@ -1616,6 +2362,52 @@ }, "type": "object" }, + "SapComponent": { + "description": "The component of sap workload", + "id": "SapComponent", + "properties": { + "databaseProperties": { + "$ref": "DatabaseProperties", + "description": "Output only. All instance properties.", + "readOnly": true + }, + "haHosts": { + "description": "A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.", + "items": { + "type": "string" + }, + "type": "array" + }, + "resources": { + "description": "Output only. resources in the component", + "items": { + "$ref": "CloudResource" + }, + "readOnly": true, + "type": "array" + }, + "sid": { + "description": "Output only. sid is the sap component identificator", + "readOnly": true, + "type": "string" + }, + "topologyType": { + "description": "The detected topology of the component.", + "enum": [ + "TOPOLOGY_TYPE_UNSPECIFIED", + "TOPOLOGY_SCALE_UP", + "TOPOLOGY_SCALE_OUT" + ], + "enumDescriptions": [ + "Unspecified topology.", + "A scale-up single node system.", + "A scale-out multi-node system." + ], + "type": "string" + } + }, + "type": "object" + }, "SapDiscovery": { "description": "The schema of SAP system discovery data.", "id": "SapDiscovery", @@ -1955,6 +2747,13 @@ }, "type": "array" }, + "diskMounts": { + "description": "Optional. Disk mounts on the instance.", + "items": { + "$ref": "SapDiscoveryResourceInstancePropertiesDiskMount" + }, + "type": "array" + }, "instanceNumber": { "deprecated": true, "description": "Optional. The VM's instance number.", @@ -2027,6 +2826,21 @@ }, "type": "object" }, + "SapDiscoveryResourceInstancePropertiesDiskMount": { + "description": "Disk mount on the instance.", + "id": "SapDiscoveryResourceInstancePropertiesDiskMount", + "properties": { + "mountPoint": { + "description": "Optional. Filesystem mount point.", + "type": "string" + }, + "name": { + "description": "Optional. Name of the disk.", + "type": "string" + } + }, + "type": "object" + }, "SapDiscoveryWorkloadProperties": { "description": "A set of properties describing an SAP workload.", "id": "SapDiscoveryWorkloadProperties", @@ -2086,6 +2900,20 @@ }, "type": "object" }, + "SapInstanceProperties": { + "description": "SAP instance properties.", + "id": "SapInstanceProperties", + "properties": { + "numbers": { + "description": "Optional. SAP Instance numbers. They are from '00' to '99'.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SapValidation": { "description": "A presentation of SAP workload insight. The schema of SAP workloads validation related data.", "id": "SapValidation", @@ -2150,6 +2978,62 @@ }, "type": "object" }, + "SapWorkload": { + "description": "The body of sap workload", + "id": "SapWorkload", + "properties": { + "application": { + "$ref": "SapComponent", + "description": "Output only. the acsc componment", + "readOnly": true + }, + "architecture": { + "description": "Output only. the architecture", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "INVALID", + "CENTRALIZED", + "DISTRIBUTED", + "DISTRIBUTED_HA", + "STANDALONE_DATABASE", + "STANDALONE_DATABASE_HA" + ], + "enumDescriptions": [ + "Unspecified architecture.", + "Invaliad architecture.", + "A centralized system.", + "A distributed system.", + "A distributed with HA system.", + "A standalone database system.", + "A standalone database with HA system." + ], + "readOnly": true, + "type": "string" + }, + "database": { + "$ref": "SapComponent", + "description": "Output only. the database componment", + "readOnly": true + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. The metadata for SAP workload.", + "readOnly": true, + "type": "object" + }, + "products": { + "description": "Output only. the products on this workload.", + "items": { + "$ref": "Product" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "ScannedResource": { "description": "Message of scanned resource", "id": "ScannedResource", @@ -2273,6 +3157,39 @@ }, "type": "object" }, + "SqlserverWorkload": { + "description": "The body of sqlserver workload", + "id": "SqlserverWorkload", + "properties": { + "ags": { + "description": "Output only. The availability groups for sqlserver", + "items": { + "$ref": "AvailabilityGroup" + }, + "readOnly": true, + "type": "array" + }, + "cluster": { + "$ref": "Cluster", + "description": "Output only. The cluster for sqlserver", + "readOnly": true + }, + "databases": { + "description": "Output only. The databases for sqlserver", + "items": { + "$ref": "Database" + }, + "readOnly": true, + "type": "array" + }, + "loadBalancerServer": { + "$ref": "LoadBalancerServer", + "description": "Output only. The load balancer for sqlserver", + "readOnly": true + } + }, + "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", @@ -2325,6 +3242,33 @@ }, "type": "object" }, + "ThreeTierWorkload": { + "description": "The body of three tier workload", + "id": "ThreeTierWorkload", + "properties": { + "apiLayer": { + "$ref": "APILayerServer", + "description": "Output only. The API layer for three tier workload", + "readOnly": true + }, + "backend": { + "$ref": "BackendServer", + "description": "Output only. The backend for three tier workload", + "readOnly": true + }, + "endpoint": { + "description": "Output only. the workload endpoint", + "readOnly": true, + "type": "string" + }, + "frontend": { + "$ref": "FrontEndServer", + "description": "Output only. The frontend for three tier workload", + "readOnly": true + } + }, + "type": "object" + }, "TorsoValidation": { "description": "The schema of torso workload validation data.", "id": "TorsoValidation", @@ -2367,6 +3311,31 @@ }, "type": "object" }, + "UpcomingMaintenanceEvent": { + "description": "Maintenance Event", + "id": "UpcomingMaintenanceEvent", + "properties": { + "endTime": { + "description": "Optional. End time", + "format": "google-datetime", + "type": "string" + }, + "maintenanceStatus": { + "description": "Optional. Maintenance status", + "type": "string" + }, + "startTime": { + "description": "Optional. Start time", + "format": "google-datetime", + "type": "string" + }, + "type": { + "description": "Optional. Type", + "type": "string" + } + }, + "type": "object" + }, "ViolationDetails": { "description": "Message describing the violation in an evaluation result.", "id": "ViolationDetails", @@ -2389,6 +3358,130 @@ }, "type": "object" }, + "WorkloadProfile": { + "description": "workload resource", + "id": "WorkloadProfile", + "properties": { + "application": { + "$ref": "Layer", + "deprecated": true, + "description": "Optional. The application layer" + }, + "ascs": { + "$ref": "Layer", + "deprecated": true, + "description": "Optional. The ascs layer" + }, + "database": { + "$ref": "Layer", + "deprecated": true, + "description": "Optional. The database layer" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. such as name, description, version. More example can be found in deployment", + "type": "object" + }, + "name": { + "description": "Identifier. name of resource names have the form 'projects/{project_id}/workloads/{workload_id}'", + "type": "string" + }, + "refreshedTime": { + "description": "Required. time when the workload data was refreshed", + "format": "google-datetime", + "type": "string" + }, + "sapWorkload": { + "$ref": "SapWorkload", + "description": "The sap workload content" + }, + "sqlserverWorkload": { + "$ref": "SqlserverWorkload", + "description": "The sqlserver workload content" + }, + "state": { + "deprecated": true, + "description": "Output only. [output only] the current state if a a workload", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "DEPLOYING", + "DESTROYING", + "MAINTENANCE" + ], + "enumDescriptions": [ + "unspecified", + "ACTIVE state", + "workload is in Deploying state", + "The workload is in Destroying state", + "The Workload is undermaintance" + ], + "readOnly": true, + "type": "string" + }, + "threeTierWorkload": { + "$ref": "ThreeTierWorkload", + "description": "The 3 tier web app workload content" + }, + "workloadType": { + "description": "Required. The type of the workload", + "enum": [ + "WORKLOAD_TYPE_UNSPECIFIED", + "S4_HANA", + "SQL_SERVER", + "THREE_TIER_WEB_APP" + ], + "enumDescriptions": [ + "unspecified workload type", + "running sap workload s4/hana", + "running sqlserver workload", + "running 3 tier web app workload" + ], + "type": "string" + } + }, + "type": "object" + }, + "WorkloadProfileHealth": { + "description": "WorkloadProfileHealth contains the detailed health check of workload.", + "id": "WorkloadProfileHealth", + "properties": { + "checkTime": { + "description": "The time when the health check was performed.", + "format": "google-datetime", + "type": "string" + }, + "componentHealthes": { + "description": "The detailed condition reports of each component.", + "items": { + "$ref": "ComponentHealth" + }, + "type": "array" + }, + "state": { + "description": "Output only. The health state of the workload.", + "enum": [ + "HEALTH_STATE_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY", + "CRITICAL", + "UNSUPPORTED" + ], + "enumDescriptions": [ + "Unspecified", + "healthy workload", + "unhealthy workload", + "has critical issues", + "unsupported" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "WriteInsightRequest": { "description": "Request for sending the data insights.", "id": "WriteInsightRequest", diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index 268fe1ae9d1..4c3337c476e 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -137,6 +137,82 @@ export namespace workloadmanager_v1 { */ parameters?: {[key: string]: string} | null; } + /** + * The API layer server + */ + export interface Schema$APILayerServer { + /** + * Output only. The api layer name + */ + name?: string | null; + /** + * Output only. OS information + */ + osVersion?: string | null; + /** + * Output only. resources in the component + */ + resources?: Schema$CloudResource[]; + } + /** + * The availability groups for sqlserver + */ + export interface Schema$AvailabilityGroup { + /** + * Output only. The databases + */ + databases?: string[] | null; + /** + * Output only. The availability group name + */ + name?: string | null; + /** + * Output only. The primary server + */ + primaryServer?: string | null; + /** + * Output only. The secondary servers + */ + secondaryServers?: string[] | null; + } + /** + * The backend server + */ + export interface Schema$BackendServer { + /** + * Output only. The backup file + */ + backupFile?: string | null; + /** + * Output only. The backup schedule + */ + backupSchedule?: string | null; + /** + * Output only. The backend name + */ + name?: string | null; + /** + * Output only. OS information + */ + osVersion?: string | null; + /** + * Output only. resources in the component + */ + resources?: Schema$CloudResource[]; + } + /** + * Backup properties. + */ + export interface Schema$BackupProperties { + /** + * Output only. The state of the latest backup. + */ + latestBackupStatus?: string | null; + /** + * The time when the latest backup was performed. + */ + latestBackupTime?: string | null; + } /** * Message describing big query destination */ @@ -154,6 +230,36 @@ export namespace workloadmanager_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * The resource on GCP + */ + export interface Schema$CloudResource { + /** + * Output only. All instance properties. + */ + instanceProperties?: Schema$InstanceProperties; + /** + * Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc. + */ + kind?: string | null; + /** + * Output only. resource name + */ + name?: string | null; + } + /** + * The cluster for sqlserver + */ + export interface Schema$Cluster { + /** + * Output only. The nodes + */ + nodes?: string[] | null; + /** + * Output only. The witness server + */ + witnessServer?: string | null; + } /** * * Command specifies the type of command to execute. */ @@ -167,6 +273,69 @@ export namespace workloadmanager_v1 { */ shellCommand?: Schema$ShellCommand; } + /** + * HealthCondition contains the detailed health check of each component. + */ + export interface Schema$ComponentHealth { + /** + * The component of a workload. + */ + component?: string | null; + /** + * The detailed health checks of the component. + */ + componentHealthChecks?: Schema$HealthCheck[]; + /** + * Output only. The type of the component health. + */ + componentHealthType?: string | null; + /** + * Output only. The requirement of the component. + */ + isRequired?: boolean | null; + /** + * Output only. The health state of the component. + */ + state?: string | null; + /** + * Sub component health. + */ + subComponentHealthes?: Schema$ComponentHealth[]; + } + /** + * The database for sqlserver + */ + export interface Schema$Database { + /** + * Output only. The backup file + */ + backupFile?: string | null; + /** + * Output only. The backup schedule + */ + backupSchedule?: string | null; + /** + * Output only. The host VM + */ + hostVm?: string | null; + /** + * Output only. The database name + */ + name?: string | null; + } + /** + * Database Properties. + */ + export interface Schema$DatabaseProperties { + /** + * Output only. Backup properties. + */ + backupProperties?: Schema$BackupProperties; + /** + * Output only. Type of the database. HANA, DB2, etc. + */ + databaseType?: 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); \} */ @@ -339,6 +508,23 @@ export namespace workloadmanager_v1 { */ uri?: string | null; } + /** + * The front end server + */ + export interface Schema$FrontEndServer { + /** + * Output only. The frontend name + */ + name?: string | null; + /** + * Output only. OS information + */ + osVersion?: string | null; + /** + * Output only. resources in the component + */ + resources?: Schema$CloudResource[]; + } /** * Message describing compute engine instance filter */ @@ -348,6 +534,31 @@ export namespace workloadmanager_v1 { */ serviceAccounts?: string[] | null; } + /** + * HealthCheck contains the detailed health check of a component based on asource. + */ + export interface Schema$HealthCheck { + /** + * Output only. The message of the health check. + */ + message?: string | null; + /** + * Output only. The health check source metric name. + */ + metric?: string | null; + /** + * Output only. The resource the check performs on. + */ + resource?: Schema$CloudResource; + /** + * Output only. The source of the health check. + */ + source?: string | null; + /** + * Output only. The state of the health check. + */ + state?: string | null; + } /** * A presentation of host resource usage where the workload runs. */ @@ -377,6 +588,94 @@ export namespace workloadmanager_v1 { */ torsoValidation?: Schema$TorsoValidation; } + /** + * a vm instance + */ + export interface Schema$Instance { + /** + * Output only. name of the VM + */ + name?: string | null; + /** + * Output only. The location of the VM + */ + region?: string | null; + /** + * Output only. The state of the VM + */ + status?: string | null; + } + /** + * Instance Properties. + */ + export interface Schema$InstanceProperties { + /** + * Optional. Instance number. + */ + instanceNumber?: string | null; + /** + * Optional. Instance machine type. + */ + machineType?: string | null; + /** + * Optional. Instance role. + */ + role?: string | null; + /** + * Optional. Instance roles. + */ + roles?: string[] | null; + /** + * Optional. SAP Instance properties. + */ + sapInstanceProperties?: Schema$SapInstanceProperties; + /** + * Optional. Instance status. + */ + status?: string | null; + /** + * Optional. the next maintenance event on VM + */ + upcomingMaintenanceEvent?: Schema$UpcomingMaintenanceEvent; + } + /** + * The database layer + */ + export interface Schema$Layer { + /** + * the application layer + */ + applicationType?: string | null; + /** + * Optional. the database layer + */ + databaseType?: string | null; + /** + * Optional. instances in a layer + */ + instances?: Schema$Instance[]; + /** + * Output only. system identification of a layer + */ + sid?: string | null; + } + /** + * List discovered profile Response returns discovered profiles from agents + */ + export interface Schema$ListDiscoveredProfilesResponse { + /** + * Output only. A token identifying a page of results the server should return + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + /** + * Output only. The list of workload profiles + */ + workloadProfiles?: Schema$WorkloadProfile[]; + } /** * Message for response to listing Evaluations */ @@ -476,6 +775,19 @@ export namespace workloadmanager_v1 { */ scannedResources?: Schema$ScannedResource[]; } + /** + * The load balancer for sqlserver + */ + export interface Schema$LoadBalancerServer { + /** + * Output only. The IP address + */ + ip?: string | null; + /** + * Output only. The VM name + */ + vm?: string | null; + } /** * A resource that represents a Google Cloud location. */ @@ -568,6 +880,19 @@ export namespace workloadmanager_v1 { */ verb?: string | null; } + /** + * Product contains the details of a product. + */ + export interface Schema$Product { + /** + * Optional. Name of the product. + */ + name?: string | null; + /** + * Optional. Version of the product. + */ + version?: string | null; + } /** * Message represent resource in execution result */ @@ -710,6 +1035,31 @@ export namespace workloadmanager_v1 { */ requestId?: string | null; } + /** + * The component of sap workload + */ + export interface Schema$SapComponent { + /** + * Output only. All instance properties. + */ + databaseProperties?: Schema$DatabaseProperties; + /** + * A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA. + */ + haHosts?: string[] | null; + /** + * Output only. resources in the component + */ + resources?: Schema$CloudResource[]; + /** + * Output only. sid is the sap component identificator + */ + sid?: string | null; + /** + * The detected topology of the component. + */ + topologyType?: string | null; + } /** * The schema of SAP system discovery data. */ @@ -933,6 +1283,10 @@ export namespace workloadmanager_v1 { * Optional. A list of instance URIs that are part of a cluster with this one. */ clusterInstances?: string[] | null; + /** + * Optional. Disk mounts on the instance. + */ + diskMounts?: Schema$SapDiscoveryResourceInstancePropertiesDiskMount[]; /** * Optional. The VM's instance number. */ @@ -963,6 +1317,19 @@ export namespace workloadmanager_v1 { */ number?: string | null; } + /** + * Disk mount on the instance. + */ + export interface Schema$SapDiscoveryResourceInstancePropertiesDiskMount { + /** + * Optional. Filesystem mount point. + */ + mountPoint?: string | null; + /** + * Optional. Name of the disk. + */ + name?: string | null; + } /** * A set of properties describing an SAP workload. */ @@ -1010,6 +1377,15 @@ export namespace workloadmanager_v1 { */ version?: string | null; } + /** + * SAP instance properties. + */ + export interface Schema$SapInstanceProperties { + /** + * Optional. SAP Instance numbers. They are from '00' to '99'. + */ + numbers?: string[] | null; + } /** * A presentation of SAP workload insight. The schema of SAP workloads validation related data. */ @@ -1044,6 +1420,31 @@ export namespace workloadmanager_v1 { */ sapValidationType?: string | null; } + /** + * The body of sap workload + */ + export interface Schema$SapWorkload { + /** + * Output only. the acsc componment + */ + application?: Schema$SapComponent; + /** + * Output only. the architecture + */ + architecture?: string | null; + /** + * Output only. the database componment + */ + database?: Schema$SapComponent; + /** + * Output only. The metadata for SAP workload. + */ + metadata?: {[key: string]: string} | null; + /** + * Output only. the products on this workload. + */ + products?: Schema$Product[]; + } /** * Message of scanned resource */ @@ -1117,6 +1518,27 @@ export namespace workloadmanager_v1 { */ type?: string | null; } + /** + * The body of sqlserver workload + */ + export interface Schema$SqlserverWorkload { + /** + * Output only. The availability groups for sqlserver + */ + ags?: Schema$AvailabilityGroup[]; + /** + * Output only. The cluster for sqlserver + */ + cluster?: Schema$Cluster; + /** + * Output only. The databases for sqlserver + */ + databases?: Schema$Database[]; + /** + * Output only. The load balancer for sqlserver + */ + loadBalancerServer?: Schema$LoadBalancerServer; + } /** * 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). */ @@ -1152,19 +1574,40 @@ export namespace workloadmanager_v1 { newFixes?: string | null; } /** - * The schema of torso workload validation data. + * The body of three tier workload */ - export interface Schema$TorsoValidation { + export interface Schema$ThreeTierWorkload { /** - * Required. agent_version lists the version of the agent that collected this data. + * Output only. The API layer for three tier workload */ - agentVersion?: string | null; + apiLayer?: Schema$APILayerServer; /** - * Required. instance_name lists the human readable name of the instance that the data comes from. + * Output only. The backend for three tier workload */ - instanceName?: string | null; + backend?: Schema$BackendServer; /** - * Required. project_id lists the human readable cloud project that the data comes from. + * Output only. the workload endpoint + */ + endpoint?: string | null; + /** + * Output only. The frontend for three tier workload + */ + frontend?: Schema$FrontEndServer; + } + /** + * The schema of torso workload validation data. + */ + export interface Schema$TorsoValidation { + /** + * Required. agent_version lists the version of the agent that collected this data. + */ + agentVersion?: string | null; + /** + * Required. instance_name lists the human readable name of the instance that the data comes from. + */ + instanceName?: string | null; + /** + * Required. project_id lists the human readable cloud project that the data comes from. */ projectId?: string | null; /** @@ -1176,6 +1619,27 @@ export namespace workloadmanager_v1 { */ workloadType?: string | null; } + /** + * Maintenance Event + */ + export interface Schema$UpcomingMaintenanceEvent { + /** + * Optional. End time + */ + endTime?: string | null; + /** + * Optional. Maintenance status + */ + maintenanceStatus?: string | null; + /** + * Optional. Start time + */ + startTime?: string | null; + /** + * Optional. Type + */ + type?: string | null; + } /** * Message describing the violation in an evaluation result. */ @@ -1193,6 +1657,72 @@ export namespace workloadmanager_v1 { */ serviceAccount?: string | null; } + /** + * workload resource + */ + export interface Schema$WorkloadProfile { + /** + * Optional. The application layer + */ + application?: Schema$Layer; + /** + * Optional. The ascs layer + */ + ascs?: Schema$Layer; + /** + * Optional. The database layer + */ + database?: Schema$Layer; + /** + * Optional. such as name, description, version. More example can be found in deployment + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. name of resource names have the form 'projects/{project_id\}/workloads/{workload_id\}' + */ + name?: string | null; + /** + * Required. time when the workload data was refreshed + */ + refreshedTime?: string | null; + /** + * The sap workload content + */ + sapWorkload?: Schema$SapWorkload; + /** + * The sqlserver workload content + */ + sqlserverWorkload?: Schema$SqlserverWorkload; + /** + * Output only. [output only] the current state if a a workload + */ + state?: string | null; + /** + * The 3 tier web app workload content + */ + threeTierWorkload?: Schema$ThreeTierWorkload; + /** + * Required. The type of the workload + */ + workloadType?: string | null; + } + /** + * WorkloadProfileHealth contains the detailed health check of workload. + */ + export interface Schema$WorkloadProfileHealth { + /** + * The time when the health check was performed. + */ + checkTime?: string | null; + /** + * The detailed condition reports of each component. + */ + componentHealthes?: Schema$ComponentHealth[]; + /** + * Output only. The health state of the workload. + */ + state?: string | null; + } /** * Request for sending the data insights. */ @@ -1224,26 +1754,248 @@ export namespace workloadmanager_v1 { } } - export class Resource$Projects$Locations { + export class Resource$Projects$Locations { + context: APIRequestContext; + discoveredprofiles: Resource$Projects$Locations$Discoveredprofiles; + evaluations: Resource$Projects$Locations$Evaluations; + insights: Resource$Projects$Locations$Insights; + operations: Resource$Projects$Locations$Operations; + rules: Resource$Projects$Locations$Rules; + constructor(context: APIRequestContext) { + this.context = context; + this.discoveredprofiles = + new Resource$Projects$Locations$Discoveredprofiles(this.context); + this.evaluations = new Resource$Projects$Locations$Evaluations( + this.context + ); + this.insights = new Resource$Projects$Locations$Insights(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.rules = new Resource$Projects$Locations$Rules(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://workloadmanager.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://workloadmanager.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$Discoveredprofiles { context: APIRequestContext; - evaluations: Resource$Projects$Locations$Evaluations; - insights: Resource$Projects$Locations$Insights; - operations: Resource$Projects$Locations$Operations; - rules: Resource$Projects$Locations$Rules; + healthes: Resource$Projects$Locations$Discoveredprofiles$Healthes; constructor(context: APIRequestContext) { this.context = context; - this.evaluations = new Resource$Projects$Locations$Evaluations( - this.context - ); - this.insights = new Resource$Projects$Locations$Insights(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.rules = new Resource$Projects$Locations$Rules(this.context); + this.healthes = + new Resource$Projects$Locations$Discoveredprofiles$Healthes( + this.context + ); } /** - * Gets information about a location. + * Gets details of a discovered workload profile. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1251,49 +2003,50 @@ export namespace workloadmanager_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$Discoveredprofiles$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Get, + params?: Params$Resource$Projects$Locations$Discoveredprofiles$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Discoveredprofiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Discoveredprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Discoveredprofiles$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Discoveredprofiles$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$Discoveredprofiles$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$Discoveredprofiles$Get; options = {}; } @@ -1319,17 +2072,17 @@ export namespace workloadmanager_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. + * List discovered workload profiles * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1337,54 +2090,57 @@ export namespace workloadmanager_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$Discoveredprofiles$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$List, + params?: Params$Resource$Projects$Locations$Discoveredprofiles$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Discoveredprofiles$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Discoveredprofiles$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Discoveredprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Discoveredprofiles$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$Discoveredprofiles$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$Discoveredprofiles$List; options = {}; } @@ -1398,7 +2154,7 @@ export namespace workloadmanager_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+parent}/discoveredprofiles').replace( /([^:]\/)\/+/g, '$1' ), @@ -1408,46 +2164,155 @@ export namespace workloadmanager_v1 { 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$Get + export interface Params$Resource$Projects$Locations$Discoveredprofiles$Get extends StandardParameters { /** - * Resource name for the location. + * Required. Name of the resource */ name?: string; } - export interface Params$Resource$Projects$Locations$List + export interface Params$Resource$Projects$Locations$Discoveredprofiles$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). + * Optional. Filtering results */ 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. + * 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. Parent value for ListDiscoveredProfilesRequest + */ + parent?: string; + } + + export class Resource$Projects$Locations$Discoveredprofiles$Healthes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get the health of a discovered workload profile. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Discoveredprofiles$Healthes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Discoveredprofiles$Healthes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Discoveredprofiles$Healthes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Discoveredprofiles$Healthes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Discoveredprofiles$Healthes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredprofiles$Healthes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredprofiles$Healthes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredprofiles$Healthes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://workloadmanager.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$Discoveredprofiles$Healthes$Get + extends StandardParameters { + /** + * Required. The resource name + */ + name?: string; } export class Resource$Projects$Locations$Evaluations { @@ -2578,6 +3443,92 @@ export namespace workloadmanager_v1 { this.context = context; } + /** + * Delete the data insights from workload manager data warehouse. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Insights$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Insights$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Insights$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Insights$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Insights$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Insights$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Insights$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Insights$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://workloadmanager.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); + } + } + /** * Write the data insights to workload manager data warehouse. * @@ -2675,6 +3626,17 @@ export namespace workloadmanager_v1 { } } + export interface Params$Resource$Projects$Locations$Insights$Delete + extends StandardParameters { + /** + * Required. The system id of the SAP system resource to delete. Formatted as projects/{project\}/locations/{location\}/sapSystems/{sap_system_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 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; + } export interface Params$Resource$Projects$Locations$Insights$Writeinsight extends StandardParameters { /** @@ -3198,6 +4160,10 @@ export namespace workloadmanager_v1 { * The Cloud Storage bucket name for custom rules. */ customRulesBucket?: string; + /** + * Optional. The evaluation type of the rules will be applied to. The Cloud Storage bucket name for custom rules. + */ + evaluationType?: string; /** * Filter based on primary_category, secondary_category */ From b2468bb1ca83bee6de40332c29cf4d4398cc6fbd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 140/144] fix(workspaceevents): update the API #### workspaceevents:v1 The following keys were changed: - schemas.NotificationEndpoint.properties.pubsubTopic.description --- discovery/workspaceevents-v1.json | 4 ++-- src/apis/workspaceevents/v1.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index 3ee66e74b21..e10219a967c 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -474,7 +474,7 @@ } } }, - "revision": "20250114", + "revision": "20250225", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { @@ -500,7 +500,7 @@ "id": "NotificationEndpoint", "properties": { "pubsubTopic": { - "description": "Immutable. The Cloud Pub/Sub topic that receives events for the subscription. Format: `projects/{project}/topics/{topic}` You must create the topic in the same Google Cloud project where you create this subscription. When the topic receives events, the events are encoded as Cloud Pub/Sub messages. For details, see the [Google Cloud Pub/Sub Protocol Binding for CloudEvents](https://github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md).", + "description": "Immutable. The Pub/Sub topic that receives events for the subscription. Format: `projects/{project}/topics/{topic}` You must create the topic in the same Google Cloud project where you create this subscription. When the topic receives events, the events are encoded as Pub/Sub messages. For details, see the [Google Cloud Pub/Sub Protocol Binding for CloudEvents](https://github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md).", "type": "string" } }, diff --git a/src/apis/workspaceevents/v1.ts b/src/apis/workspaceevents/v1.ts index b1cff67934b..54858d1c9d7 100644 --- a/src/apis/workspaceevents/v1.ts +++ b/src/apis/workspaceevents/v1.ts @@ -144,7 +144,7 @@ export namespace workspaceevents_v1 { */ export interface Schema$NotificationEndpoint { /** - * Immutable. The Cloud Pub/Sub topic that receives events for the subscription. Format: `projects/{project\}/topics/{topic\}` You must create the topic in the same Google Cloud project where you create this subscription. When the topic receives events, the events are encoded as Cloud Pub/Sub messages. For details, see the [Google Cloud Pub/Sub Protocol Binding for CloudEvents](https://github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md). + * Immutable. The Pub/Sub topic that receives events for the subscription. Format: `projects/{project\}/topics/{topic\}` You must create the topic in the same Google Cloud project where you create this subscription. When the topic receives events, the events are encoded as Pub/Sub messages. For details, see the [Google Cloud Pub/Sub Protocol Binding for CloudEvents](https://github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md). */ pubsubTopic?: string | null; } From 8e17ec6d16c7d6fbebccebd3fd191b8e01195649 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 141/144] feat(workstations): update the API #### workstations:v1beta The following keys were added: - schemas.Workstation.properties.conditions.description - schemas.Workstation.properties.conditions.items.$ref - schemas.Workstation.properties.conditions.readOnly - schemas.Workstation.properties.conditions.type - schemas.Workstation.properties.degraded.description - schemas.Workstation.properties.degraded.readOnly - schemas.Workstation.properties.degraded.type The following keys were changed: - schemas.GcePersistentDisk.properties.sourceImage.description - schemas.GcePersistentDisk.properties.sourceSnapshot.description - schemas.PrivateClusterConfig.properties.serviceAttachmentUri.description #### workstations:v1 The following keys were changed: - schemas.GcePersistentDisk.properties.sourceImage.description - schemas.GcePersistentDisk.properties.sourceSnapshot.description - schemas.PrivateClusterConfig.properties.serviceAttachmentUri.description --- discovery/workstations-v1.json | 8 ++++---- discovery/workstations-v1beta.json | 21 +++++++++++++++++---- src/apis/workstations/v1.ts | 6 +++--- src/apis/workstations/v1beta.ts | 14 +++++++++++--- 4 files changed, 35 insertions(+), 14 deletions(-) diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index fa148d5c359..7b86048fa04 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -1195,7 +1195,7 @@ } } }, - "revision": "20250101", + "revision": "20250219", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1563,11 +1563,11 @@ "type": "boolean" }, "sourceImage": { - "description": "Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.", + "description": "Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.", "type": "string" }, "sourceSnapshot": { - "description": "Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.", + "description": "Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.", "type": "string" } }, @@ -2043,7 +2043,7 @@ "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).", + "description": "Output only. Service attachment URI for the workstation cluster. The service attachment 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" } diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index 38e6ddf01e7..f929a82517e 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -1127,7 +1127,7 @@ } } }, - "revision": "20250101", + "revision": "20250219", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1495,11 +1495,11 @@ "type": "boolean" }, "sourceImage": { - "description": "Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.", + "description": "Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.", "type": "string" }, "sourceSnapshot": { - "description": "Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.", + "description": "Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.", "type": "string" } }, @@ -1938,7 +1938,7 @@ "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).", + "description": "Output only. Service attachment URI for the workstation cluster. The service attachment 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" } @@ -2096,12 +2096,25 @@ "readOnly": true, "type": "array" }, + "conditions": { + "description": "Output only. Status conditions describing the workstation's current state.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, "createTime": { "description": "Output only. Time when this workstation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, + "degraded": { + "description": "Output only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.", + "readOnly": true, + "type": "boolean" + }, "deleteTime": { "description": "Output only. Time when this workstation was soft-deleted.", "format": "google-datetime", diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index eaf1f2cf339..fcf78db6db2 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -402,11 +402,11 @@ export namespace workstations_v1 { */ readOnly?: boolean | null; /** - * Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable. + * Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable. */ sourceImage?: string | null; /** - * Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable. + * Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable. */ sourceSnapshot?: string | null; } @@ -753,7 +753,7 @@ export namespace workstations_v1 { */ 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). + * Output only. Service attachment URI for the workstation cluster. The service attachment 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; } diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index 4c729deb314..cbaa3e830a5 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -402,11 +402,11 @@ export namespace workstations_v1beta { */ readOnly?: boolean | null; /** - * Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable. + * Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable. */ sourceImage?: string | null; /** - * Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable. + * Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable. */ sourceSnapshot?: string | null; } @@ -728,7 +728,7 @@ export namespace workstations_v1beta { */ 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). + * Output only. Service attachment URI for the workstation cluster. The service attachment 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; } @@ -844,10 +844,18 @@ export namespace workstations_v1beta { * Output only. List of available boost configuration IDs that this workstation can be boosted up to. */ boostConfigs?: Schema$WorkstationBoostConfig[]; + /** + * Output only. Status conditions describing the workstation's current state. + */ + conditions?: Schema$Status[]; /** * Output only. Time when this workstation was created. */ createTime?: string | null; + /** + * Output only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. + */ + degraded?: boolean | null; /** * Output only. Time when this workstation was soft-deleted. */ From 66d216b4ea695d59d15e2a71d0bb7370a2ea29c7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 142/144] feat(youtube): update the API #### youtube:v3 The following keys were added: - schemas.ChannelStatus.properties.isChannelMonetizationEnabled.description - schemas.ChannelStatus.properties.isChannelMonetizationEnabled.type The following keys were changed: - schemas.ContentRating.properties.djctqRatingReasons.items.enum - schemas.ContentRating.properties.djctqRatingReasons.items.enumDescriptions --- discovery/youtube-v3.json | 18 +++++++++++++++--- src/apis/youtube/v3.ts | 4 ++++ 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/discovery/youtube-v3.json b/discovery/youtube-v3.json index da6c2e3d59b..5b09910eace 100644 --- a/discovery/youtube-v3.json +++ b/discovery/youtube-v3.json @@ -4100,7 +4100,7 @@ } } }, - "revision": "20250122", + "revision": "20250224", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -5528,6 +5528,10 @@ "description": "JSON template for the status part of a channel.", "id": "ChannelStatus", "properties": { + "isChannelMonetizationEnabled": { + "description": "Whether the channel is considered ypp monetization enabled. See go/yppornot for more details.", + "type": "boolean" + }, "isLinked": { "description": "If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.", "type": "boolean" @@ -6486,7 +6490,11 @@ "djctqIllegalDrugs", "djctqInappropriateLanguage", "djctqCriminalActs", - "djctqImpactingContent" + "djctqImpactingContent", + "djctqFear", + "djctqMedicalProcedures", + "djctqSensitiveTopics", + "djctqFantasyViolence" ], "enumDescriptions": [ "", @@ -6501,7 +6509,11 @@ "Drogas Ilícitas (Illegal drugs)", "Linguagem Imprópria (Inappropriate language)", "Atos Criminosos (Criminal Acts)", - "Conteúdo Impactante (Impacting content)" + "Conteúdo Impactante (Impacting content)", + "Temer (Fear)", + "Procedimentos médicos (Medical Procedures)", + "Tópicos sensíveis (Sensitive Topics)", + "Fantasia Violência (Fantasy Violence)" ], "type": "string" }, diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index f3fdb47f726..df665f98f5e 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -1112,6 +1112,10 @@ export namespace youtube_v3 { * JSON template for the status part of a channel. */ export interface Schema$ChannelStatus { + /** + * Whether the channel is considered ypp monetization enabled. See go/yppornot for more details. + */ + isChannelMonetizationEnabled?: boolean | null; /** * If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity. */ From 0b6c7af2c222965b9a10be184eb84862a5cd58d7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 18 Mar 2025 00:03:51 +0000 Subject: [PATCH 143/144] feat: regenerate index files --- discovery/accessapproval-v1.json | 10 +- discovery/apigee-v1.json | 678 +++++++++++++++++++++--- discovery/assuredworkloads-v1.json | 4 +- discovery/assuredworkloads-v1beta1.json | 4 +- discovery/datalineage-v1.json | 11 +- discovery/doubleclickbidmanager-v2.json | 6 +- discovery/index.json | 38 +- discovery/integrations-v1.json | 320 +++++++---- discovery/kmsinventory-v1.json | 20 +- discovery/meet-v2.json | 11 +- discovery/secretmanager-v1.json | 47 +- discovery/secretmanager-v1beta1.json | 47 +- discovery/secretmanager-v1beta2.json | 47 +- discovery/speech-v1p1beta1.json | 39 +- discovery/sts-v1.json | 42 +- discovery/sts-v1beta.json | 42 +- discovery/toolresults-v1beta3.json | 3 +- discovery/trafficdirector-v3.json | 56 +- src/apis/index.ts | 3 + src/index.ts | 1 + 20 files changed, 1210 insertions(+), 219 deletions(-) diff --git a/discovery/accessapproval-v1.json b/discovery/accessapproval-v1.json index 104ad358d77..35808321aec 100644 --- a/discovery/accessapproval-v1.json +++ b/discovery/accessapproval-v1.json @@ -913,7 +913,7 @@ } } }, - "revision": "20240820", + "revision": "20250206", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalServiceAccount": { @@ -1294,7 +1294,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", - "EXTERNAL_SYMMETRIC_ENCRYPTION" + "EXTERNAL_SYMMETRIC_ENCRYPTION", + "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -1332,7 +1334,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", - "Algorithm representing symmetric encryption by an external key manager." + "Algorithm representing symmetric encryption by an external key manager.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "type": "string" }, diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 339bd97b813..bdfde297946 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -770,7 +770,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -798,7 +798,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`", + "description": "Required. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -826,7 +826,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -851,7 +851,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -867,7 +867,7 @@ ] }, "list": { - "description": "Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.", + "description": "Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "flatPath": "v1/organizations/{organizationsId}/apiproducts", "httpMethod": "GET", "id": "apigee.organizations.apiproducts.list", @@ -897,12 +897,17 @@ "type": "boolean" }, "parent": { - "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`", + "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, + "space": { + "description": "Optional. The Space to list API products for. When none provided, all the spaces the user has list access, will be used implicitly, and the same following rules will apply. Can be used in conjunction with start_key, expand and count for paginated response. Composite queries with attributename and attributevalue are not supported yet.", + "location": "query", + "type": "string" + }, "startKey": { "description": "Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the `count` query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using `startKey`). Product name is case sensitive.", "location": "query", @@ -917,6 +922,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "move": { + "description": "Moves an API product to a different space.", + "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}:move", + "httpMethod": "POST", + "id": "apigee.organizations.apiproducts.move", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. API product to move in the following format: `organizations/{org}/apiproducts/{apiproduct}", + "location": "path", + "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:move", + "request": { + "$ref": "GoogleCloudApigeeV1MoveApiProductRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1ApiProduct" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "update": { "description": "Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.", "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}", @@ -927,7 +960,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path.To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -959,7 +992,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`", + "description": "Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -984,7 +1017,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`", + "description": "Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -1009,7 +1042,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -1034,7 +1067,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -1066,7 +1099,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", + "description": "Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -1094,7 +1127,7 @@ ], "parameters": { "name": { - "description": "Required. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`", + "description": "Required. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/rateplans/[^/]+$", "required": true, @@ -1119,7 +1152,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`", + "description": "Required. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/rateplans/[^/]+$", "required": true, @@ -1160,7 +1193,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization. If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -1205,7 +1238,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`", + "description": "Required. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/rateplans/[^/]+$", "required": true, @@ -1249,12 +1282,17 @@ "type": "string" }, "parent": { - "description": "Required. Name of the organization in the following format: `organizations/{org}`", + "description": "Required. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, + "space": { + "description": "Optional. The ID of the space associated with this proxy. Any IAM policies applied to the space will affect access to this proxy. Note that this field is only respected when creating a new proxy. It has no effect when creating a new revision for an existing proxy.", + "location": "query", + "type": "string" + }, "validate": { "description": "Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.", "location": "query", @@ -1282,7 +1320,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`", + "description": "Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -1307,7 +1345,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`", + "description": "Required. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -1323,7 +1361,7 @@ ] }, "list": { - "description": "Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.", + "description": "Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "flatPath": "v1/organizations/{organizationsId}/apis", "httpMethod": "GET", "id": "apigee.organizations.apis.list", @@ -1342,11 +1380,16 @@ "type": "boolean" }, "parent": { - "description": "Required. Name of the organization in the following format: `organizations/{org}`", + "description": "Required. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" + }, + "space": { + "description": "Optional. The space ID to filter the list of proxies (optional). If unspecified, all proxies in the organization will be listed.", + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/apis", @@ -1357,6 +1400,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "move": { + "description": "Moves an API proxy to a different space.", + "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}:move", + "httpMethod": "POST", + "id": "apigee.organizations.apis.move", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. API proxy to move in the following format: `organizations/{org}/apis/{api}`", + "location": "path", + "pattern": "^organizations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:move", + "request": { + "$ref": "GoogleCloudApigeeV1MoveApiProxyRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1ApiProxy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "patch": { "description": "Updates an existing API proxy.", "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}", @@ -1367,7 +1438,7 @@ ], "parameters": { "name": { - "description": "Required. API proxy to update in the following format: `organizations/{org}/apis/{api}`", + "description": "Required. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -1393,6 +1464,46 @@ } }, "resources": { + "debugsessions": { + "methods": { + "list": { + "description": "Lists debug sessions that are currently active in the given API Proxy.", + "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/debugsessions", + "httpMethod": "GET", + "id": "apigee.organizations.apis.debugsessions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of debug sessions to return. The page size defaults to 25.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token, returned from a previous ListApiDebugSessions call, that you can use to retrieve the next page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the API Proxy for which to list debug sessions. Must be of the form: `organizations/{organization}/apis/{api}`.", + "location": "path", + "pattern": "^organizations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/debugsessions", + "response": { + "$ref": "GoogleCloudApigeeV1ListApiDebugSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "deployments": { "methods": { "list": { @@ -1405,7 +1516,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`", + "description": "Required. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -1434,7 +1545,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}`", + "description": "Required. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+$", "required": true, @@ -1462,7 +1573,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}`", + "description": "Required. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -1491,7 +1602,7 @@ ], "parameters": { "parent": { - "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -1519,7 +1630,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.", + "description": "Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -1544,7 +1655,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.", + "description": "Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -1580,7 +1691,7 @@ "type": "string" }, "parent": { - "description": "Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -1605,7 +1716,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -1639,7 +1750,7 @@ ], "parameters": { "name": { - "description": "Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", + "description": "Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -1669,7 +1780,7 @@ "type": "string" }, "name": { - "description": "Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", + "description": "Required. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -1694,7 +1805,7 @@ ], "parameters": { "name": { - "description": "Required. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`", + "description": "Required. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -1731,7 +1842,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.", + "description": "Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -1783,7 +1894,7 @@ ] }, "delete": { - "description": "Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. **Warning**: This API will permanently delete the AppGroup and related artifacts. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.", + "description": "Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. **Warning**: This API will permanently delete the AppGroup and related artifacts. **Note**: The delete operation is asynchronous. The AppGroup is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.", "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}", "httpMethod": "DELETE", "id": "apigee.organizations.appgroups.delete", @@ -2600,7 +2711,7 @@ ] }, "delete": { - "description": "Deletes a developer. All apps and API keys associated with the developer are also removed. **Warning**: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to `inactive` using the SetDeveloperStatus API. **Note**: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.", + "description": "Deletes a developer. All apps and API keys associated with the developer are also removed. **Warning**: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to `inactive` using the SetDeveloperStatus API. **Note**: The delete operation is asynchronous. The developer is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", "httpMethod": "DELETE", "id": "apigee.organizations.developers.delete", @@ -4895,7 +5006,7 @@ ], "parameters": { "parent": { - "description": "Required. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`", + "description": "Required. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+$", "required": true, @@ -4915,7 +5026,7 @@ "revisions": { "methods": { "deploy": { - "description": "Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` ", + "description": "Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` All successful API proxy deployments to Apigee are [zero-downtime deployments](https://cloud.google.com/apigee/docs/api-platform/deploy/ui-deploy-overview#zero-downtime-deployment). Apigee hybrid validates the dependencies between shared flows and API proxies at deployment time. For example, if the Flow Callout policy in an API proxy references a shared flow that either doesn't exist or isn't deployed, the API proxy deployment fails.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments", "httpMethod": "POST", "id": "apigee.organizations.environments.apis.revisions.deploy", @@ -4924,7 +5035,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", + "description": "Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -4964,7 +5075,7 @@ ], "parameters": { "name": { - "description": "Required. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", + "description": "Required. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -4989,7 +5100,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", + "description": "Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -5023,7 +5134,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.", + "description": "Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -5057,7 +5168,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.", + "description": "Required. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$", "required": true, @@ -5082,7 +5193,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.", + "description": "Required. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$", "required": true, @@ -5118,7 +5229,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.", + "description": "Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -5147,7 +5258,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.", + "description": "Required. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+/data/[^/]+$", "required": true, @@ -5178,7 +5289,7 @@ ], "parameters": { "name": { - "description": "Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`", + "description": "Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+$", "required": true, @@ -6052,7 +6163,7 @@ ], "parameters": { "parent": { - "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -6080,7 +6191,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.", + "description": "Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -6105,7 +6216,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.", + "description": "Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -6141,7 +6252,7 @@ "type": "string" }, "parent": { - "description": "Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -6166,7 +6277,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -7321,7 +7432,7 @@ ], "parameters": { "parent": { - "description": "Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`", + "description": "Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+$", "required": true, @@ -7350,7 +7461,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", + "description": "Required. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -7385,7 +7496,7 @@ ], "parameters": { "name": { - "description": "Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", + "description": "Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -7410,7 +7521,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`", + "description": "Required. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -8817,7 +8928,7 @@ ], "parameters": { "parent": { - "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -8845,7 +8956,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.", + "description": "Required. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -8870,7 +8981,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.", + "description": "Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -8906,7 +9017,7 @@ "type": "string" }, "parent": { - "description": "Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$", "required": true, @@ -8931,7 +9042,7 @@ ], "parameters": { "name": { - "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.", + "description": "Required. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+/entries/[^/]+$", "required": true, @@ -9753,11 +9864,16 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`", + "description": "Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" + }, + "space": { + "description": "Optional. The ID of the space to associated with this shared flow. Any IAM policies applied to the space will affect access to this shared flow. Note that this field is only respected when creating a new shared flow. It has no effect when creating a new revision for an existing shared flow.", + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/sharedflows", @@ -9781,7 +9897,7 @@ ], "parameters": { "name": { - "description": "Required. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`", + "description": "Required. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", "required": true, @@ -9806,7 +9922,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`", + "description": "Required. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", "required": true, @@ -9822,7 +9938,7 @@ ] }, "list": { - "description": "Lists all shared flows in the organization.", + "description": "Lists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "flatPath": "v1/organizations/{organizationsId}/sharedflows", "httpMethod": "GET", "id": "apigee.organizations.sharedflows.list", @@ -9841,11 +9957,16 @@ "type": "boolean" }, "parent": { - "description": "Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`", + "description": "Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" + }, + "space": { + "description": "Optional. The space ID used to filter the list of shared flows (optional). If unspecified, all shared flows in the organization will be listed. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/sharedflows", @@ -9855,6 +9976,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "move": { + "description": "Moves an shared flow to a different space.", + "flatPath": "v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}:move", + "httpMethod": "POST", + "id": "apigee.organizations.sharedflows.move", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Shared Flow to move in the following format: `organizations/{org}/sharedflows/{shared_flow}`", + "location": "path", + "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:move", + "request": { + "$ref": "GoogleCloudApigeeV1MoveSharedFlowRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SharedFlow" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -9870,7 +10019,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`", + "description": "Required. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+$", "required": true, @@ -9899,7 +10048,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", + "description": "Required. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -9929,7 +10078,7 @@ "type": "string" }, "name": { - "description": "Required. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", + "description": "Required. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -9954,7 +10103,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`", + "description": "Required. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -9991,7 +10140,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.", + "description": "Required. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`. If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", "location": "path", "pattern": "^organizations/[^/]+/sharedflows/[^/]+/revisions/[^/]+$", "required": true, @@ -10349,6 +10498,250 @@ } } } + }, + "spaces": { + "methods": { + "create": { + "description": "Create a space under an organization.", + "flatPath": "v1/organizations/{organizationsId}/spaces", + "httpMethod": "POST", + "id": "apigee.organizations.spaces.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the Google Cloud project in which to associate the Apigee space. Pass the information as a query parameter using the following structure in your request: `organizations/`", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + }, + "spaceId": { + "description": "Required. Resource ID of the space.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/spaces", + "request": { + "$ref": "GoogleCloudApigeeV1Space" + }, + "response": { + "$ref": "GoogleCloudApigeeV1Space" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an organization space.", + "flatPath": "v1/organizations/{organizationsId}/spaces/{spacesId}", + "httpMethod": "DELETE", + "id": "apigee.organizations.spaces.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Apigee organization space name in the following format: `organizations/{org}/spaces/{space}`", + "location": "path", + "pattern": "^organizations/[^/]+/spaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a space under an Organization.", + "flatPath": "v1/organizations/{organizationsId}/spaces/{spacesId}", + "httpMethod": "GET", + "id": "apigee.organizations.spaces.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Apigee organization space name in the following format: `organizations/{org}/spaces/{space}`", + "location": "path", + "pattern": "^organizations/[^/]+/spaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1Space" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Callers must have apigee.spaces.getIamPolicy.", + "flatPath": "v1/organizations/{organizationsId}/spaces/{spacesId}:getIamPolicy", + "httpMethod": "GET", + "id": "apigee.organizations.spaces.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/[^/]+/spaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists spaces under an organization.", + "flatPath": "v1/organizations/{organizationsId}/spaces", + "httpMethod": "GET", + "id": "apigee.organizations.spaces.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 50 spaces 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 `ListSpaces` call. Provide this to retrieve the subsequent page. When paginating, all parameters must match the original call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Use the following structure in your request: `organizations`", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/spaces", + "response": { + "$ref": "GoogleCloudApigeeV1ListSpacesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a space.", + "flatPath": "v1/organizations/{organizationsId}/spaces/{spacesId}", + "httpMethod": "PATCH", + "id": "apigee.organizations.spaces.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the space in the following format: `organizations/{org}/spaces/{space_id}`.", + "location": "path", + "pattern": "^organizations/[^/]+/spaces/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. List of fields to be updated. Fields that can be updated: display_name.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1Space" + }, + "response": { + "$ref": "GoogleCloudApigeeV1Space" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "IAM META APIs Callers must have apigee.spaces.setIamPolicy.", + "flatPath": "v1/organizations/{organizationsId}/spaces/{spacesId}:setIamPolicy", + "httpMethod": "POST", + "id": "apigee.organizations.spaces.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/[^/]+/spaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Callers don't need any permissions.", + "flatPath": "v1/organizations/{organizationsId}/spaces/{spacesId}:testIamPermissions", + "httpMethod": "POST", + "id": "apigee.organizations.spaces.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/[^/]+/spaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -10385,7 +10778,7 @@ } } }, - "revision": "20241213", + "revision": "20250306", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -10739,6 +11132,30 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ApiDebugSession": { + "description": "Session carries the debug session id and its creation time.", + "id": "GoogleCloudApigeeV1ApiDebugSession", + "properties": { + "apiProxyRevisionId": { + "description": "The revision ID of the deployed API proxy.", + "type": "string" + }, + "createTime": { + "description": "The first transaction creation timestamp in millisecond, recorded by UAP.", + "format": "google-datetime", + "type": "string" + }, + "environmentId": { + "description": "The environment ID of the deployed API proxy.", + "type": "string" + }, + "id": { + "description": "The debug session ID.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ApiDoc": { "description": "`ApiDoc` represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.", "id": "GoogleCloudApigeeV1ApiDoc", @@ -11001,6 +11418,10 @@ "type": "string" }, "type": "array" + }, + "space": { + "description": "Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "type": "string" } }, "type": "object" @@ -11072,6 +11493,10 @@ }, "readOnly": true, "type": "array" + }, + "space": { + "description": "Optional. The id of the space this proxy is associated with. Any IAM policies applied to the space will control access to this proxy. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "type": "string" } }, "type": "object" @@ -11745,13 +12170,13 @@ "type": "object" }, "GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll": { - "description": "Message for include_all option.", + "description": "Message for include_all_resources option.", "id": "GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll", "properties": {}, "type": "object" }, "GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray": { - "description": "An array of resource messages.", + "description": "Message for the array of resources. For Apigee, the proxies are resources.", "id": "GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray", "properties": { "resources": { @@ -12649,6 +13074,7 @@ "type": "object" }, "GoogleCloudApigeeV1Deployment": { + "description": "Deployment represents a deployment of an API proxy or shared flow.", "id": "GoogleCloudApigeeV1Deployment", "properties": { "apiProxy": { @@ -13423,7 +13849,7 @@ "type": "string" }, "forwardProxyUri": { - "description": "Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of \"http\" or \"https\", and the port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request.", + "description": "Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the only supported scheme is \"http\". The port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request.", "type": "string" }, "hasAttachedFlowHooks": { @@ -14477,6 +14903,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListApiDebugSessionsResponse": { + "description": "Response for ListApiDebugSessions.", + "id": "GoogleCloudApigeeV1ListApiDebugSessionsResponse", + "properties": { + "nextPageToken": { + "description": "Page token that you can include in a ListApiDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist.", + "type": "string" + }, + "sessions": { + "description": "Session info that includes debug session ID, environment ID, api proxy revision ID and the first transaction creation timestamp.", + "items": { + "$ref": "GoogleCloudApigeeV1ApiDebugSession" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListApiDocsResponse": { "id": "GoogleCloudApigeeV1ListApiDocsResponse", "properties": { @@ -15066,6 +15510,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListSpacesResponse": { + "description": "A response to a ListSpaces request containing the list of organization spaces and a page token for the next page.", + "id": "GoogleCloudApigeeV1ListSpacesResponse", + "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" + }, + "spaces": { + "description": "List of Apigee organization spaces.", + "items": { + "$ref": "GoogleCloudApigeeV1Space" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListTraceConfigOverridesResponse": { "description": "Response for ListTraceConfigOverrides.", "id": "GoogleCloudApigeeV1ListTraceConfigOverridesResponse", @@ -15179,6 +15641,39 @@ }, "type": "object" }, + "GoogleCloudApigeeV1MoveApiProductRequest": { + "description": "Moves API product to a different space.", + "id": "GoogleCloudApigeeV1MoveApiProductRequest", + "properties": { + "space": { + "description": "Optional. Resource ID of the space to move the API product to. If unspecified, the API product will be moved to the organization level.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1MoveApiProxyRequest": { + "description": "Moves an API Proxy to a different Space.", + "id": "GoogleCloudApigeeV1MoveApiProxyRequest", + "properties": { + "space": { + "description": "Optional. Resource ID of the space to move the proxy to. If unspecified, the proxy will be moved to the organization level.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1MoveSharedFlowRequest": { + "description": "Moves a Shared Flow to a different space.", + "id": "GoogleCloudApigeeV1MoveSharedFlowRequest", + "properties": { + "space": { + "description": "Optional. Resource ID of the space to move the shared flow to. If unspecified, the shared flow will be moved to the organization level.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1NatAddress": { "description": "Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic.", "id": "GoogleCloudApigeeV1NatAddress", @@ -17362,7 +17857,6 @@ "type": "integer" }, "severity": { - "description": "The severity of the assessment.", "enum": [ "SEVERITY_UNSPECIFIED", "LOW", @@ -18067,6 +18561,10 @@ "type": "string" }, "type": "array" + }, + "space": { + "description": "Optional. The ID of the space associated with this shared flow. Any IAM policies applied to the space will control access to this shared flow. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "type": "string" } }, "type": "object" @@ -18148,6 +18646,34 @@ }, "type": "object" }, + "GoogleCloudApigeeV1Space": { + "description": "Organization space resource.", + "id": "GoogleCloudApigeeV1Space", + "properties": { + "createTime": { + "description": "Output only. Create timestamp of the space.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Display name of the space.", + "type": "string" + }, + "name": { + "description": "Output only. Identifier. Id of the space. This field is used as the resource name, and must follow [AIP-122](https://google.aip.dev/122) guidelines.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last modified timestamp of the space.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1Stats": { "description": "Encapsulates a `stats` response.", "id": "GoogleCloudApigeeV1Stats", diff --git a/discovery/assuredworkloads-v1.json b/discovery/assuredworkloads-v1.json index b4605623d79..1cb0a663005 100644 --- a/discovery/assuredworkloads-v1.json +++ b/discovery/assuredworkloads-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20241206", + "revision": "20250213", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -1675,7 +1675,7 @@ ], "enumDescriptions": [ "KAJ Enrollment type is unspecified", - "KAT sets External, Hardware, and Software key feature logging only to TRUE. (no enforcement)" + "KAT sets External, Hardware, and Software key feature logging only to TRUE." ], "type": "string" } diff --git a/discovery/assuredworkloads-v1beta1.json b/discovery/assuredworkloads-v1beta1.json index 5f956df8633..4b4a86d4836 100644 --- a/discovery/assuredworkloads-v1beta1.json +++ b/discovery/assuredworkloads-v1beta1.json @@ -656,7 +656,7 @@ } } }, - "revision": "20241206", + "revision": "20250213", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -2029,7 +2029,7 @@ ], "enumDescriptions": [ "KAJ Enrollment type is unspecified", - "KAT sets External, Hardware, and Software key feature logging only to TRUE. (no enforcement)" + "KAT sets External, Hardware, and Software key feature logging only to TRUE." ], "type": "string" } diff --git a/discovery/datalineage-v1.json b/discovery/datalineage-v1.json index ff62b2b15e8..974be1416de 100644 --- a/discovery/datalineage-v1.json +++ b/discovery/datalineage-v1.json @@ -111,6 +111,11 @@ "endpointUrl": "https://datalineage.europe-west12.rep.googleapis.com/", "location": "europe-west12" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://datalineage.europe-west15.rep.googleapis.com/", + "location": "europe-west15" + }, { "description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-west2.rep.googleapis.com/", @@ -1035,7 +1040,7 @@ } } }, - "revision": "20241202", + "revision": "20250207", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { @@ -1084,7 +1089,7 @@ "id": "GoogleCloudDatacatalogLineageV1EntityReference", "properties": { "fullyQualifiedName": { - "description": "Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.", + "description": "Required. [Fully Qualified Name (FQN)](https://cloud.google.com/dataplex/docs/fully-qualified-names) of the entity.", "type": "string" } }, @@ -1285,7 +1290,7 @@ "id": "GoogleCloudDatacatalogLineageV1Origin", "properties": { "name": { - "description": "If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: \"projects/foo/locations/us/environments/bar\"}` - `{source_type: BIGQUERY, name: \"projects/foo/locations/eu\"}` - `{source_type: CUSTOM, name: \"myCustomIntegration\"}`", + "description": "If the source_type isn't CUSTOM, the value of this field should be a Google Cloud resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: \"projects/foo/locations/us/environments/bar\"}` - `{source_type: BIGQUERY, name: \"projects/foo/locations/eu\"}` - `{source_type: CUSTOM, name: \"myCustomIntegration\"}`", "type": "string" }, "sourceType": { diff --git a/discovery/doubleclickbidmanager-v2.json b/discovery/doubleclickbidmanager-v2.json index fbeb27346e9..40668c626f7 100644 --- a/discovery/doubleclickbidmanager-v2.json +++ b/discovery/doubleclickbidmanager-v2.json @@ -319,7 +319,7 @@ } } }, - "revision": "20240731", + "revision": "20250305", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "DataRange": { @@ -513,7 +513,7 @@ "enumDeprecated": [ false, false, - false, + true, true, false, false, @@ -527,7 +527,7 @@ "enumDescriptions": [ "Default value when report type is not specified or is unknown in this version.", "Standard report.", - "Inventory Availability report.", + "Inventory Availability report. See the [Display & Video 360 Help Center announcement](https://support.google.com/displayvideo/answer/15874746) for more information on this deprecation.", "Audience Composition report.", "Floodlight report.", "YouTube report.", diff --git a/discovery/index.json b/discovery/index.json index 4bdd1d6aa43..0808e57f094 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -2699,10 +2699,25 @@ "id": "displayvideo:v3", "kind": "discovery#directoryItem", "name": "displayvideo", - "preferred": true, + "preferred": false, "title": "Display & Video 360 API", "version": "v3" }, + { + "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=v4", + "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" + }, + "id": "displayvideo:v4", + "kind": "discovery#directoryItem", + "name": "displayvideo", + "preferred": true, + "title": "Display & Video 360 API", + "version": "v4" + }, { "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", @@ -3338,7 +3353,7 @@ { "description": "Reads and writes Google Forms and responses.", "discoveryRestUrl": "https://forms.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://developers.google.com/forms/api", + "documentationLink": "https://developers.google.com/workspace/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" @@ -3527,7 +3542,7 @@ "kind": "discovery#directoryItem", "name": "gkeonprem", "preferred": true, - "title": "GDC Virtual API", + "title": "GKE On-Prem API", "version": "v1" }, { @@ -4100,6 +4115,21 @@ "title": "Managed Service for Microsoft Active Directory API", "version": "v1" }, + { + "description": "Manage Apache Kafka clusters and resources.", + "discoveryRestUrl": "https://managedkafka.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/managed-service-for-apache-kafka/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" + }, + "id": "managedkafka:v1", + "kind": "discovery#directoryItem", + "name": "managedkafka", + "preferred": true, + "title": "Managed Service for Apache Kafka API", + "version": "v1" + }, { "description": "Public API for managing Manufacturer Center related data.", "discoveryRestUrl": "https://manufacturers.googleapis.com/$discovery/rest?version=v1", @@ -5452,7 +5482,7 @@ "version": "v1" }, { - "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.", + "description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive with pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.", "discoveryRestUrl": "https://realtimebidding.googleapis.com/$discovery/rest?version=v1", "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", "icons": { diff --git a/discovery/integrations-v1.json b/discovery/integrations-v1.json index 796d5c6f266..8847e6c307d 100644 --- a/discovery/integrations-v1.json +++ b/discovery/integrations-v1.json @@ -1090,6 +1090,11 @@ "name" ], "parameters": { + "GCPCloudEventsMode": { + "description": "Optional. LINT: LEGACY_NAMES The query parameter value for __GCP_CloudEventsMode, set by the Eventarc service when configuring triggers.", + "location": "query", + "type": "string" + }, "name": { "description": "Required. The integration resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration_id}", "location": "path", @@ -1192,6 +1197,52 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "search": { + "description": "Searches and returns the list of integrations in the specified project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations:search", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The pre-filter to be applied to the search. This should follow the expressions defined in https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata. For example, \"status:ANY(\"ACTIVE\")\" will return all the resources whose status contains the \"ACTIVE\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 10 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `SearchIntegrations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchIntegrations` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Project and location from which the integrations should be listed. Format: projects/*/locations/*/resources/integrations", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "query": { + "description": "Required. The user query", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/integrations:search", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "test": { "description": "Execute the integration in draft state", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test", @@ -2167,64 +2218,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "listExecutions": { - "description": "Lists the results of all functional test executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executions", - "httpMethod": "GET", - "id": "integrations.projects.locations.integrations.versions.testCases.listExecutions", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Standard filter field, we support filtering on following fields: test_case_id: the ID of the test case. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: \"parameter_type\" HAS \\\"string\\\" Also supports operators like AND, OR, NOT For example, trigger_id=\\\"id1\\\" AND test_case_id=\\\"testCaseId\\\"", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. The results would be returned in order you specified here. Currently supporting \"last_modified_time\" and \"create_time\".", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The size of entries in the response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The token returned in the previous response.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource name of the test case execution.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - }, - "truncateParams": { - "deprecated": true, - "description": "Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+parent}:executions", - "response": { - "$ref": "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "patch": { "description": "Updates a test case", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", @@ -4553,7 +4546,7 @@ } } }, - "revision": "20250113", + "revision": "20250310", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -7268,6 +7261,10 @@ "description": "Contains the details of the execution of this task. Next available id: 11", "id": "EnterpriseCrmEventbusProtoTaskExecutionDetails", "properties": { + "skippedOnFailure": { + "description": "Indicates whether the task was skipped on failure. Only relevant if the task is in SKIPPED state.", + "type": "boolean" + }, "taskAttemptStats": { "items": { "$ref": "EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats" @@ -9656,6 +9653,13 @@ "readOnly": true, "type": "string" }, + "trafficShapingConfigs": { + "description": "Optional. Traffic shaping configuration for the connection.", + "items": { + "$ref": "GoogleCloudConnectorsV1TrafficShapingConfig" + }, + "type": "array" + }, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", @@ -9705,7 +9709,7 @@ "type": "object" }, "GoogleCloudConnectorsV1ConnectorVersionInfraConfig": { - "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", + "description": "This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version", "id": "GoogleCloudConnectorsV1ConnectorVersionInfraConfig", "properties": { "connectionRatelimitWindowSeconds": { @@ -9867,6 +9871,17 @@ }, "type": "object" }, + "GoogleCloudConnectorsV1EnrichmentConfig": { + "description": "Data enrichment configuration.", + "id": "GoogleCloudConnectorsV1EnrichmentConfig", + "properties": { + "appendAcl": { + "description": "Optional. Append ACL to the event.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudConnectorsV1EventingConfig": { "description": "Eventing Configuration of a connection", "id": "GoogleCloudConnectorsV1EventingConfig", @@ -9886,6 +9901,10 @@ "$ref": "GoogleCloudConnectorsV1EventingConfigDeadLetterConfig", "description": "Optional. Dead letter configuration for eventing of a connection." }, + "enrichmentConfig": { + "$ref": "GoogleCloudConnectorsV1EnrichmentConfig", + "description": "Optional. Data enrichment configuration." + }, "enrichmentEnabled": { "description": "Optional. Enrichment Enabled.", "type": "boolean" @@ -10256,6 +10275,23 @@ }, "type": "object" }, + "GoogleCloudConnectorsV1TrafficShapingConfig": { + "description": "* TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.", + "id": "GoogleCloudConnectorsV1TrafficShapingConfig", + "properties": { + "duration": { + "description": "Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.", + "format": "google-duration", + "type": "string" + }, + "quotaLimit": { + "description": "Required. Maximum number of api calls allowed.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaAccessToken": { "description": "The access token represents the authorization of a specific application to access specific parts of a user’s data.", "id": "GoogleCloudIntegrationsV1alphaAccessToken", @@ -10420,7 +10456,7 @@ "type": "string" }, "credentialType": { - "description": "Credential type of the encrypted credential.", + "description": "Required. Credential type of the encrypted credential.", "enum": [ "CREDENTIAL_TYPE_UNSPECIFIED", "USERNAME_AND_PASSWORD", @@ -10456,7 +10492,7 @@ "description": "Raw auth credentials." }, "description": { - "description": "A description of the auth config.", + "description": "Optional. A description of the auth config.", "type": "string" }, "displayName": { @@ -10469,7 +10505,7 @@ "type": "string" }, "expiryNotificationDuration": { - "description": "User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.", + "description": "Optional. User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.", "items": { "format": "google-duration", "type": "string" @@ -10485,7 +10521,7 @@ "type": "string" }, "overrideValidTime": { - "description": "User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.", + "description": "Optional. User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.", "format": "google-datetime", "type": "string" }, @@ -10522,12 +10558,12 @@ "type": "string" }, "validTime": { - "description": "The time until the auth config is valid. Empty or max value is considered the auth config won't expire.", + "description": "Optional. The time until the auth config is valid. Empty or max value is considered the auth config won't expire.", "format": "google-datetime", "type": "string" }, "visibility": { - "description": "The visibility of the auth config.", + "description": "Optional. The visibility of the auth config.", "enum": [ "AUTH_CONFIG_VISIBILITY_UNSPECIFIED", "PRIVATE", @@ -11253,6 +11289,13 @@ "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" }, "type": "array" + }, + "parameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Optional. OUTPUT parameters from integration execution.", + "type": "object" } }, "type": "object" @@ -11335,6 +11378,10 @@ "description": "The Execution resource contains detailed information of an individual integration execution.", "id": "GoogleCloudIntegrationsV1alphaExecution", "properties": { + "cloudKmsKey": { + "description": "Optional. Cloud KMS resource name for the CMEK encryption key.", + "type": "string" + }, "cloudLoggingDetails": { "$ref": "GoogleCloudIntegrationsV1alphaCloudLoggingDetails", "description": "Cloud Logging details for the integration version" @@ -11770,11 +11817,7 @@ "id": "GoogleCloudIntegrationsV1alphaImportTemplateRequest", "properties": { "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.", + "description": "Required. Resource Name of the integration where template needs to be imported/inserted.", "type": "string" }, "subIntegrations": { @@ -12084,6 +12127,10 @@ "description": "The integration version definition.", "id": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "properties": { + "cloudKmsKey": { + "description": "Optional. Cloud KMS resource name for the CMEK encryption key.", + "type": "string" + }, "cloudLoggingDetails": { "$ref": "GoogleCloudIntegrationsV1alphaCloudLoggingDetails", "description": "Optional. Cloud Logging details for the integration version" @@ -12197,8 +12244,9 @@ "type": "string" }, "snapshotNumber": { - "description": "Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use \"HEAD\" tag to identify the head.", + "description": "Output only. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use \"HEAD\" tag to identify the head.", "format": "int64", + "readOnly": true, "type": "string" }, "state": { @@ -12598,24 +12646,6 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse": { - "description": "The response for listing the functional test execution data.", - "id": "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse", - "properties": { - "executions": { - "description": "The detailed information of requested executions", - "items": { - "$ref": "GoogleCloudIntegrationsV1alphaExecution" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The token used to retrieve the next page results.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudIntegrationsV1alphaListTestCasesResponse": { "description": "Response for ListTestCases", "id": "GoogleCloudIntegrationsV1alphaListTestCasesResponse", @@ -13133,9 +13163,35 @@ "description": "Request for replaying an execution.", "id": "GoogleCloudIntegrationsV1alphaReplayExecutionRequest", "properties": { + "modifiedParameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Optional. The modified input parameters for replay. - Provide values for all the fields in the 'update_mask'. Any field not present in the 'update_mask' will be ignored and its value will be taken from the original execution. - If the 'update_mask' is not specified, all the parameters from original execution will be ignored and only the `modified_parameters` will be used.", + "type": "object" + }, + "replayMode": { + "description": "Optional. The mode of the replay.", + "enum": [ + "REPLAY_MODE_UNSPECIFIED", + "REPLAY_MODE_FROM_BEGINNING", + "REPLAY_MODE_POINT_OF_FAILURE" + ], + "enumDescriptions": [ + "Default value.", + "Replay the original execution.", + "Replay the execution with the modified parameters." + ], + "type": "string" + }, "replayReason": { "description": "Required. The user provided reason for replaying the execution.", "type": "string" + }, + "updateMask": { + "description": "Optional. The list of parameters to be updated. - If the `update_mask` is not specified, all the parameters from original execution will be ignored and only the `modified_parameters` will be used. - It is an error to include a parameter in `update_mask` but not in `modified_parameters`. - Updating nested fields in a JSON parameter is not supported, please provide the complete JSON in the `modified_parameters`.", + "format": "google-fieldmask", + "type": "string" } }, "type": "object" @@ -13276,6 +13332,80 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse": { + "description": "Response for SearchIntegrations.", + "id": "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse", + "properties": { + "integrations": { + "description": "The list of integrations that match the search criteria.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult" + }, + "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" + }, + "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult": { + "description": "The integration search result with integration level information.", + "id": "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult", + "properties": { + "createTime": { + "description": "Output only. The create time of the integration version.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creator": { + "description": "The creator of the integration version.", + "type": "string" + }, + "description": { + "description": "The description of the integration version.", + "type": "string" + }, + "id": { + "description": "The integration id.", + "type": "string" + }, + "name": { + "description": "The integration document metadata.", + "type": "string" + }, + "region": { + "description": "The region of the integration version.", + "type": "string" + }, + "status": { + "description": "Output only. The status of the integration version.", + "enum": [ + "INTEGRATION_STATE_UNSPECIFIED", + "DRAFT", + "ACTIVE", + "ARCHIVED", + "SNAPSHOT" + ], + "enumDescriptions": [ + "Default.", + "Draft.", + "Active.", + "Archived.", + "Snapshot." + ], + "readOnly": true, + "type": "string" + }, + "version": { + "description": "The version of the integration version.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaSearchTemplatesResponse": { "description": "Response for a request to search templates", "id": "GoogleCloudIntegrationsV1alphaSearchTemplatesResponse", @@ -13339,7 +13469,7 @@ "id": "GoogleCloudIntegrationsV1alphaSfdcChannel", "properties": { "channelTopic": { - "description": "The Channel topic defined by salesforce once an channel is opened", + "description": "Required. The Channel topic defined by salesforce once an channel is opened", "type": "string" }, "createTime": { @@ -13355,11 +13485,11 @@ "type": "string" }, "description": { - "description": "The description for this channel", + "description": "Optional. The description for this channel", "type": "string" }, "displayName": { - "description": "Client level unique name/alias to easily reference a channel.", + "description": "Optional. Client level unique name/alias to easily reference a channel.", "type": "string" }, "isActive": { @@ -13407,11 +13537,11 @@ "type": "string" }, "description": { - "description": "A description of the sfdc instance.", + "description": "Optional. A description of the sfdc instance.", "type": "string" }, "displayName": { - "description": "User selected unique name/alias to easily reference an instance.", + "description": "Optional. User selected unique name/alias to easily reference an instance.", "type": "string" }, "name": { diff --git a/discovery/kmsinventory-v1.json b/discovery/kmsinventory-v1.json index 043a9e41119..cdc9f718342 100644 --- a/discovery/kmsinventory-v1.json +++ b/discovery/kmsinventory-v1.json @@ -242,7 +242,7 @@ } } }, - "revision": "20240630", + "revision": "20250302", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { @@ -504,7 +504,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", - "EXTERNAL_SYMMETRIC_ENCRYPTION" + "EXTERNAL_SYMMETRIC_ENCRYPTION", + "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -542,7 +544,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", - "Algorithm representing symmetric encryption by an external key manager." + "Algorithm representing symmetric encryption by an external key manager.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "readOnly": true, "type": "string" @@ -655,7 +659,7 @@ "This version is still being generated. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.", "This version may be used for cryptographic operations.", "This version may not be used, but the key material is still available, and the version can be placed back into the ENABLED state.", - "This version is destroyed, and the key material is no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.", + "This key material of this version is destroyed and no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.", "This version is scheduled for destruction, and will be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the DISABLED state.", "This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.", "This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason.", @@ -710,7 +714,9 @@ "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", - "EXTERNAL_SYMMETRIC_ENCRYPTION" + "EXTERNAL_SYMMETRIC_ENCRYPTION", + "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_SLH_DSA_SHA2_128S" ], "enumDescriptions": [ "Not specified.", @@ -748,7 +754,9 @@ "HMAC-SHA384 signing with a 384 bit key.", "HMAC-SHA512 signing with a 512 bit key.", "HMAC-SHA224 signing with a 224 bit key.", - "Algorithm representing symmetric encryption by an external key manager." + "Algorithm representing symmetric encryption by an external key manager.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version." ], "type": "string" }, diff --git a/discovery/meet-v2.json b/discovery/meet-v2.json index 79728573fd2..e6870bbe579 100644 --- a/discovery/meet-v2.json +++ b/discovery/meet-v2.json @@ -7,6 +7,9 @@ }, "https://www.googleapis.com/auth/meetings.space.readonly": { "description": "Read information about any of your Google Meet conferences" + }, + "https://www.googleapis.com/auth/meetings.space.settings": { + "description": "Edit, and see settings for all of your Google Meet calls." } } } @@ -593,7 +596,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/meetings.space.created", - "https://www.googleapis.com/auth/meetings.space.readonly" + "https://www.googleapis.com/auth/meetings.space.readonly", + "https://www.googleapis.com/auth/meetings.space.settings" ] }, "patch": { @@ -627,13 +631,14 @@ "$ref": "Space" }, "scopes": [ - "https://www.googleapis.com/auth/meetings.space.created" + "https://www.googleapis.com/auth/meetings.space.created", + "https://www.googleapis.com/auth/meetings.space.settings" ] } } } }, - "revision": "20240808", + "revision": "20250127", "rootUrl": "https://meet.googleapis.com/", "schemas": { "ActiveConference": { diff --git a/discovery/secretmanager-v1.json b/discovery/secretmanager-v1.json index 82d5d035abb..3aa1c552cd9 100644 --- a/discovery/secretmanager-v1.json +++ b/discovery/secretmanager-v1.json @@ -110,6 +110,51 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1205,7 +1250,7 @@ } } }, - "revision": "20250117", + "revision": "20250228", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta1.json b/discovery/secretmanager-v1beta1.json index 592eb79bdbd..09872e5c212 100644 --- a/discovery/secretmanager-v1beta1.json +++ b/discovery/secretmanager-v1beta1.json @@ -110,6 +110,51 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -725,7 +770,7 @@ } } }, - "revision": "20250117", + "revision": "20250228", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta2.json b/discovery/secretmanager-v1beta2.json index f2165b952e3..eb861ed7a46 100644 --- a/discovery/secretmanager-v1beta2.json +++ b/discovery/secretmanager-v1beta2.json @@ -110,6 +110,51 @@ "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.eu.rep.googleapis.com/", + "location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1205,7 +1250,7 @@ } } }, - "revision": "20250117", + "revision": "20250228", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/speech-v1p1beta1.json b/discovery/speech-v1p1beta1.json index 05edd0c33cd..8c2589969d9 100644 --- a/discovery/speech-v1p1beta1.json +++ b/discovery/speech-v1p1beta1.json @@ -15,6 +15,43 @@ "description": "Converts audio to text by applying powerful neural network models.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/speech-to-text/docs/quickstart-protocol", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://speech.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://speech.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://speech.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://speech.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://speech.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://speech.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://speech.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -524,7 +561,7 @@ } } }, - "revision": "20240926", + "revision": "20241111", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index b79a1b7aa9f..dc73dbc4923 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -7,10 +7,50 @@ "discoveryVersion": "v1", "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west1.rep.googleapis.com/", + "location": "us-west1" } ], "fullyEncodeReservedExpansion": true, @@ -123,7 +163,7 @@ } } }, - "revision": "20241106", + "revision": "20250303", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/discovery/sts-v1beta.json b/discovery/sts-v1beta.json index 426e25045b3..0f226c1c64c 100644 --- a/discovery/sts-v1beta.json +++ b/discovery/sts-v1beta.json @@ -7,10 +7,50 @@ "discoveryVersion": "v1", "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.us-west1.rep.googleapis.com/", + "location": "us-west1" } ], "fullyEncodeReservedExpansion": true, @@ -123,7 +163,7 @@ } } }, - "revision": "20241106", + "revision": "20250303", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/discovery/toolresults-v1beta3.json b/discovery/toolresults-v1beta3.json index 25bd2bb83ef..56b1d6591fa 100644 --- a/discovery/toolresults-v1beta3.json +++ b/discovery/toolresults-v1beta3.json @@ -1464,7 +1464,7 @@ } } }, - "revision": "20241121", + "revision": "20250204", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { @@ -2635,6 +2635,7 @@ "type": "integer" }, "list": { + "deprecated": true, "description": "Which list this API appears on", "enum": [ "NONE", diff --git a/discovery/trafficdirector-v3.json b/discovery/trafficdirector-v3.json index 57ecc5964a0..11d8c37743d 100644 --- a/discovery/trafficdirector-v3.json +++ b/discovery/trafficdirector-v3.json @@ -128,7 +128,7 @@ } } }, - "revision": "20240410", + "revision": "20250206", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { @@ -321,14 +321,18 @@ "REQUESTED", "DOES_NOT_EXIST", "ACKED", - "NACKED" + "NACKED", + "RECEIVED_ERROR", + "TIMEOUT" ], "enumDescriptions": [ "Resource status is not available/unknown.", "Client requested this resource but hasn't received any update from management server. The client will not fail requests, but will queue them until update arrives or the client times out waiting for the resource.", "This resource has been requested by the client but has either not been delivered by the server or was previously delivered by the server and then subsequently removed from resources provided by the server. For more information, please refer to the :ref:`\"Knowing When a Requested Resource Does Not Exist\" ` section.", "Client received this resource and replied with ACK.", - "Client received this resource and replied with NACK." + "Client received this resource and replied with NACK.", + "Client received an error from the control plane. The attached config dump is the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.", + "Client timed out waiting for the resource from the control plane." ], "type": "string" }, @@ -367,14 +371,18 @@ "REQUESTED", "DOES_NOT_EXIST", "ACKED", - "NACKED" + "NACKED", + "RECEIVED_ERROR", + "TIMEOUT" ], "enumDescriptions": [ "Resource status is not available/unknown.", "Client requested this resource but hasn't received any update from management server. The client will not fail requests, but will queue them until update arrives or the client times out waiting for the resource.", "This resource has been requested by the client but has either not been delivered by the server or was previously delivered by the server and then subsequently removed from resources provided by the server. For more information, please refer to the :ref:`\"Knowing When a Requested Resource Does Not Exist\" ` section.", "Client received this resource and replied with ACK.", - "Client received this resource and replied with NACK." + "Client received this resource and replied with NACK.", + "Client received an error from the control plane. The attached config dump is the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.", + "Client timed out waiting for the resource from the control plane." ], "type": "string" }, @@ -417,14 +425,18 @@ "REQUESTED", "DOES_NOT_EXIST", "ACKED", - "NACKED" + "NACKED", + "RECEIVED_ERROR", + "TIMEOUT" ], "enumDescriptions": [ "Resource status is not available/unknown.", "Client requested this resource but hasn't received any update from management server. The client will not fail requests, but will queue them until update arrives or the client times out waiting for the resource.", "This resource has been requested by the client but has either not been delivered by the server or was previously delivered by the server and then subsequently removed from resources provided by the server. For more information, please refer to the :ref:`\"Knowing When a Requested Resource Does Not Exist\" ` section.", "Client received this resource and replied with ACK.", - "Client received this resource and replied with NACK." + "Client received this resource and replied with NACK.", + "Client received an error from the control plane. The attached config dump is the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.", + "Client timed out waiting for the resource from the control plane." ], "type": "string" }, @@ -481,14 +493,18 @@ "REQUESTED", "DOES_NOT_EXIST", "ACKED", - "NACKED" + "NACKED", + "RECEIVED_ERROR", + "TIMEOUT" ], "enumDescriptions": [ "Resource status is not available/unknown.", "Client requested this resource but hasn't received any update from management server. The client will not fail requests, but will queue them until update arrives or the client times out waiting for the resource.", "This resource has been requested by the client but has either not been delivered by the server or was previously delivered by the server and then subsequently removed from resources provided by the server. For more information, please refer to the :ref:`\"Knowing When a Requested Resource Does Not Exist\" ` section.", "Client received this resource and replied with ACK.", - "Client received this resource and replied with NACK." + "Client received this resource and replied with NACK.", + "Client received an error from the control plane. The attached config dump is the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.", + "Client timed out waiting for the resource from the control plane." ], "type": "string" }, @@ -527,14 +543,18 @@ "REQUESTED", "DOES_NOT_EXIST", "ACKED", - "NACKED" + "NACKED", + "RECEIVED_ERROR", + "TIMEOUT" ], "enumDescriptions": [ "Resource status is not available/unknown.", "Client requested this resource but hasn't received any update from management server. The client will not fail requests, but will queue them until update arrives or the client times out waiting for the resource.", "This resource has been requested by the client but has either not been delivered by the server or was previously delivered by the server and then subsequently removed from resources provided by the server. For more information, please refer to the :ref:`\"Knowing When a Requested Resource Does Not Exist\" ` section.", "Client received this resource and replied with ACK.", - "Client received this resource and replied with NACK." + "Client received this resource and replied with NACK.", + "Client received an error from the control plane. The attached config dump is the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.", + "Client timed out waiting for the resource from the control plane." ], "type": "string" }, @@ -651,14 +671,18 @@ "REQUESTED", "DOES_NOT_EXIST", "ACKED", - "NACKED" + "NACKED", + "RECEIVED_ERROR", + "TIMEOUT" ], "enumDescriptions": [ "Resource status is not available/unknown.", "Client requested this resource but hasn't received any update from management server. The client will not fail requests, but will queue them until update arrives or the client times out waiting for the resource.", "This resource has been requested by the client but has either not been delivered by the server or was previously delivered by the server and then subsequently removed from resources provided by the server. For more information, please refer to the :ref:`\"Knowing When a Requested Resource Does Not Exist\" ` section.", "Client received this resource and replied with ACK.", - "Client received this resource and replied with NACK." + "Client received this resource and replied with NACK.", + "Client received an error from the control plane. The attached config dump is the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.", + "Client timed out waiting for the resource from the control plane." ], "type": "string" }, @@ -937,13 +961,15 @@ "CLIENT_UNKNOWN", "CLIENT_REQUESTED", "CLIENT_ACKED", - "CLIENT_NACKED" + "CLIENT_NACKED", + "CLIENT_RECEIVED_ERROR" ], "enumDescriptions": [ "Config status is not available/unknown.", "Client requested the config but hasn't received any config from management server yet.", "Client received the config and replied with ACK.", - "Client received the config and replied with NACK. Notably, the attached config dump is not the NACKed version, but the most recent accepted one. If no config is accepted yet, the attached config dump will be empty." + "Client received the config and replied with NACK. Notably, the attached config dump is not the NACKed version, but the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.", + "Client received an error from the control plane. The attached config dump is the most recent accepted one. If no config is accepted yet, the attached config dump will be empty." ], "type": "string" }, diff --git a/src/apis/index.ts b/src/apis/index.ts index df3c3f7f990..d11944c1608 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -423,6 +423,7 @@ import { VERSIONS as managedidentitiesVersions, managedidentities, } from './managedidentities'; +import {VERSIONS as managedkafkaVersions, managedkafka} from './managedkafka'; import { VERSIONS as manufacturersVersions, manufacturers, @@ -919,6 +920,7 @@ export const APIS: APIList = { logging: loggingVersions, looker: lookerVersions, managedidentities: managedidentitiesVersions, + managedkafka: managedkafkaVersions, manufacturers: manufacturersVersions, marketingplatformadmin: marketingplatformadminVersions, meet: meetVersions, @@ -1228,6 +1230,7 @@ export class GeneratedAPIs { logging = logging; looker = looker; managedidentities = managedidentities; + managedkafka = managedkafka; manufacturers = manufacturers; marketingplatformadmin = marketingplatformadmin; meet = meet; diff --git a/src/index.ts b/src/index.ts index ed413ed1845..fe764bbf728 100644 --- a/src/index.ts +++ b/src/index.ts @@ -341,6 +341,7 @@ export {looker_v1} from './apis/looker/v1'; export {managedidentities_v1} from './apis/managedidentities/v1'; export {managedidentities_v1alpha1} from './apis/managedidentities/v1alpha1'; export {managedidentities_v1beta1} from './apis/managedidentities/v1beta1'; +export {managedkafka_v1} from './apis/managedkafka/v1'; export {manufacturers_v1} from './apis/manufacturers/v1'; export {marketingplatformadmin_v1alpha} from './apis/marketingplatformadmin/v1alpha'; export {meet_v2} from './apis/meet/v2'; From fd76f2d797750a1f9c7c4c6ed5b337f0949d05b7 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 18 Mar 2025 00:06:49 +0000 Subject: [PATCH 144/144] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= =?UTF-8?q?=20post-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- release-please-config.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/release-please-config.json b/release-please-config.json index 318b8be433f..39576cd4786 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -308,6 +308,7 @@ "src/apis/netapp": {}, "src/apis/parallelstore": {}, "src/apis/securityposture": {}, - "src/apis/areainsights": {} + "src/apis/areainsights": {}, + "src/apis/managedkafka": {} } } \ No newline at end of file